Interface: LongTermSubscriptionService

ServerlessDb.LongTermSubscriptionService

Interface common to all Webcom services that support LongTermSubscriptions, namely the ServerlessDb and ServerlessDbLite services.

Since:
  • 3.5

Extends

  • WebcomService

Members

(protected) _ltsAuth :Authentication.State

Internal authentication state associated with ongoing ServerlessDb.LongTermSubscriptions.

Type:

Methods

cleanLongTermSubscriptions()

Clears all the ongoing long term subscriptions associated with the current authenticated user from the client local storage.

This method requires a user to be authenticated.

WARNING: this method doesn't cancel the subscriptions!
It only removes them from the local storage, so that the ServerlessDb#getLongTermSubscriptions method can no longer retrieve them. Use ServerlessDb.ServerlessDbNode#unsubscribe or ServerlessDbLite.ServerlessDbLiteNode#unsubscribe to actually cancel them (otherwise they may still persist in the Webcom back end).

getLongTermSubscriptions() → {Array.<ServerlessDb.LongTermSubscription>}

Retrieves the list of the ongoing long term subscriptions associated with the current authenticated user, which are stored in the client local storage.

Such subscriptions are stored when invoking the ServerlessDb.ServerlessDbNode#subscribe method with a ServerlessDb.Webhook or the ServerlessDbLite.ServerlessDbLiteNode#subscribe method.

This method requires a user to be authenticated.

Returns:
Type
Array.<ServerlessDb.LongTermSubscription>
show
deprecated