Protected
内部state
がSubscriptionSetState.Errorの場合、これはSubscriptionSetがエラー状態である理由を表す string になります。 エラーが発生しない場合はnull
になります。
エラーを表す string、エラーがない場合はnull
。
セット内にサブスクライブがないかどうか。
true
セット内にサブスクライブがない場合は、それ以外の場合はfalse
。
セット内のサブスクライブの数。
SubscriptionSet の状態。
SubscriptionSet のバージョン。 この値は、 SubscriptionSet.updateが適用されるたびに増加します。
SubscriptionSetのバージョン。
サブスクリプション セットを反復可能にします。
セット内の各値の反復可能値。
for (const subscription of subscriptions) {
// ...
}
これを呼び出して、セットからサブスクリプションを追加したり削除したりするなど、コールバック内からこの SubscriptionSet に変更を加えます。
MutableSubscriptionSet 引数は コールバックからのみ使用でき、返された後は使用しないでください。
コールバックによって行われた変更はすべてバッチ化され、サーバーに送信されます。 update
への呼び出しをawait
にするか、 SubscriptionSet.waitForSynchronizationを呼び出して新しいデータが利用可能になるまで待機します。
セットからサブスクリプションを追加または削除するために使用できるMutableSubscriptionSetインスタンスを最初の引数として受け取り、2 番目の引数として SubscriptionSet に関連付けられたRealmを受け取るコールバック関数(主にFlexibleSyncConfigurationでinitialSubscriptions
を操作する場合に便利です)。
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
サーバーがこのサブスクリプションのセットを確認し、一致するオブジェクトを返すまで待ちます。
state
がSubscriptionSetState.Completeの場合、Promise はすぐに解決されます。
state
がSubscriptionSetState.Errorの場合、Promise はすぐに拒否されます。
同期が完了したときに解決される Promise 、同期中にエラーが発生した場合は拒否される Promise 。
TypeDocを使用して生成
Realm インスタンスのすべてのアクティブな同期サブスクライブのセットを表します。
サーバーは、 インスタンスがサブスクライブされているクエリを継続的に評価し、それに一致するデータを送信し、不要なデータを削除します。
サブスクリプションのセットは、対応する MutableSubscriptionSet インスタンスでメソッドを呼び出すことで、 SubscriptionSet.update コールバック内でのみ変更できます。