Home | Class Index
Class
caplin.streamlink

SubscriptionStatusEvent

Provides information about a change in the state of a subscription.

The SubscriptionStatusEvent will be provided on a onSubscriptionStatus callback to a caplin.streamlink.SubscriptionListener.

Constructor Summary

Attributes Name and Description
caplin.streamlink.SubscriptionStatusEvent()

Method Summary

Attributes Name and Description
Object getFields()

Returns any fields associated with the status event.
caplin.streamlink.SubscriptionStatusType getStatus()

Returns the new status of the subject of the subscription.
String getStatusMessage()

Returns the new status message of the subject of the subscription.
String getSubject()

Returns the subject of the subscription to which the event relates.

Constructor Detail

► caplin.streamlink.SubscriptionStatusEvent()

Method Detail

► Object getFields()

Returns any fields associated with the status event.

The fields may contain metadata related to the event, the known keys are "code" and "status".

Returns
{Object} the fields

► caplin.streamlink.SubscriptionStatusType getStatus()

Returns the new status of the subject of the subscription.

Returns
{caplin.streamlink.SubscriptionStatusType} The new status.

► String getStatusMessage()

Returns the new status message of the subject of the subscription.

Returns
{String} The new status message.

► String getSubject()

Returns the subject of the subscription to which the event relates.

Returns
{String} The subject.