  Caplin | |
 StreamLink | The interfaces, classes and enumerators within this package provide the functionality of StreamLink. |
 Alerts | The classes within this package provide the functionality of StreamLink alerts |
   INotification | Notifications can be created by ITrigger's firing when their conditions are met or by being sent from a Notifications adapter. |
| INotificationListener | A trivial implementation of NotificationListener would be: |
| IResultListener | An interface that can be registered to be called back when an operation completes |
| ITrigger | Note: Different instances of this class are not equal and will need to be checked for equality manually if the need arises. Use the trigger ID to identify a trigger. |
| ITriggerListener | A trivial implementation of TriggerListener would be: |
| 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 |
 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. |
| BaseConnectionListener | Adapter class implementing the IConnectionListener methods |
| BaseSubscriptionListener | Adapter class implementing the ISubscriptionListener methods |
| ConsoleLogListener | Register by calling ILogger.AddListener on the logger acquired from IStreamLink |
| ContainerFilterFactory | |
| IAdvancedConfiguration | This interface provides access to advanced features of the StreamLink library. |
| IBinaryEvent | The BinaryEvent is provided in an onBinaryUpdate callback to a ISubscriptionListener. |
| IBinaryHandler | Handler for parsing and patching BINARY objects |
| IChannel | A Channel provides a bi-directional communication channel between a StreamLink application and a DataSource adapter. Using a Channel in both DataSource and StreamLink provides a simplified method of communication between the two components and can allow you just to use the Caplin platform as a bi-directional messaging pipe. |
| IChannelListener | Interface for receiving updates on the channel from the Liberator |
| IChatEvent | The ChatEvent is provided in an onChatUpdate callback to a ISubscriptionListener. |
| ICommandErrorEvent | The CommandErrorEvent will be provided on a onCommandError callback to a ICommandListener. |
| ICommandListener | For more about commands, see ICommandSubscription |
| ICommandParameters | |
| ICommandResultEvent | The CommandResultEvent will be provided on callbacks to a ICommandResultListener. |
| ICommandResultListener | For more about commands, see ICommandSubscription. |
| ICommandSubscription | Stored information on the subscription and lets you unpersist the command |
| IConnectionCurrentState | |
| IConnectionListener | You should implement this interface if your application needs to take particular actions when such state changes occur |
| IConnectionStatusEvent | The ConnectionStatusEvent is provided on a onConnectionStatusChange callback to a IConnectionListener. |
| IContainerElement | The insert(), remove() or move() callbacks of IContainerModel all supply a ContainerElement that applies to the action.. |
| IContainerEvent | The ContainerEvent will be provided on a onContainerUpdate callback to a ISubscriptionListener. |
| IContainerModel | The methods on this interface will be called in the correct order to ensure that your representation is correct. |
| IContainerSubscriptionParameters | |
| ICredentials | |
| ICredentialsProvider | |
| ICredentialsReceiver | |
| IDataEvent | In application code, use the derived interfaces that related to specific types of data, rather than this base-level interface. For example IRecordType1Event interface is derived from IDataEvent; it provides information about changes to a subscribed subject of type record, including the fields that have changed and their new values. |
| IDirectoryChangeElement | Provides information about a change to a directory element |
| IDirectoryEvent | Provides information about a change to a directory |
| IDiscardHandler | |
| IFilterExpression | Interface that represents a filter expression |
| IFreeFormSubscriptionParameters | |
| IHttpHeaderProvider | |
| IJsonChannel | A Channel provides a bi-directional communication channel between a StreamLink application and a DataSource adapter. Using a Channel in both DataSource and StreamLink provides a simplified method of communication between the two components and can allow you just to use the Caplin platform as a bi-directional messaging pipe. |
| IJsonChannelListener | Interface for receiving updates on the JSON channel from the Liberator |
| IJsonDiscardHandler | Object registered to receive discard callbacks |
| IJsonEvent | The JsonEvent is provided in an onJsonUpdate callback to a ISubscriptionListener. |
| IJsonHandler | Handler for parsing and patching JSON objects |
| IJsonProvider | |
| IJsonProviderHandle | Object returned from the StreamLink.register...Provider methods |
| IJsonPublisher | An object that can send JSON messages for a subject that StreamLink is providing |
| IJsonSubscriptionParameters | |
| IKeymasterCookieProvider | The set of cookies provided by this interface will be sent with KeyMaster connections |
| IKeymasterHttpHeaderProvider | The set of headers provided by this interface will be sent with KeyMaster connections |
| IKeymasterPollResponseListener | The KeymasterPollResponseListener needs to be added to the StreamLinkFactory create method in order to receive callbacks |
| ILiberatorUrlProvider | |
| ILogger | You obtain an instance of caplin.streamlink.Logger by calling streamLinkInstance.getLogger() on the StreamLink instance |
| ILogInfo | This will be passed into any ILogListener.OnLog method of any ILogListener registered at an appropriate LogLevel. The LogListener can then get the log line using the ILogInfo.Message method. See ILogListener. |
| ILogListener | If you wish to capture StreamLink's log messages (for example, to write them to your own log window), implement this interface, create an instance of it, and attach it to an instance of ILogger |
| INewsEvent | Provides information about a news headline update |
| IPageElement | Provides information about a single text change for the given row and column in a Page |
| IPageEvent | Pages may be sent from the Liberator in one or more PageElementss. The initial page data is indicated by the isImage() method returning true. |
| IPermissionEvent | Provides information about a change to permission data |
| IPublisher | An object that can send messages for a subject that StreamLink is providing |
| IRawSocketFactory | This interface allows a user application to specify a connection strategy to use when creating Type 1 (direct socket) connections. For example, to negotiate a SOCKS proxy or other custom tunneling requirements. |
| IRecordDiscardHandler | Object registered to receive discard callbacks |
| IRecordProvider | |
| IRecordProviderHandle | Object returned from the StreamLink.register...Provider methods |
| IRecordPublisher | An object that can send record messages for a subject that StreamLink is providing |
| IRecordSubscriptionParameters | |
| IRecordType1Event | The RecordType1Event is provided in an onRecordUpdate callback to a ISubscriptionListener. |
| IRecordType2Event | The RecordType2Event is provided in an onRecordType2Update callback to a ISubscriptionListener |
| IRecordType3Event | The RecordType3Event will be provided on a onRecordType3Update callback to a ISubscriptionListener |
| IServiceStatusEvent | The ServiceStatusEvent will be provided on a onServiceStatusChange callback to a IConnectionListener. |
| ISourceStatusEvent | The SourceStatusEvent will be provided on a onSourceStatusChange callback to a IConnectionListener |
| IStatisticsEvent | The StatisticsEvent is provided in an onStatisticsChange callback to a IConnectionListener. |
| IStoryEvent | Stories may be sent from the Liberator in one or more IStoryEvents. The start of the story is indicated by the isImage() method returning true. |
| IStreamLink | Defines the StreamLink interface. |
| IStreamLinkConfiguration | Interface that allows the configuration of StreamLink to be defined programmatically. |
| ISubscription | Represents a subscription to a subject on the Liberator |
| ISubscriptionErrorEvent | Provides information about a subscription error |
| ISubscriptionListener | Your application should implement this interface |
| ISubscriptionParameters | |
| ISubscriptionStatusEvent | The SubscriptionStatusEvent will be provided on a onSubscriptionStatus callback to a ISubscriptionListener. |
| IWebRequestParameters | Call the createWebRequestParameters method of the StreamLink object to obtain these parameters for the specified web module. |
| LogLevel | Each log message generated by StreamLink has an associated LogLevel that indicates its importance, in the following order (highest to lowest) |
| StreamLinkFactory | Factory that creates StreamLink instances. |
| STuple | |
