Class Subscription

Used to subscribe to receive updates from remote peers about matching documents.

While Subscription objects remain in scope they ensure that documents in the collection specified and that match the query provided will try to be kept up-to-date with the latest changes from remote peers.

This class is used by Ditto's query builder APIs.

See

SyncSubscription for the DQL equivalent.

Not available in React Native environments.

Deprecated

Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Index

Properties

Accessors

collectionName isCancelled

Methods

Properties

`Readonly`query

query: string

The query that the subscription is based on.

Deprecated

Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Accessors

collectionName

get collectionName(): string
The name of the collection that the subscription is based on.

Returns string
Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

isCancelled

get isCancelled(): boolean
Returns true if subscription has been explicitly cancelled, false otherwise.

Returns boolean
Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Methods

cancel

cancel(): void
Cancels a subscription and releases all associated resources.

Returns void
Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption