Class SubscriptionListener

Name

SubscriptionListener

Hierarchy

SubscriptionListener

Index

Constructors

Methods

onChatUpdate? onContainerUpdate? onDirectoryUpdate? onJsonUpdate? onNewsUpdate? onPageUpdate? onPermissionUpdate? onRecordType2Update? onRecordType3Update? onRecordUpdate? onStoryUpdate? onSubscriptionError onSubscriptionStatus

Constructors

constructor

new SubscriptionListener(): SubscriptionListener
Returns SubscriptionListener

Methods

`Optional` onChatUpdate

onChatUpdate(subscription, evt): void
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

onContainerUpdate(subscription, evt): void
Called when a container update is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: ContainerEvent
  
  The container update.
Returns void

`Optional` onDirectoryUpdate

onDirectoryUpdate(subscription, evt): void
Called when a directory update is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: DirectoryEvent
  
  The directory update.
Returns void

`Optional` onJsonUpdate

onJsonUpdate(subscription, evt): void
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

onNewsUpdate(subscription, evt): void
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

onPageUpdate(subscription, evt): void
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

onPermissionUpdate(subscription, evt): void
Called when a permission update is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: PermissionEvent
  
  The permission update.
Returns void

`Optional` onRecordType2Update

onRecordType2Update(subscription, evt): void
Called when an update to type 2 data in a record is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: RecordType2Event
  
  The record update.
Returns void

`Optional` onRecordType3Update

onRecordType3Update(subscription, evt): void
Called when an update to type 3 data in a record is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: RecordType3Event
  
  The record update.
Returns void

`Optional` onRecordUpdate

onRecordUpdate(subscription, evt): void
Called when an update to type 1 data in a record is received. Implementing this method is optional.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: RecordType1Event
  
  The record update.
Returns void

`Optional` onStoryUpdate

onStoryUpdate(subscription, evt): void
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

onSubscriptionError(subscription, evt): void
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
- subscription: Subscription
  
  The subscription for which the error occurred.
- evt: SubscriptionErrorEvent
  
  The subscription error event.
Returns void

onSubscriptionStatus

onSubscriptionStatus(subscription, evt): void
Called when there is a change in the status of a subscription.
Parameters
- subscription: Subscription
  
  The subscription for which the update occurred.
- evt: SubscriptionStatusEvent
  
  The subscription status event.
Returns void

Generated using TypeDoc