Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubscriptionListener

name

SubscriptionListener

Hierarchy

  • SubscriptionListener

Index

Methods

Optional onChatUpdate

  • Called when a chat update is received. Implementing this method is optional.

    Parameters

    • subscription: Subscription

      The subscription for which the update occurred.

    • evt: ChatEvent

      The chat update.

    Returns void

Optional onContainerUpdate

  • Called when a container update is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onDirectoryUpdate

  • Called when a directory update is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onJsonUpdate

  • Called when a json update is received. Implementing this method is optional.

    Parameters

    • subscription: Subscription

      The subscription for which the update occurred.

    • evt: JsonEvent

      The JSON update.

    Returns void

Optional onNewsUpdate

  • Called when a news headline update is received. Implementing this method is optional.

    Parameters

    • subscription: Subscription

      The subscription for which the update occurred.

    • evt: NewsEvent

      The news headline update.

    Returns void

Optional onPageUpdate

  • Called when a page update is received. Implementing this method is optional.

    Parameters

    • subscription: Subscription

      The subscription for which the update occurred.

    • evt: PageEvent

      The page update.

    Returns void

Optional onPermissionUpdate

  • Called when a permission update is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onRecordType2Update

  • Called when an update to type 2 data in a record is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onRecordType3Update

  • Called when an update to type 3 data in a record is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onRecordUpdate

  • Called when an update to type 1 data in a record is received. Implementing this method is optional.

    Parameters

    Returns void

Optional onStoryUpdate

  • Called when a news story update is received. Implementing this method is optional.

    Parameters

    • subscription: Subscription

      The subscription for which the update occurred.

    • evt: StoryEvent

      The news story update.

    Returns void

onSubscriptionError

  • Called when there is an error in a subscription.

    This callback being invoked is a final state for the subscription and no further callbacks will be received for it.

    Parameters

    Returns void

onSubscriptionStatus

  • Called when there is a change in the status of a subscription.

    Parameters

    Returns void

Generated using TypeDoc