Package io.realm.mongodb.sync

Interface Subscription

public interface Subscription

A subscription defines a specific server query and its metadata. The result of this query is continuously being synchronized with the device as long as the subscription is part of a SubscriptionSet with a state of SubscriptionSet.State.COMPLETE. Subscriptions are immutable once created, but they can be updated by using a MutableSubscriptionSet.addOrUpdate(Subscription).

Method Summary

Modifier and Type	Method	Description
static Subscription	create(RealmQuery query)	Create an unmanaged anonymous subscription for a flexible sync enabled Realm.
static Subscription	create(String name, RealmQuery query)	Create an unmanaged named subscription for a flexible sync enabled Realm.
Date	getCreatedAt()	Returns the timestamp for when this subscription was persisted.
String	getName()	Returns the name of subscription or null if no name was defined.
String	getObjectType()	Returns the type that is being queried.
String	getQuery()	Returns the subscription query that is running on objects of type getObjectType().
Date	getUpdatedAt()	Returns the timestamp for when a persisted subscription was updated.

Method Detail

create

static Subscription create(String name,
                           RealmQuery query)

Create an unmanaged named subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either MutableSubscriptionSet.add(Subscription) or MutableSubscriptionSet.addOrUpdate(Subscription).

Parameters:

name - the name of the subscription

query - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries.

Returns:

the unmanaged subscription.

create

static Subscription create(RealmQuery query)

Create an unmanaged anonymous subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either MutableSubscriptionSet.add(Subscription) or MutableSubscriptionSet.addOrUpdate(Subscription).

Parameters:

query - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries.

Returns:

the unmanaged subscription.

getCreatedAt

@Nullable
Date getCreatedAt()

Returns the timestamp for when this subscription was persisted. This will return null until the Subscription has been added using either MutableSubscriptionSet.add(Subscription) or MutableSubscriptionSet.addOrUpdate(Subscription).

Returns:

the time this subscription was persisted, or null if the subscription hasn't been persisted yet.

getUpdatedAt

@Nullable
Date getUpdatedAt()

Returns the timestamp for when a persisted subscription was updated. This will return null until the Subscription has been added using either MutableSubscriptionSet.add(Subscription) or MutableSubscriptionSet.addOrUpdate(Subscription).

Returns:

the time this subscription was updated, or null if the subscription hasn't been persisted yet.

getName

@Nullable
String getName()

Returns the name of subscription or null if no name was defined.

Returns:

the name of the subscription.

getObjectType

String getObjectType()

Returns the type that is being queried.

Returns:

the type that is being queried.

getQuery

String getQuery()

Returns the subscription query that is running on objects of type getObjectType().

Returns:

the query covered by this subscription.