クラスサブスクリプションセット

Realm インスタンスのすべてのアクティブな同期サブスクライブのセットを表します。

サーバーは、 インスタンスがサブスクライブされているクエリを継続的に評価し、それに一致するデータを送信し、不要なデータを削除します。

サブスクリプションのセットは、対応する MutableSubscriptionSet インスタンスでメソッドを呼び出すことで、 SubscriptionSet.update コールバック内でのみ変更できます。

階層(完全に表示

コンストラクター

アクセス

  • エラー発生 : null | string
  • stateSubscriptionSetState.Errorの場合、これはSubscriptionSetがエラー状態である理由を表す string になります。 エラーが発生しない場合はnullになります。

    null |を返すstring

    エラーを表す string、エラーがない場合はnull

  • get isEmpty ( ) :ブール値
  • セット内にサブスクライブがないかどうか。

    ブール値を返します

    true セット内にサブスクライブがない場合は、それ以外の場合はfalse

  • 長さを取得する :数値
  • 数値を返します

    セット内のサブスクライブの数。

  • 状態を取得します : SubscriptionSetState
  • SubscriptionSetState を返す

    SubscriptionSet の状態。

  • バージョン :番号
  • SubscriptionSet のバージョン。 この値は、 SubscriptionSet.updateが適用されるたびに増加します。

    数値を返します

    SubscriptionSetのバージョン。

メソッド

  • サブスクリプション セットを反復可能にします。

    イテラブル 返す

    セット内の各値の反復可能値。

    for (const subscription of subscriptions) {
    // ...
    }
  • 名前でサブスクライブを検索します。

    パラメーター

    • name : string

      検索する名前。

    null |を返すサブスクライブ

    名前付きサブスクライブ。サブスクライブが見つからない場合はnull

  • これを呼び出して、セットからサブスクリプションを追加したり削除したりするなど、コールバック内からこの SubscriptionSet に変更を加えます。

    MutableSubscriptionSet 引数は コールバックからのみ使用でき、返された後は使用しないでください。

    コールバックによって行われた変更はすべてバッチ化され、サーバーに送信されます。 updateへの呼び出しをawaitにするか、 SubscriptionSet.waitForSynchronizationを呼び出して新しいデータが利用可能になるまで待機します。

    パラメーター

    • コールバック: 可変サブスクリプションRealm =>無効

      セットからサブスクリプションを追加または削除するために使用できるMutableSubscriptionSetインスタンスを最初の引数として受け取り、2 番目の引数として SubscriptionSet に関連付けられたRealmを受け取るコールバック関数(主にFlexibleSyncConfigurationinitialSubscriptionsを操作する場合に便利です)。

    Returns Promise<void>

    SubscriptionSetが同期されたときに解決される Promise を解決するか、同期中にエラーが発生した場合は拒否される Promise を参照してください。

    await realm.subscriptions.update(mutableSubscriptions => {
    mutableSubscriptions.add(realm.objects("Cat").filtered("age > 10"));
    mutableSubscriptions.add(realm.objects("Dog").filtered("age > 20"), { name: "oldDogs" });
    mutableSubscriptions.removeByName("youngDogs");
    });
    // `realm` will now return the expected results based on the updated subscriptions
  • サーバーがこのサブスクリプションのセットを確認し、一致するオブジェクトを返すまで待ちます。

    stateSubscriptionSetState.Completeの場合、Promise はすぐに解決されます。

    stateSubscriptionSetState.Errorの場合、Promise はすぐに拒否されます。

    Returns Promise<void>

    同期が完了したときに解決される Promise 、同期中にエラーが発生した場合は拒否される Promise 。

TypeDocを使用して生成