Realm JavaScript

Realm~App.Sync.MutableSubscriptionSet

The mutable version of a given SubscriptionSet. The mutable methods of a given Realm.App.Sync.SubscriptionSet instance can only be accessed from inside the Realm.App.Sync.SubscriptionSet#update callback.

Extends

Members

error
readonly

If state is Realm.App.Sync.SubscriptionsState.Error, this will return a string representing why the SubscriptionSet is in an error state. null is returned if there is no error.

Type:
string or null
isEmpty
readonly

Returns true if there are no subscriptions in the set, false otherwise.

Type:
boolean
length
readonly

The number of subscriptions in the set.

Type:
number
state
readonly

The state of the SubscriptionSet.

Type:
Realm.App.Sync.SubscriptionSetState
version
readonly

The version of the SubscriptionSet. This is incremented every time a Realm.App.Sync.SubscriptionSet#update is applied.

Type:
number

Methods

add(query, options)Realm.App.Sync.Subscription

Adds a query to the set of active subscriptions. The query will be joined via an OR operator with any existing queries for the same type.

A query is represented by a Realm.Results instance returned from Realm#objects, for example: mutableSubs.add(realm.objects("Cat").filtered("age > 10"));.

Parameters:
Returns: Realm.App.Sync.Subscription The new subscription.
remove(query)boolean

Removes a subscription with the given query from the SubscriptionSet.

Parameters:
Returns: boolean true if the subscription was removed, false if it was not found.
removeAll()number

Removes all subscriptions from the SubscriptionSet.

Returns: number The number of subscriptions removed.
removeByName(name)boolean

Removes a subscription with the given name from the SubscriptionSet.

Parameters:
  • name
    • Type: string

    • The name of the subscription to remove.

Returns: boolean true if the subscription was removed, false if it was not found.
removeByObjectType(objectType)number

Removes all subscriptions for the specified object type from the SubscriptionSet.

Parameters:
  • objectType
    • Type: string

    • The string name of the object type to remove all subscriptions for.

Returns: number The number of subscriptions removed.
removeSubscription(subscription)boolean

Removes the specified subscription from the SubscriptionSet.

Parameters:
Returns: boolean true if the subscription was removed, false if it was not found.

Inherited Methods

every(callback, thisArg)boolean
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.every
Parameters:
  • callback
    • Type: function

    • Function to execute on each object in the SubscriptionSet. If this function returns true for every object, then this method will return true. This function takes three arguments:

      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • thisArg optional
    • Type: object

    • The value of this when callback is called.

Returns: boolean representing if callback returned true for every object in the SubscriptionSet.
Since: 0.11.0
findByName(name)Realm.App.Sync.Subscription or null

Find a subscription by name.

Parameters:
  • name
    • Type: string

    • The name to search for.

Returns: Realm.App.Sync.Subscription or null The named subscription, or null if the subscription is not found.
findByQuery(query)Realm.App.Sync.Subscription or null

Find a subscription by query. Will match both named and unnamed subscriptions.

Parameters:
  • query
    • Type: Realm.Results

    • The query to search for, represented as a Realm.Results instance, e.g. Realm.objects("Cat").filtered("age > 10").

Returns: Realm.App.Sync.Subscription or null The subscription with the specified query, or null if the subscription is not found.
forEach(callback, thisArg)
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.forEach
Parameters:
  • callback
    • Type: function

    • Function to execute on each object in the SubscriptionSet. This function takes three arguments:

      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • thisArg optional
    • Type: object

    • The value of this when callback is called.

Since: 0.11.0
map(callback, thisArg)[any, ...]
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.map
Parameters:
  • callback
    • Type: function

    • Function to execute on each object in the SubscriptionSet. This function takes three arguments:

      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • thisArg optional
    • Type: object

    • The value of this when callback is called.

Returns: [any, ...] – the return values of callback after being called on every object in the SubscriptionSet.
Since: 0.11.0
reduce(callback, initialValue)any
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.reduce
Parameters:
  • callback
    • Type: function

    • Function to execute on each object in the SubscriptionSet. This function takes four arguments:

      • previousValue – The value previously returned in the last invocation of the callback, or initialValue, if supplied.
      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • initialValue optional
    • Type: object

    • The value to use as the first argument to the first call of the callback.

Throws:
  • TypeError

    • If the SubscriptionSet is empty and no initialValue was supplied.

Returns: any – the value returned by the final invocation of callback, except for the following special cases:
  • If SubscriptionSet consists of a single object, and no initalValue was supplied, then that object will be returned.
  • If the SubscriptionSet is empty, then initialValue must be supplied and will be returned.
Since: 0.11.0
reduceRight(callback, initialValue)any
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.reduceRight
Parameters:
  • callback
    • Type: function

    • Function to execute on each object, from right to left, in the SubscriptionSet. This function takes four arguments:

      • previousValue – The value previously returned in the last invocation of the callback, or initialValue, if supplied.
      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • initialValue optional
    • Type: object

    • The value to use as the first argument to the first call of the callback.

Throws:
  • TypeError

    • If the SubscriptionSet is empty and no initialValue was supplied.

Returns: any – the value returned by the final invocation of callback, except for the following special cases:
  • If SubscriptionSet consists of a single object, and no initalValue was supplied, then that object will be returned.
  • If the SubscriptionSet is empty, then initialValue must be supplied and will be returned.
Since: 0.11.0
some(callback, thisArg)boolean
Deprecated: Will be removed in v12.0.0.
See: Array.prototype.some
Parameters:
  • callback
    • Type: function

    • Function to execute on each object in the SubscriptionSet. If this function ever returns true, then this method will return true. This function takes three arguments:

      • object – The current object being processed in the SubscriptionSet.
      • index – The index of the object being processed in the SubscriptionSet.
      • subscriptionSet – The SubscriptionSet itself.
  • thisArg optional
    • Type: object

    • The value of this when callback is called.

Returns: boolean – true when callback returns true for an object in the SubscriptionSet, otherwise false.
Since: 0.11.0