Caplin Systems - Index (StreamLinkAndroid 6.2.10-3513-c11dd52 API Documentation)

A B C D E F G I K L M N O P R S T U V W

A

addConnectionListener(ConnectionListener) - Method in interface com.caplin.streamlink.StreamLink: Adds a connection listener with this StreamLink instance.
addLiberatorUrlGroup(String...) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Adds a group of URLs that define possible Liberator connections.
addListener(NotificationListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Adds a notification listener that will be called back when notifications are triggered or dismissed.
addListener(TriggerListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Adds a trigger listener that will be called back when triggers are added and removed.
addListener(LogListener, LogLevel) - Method in interface com.caplin.streamlink.Logger: Adds a LogListener to this Logger.
addTrigger(String, String, Map<String, String>, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Add a new trigger for the current user.

B

BaseConnectionListener - Class in com.caplin.streamlink: Adapter class implementing the ConnectionListener methods
BaseConnectionListener() - Constructor for class com.caplin.streamlink.BaseConnectionListener
BaseSubscriptionListener - Class in com.caplin.streamlink: Adapter class implementing the SubscriptionListener methods
BaseSubscriptionListener() - Constructor for class com.caplin.streamlink.BaseSubscriptionListener

C

cancel() - Method in interface com.caplin.streamlink.CredentialsProvider: This method is called by the StreamLink library when it needs to cancel a request to get credentials.
Channel - Interface in com.caplin.streamlink: Represents a channel to a subject on the Liberator.
ChannelListener - Interface in com.caplin.streamlink: Interface for receiving updates on the channel from the Liberator.
ChatEvent - Interface in com.caplin.streamlink: Provides information about updates to a chat subject.
ChatEventType - Enum in com.caplin.streamlink: Enumeration that defines the type of the ChatEvent.
clear() - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should clear your model of the container.
closeChannel() - Method in interface com.caplin.streamlink.Channel: Closes the channel to the Liberator.
com.caplin.streamlink - package com.caplin.streamlink: The interfaces within this package provide the functionality of StreamLink.
com.caplin.streamlink.alerts - package com.caplin.streamlink.alerts: The interfaces within this package provide the functionality of Triggers and Notifications.
CommandErrorEvent - Interface in com.caplin.streamlink: Provides error information for commands.
CommandErrorType - Enum in com.caplin.streamlink: Enumeration defining the errors that can occur for a command.
CommandListener - Interface in com.caplin.streamlink: Defines the interface that you should implement to receive information on the result of a command.
CommandParameters - Interface in com.caplin.streamlink: Interface that defines parameters for a CommandSubscription.
CommandSubscription - Interface in com.caplin.streamlink: Stored information on the subscription and lets you unpersist the command.
connect() - Method in interface com.caplin.streamlink.StreamLink: Instructs this StreamLink instance to attempt to connect to the Liberator.
ConnectionListener - Interface in com.caplin.streamlink: 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.
ConnectionState - Enum in com.caplin.streamlink: Enumeration that defines the state of a StreamLink connection to a Liberator.
ConnectionStatusEvent - Interface in com.caplin.streamlink: Provides information about a change in status of the connection to the Liberator.
ConsoleLogListener - Class in com.caplin.streamlink: Utility class to aid debugging.
ConsoleLogListener() - Constructor for class com.caplin.streamlink.ConsoleLogListener
ContainerElement - Interface in com.caplin.streamlink: Representation of a subject that is within a container.
ContainerEvent - Interface in com.caplin.streamlink: Represents an update to a container subject.
ContainerFilterFactory - Class in com.caplin.streamlink: A factory for creating FilterExpressions for use in the ContainerSubscriptionParameters select method.
ContainerFilterFactory() - Constructor for class com.caplin.streamlink.ContainerFilterFactory
ContainerModel - Interface in com.caplin.streamlink: This interface defines a model that represents a container.
ContainerSubscriptionParameters - Interface in com.caplin.streamlink: Defines the parameters used for Container subscriptions.
create(String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new field filter expression.
create(String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied JSON configuration.
create(String, KeymasterPollResponseListener) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied JSON configuration.
create(String, String, String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied configuration and username/password credentials.
create(String, CredentialsProvider) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied configuration and CredentialsProvider.
create(StreamLinkConfiguration) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance with the supplied StreamLinkConfiguration object.
create(StreamLinkConfiguration, CredentialsProvider) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance with the supplied StreamLinkConfiguration object and CredentialsProvider.
createChannel(String, ChannelListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Creates a Channel for the specified subject on the Liberator.
createCommandParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a set of CommandParameters which can be used to set a command to be persistent.
createConfiguration() - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLinkConfiguration object that can be used to configure StreamLink.
createConfiguration(String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLinkConfiguration object that can be used to configure StreamLink.
createContainerSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for a container subscription.
createCustom(String, String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new custom field filter expression.
createFreeFormSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for subscriptions.
createLogical(FilterExpressionLogicalOperator, FilterExpression...) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new logical filter expression.
createRecordSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for a record subscription.
createSubject(String, SubjectType, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Creates a subject on the Liberator.
createSubject(String, SubjectType, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Creates a subject on the Liberator.
createWebRequestParameters(String, Map<String, String>) - Method in interface com.caplin.streamlink.StreamLink: Creates a WebRequestParameters object for the specified Liberator web module.
Credentials - Interface in com.caplin.streamlink: Encapsulates authentication information used to log in to a Liberator server.
CredentialsProvider - Interface in com.caplin.streamlink: This interface defines how to provide the user credentials that StreamLink uses to log into a Liberator server.
CredentialsReceiver - Interface in com.caplin.streamlink: Interface that your custom implementation of CredentialsProvider must call to provide credential information to StreamLink.
credentialsUnavailable(String) - Method in interface com.caplin.streamlink.CredentialsReceiver: Call this method to indicate that an error occurred when retrieving a set of credentials.

D

DataEvent - Interface in com.caplin.streamlink: 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.
deleteAllEntries() - Method in interface com.caplin.streamlink.RecordType3Event: Indicates whether all type 3 entries should be deleted.
deleteAllKeys() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the boolean that indicates whether all permission keys for this subject have been deleted.
deleteAllRows() - Method in interface com.caplin.streamlink.RecordType2Event: Returns whether all rows should be deleted.
deleteKey() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the boolean that indicates whether the permission key within this update has been deleted.
deleteRow() - Method in interface com.caplin.streamlink.RecordType2Event: Returns whether the row should be deleted.
deleteSubject(String, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Deletes a subject on the Liberator.
DirectoryChangeElement - Interface in com.caplin.streamlink: Provides information about a change to a directory element.
DirectoryEvent - Interface in com.caplin.streamlink: Provides information about a change to a directory.
disconnect() - Method in interface com.caplin.streamlink.StreamLink: Instructs this StreamLink instance to disconnect from the Liberator.
dismissNotification(Notification, ResultListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Dismiss a notification for the current user.

E

ErrorReason - Enum in com.caplin.streamlink: Enumeration that defines the reasons for an error being raised in a SubscriptionErrorEvent or a CommandErrorEvent.

F

FilterExpression - Interface in com.caplin.streamlink: Interface that represents a filter expression.
FilterExpressionLogicalOperator - Enum in com.caplin.streamlink: Enumeration that represents a particular logical operation.
FilterExpressionOperator - Enum in com.caplin.streamlink: Enumeration that represents the operators that are available for a FieldFilterExpression.
FreeFormSubscriptionParameters - Interface in com.caplin.streamlink: A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers.

G

getAverageLatency() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the average latency of heartbeat messages sent from Liberator to StreamLink.
getChangedElements() - Method in interface com.caplin.streamlink.DirectoryEvent: Returns a list of changes to the Directory.
getClockOffset() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the clock offset between Liberator and StreamLink (Liberator time minus StreamLink time).
getColumn() - Method in interface com.caplin.streamlink.PageElement
getCommandListener() - Method in interface com.caplin.streamlink.CommandSubscription: Returns the CommandListener that is informed of success or failure of this command.
getCondition() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the condition that must be met for this trigger to fire a notification.
getConnectionState() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the new state of a connection the the Liberator.
getDate() - Method in interface com.caplin.streamlink.LogInfo: Returns the date for this log entry.
getDateTime() - Method in interface com.caplin.streamlink.NewsEvent: Returns the date/time associated with this headline update.
getElements() - Method in interface com.caplin.streamlink.PageEvent: Returns array of com.caplin.streamlink.PageElementss.
getError() - Method in interface com.caplin.streamlink.CommandErrorEvent: Returns the CommandErrorType of the event.
getError() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the type of subscription error.
getErrorReason() - Method in interface com.caplin.streamlink.CommandErrorEvent: Returns the ErrorReason of the event.
getErrorReason() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the ErrorReason of the event.
getFields() - Method in interface com.caplin.streamlink.NewsEvent: Returns all field/value pairs that were updated in this update.
getFields() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the collection of fields relating to this PermissionEvent.
getFields() - Method in interface com.caplin.streamlink.RecordType1Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.RecordType2Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.RecordType3Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns any fields associated with the status event.
getHeadline() - Method in interface com.caplin.streamlink.NewsEvent: Returns the headline for this update.
getId() - Method in interface com.caplin.streamlink.alerts.Notification: Gets the unique id of the notification, can be used to dismiss the notification from the NotificationProvider.
getKey() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the permission key relating to this event.
getLastLog() - Method in interface com.caplin.streamlink.StreamLink: Returns a List containing the last "log_buffer_size" log lines written by the current StreamLink instance.
getLatency(String) - Method in interface com.caplin.streamlink.RecordType1Event: Gets the latency of the record in milliseconds.
getLatency() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the latency of the latest heartbeat message sent from Liberator to StreamLink.
getLevel() - Method in interface com.caplin.streamlink.LogInfo: Returns the log level for this log entry.
getLiberatorUrl() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the URL of the Liberator connection that this status event has been raised for.
getLogger() - Method in interface com.caplin.streamlink.StreamLink: Returns the StreamLink logger object.
getLoginFailReason() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the reason for the login attempt failing.
getMaxColumn() - Method in interface com.caplin.streamlink.PageEvent
getMaxRow() - Method in interface com.caplin.streamlink.PageEvent
getMessage() - Method in interface com.caplin.streamlink.ChatEvent: Returns the chat message.
getMessage() - Method in interface com.caplin.streamlink.LogInfo: Returns the message text for this log entry.
getPaddedName() - Method in enum com.caplin.streamlink.LogLevel
getParameters() - Method in interface com.caplin.streamlink.alerts.Notification: Gets a map that contains the notification data fields.
getParameters() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets a map containing the trigger parameters.
getPassword() - Method in interface com.caplin.streamlink.Credentials: Returns the password.
getPostBody() - Method in interface com.caplin.streamlink.WebRequestParameters: Returns the contents of the HTTP post body that should be used (to specify parameters) with the web module URL.
getRow() - Method in interface com.caplin.streamlink.PageElement
getServiceName() - Method in interface com.caplin.streamlink.ServiceStatusEvent: Returns the name of the service that has changed state.
getServiceStatus() - Method in interface com.caplin.streamlink.ServiceStatusEvent: Returns the new ServiceStatus of a service.
getSize() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the size of the container.
getSourceName() - Method in interface com.caplin.streamlink.SourceStatusEvent: Returns the name of the Integration Adapter that has changed state.
getSourceStatus() - Method in interface com.caplin.streamlink.SourceStatusEvent: Returns the new status of an Integration Adapter.
getState() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the current state of the trigger.
getStatus() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns the new status of the subject of the subscription.
getStoryCode() - Method in interface com.caplin.streamlink.NewsEvent: Returns the story code associated with this update.
getSubject() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the rttp subject associated with this trigger.
getSubject() - Method in interface com.caplin.streamlink.Channel: Returns the subject name to which the channel relates.
getSubject() - Method in interface com.caplin.streamlink.CommandSubscription: Returns the subject the command was executed on.
getSubject() - Method in interface com.caplin.streamlink.ContainerElement: Returns the subject of the element.
getSubject() - Method in interface com.caplin.streamlink.DataEvent: Returns the subject to which the event relates.
getSubject() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Returns the subject of the directory element that has changed.
getSubject() - Method in interface com.caplin.streamlink.Subscription: Returns the subject name to which the subscription relates (for example, /FX/EURUSD).
getSubject() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the subject of subscription to which the event relates.
getSubject() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns the subject of the subscription to which the event relates.
getSubscriptionListener() - Method in interface com.caplin.streamlink.Subscription: Returns the SubscriptionListener that is informed of all subscription events relating to this subscription.
getText() - Method in interface com.caplin.streamlink.PageElement: Returns the page text at the given row and column.
getText() - Method in interface com.caplin.streamlink.StoryEvent: Returns the story text relating to the event.
getTime() - Method in interface com.caplin.streamlink.ChatEvent: Returns the time when the chat event was raised.
getTimeReceived() - Method in interface com.caplin.streamlink.RecordType1Event: Returns the time that the record data in the event was received at the client.
getTriggerId() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the unique id of the trigger.
getType() - Method in interface com.caplin.streamlink.ContainerElement: Returns the SubjectType of the element.
getType() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Returns the subject type of the Directoruy element that has changed.
getType2IndexField() - Method in interface com.caplin.streamlink.RecordType2Event: Gets the type 2 index field relating to the event.
getUpdateType() - Method in interface com.caplin.streamlink.ChatEvent: Returns the type of chat event that this event represents.
getUrl() - Method in interface com.caplin.streamlink.WebRequestParameters: Returns the URL that must be used to invoke the required web module
getUser() - Method in interface com.caplin.streamlink.ChatEvent: Returns the username of the user who generated this chat event.
getUsername() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the username that will be used to log in to the Liberator.
getUsername() - Method in interface com.caplin.streamlink.Credentials: Returns the user-name.
getValue() - Method in enum com.caplin.streamlink.LogLevel
getVersion() - Method in interface com.caplin.streamlink.StreamLink: Gets the version of StreamLink.
getWindowEnd() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the index of the end of the container window.
getWindowStart() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the index of the start of the window.

I

insert(int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should insert the ContainerElement at the specified position.
isAdded() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Indicates whether this directory element has been added or removed from the directory.
isImage() - Method in interface com.caplin.streamlink.DataEvent: Returns whether this was an image event or an update event.

K

KeymasterPollResponseListener - Interface in com.caplin.streamlink: Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses.

L

log(LogLevel, String, Object...) - Method in interface com.caplin.streamlink.Logger: Sends a log message to all LogListener's that have been registered for this log level or above.
Logger - Interface in com.caplin.streamlink: Allows StreamLink log messages to be written to the destination of your choice.
LoginFailedReason - Enum in com.caplin.streamlink: Enumeration that defines the reason for a failed login.
LogInfo - Interface in com.caplin.streamlink: Stores log information including message and level of a log entry.
LogLevel - Enum in com.caplin.streamlink: Enumeration that represents the available logging levels.
LogListener - Interface in com.caplin.streamlink: Interface for receiving log messages from the StreamLink application.

M

move(int, int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should move the specified ContainerElement.

N

networkAvailable() - Method in interface com.caplin.streamlink.StreamLink: Informs StreamLink the network is available.
networkUnavailable() - Method in interface com.caplin.streamlink.StreamLink: Informs StreamLink the network is unavailable.
NewsEvent - Interface in com.caplin.streamlink: Provides information about a news headline update.
Notification - Interface in com.caplin.streamlink.alerts: A Notification is an object that can be sent to notify a user of a particular event.
NotificationListener - Interface in com.caplin.streamlink.alerts: Interface that should be implemented to receive notification change callbacks from the NotificationProvider
NotificationService - Class in com.caplin.streamlink.alerts: 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.
NotificationService(StreamLink) - Constructor for class com.caplin.streamlink.alerts.NotificationService: Creates a new NotificationService for the given StreamLink instance.

O

onChannelData(Channel, RecordType1Event) - Method in interface com.caplin.streamlink.ChannelListener: Called when an update is received.
onChannelError(Channel, SubscriptionErrorEvent) - Method in interface com.caplin.streamlink.ChannelListener: Called when there is an error on the channel.
onChannelStatus(Channel, SubscriptionStatusEvent) - Method in interface com.caplin.streamlink.ChannelListener: Called when there is a change in the status for the channel.
onChatUpdate(Subscription, ChatEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onChatUpdate(Subscription, ChatEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a chat update is received.
onCommandError(String, CommandErrorEvent) - Method in interface com.caplin.streamlink.CommandListener: Callback invoked when a command failed or is an unknown state.
onCommandOk(String) - Method in interface com.caplin.streamlink.CommandListener: Callback invoked when a command was successful.
onConnectionStatusChange(ConnectionStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onConnectionStatusChange(ConnectionStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of the StreamLink connection changes.
onContainerUpdate(Subscription, ContainerEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onContainerUpdate(Subscription, ContainerEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a container update is received.
onCredentialsRequired(CredentialsReceiver) - Method in interface com.caplin.streamlink.CredentialsProvider: Gets the credentials used to log in to the Liberator.
onDirectoryUpdate(Subscription, DirectoryEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onDirectoryUpdate(Subscription, DirectoryEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a directory update is received.
onFailure(String) - Method in interface com.caplin.streamlink.alerts.ResultListener: Called when the associated operation failed.
onKeymasterError(String) - Method in interface com.caplin.streamlink.KeymasterPollResponseListener: Returns an unsuccessful KeyMaster keep alive Response.
onKeymasterResponse(String) - Method in interface com.caplin.streamlink.KeymasterPollResponseListener: Returns a successful KeyMaster keep alive Response.
onLog(LogInfo) - Method in class com.caplin.streamlink.ConsoleLogListener
onLog(LogInfo) - Method in interface com.caplin.streamlink.LogListener: Called when a StreamLink log message is to be logged.
onNewsUpdate(Subscription, NewsEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onNewsUpdate(Subscription, NewsEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a news headline update is received.
onNotification(Notification) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when notification gets added to the container.
onNotificationRemoved(Notification) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when notification is removed from the container.
onPageUpdate(Subscription, PageEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onPageUpdate(Subscription, PageEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a page update is received.
onPermissionUpdate(Subscription, PermissionEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onPermissionUpdate(Subscription, PermissionEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a permission update is received.
onRecordType2Update(Subscription, RecordType2Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordType2Update(Subscription, RecordType2Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 2 data in a record is received.
onRecordType3Update(Subscription, RecordType3Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordType3Update(Subscription, RecordType3Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 3 data in a record is received.
onRecordUpdate(Subscription, RecordType1Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordUpdate(Subscription, RecordType1Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 1 data in a record is received.
onServiceStatus(ServiceStatus) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when the notification service availability changes.
onServiceStatus(ServiceStatus) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when the trigger service availability changes.
onServiceStatusChange(ServiceStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onServiceStatusChange(ServiceStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of a data service available from the Liberator changes.
onSourceStatusChange(SourceStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onSourceStatusChange(SourceStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of one of the Integration Adapters connected to Liberator changes.
onStatisticsChange(StatisticsEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onStatisticsChange(StatisticsEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when new connection statistics are available.
onStoryUpdate(Subscription, StoryEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onStoryUpdate(Subscription, StoryEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a news story update is received.
onSubscriptionError(Subscription, SubscriptionErrorEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onSubscriptionError(Subscription, SubscriptionErrorEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when there is an error in a subscription.
onSubscriptionStatus(Subscription, SubscriptionStatusEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onSubscriptionStatus(Subscription, SubscriptionStatusEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when there is a change in the status of a subscription.
onSuccess() - Method in interface com.caplin.streamlink.alerts.ResultListener: Called when the associated operation was successful.
onTriggerAdded(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger gets added to container.
onTriggerRemoved(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger gets removed from container.
onTriggerUpdated(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger is updated.

P

PageElement - Interface in com.caplin.streamlink: Provides information about a single text change for the given row and column in a Page.
PageEvent - Interface in com.caplin.streamlink: Provides information about a change to data in a Page.
pause() - Method in interface com.caplin.streamlink.StreamLink: Pauses StreamLink so it does not receive new updates from the Liberator.
PermissionEvent - Interface in com.caplin.streamlink: Provides information about a change to permission data.
provideCredentials(Credentials) - Method in interface com.caplin.streamlink.CredentialsReceiver: Call this method to provide a set of Credentials to StreamLink.
publishToSubject(String, Map<String, String>, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.
publishToSubject(String, Map<String, String>, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.

R

RecordSubscriptionParameters - Interface in com.caplin.streamlink: Defines the parameters used for Record subscriptions.
RecordType1Event - Interface in com.caplin.streamlink: Provides information about a change to type 1 data (fieldname and data pairs) in a record.
RecordType2Event - Interface in com.caplin.streamlink: Provides information about a change to type 2 data in a record.
RecordType3Event - Interface in com.caplin.streamlink: Provides information about a change to type 3 data in a record.
remove(int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should remove the ContainerElement from the specified position.
removeConnectionListener(ConnectionListener) - Method in interface com.caplin.streamlink.StreamLink: Removes a previously added ConnectionListener from this StreamLink instance.
removeListener(NotificationListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Removes a previously added notification listener, callbacks to this listener will be stopped.
removeListener(TriggerListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Removes a previously added trigger listener, callbacks to this listener will be stopped.
removeListener(LogListener) - Method in interface com.caplin.streamlink.Logger: Removes a LogListener that you previously added (see addListener).
removeTrigger(Trigger, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Removes a trigger from the system.
ResultListener - Interface in com.caplin.streamlink.alerts: An interface that can be registered to be called back when an operation completes.
resume() - Method in interface com.caplin.streamlink.StreamLink: Re-establishes the connection to the Liberator to receive updates.

S

select(String, String, String) - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Allow selection, sorting and grouping of containers.
send(Map<String, String>, CommandListener) - Method in interface com.caplin.streamlink.Channel: Sends fields to the channel subject
ServiceStatus - Enum in com.caplin.streamlink: Enumeration that defines the status of a Service.
ServiceStatusEvent - Interface in com.caplin.streamlink: Provides information about the change in status of a data service to which StreamLink is connected via the Liberator.
setApplicationId(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the application identifier.
setCancellable() - Method in interface com.caplin.streamlink.CommandParameters: Sets the command associated with a CommandSubscription to be cancelled in the event that the connection goes down before it is sent.
setClockOffsetInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the interval between successive calculations of clock offset value(default 10000 milliseconds).
setClockOffsetWindow(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time a calculated clock offset is valid for use in producing statistics (default 120000 milliseconds).
setContainerWindow(int, int) - Method in interface com.caplin.streamlink.Subscription: Sets the container window for this subscription.
setDisablePolling(Boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Set to true if you don't want to use polling connection when the rttp(s) protocol is specified.
setDisableSseConnection(Boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Set to true if you don't want to use server side events connection when the rttp(s) protocol is specified.
setFields(List<String>) - Method in interface com.caplin.streamlink.RecordSubscriptionParameters: Sets the record fields that will be requested when a subscription is made using these parameters.
setFilter(String, boolean) - Method in interface com.caplin.streamlink.RecordSubscriptionParameters: Sets the filter that restricts the the information returned by the subscription.
setForeverFrameReconnectCount(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setHttpPadLength(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the http pad length to be used for http and Forever Frame connections.
setHttpTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time allowed for an HTTP Request to finish successfully before StreamLink times out (default 3000 milliseconds).
setInactivityTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Maximum time in milliseconds that Liberator waits to receive messages from this StreamLink client.
setKeymasterPollInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Interval in milliseconds at which StreamLink will poll KeyMaster (on the KeyMaster poll URL) to keep the KeyMaster session open.
setKeymasterPollResponseListener(KeymasterPollResponseListener) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a KeymasterPollResponseListener to receive information about responses to keep-alive requests made to KeyMaster.
setKeymasterPollUrl(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the URL that StreamLink uses to check the connection to KeyMaster every KeyMaster poll interval milliseconds.
setKeymasterUrl(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the URL of KeyMaster for secure authentication of Liberator login requests.
setLatencyInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time between successive calculations of average latency (default 10000 milliseconds).
setLatencyWindow(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time for which a calculated latency value is valid for use in producing statistics (default 120000 milliseconds).
setLogBufferSize(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the size of the log buffer to be used in Streamlink.
setLogWindowLogLevel(LogLevel) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setLogWindowVisible(boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setParameters(String) - Method in interface com.caplin.streamlink.FreeFormSubscriptionParameters: Sets the parameters using a free-form string.
setPassword(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the Liberator login password to use if logins are not being managed by KeyMaster or a custom CredentialsProvider.
setPersistent() - Method in interface com.caplin.streamlink.CommandParameters: Sets the command associated with a CommandSubscription to be persistent.
setPollInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time interval in milliseconds between polls of the Liberator.
setProxy(Proxy) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the proxy to be used for http(s) and poll(s) connection protocols.
setReconnectDelay(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Delay in milliseconds before retrying, after failing to connect with all available connection options (default 2000 milliseconds).
setRequestTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Time in milliseconds allowed for the response to each command before StreamLink reconnects to the Liberator.
setUsername(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the Liberator login user-name to use if logins are not being managed by KeyMaster or a custom CredentialsProvider.
setWindow(int, int) - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Sets the size of the container window.
snapshot(String, SubscriptionListener, SubscriptionParameters) - Method in interface com.caplin.streamlink.StreamLink: Requests a single update from a subject.
snapshot(String, SubscriptionListener) - Method in interface com.caplin.streamlink.StreamLink: Requests a single update from a subject.
SourceStatus - Enum in com.caplin.streamlink: Enumeration that defines the status of a source.
SourceStatusEvent - Interface in com.caplin.streamlink: Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator.
StatisticsEvent - Interface in com.caplin.streamlink: Provides access to the statistics relating to an instance of StreamLink.
StoryEvent - Interface in com.caplin.streamlink: Provides information about a change to story data in a Story.
StreamLink - Interface in com.caplin.streamlink: Defines the StreamLink interface.
StreamLinkConfiguration - Interface in com.caplin.streamlink: Interface that allows the configuration of StreamLink to be defined programmatically.
StreamLinkFactory - Class in com.caplin.streamlink: Factory that creates StreamLink instances.
SubjectType - Enum in com.caplin.streamlink: Enumeration that represents the available subject types.
subscribe(String, SubscriptionListener, SubscriptionParameters) - Method in interface com.caplin.streamlink.StreamLink: Subscribes to a subject to receive updates.
subscribe(String, SubscriptionListener) - Method in interface com.caplin.streamlink.StreamLink: Subscribes to a subject to receive updates.
Subscription - Interface in com.caplin.streamlink: Represents a subscription to a subject on the Liberator.
SubscriptionErrorEvent - Interface in com.caplin.streamlink: Provides information about a subscription error.
SubscriptionErrorType - Enum in com.caplin.streamlink: Enumeration which represents the errors that can occur for a subject.
SubscriptionListener - Interface in com.caplin.streamlink: Interface for receiving updates to subscribed data from the Liberator.
SubscriptionParameters - Interface in com.caplin.streamlink: The base interface for defining parameters that apply to Subscriptions.
SubscriptionStatusEvent - Interface in com.caplin.streamlink: Provides information about a change in the state of a subscription.
SubscriptionStatusType - Enum in com.caplin.streamlink: Enumeration that defines the status of a subject.

T

ThrottleCommand - Enum in com.caplin.streamlink: Enumeration that defines the available throttle levels and throttle commands.
throttleEverything(ThrottleCommand, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Throttles all the currently subscribed subjects, reducing the number of updates that are sent every second.
throttleEverything(ThrottleCommand, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Throttles all the currently subscribed subjects, reducing the number of updates that are sent every second.
throttleSubject(String, ThrottleCommand, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Throttles the specified subject, reducing the number of updates that are sent every second.
throttleSubject(String, ThrottleCommand, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Throttles the specified subject, reducing the number of updates that are sent every second.
toFilterString() - Method in interface com.caplin.streamlink.FilterExpression
toString() - Method in enum com.caplin.streamlink.LogLevel
Trigger - Interface in com.caplin.streamlink.alerts: 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.
TriggerListener - Interface in com.caplin.streamlink.alerts: Interface that should be implemented to receive trigger change callbacks from the TriggerProvider
TriggerService - Class in com.caplin.streamlink.alerts: 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.
TriggerService(StreamLink) - Constructor for class com.caplin.streamlink.alerts.TriggerService: Creates a new TriggerService for the given StreamLink instance.
TriggerState - Enum in com.caplin.streamlink.alerts: Enumeration that defines the different states a Trigger can be in

U

unPersist() - Method in interface com.caplin.streamlink.CommandSubscription: For commands that have been set as persistent this method will turn off that persistence.
unsubscribe() - Method in interface com.caplin.streamlink.Subscription: Unsubscribes to the subject on the Liberator.
updateModel(ContainerModel) - Method in interface com.caplin.streamlink.ContainerEvent: Update your implementation of ContainerModel with the contents of this ContainerEvent.

V

valueOf(String) - Static method in enum com.caplin.streamlink.alerts.TriggerState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.ChatEventType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.CommandErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.ConnectionState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.ErrorReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.FilterExpressionLogicalOperator: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.FilterExpressionOperator: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.LoginFailedReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.LogLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.ServiceStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.SourceStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.SubjectType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.SubscriptionErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.SubscriptionStatusType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.caplin.streamlink.ThrottleCommand: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.caplin.streamlink.alerts.TriggerState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.ChatEventType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.CommandErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.ConnectionState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.ErrorReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.FilterExpressionLogicalOperator: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.FilterExpressionOperator: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.LoginFailedReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.LogLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.ServiceStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.SourceStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.SubjectType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.SubscriptionErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.SubscriptionStatusType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.caplin.streamlink.ThrottleCommand: Returns an array containing the constants of this enum type, in the order they are declared.

W

WebRequestParameters - Interface in com.caplin.streamlink: Contains the parameters needed to call a specific Liberator web module.

A B C D E F G I K L M N O P R S T U V W