Interface MutableSubscriptionSet

On this page

io.realm.mongodb.sync

Method Summary
Inherited Methods
Method Detail
add
addOrUpdate
remove
removeAll

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm.mongodb.sync

Implemented interfaces:

A mutable subscription set is available when calling SubscriptionSet.update(UpdateCallback) This is the only way to modify a SubscriptionSet . Subscription s can be either

managed or unmanaged. Unmanaged subscriptions are those created by using Subscription.create(RealmQuery) or Subscription.create(String, RealmQuery) , while managed subscriptions are the ones being returned from the subscription set.

Tip

Method Summary

Modifier and Type	Method and Description
public Subscription	add ( Subscription subscription ) Adds a new unmanaged subscription to the subscription set.
public Subscription	addOrUpdate ( Subscription subscription ) Add a new subscription or update an existing named subscription.
public boolean	remove ( String name ) Remove a named subscription.
public boolean	remove ( Subscription subscription ) Remove a managed subscription.
public boolean	removeAll () Remove all current managed subscriptions.
public boolean	removeAll <T >( java.lang.Class<T> clazz ) Remove all subscriptions with queries on a given given model class.
public boolean	removeAll ( String objectType ) Remove all subscriptions on a given Subscription.getObjectType() .

Inherited Methods

Method Detail

add

public Subscription add ( Subscription subscription )
Adds a new unmanaged subscription to the subscription set. Parameters `subscription` - unmanaged subscription to add. Returns the newly added managed subscription. Throws IllegalArgumentException - if a subscription matching the provided one already exists.

addOrUpdate

public Subscription addOrUpdate (

Subscription subscription

)

Add a new subscription or update an existing named subscription. It isn't possible to update an anonymous subscription. These must removed and re-inserted.

Parameters

subscription - anonymous or named subscription created via Subscription.create(...) , used to update a matching one within a specific set. It creates a new one in case there is no match..

Returns

the updated or inserted managed subscription.

remove

public boolean remove ( String name )
Remove a named subscription. Parameters `name` - name of managed subscription to remove. Returns `true` if the subscription was removed, `false` if not.

public boolean remove ( Subscription subscription )
Remove a managed subscription. Parameters `subscription` - managed subscription to remove Returns `true` if the subscription was removed, `false` if not. Throws IllegalArgumentException - if the subscription provided is unmanaged. Only managed subscriptions can be used as input.

removeAll

public boolean removeAll ()
Remove all current managed subscriptions. Returns `true` if 1 or more subscriptions were removed, `false` if no subscriptions were removed.

public boolean removeAll <T >( java.lang.Class<T> clazz )
Remove all subscriptions with queries on a given given model class. Parameters `clazz` - subscriptions on this type will be removed. Returns `true` if 1 or more subscriptions were removed, `false` if no subscriptions were removed.

public boolean removeAll ( String objectType )
Remove all subscriptions on a given Subscription.getObjectType() . Parameters `objectType` - subscriptions on this object type will be removed. Returns `true` if 1 or more subscriptions were removed, `false` if no subscriptions were removed.

Back

ManuallyRecoverUnsyncedChangesStrategy

Progress