Class Subscription

Class representing a single query subscription in a set of flexible sync SubscriptionSet. This class contains readonly information about the subscription – any changes to the set of subscriptions must be carried out in a SubscriptionSet.update callback.

Constructors

constructor

Accessors

createdAt id name objectType queryString updatedAt

Constructors

constructor

Accessors

createdAt

  • get createdAt(): Date

  • The date when this subscription was created.

    Returns Date

    The date when this subscription was created.

id

  • get id(): ObjectId

  • The ObjectId of the subscription.

    Returns ObjectId

    The ObjectId of the subscription.

name

  • get name(): null | string

  • The name given to this subscription when it was created. If no name was set, this will be null.

    Returns null | string

    The name of the subscription or null if unnamed.

objectType

  • get objectType(): string

  • The type of objects the subscription refers to.

    Returns string

    The type of objects the subscription refers to.

queryString

  • get queryString(): string

  • The string representation of the query the subscription was created with. If no filter or sort was specified, this will be "TRUEPREDICATE".

    Returns string

    The string representation of the query the subscription was created with.

updatedAt

  • get updatedAt(): Date

  • The date when this subscription was last updated.

    Returns Date

    The date when this subscription was last updated.

Settings

Theme

On This Page

Generated using TypeDoc