ノード
stateがRealm.App.Sync.SubscriptionsState.Errorの場合、SubscriptionSet がエラー状態になっている理由を表すstringが返されます。 エラーがない場合はnullが返されます。
タイプ:
string or null
セットにサブスクライブがない場合はtrue 、そうでない場合はfalseを返します。
タイプ:
boolean
セット内のサブスクライブの数。
タイプ:
number
SubscriptionSet の状態。
タイプ:
Realm.App.Sync.SubscriptionSetState
SubscriptionSet のバージョン。 この数値はRealm.App.Sync.SubscriptionSet#updateが適用されるたびに増加します。
タイプ:
number
メソッド
- コールバック
- タイプ:
function コールバック関数は、最初の引数として
Realm.App.Sync.MutableSubscriptionSetインスタンスを受け取ります。これはセットからサブスクリプションを追加または削除するために使用でき、2 番目の引数として SubscriptionSet に関連付けられた Realm を使用します（主に { でRealm.App.Sync~FlexibleSyncConfigurationinitialSubscriptionsを操作する場合に役立ちます） ）。注意: コールバックは非同期であってはなりません。
Promise<void>
SubscriptionSet を更新し、このインスタンスが更新された SubscriptionSet を指すように変更します。
セットからのサブスクリプションの追加または削除は、このメソッドのコールバック引数内で実行される必要があり、ミューテーション メソッドは元のRealm.App.Sync.SubscriptionSetインスタンスではなくmutableSubs引数で呼び出される必要があります。
コールバックが実行された後のサブスクリプションに対する変更はバッチされてサーバーに送信されます。 awaitはupdateを呼び出すか、 Realm.App.Sync.SubscriptionSet#waitForSynchronizationを呼び出して新しいデータが利用可能になるまで待機します。
例:
await realm.subscriptions.update(mutableSubs => {
mutableSubs.add(realm.objects("Cat").filtered("age > 10"));
mutableSubs.add(realm.objects("Dog").filtered("age > 20"));
mutableSubs.removeByName("personSubs");
});
// `realm` will now return the expected results based on the updated subscriptions
パラメーター:
Promise<void> SubscriptionSet が同期されたときに解決されるか、同期中にエラーが発生した場合は拒否される Promise を返します（ waitForSynchronisationを参照）
Promise<void>
サーバーがこのサブスクリプションのセットを確認し、一致するオブジェクトを返すまで待ちます。
stateがRealm.App.Sync.SubscriptionSetState.Completeの場合、Promise はすぐに解決されます。
stateがRealm.App.Sync.SubscriptionSetState.Errorの場合、Promise はすぐに拒否されます。
Promise<void>同期が完了したときに解決されるか、同期中にエラーが発生した場合は拒否される Promise を返します。
継承されたメソッド
- コールバック
- タイプ:
function SubscriptionSet 内の各オブジェクトで実行する関数。 この関数がすべてのオブジェクトに対して
trueを返す場合、このメソッドはtrueを返します。 この関数は 3 つの引数を取ります。object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- このArg 任意
- タイプ:
object callbackが呼び出されるときのthisの値。- name
- タイプ:
string 検索する名前。
- クエリ
- タイプ:
Realm.Results 検索するクエリは
Realm.Resultsインスタンスとして表されます。例:Realm.objects("Cat").filtered("age > 10")。- コールバック
- タイプ:
function SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 3 つの引数を取ります。
object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- このArg 任意
- タイプ:
object callbackが呼び出されるときのthisの値。- コールバック
- タイプ:
function SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 3 つの引数を取ります。
object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- このArg 任意
- タイプ:
object callbackが呼び出されるときのthisの値。- コールバック
- タイプ:
function SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 4 つの引数を取ります。
previousValue- コールバックの最後の呼び出しで返された値、または指定されている場合はinitialValue。object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- initialValue 任意
- タイプ:
object callbackの最初の呼び出しの最初の引数として使用する値。-
TypeErrorSubscriptionSet が空で、
initialValueが指定されていない場合。
- SubscriptionSet が単一のオブジェクトで構成されており、
initalValueが指定されていない場合は、そのオブジェクトが返されます。 - SubscriptionSet が空の場合は、
initialValueを指定する必要があります。また、 が返されます。 - コールバック
- タイプ:
function SubscriptionSet 内の右から左の各オブジェクトで実行する関数。 この関数は 4 つの引数を取ります。
previousValue- コールバックの最後の呼び出しで返された値、または指定されている場合はinitialValue。object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- initialValue 任意
- タイプ:
object callbackの最初の呼び出しの最初の引数として使用する値。-
TypeErrorSubscriptionSet が空で、
initialValueが指定されていない場合。
- SubscriptionSet が単一のオブジェクトで構成されており、
initalValueが指定されていない場合は、そのオブジェクトが返されます。 - SubscriptionSet が空の場合は、
initialValueを指定する必要があります。また、 が返されます。 - コールバック
- タイプ:
function SubscriptionSet 内の各オブジェクトで実行する関数。 この関数が
trueを返す場合、このメソッドはtrueを返します。 この関数は 3 つの引数を取ります。object- SubscriptionSet で処理されている現在のオブジェクト。index- SubscriptionSet で処理されているオブジェクトのインデックス。subscriptionSet- SubscriptionSet 自体。
- このArg 任意
- タイプ:
object callbackが呼び出されるときのthisの値。
boolean
パラメーター:
booleancallbacktrueSubscriptionSet 内のすべてのオブジェクトに対して が を返したかどうかを表す : を 返します 。
Realm.App.Sync.Subscription or null
名前でサブスクライブを検索します。
パラメーター:
Realm.App.Sync.Subscriptionまたはnull名前付きサブスクリプション、サブスクライブが見つからない場合はnullを返します。
Realm.App.Sync.Subscription or null
クエリでサブスクライブを見つけます。 名前付きサブスクライブと名前のないサブスクライブの両方に一致します。
パラメーター:
null null Realm.App.Sync.Subscription返します。
パラメーター:
[any, ...]
パラメーター:
[any, ...] - SubscriptionSet 内のすべてのオブジェクトで呼び出された後、 callbackの戻り値。
any
パラメーター:
次の例外をスローします。
any - callbackの最後の呼び出しによって返された値。ただし、次の特殊なケースを除く。
any
パラメーター:
次の例外をスローします。
any - callbackの最後の呼び出しによって返された値。ただし、次の特殊なケースを除く。
boolean
パラメーター:
boolean - trueが SubscriptionSet 内のオブジェクトに対してtrue callback返し、それ以外の場合はfalseを返します。