Realm JavaScript

Realm ～ App .Sync . MutableSubscriptionSet

特定の SubscriptionSet の可変バージョン。 特定のRealm.App.Sync.SubscriptionSetインスタンスの可変メソッドには、 Realm.App.Sync.SubscriptionSet#updateコールバック内からのみアクセスできます。

拡張

ノード

エラー
readOnly

stateがRealm.App.Sync.SubscriptionsState.Errorの場合、SubscriptionSet がエラー状態になっている理由を表すstringが返されます。 エラーがない場合はnullが返されます。

タイプ:
string or null
isEmpty
readOnly

セットにサブスクライブがない場合はtrue 、そうでない場合はfalseを返します。

タイプ:
boolean
Length
readOnly

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

タイプ:
number
状態
readOnly

SubscriptionSet の状態。

タイプ:
Realm.App.Sync.SubscriptionSetState
バージョン
readOnly

SubscriptionSet のバージョン。 この数値はRealm.App.Sync.SubscriptionSet#updateが適用されるたびに増加します。

タイプ:
number

メソッド

add（クエリ、オプション）Realm.App.Sync.Subscription

アクティブなサブスクライブのセットにクエリを追加します。 クエリは、同じタイプの既存のクエリとOR演算子を介して結合されます。

クエリは、 から返されたRealm.Results Realm#objectsインスタンスによって表されます（例:mutableSubs.add(realm.objects("Cat").filtered("age > 10")); 。

パラメーター:
返します: Realm.App.Sync.Subscription新しいサブスクライブ。
delete（クエリ）boolean

指定されたクエリを持つサブスクリプションを SubscriptionSet から削除します。

パラメーター:
  • クエリ
booleantrueサブスクリプションが削除された場合は 、見つからない場合は をfalse 返します 。
すべて削除()number

SubscriptionSet からすべてのサブスクライブを削除します。

戻り値: number削除されたサブスクライブの数。
deleteByName（名前）boolean

指定された名前のサブスクライブを SubscriptionSet から削除します。

パラメーター:
  • name
    • タイプ: string

    • 削除するサブスクライブの名前。

booleantrueサブスクリプションが削除された場合は 、見つからない場合は をfalse 返します 。
deleteByObjectType(objectType)number

指定されたオブジェクトタイプのすべてのサブスクライブを SubscriptionSet から削除します。

パラメーター:
  • objectType
    • タイプ: string

    • すべてのサブスクライブを削除するオブジェクトタイプの string 名。

戻り値: number削除されたサブスクライブの数。
deleteSubscription（サブスクライブ）boolean

指定したサブスクリプションを SubscriptionSet から削除します。

パラメーター:
booleantrueサブスクリプションが削除された場合は 、見つからない場合は をfalse 返します 。

継承されたメソッド

すべて（コールバック、このArg ）boolean
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.every
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の各オブジェクトで実行する関数。 この関数がすべてのオブジェクトに対してtrueを返す場合、このメソッドはtrueを返します。 この関数は 3 つの引数を取ります。

      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • このArg 任意
    • タイプ: object

    • callbackが呼び出されるときのthisの値。

booleancallbacktrueSubscriptionSet 内のすべてのオブジェクトに対して が を返したかどうかを表す : を 返します 。
since: 0.11.0
findByName（名前）Realm.App.Sync.Subscription or null

名前でサブスクライブを検索します。

パラメーター:
  • name
    • タイプ: string

    • 検索する名前。

を返します。 Realm.App.Sync.Subscriptionまたはnull名前付きサブスクリプション、サブスクライブが見つからない場合はnullを返します。
findByQuery（クエリ）Realm.App.Sync.Subscription or null

クエリでサブスクライブを見つけます。 名前付きサブスクライブと名前のないサブスクライブの両方に一致します。

パラメーター:
  • クエリ
    • タイプ: Realm.Results

    • 検索するクエリはRealm.Resultsインスタンスとして表されます。例: Realm.objects("Cat").filtered("age > 10") 。

指定されたクエリを含むサブスクリプションを返します。サブスクライブが見つからない場合はnull null Realm.App.Sync.Subscription返します。
forEach（コールバック、このArg ）
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.forEach
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 3 つの引数を取ります。

      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • このArg 任意
    • タイプ: object

    • callbackが呼び出されるときのthisの値。

since: 0.11.0
map（コールバック、このArg ）[any, ...]
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.map
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 3 つの引数を取ります。

      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • このArg 任意
    • タイプ: object

    • callbackが呼び出されるときのthisの値。

を返します: [any, ...] - SubscriptionSet 内のすべてのオブジェクトで呼び出された後、 callbackの戻り値。
since: 0.11.0
reduce（コールバック、 initialValue ）any
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.reduce
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の各オブジェクトで実行する関数。 この関数は 4 つの引数を取ります。

      • previousValue - コールバックの最後の呼び出しで返された値、または指定されている場合はinitialValue 。
      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • initialValue 任意
    • タイプ: object

    • callbackの最初の呼び出しの最初の引数として使用する値。

次の例外をスローします。
  • TypeError

    • SubscriptionSet が空で、 initialValueが指定されていない場合。

返します: any - callbackの最後の呼び出しによって返された値。ただし、次の特殊なケースを除く。
  • SubscriptionSet が単一のオブジェクトで構成されており、 initalValueが指定されていない場合は、そのオブジェクトが返されます。
  • SubscriptionSet が空の場合は、 initialValueを指定する必要があります。また、 が返されます。
since: 0.11.0
reduceR right（コールバック、 initialValue ）any
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.reduceR right
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の右から左の各オブジェクトで実行する関数。 この関数は 4 つの引数を取ります。

      • previousValue - コールバックの最後の呼び出しで返された値、または指定されている場合はinitialValue 。
      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • initialValue 任意
    • タイプ: object

    • callbackの最初の呼び出しの最初の引数として使用する値。

次の例外をスローします。
  • TypeError

    • SubscriptionSet が空で、 initialValueが指定されていない場合。

返します: any - callbackの最後の呼び出しによって返された値。ただし、次の特殊なケースを除く。
  • SubscriptionSet が単一のオブジェクトで構成されており、 initalValueが指定されていない場合は、そのオブジェクトが返されます。
  • SubscriptionSet が空の場合は、 initialValueを指定する必要があります。また、 が返されます。
since: 0.11.0
いくつかの（コールバック、このArg ）boolean
非推奨: v12.0.0 で削除されます。
次を参照してください。 Array.prototype.sort
パラメーター:
  • コールバック
    • タイプ: function

    • SubscriptionSet 内の各オブジェクトで実行する関数。 この関数がtrueを返す場合、このメソッドはtrueを返します。 この関数は 3 つの引数を取ります。

      • object - SubscriptionSet で処理されている現在のオブジェクト。
      • index - SubscriptionSet で処理されているオブジェクトのインデックス。
      • subscriptionSet - SubscriptionSet 自体。
  • このArg 任意
    • タイプ: object

    • callbackが呼び出されるときのthisの値。

次の値を返します: boolean - trueが SubscriptionSet 内のオブジェクトに対してtrue callback返し、それ以外の場合はfalseを返します。
since: 0.11.0