Class Subscription

Name

Subscription

Hierarchy

Subscription

Index

Constructors

Methods

getSubject getSubscriptionListener setContainerWindow unsubscribe

Constructors

constructor

new Subscription(): Subscription
Returns Subscription

Methods

getSubject

getSubject(): string
Returns the subject name to which the subscription relates (for example, /FX/EURUSD).

Returns string
The subject of this subscription.

getSubscriptionListener

getSubscriptionListener(): SubscriptionListener
Returns the SubscriptionListener that is informed of all subscription events relating to this subscription.

Returns SubscriptionListener
The subscription listener.

setContainerWindow

setContainerWindow(start, size): void
Sets the container window for this subscription.

If the subject type of this subscription is not a container then this method will throw an exception.

Note: A container element is referred to by its index within the container. The first element of a container has index 0 (zero).
Parameters
- start: number
  
  The index of the container element that is at the start of the container window.
- size: number
  
  The number of elements in the container window.
Returns void

unsubscribe

unsubscribe(): void
Unsubscribes to the subject on the Liberator.

Returns void

Generated using TypeDoc