Caplin Systems - StreamLinkJS API Documentation

caplin
- streamlink
  - alerts
    - Notification
    - NotificationListener
    - NotificationService
    - ResultListener
    - Trigger
    - TriggerListener
    - TriggerService
    - TriggerState
  - Channel
  - ChannelListener
  - ChatEvent
  - ChatEventType
  - CommandErrorEvent
  - CommandErrorType
  - CommandListener
  - CommandSubscription
  - ConnectionListener
  - ConnectionState
  - ConnectionStatusEvent
  - ConsoleLogListener
  - ContainerElement
  - ContainerEvent
  - ContainerFilterFactory
  - ContainerModel
  - DataEvent
  - DirectoryChangeElement
  - DirectoryEvent
  - ErrorReason
  - FilterExpression
  - FilterExpressionLogicalOperator
  - FilterExpressionOperator
  - KeymasterPollResponseListener
  - LiberatorUrlProvider
  - Logger
  - LoginFailedReason
  - LogInfo
  - LogLevel
  - LogListener
  - NewsEvent
  - PageElement
  - PageEvent
  - PermissionEvent
  - RecordType1Event
  - RecordType2Event
  - RecordType3Event
  - ServiceStatus
  - ServiceStatusEvent
  - SourceStatus
  - SourceStatusEvent
  - StatisticsEvent
  - StoryEvent
  - StreamLink
  - StreamLinkFactory
  - SubjectType
  - Subscription
  - SubscriptionErrorEvent
  - SubscriptionErrorType
  - SubscriptionListener
  - SubscriptionStatusEvent
  - SubscriptionStatusType
  - ThrottleCommand
  - WebRequestParameters

Class

caplin.streamlink

CommandSubscription

Stored information on the subscription and lets you unpersist the command.

Constructor Summary

Attributes	Name and Description
	`caplin.streamlink.CommandSubscription()`

Method Summary

Attributes Name and Description

Attributes	Name and Description
	`void getCommandListener()` * Returns the caplin.streamlink.CommandListener that is informed of success or * failure of this command.
	`void getSubject()` * Returns the subject the command was executed on.
	`void unPersist()` * For commands that have been set as persistent this method will turn off that persistence.


										
										
											void
										
										getCommandListener()

Returns the caplin.streamlink.CommandListener that is informed of success or * failure of this command.


										
										
											void
										
										getSubject()

Returns the subject the command was executed on.


										
										
											void
										
										unPersist()

For commands that have been set as persistent this method will turn off that persistence.

Constructor Detail

► caplin.streamlink.CommandSubscription()

Method Detail

► void getCommandListener()

Returns the caplin.streamlink.CommandListener that is informed of success or * failure of this command.

* * @returns {caplin.streamlink.CommandListener} The command listener.

► void getSubject()

Returns the subject the command was executed on.

* @returns {String} The subject of the command.

► void unPersist()

For commands that have been set as persistent this method will turn off that persistence. * Once persistence is turned off the command will not be resent to the server when a reconnection occurs.