Class Index

caplin.streamlink.alerts.Notification

A Notification is an object that can be sent to notify a user of a particular event.

caplin.streamlink.alerts.NotificationListener

Interface that should be implemented to receive notification change callbacks from the NotificationProvider

A trivial implementation of NotificationListener would be:

// A caplin.streamlink.alerts.NotificationListener that can handle
// every possible callback.
			

caplin.streamlink.alerts.NotificationService

A NotificationService subscribes to a Notifications container of the StreamLink user and allows the user to register a listener to be called when notifications are triggered or dismissed.

caplin.streamlink.alerts.ResultListener

An interface that can be registered to be called back when an operation completes.

caplin.streamlink.alerts.Trigger

A Trigger is an object associated with a particular RTTP subject that contains a condition (on the given subjects fields) that when met will trigger a notification message.

caplin.streamlink.alerts.TriggerListener

Interface that should be implemented to receive trigger change callbacks from the TriggerProvider

A trivial implementation of TriggerListener would be:

// A caplin.streamlink.alerts.TriggerListener that can handle
// every possible callback.
			

caplin.streamlink.alerts.TriggerService

A TriggerService subscribes to the Triggers of a StreamLink user and allows the user to register a listener to be called back when triggers are added, removed or modified.

caplin.streamlink.alerts.TriggerState

Enumeration that defines the different states a caplin.streamlink.alerts.Trigger can be in

caplin.streamlink.Channel

Represents a channel to a subject on the Liberator.

caplin.streamlink.ChannelListener

Interface for receiving updates on the channel from the Liberator.

caplin.streamlink.ChatEvent

Provides information about updates to a chat subject.

caplin.streamlink.ChatEventType

Enumeration that defines the type of the caplin.streamlink.ChatEvent.

caplin.streamlink.CommandErrorEvent

Provides error information for commands.

caplin.streamlink.CommandErrorType

Enumeration defining the errors that can occur for a command.

caplin.streamlink.CommandListener

Defines the interface that you should implement to receive information on the result of a command.

caplin.streamlink.CommandSubscription

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

caplin.streamlink.ConnectionListener

Defines the interface for receiving information about changes in the state of the StreamLink connection, the data services available from the Liberator, and the DataSources that are normally connected to the Liberator.

caplin.streamlink.ConnectionState

Enumeration that defines the state of a StreamLink connection to a Liberator.

caplin.streamlink.ConnectionStatusEvent

Provides information about a change in status of the connection to the Liberator.

caplin.streamlink.ConsoleLogListener

Utility class to aid debugging.

caplin.streamlink.ContainerElement

Representation of a subject that is within a container.

caplin.streamlink.ContainerEvent

Represents an update to a container subject.

caplin.streamlink.ContainerFilterFactory

A factory for creating FilterExpressions for use in the caplin.streamlink.ContainerSubscriptionParameters select method.

caplin.streamlink.ContainerModel

This interface defines a model that represents a container.

caplin.streamlink.DataEvent

Provides access to fundamental information about subscription events relating to changes in data, such as the subject and the type of event that has occurred.

caplin.streamlink.DirectoryChangeElement

Provides information about a change to a directory element.

caplin.streamlink.DirectoryEvent

Provides information about a change to a directory.

caplin.streamlink.ErrorReason

Enumeration that defines the reasons for an error being raised in a caplin.streamlink.SubscriptionErrorEvent or a caplin.streamlink.CommandErrorEvent.

caplin.streamlink.FilterExpression

Interface that represents a filter expression.

caplin.streamlink.FilterExpressionLogicalOperator

Enumeration that represents a particular logical operation.

caplin.streamlink.FilterExpressionOperator

Enumeration that represents the operators that are available for a FieldFilterExpression.

caplin.streamlink.JsonEvent

Provides information about a JSON message.

caplin.streamlink.JsonHandler

Handler for parsing and patching JSON objects

caplin.streamlink.KeymasterCookieProvider

The set of cookies provided by this interface will be sent with KeyMaster connections.

caplin.streamlink.KeymasterPollResponseListener

Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses.

caplin.streamlink.LiberatorUrlProvider

The Liberators provided by this interface will be tried in sequence until a connection is established, return null when there are no more Liberators to try.

caplin.streamlink.Logger

Allows StreamLink log messages to be written to the destination of your choice.

caplin.streamlink.LoginFailedReason

Enumeration that defines the reason for a failed login.

caplin.streamlink.LogInfo

Stores log information including message and level of a log entry.

caplin.streamlink.LogLevel

Enumeration that represents the available logging levels.

caplin.streamlink.LogListener

Interface for receiving log messages from the StreamLink application.

caplin.streamlink.NewsEvent

Provides information about a news headline update.

caplin.streamlink.PageElement

Provides information about a single text change for the given row and column in a Page.

caplin.streamlink.PageEvent

Provides information about a change to data in a Page.

caplin.streamlink.PermissionEvent

Provides information about a change to permission data.

caplin.streamlink.RecordType1Event

Provides information about a change to type 1 data (fieldname and data pairs) in a record.

caplin.streamlink.RecordType2Event

Provides information about a change to type 2 data in a record.

caplin.streamlink.RecordType3Event

Provides information about a change to type 3 data in a record.

caplin.streamlink.ServiceStatus

Enumeration that defines the status of a Service.

caplin.streamlink.ServiceStatusEvent

Provides information about the change in status of a data service to which StreamLink is connected via the Liberator.

caplin.streamlink.SourceStatus

Enumeration that defines the status of a source.

caplin.streamlink.SourceStatusEvent

Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator.

caplin.streamlink.StatisticsEvent

Provides access to the statistics relating to an instance of StreamLink.

caplin.streamlink.StoryEvent

Provides information about a change to story data in a Story.

caplin.streamlink.StreamLink

The main StreamLink Class.

caplin.streamlink.SubjectType

Enumeration that represents the available subject types.

caplin.streamlink.Subscription

Represents a subscription to a subject on the Liberator.

caplin.streamlink.SubscriptionErrorEvent

Provides information about a subscription error.

caplin.streamlink.SubscriptionErrorType

Enumeration which represents the errors that can occur for a subject.

caplin.streamlink.SubscriptionListener

Interface for receiving updates to subscribed data from the Liberator.

caplin.streamlink.SubscriptionStatusEvent

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

caplin.streamlink.SubscriptionStatusType

Enumeration that defines the status of a subject.

caplin.streamlink.ThrottleCommand

Enumeration that defines the available throttle levels and throttle commands.

caplin.streamlink.WebRequestParameters

Contains the parameters needed to call a specific Liberator web module.