Package com.caplin.streamlink
The interfaces within this package provide the functionality of StreamLink.
The
StreamLink
interface is the main entry point of the API. You
can create an instance of it using one of the create()
methods available on
StreamLinkFactory
object.-
Interface Summary Interface Description Channel Represents a channel to a subject on the Liberator.ChannelListener Interface for receiving updates on the channel from the Liberator.ChatEvent Provides information about updates to a chat subject.CommandErrorEvent Provides error information for commands.CommandListener Defines the interface that you should implement to receive information on the result of a command.CommandParameters Interface that defines parameters for aCommandSubscription
.CommandSubscription Stored information on the subscription and lets you unpersist the command.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.ConnectionStatusEvent Provides information about a change in status of the connection to the Liberator.ContainerElement Representation of a subject that is within a container.ContainerEvent Represents an update to a container subject.ContainerModel This interface defines a model that represents a container.ContainerSubscriptionParameters Defines the parameters used for Container subscriptions.Credentials Encapsulates authentication information used to log in to a Liberator server.CredentialsProvider This interface defines how to provide the user credentials that StreamLink uses to log into a Liberator server.CredentialsReceiver Interface that your custom implementation ofCredentialsProvider
must call to provide credential information to 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.DirectoryChangeElement Provides information about a change to a directory element.DirectoryEvent Provides information about a change to a directory.FilterExpression Interface that represents a filter expression.FreeFormSubscriptionParameters A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers.JsonEvent Provides information about a JSON message.JsonHandler Handler for parsing and patching JSON objectsKeymasterCookieProvider The set of cookies provided by this interface will be sent with KeyMaster connections.KeymasterPollResponseListener Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses.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.Logger Allows StreamLink log messages to be written to the destination of your choice.LogInfo Stores log information including message and level of a log entry.LogListener Interface for receiving log messages from the StreamLink application.NewsEvent Provides information about a news headline update.PageElement Provides information about a single text change for the given row and column in a Page.PageEvent Provides information about a change to data in a Page.PermissionEvent Provides information about a change to permission data.RecordSubscriptionParameters Defines the parameters used for Record subscriptions.RecordType1Event Provides information about a change to type 1 data (fieldname and data pairs) in a record.RecordType2Event Provides information about a change to type 2 data in a record.RecordType3Event Provides information about a change to type 3 data in a record.ServiceStatusEvent Provides information about the change in status of a data service to which StreamLink is connected via the Liberator.SourceStatusEvent Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator.StatisticsEvent Provides access to the statistics relating to an instance of StreamLink.StoryEvent Provides information about a change to story data in a Story.StreamLink Defines the StreamLink interface.StreamLinkConfiguration Interface that allows the configuration of StreamLink to be defined programmatically.Subscription Represents a subscription to a subject on the Liberator.SubscriptionErrorEvent Provides information about a subscription error.SubscriptionListener Interface for receiving updates to subscribed data from the Liberator.SubscriptionParameters The base interface for defining parameters that apply toSubscription
s.SubscriptionStatusEvent Provides information about a change in the state of a subscription.WebRequestParameters Contains the parameters needed to call a specific Liberator web module. -
Class Summary Class Description BaseConnectionListener Adapter class implementing the ConnectionListener methodsBaseSubscriptionListener Adapter class implementing the SubscriptionListener methodsConsoleLogListener Utility class to aid debugging.ContainerFilterFactory A factory for creating FilterExpressions for use in theContainerSubscriptionParameters
select method.StreamLinkFactory Factory that creates StreamLink instances.STuple -
Enum Summary Enum Description ChatEventType Enumeration that defines the type of theChatEvent
.CommandErrorType Enumeration defining the errors that can occur for a command.ConnectionState Enumeration that defines the state of a StreamLink connection to a Liberator.ErrorReason Enumeration that defines the reasons for an error being raised in aSubscriptionErrorEvent
or aCommandErrorEvent
.FilterExpressionLogicalOperator Enumeration that represents a particular logical operation.FilterExpressionOperator Enumeration that represents the operators that are available for a FieldFilterExpression.LoginFailedReason Enumeration that defines the reason for a failed login.LogLevel Enumeration that represents the available logging levels.ServiceStatus Enumeration that defines the status of a Service.SourceStatus Enumeration that defines the status of a source.SubjectType Enumeration that represents the available subject types.SubscriptionErrorType Enumeration which represents the errors that can occur for a subject.SubscriptionStatusType Enumeration that defines the status of a subject.ThrottleCommand Enumeration that defines the available throttle levels and throttle commands.