► caplin.streamlink.StreamLink()

► void addConnectionListener(caplin.streamlink.ConnectionListener connectionListener)

Adds a connection listener with this StreamLink instance. This connectionListener is called whenever a connection event occurs.

► void connect()

Instructs this StreamLink instance to attempt to connect to the Liberator.

When a caplin.streamlink.ConnectionListener has been registered with this StreamLink instance, the listener's methods are called when the status of the connection changes.

► void create(String subject, Map commandParameters, CommandResultListener commandListener)

Creates a subject.

This method can be used to send a POST message to a configured REST endpoint.

Returns

Information about the 'create' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► caplin.streamlink.Channel createChannel(String subject, caplin.streamlink.ChannelListener channelListener, Map commandParameters)

Creates a Channel for the specified subject on the Liberator.

Use the returned channel to send and receive data as maps of name/value pairs.

Returns

{caplin.streamlink.Channel} channel object that can be used to send and receive data as maps of name/value pairs.

► caplin.streamlink.JsonChannel createJsonChannel(String subject, caplin.streamlink.JsonChannelListener channelListener, Map commandParameters)

Creates a JsonChannel for the specified subject on the Liberator.

Use the returned channel to send and receive JSON data.

Returns

{caplin.streamlink.JsonChannel} channel object that can be used to send and receive JSON data.

► caplin.streamlink.CommandSubscription createSubject(String subject, caplin.streamlink.SubjectType subjectType, caplin.streamlink.CommandListener commandListener, Map commandParameters)

Creates a subject in the Liberator.

Returns

{caplin.streamlink.CommandSubscription} Information about the 'create subject' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► caplin.streamlink.WebRequestParameters createWebRequestParameters(String moduleName, Map options)

Creates a WebRequestParameters object for the specified Liberator web module.

The returned WebRequestParameters object contains the URL and HTTP post body that should be used to access the required web module.

Returns

{caplin.streamlink.WebRequestParameters} an object of type WebRequestParameters or null if the module is not available or the options are invalid.

► void delete(String subject, Map commandParameters, CommandResultListener commandListener)

Deletes a subject.

This method can be used to send a DELETE message to a configured REST endpoint.

Returns

Information about the 'delete' command.

► void deleteSubject(String subject, caplin.streamlink.CommandListener commandListener)

Deletes a subject in the Liberator.

► void disconnect()

Instructs this StreamLink instance to disconnect from the Liberator.

► caplin.streamlink.ConnectionCurrentState getConnectionCurrentState()

Returns information about the state of the current connection.

Returns

{caplin.streamlink.ConnectionCurrentState} object containing the current state of the connection, fields available are the latest values reported by the addConnectionListener callbacks.

► void getLastLog()

Returns an array containing the last "log_buffer_size" log lines written by the current {caplin.streamlink.StreamLink} instance. If log_buffer_size is not set or <= 0 then the log buffer is disabled and this method will always return an empty array

Returns

An array containing the last "log_buffer_size" log lines written by this instance, or an empty array if "log_buffer_size" is not set

► caplin.streamlink.Logger getLogger()

Returns the StreamLink logger object. You can receive StreamLink log messages by adding your own caplin.streamlink.LogListener to this object.

Returns

{caplin.streamlink.Logger} The StreamLink logger.

► void getVersion()

Gets the version of StreamLink JavaScript.

Returns

String The version number and build identifier for this version of the StreamLink library.

► void networkAvailable()

Informs StreamLink the network connection is available so can connect.

► void networkUnavailable()

Informs StreamLink the network connection is unavailable so it will not try to connect.

► void pause()

Pauses StreamLink so it does not receive new updates from the Liberator. The KeyMaster session will be kept alive.

This method can be used as part of your applications lifecycle to conserve battery life and reduce data usage by not receiving data when your application is in the background.

► void publish(String subject, Map commandParameters, CommandResultListener commandListener)

Publishes data to a subject.

This method can be used to send a PUT message to a configured REST endpoint.

Returns

Information about the 'publish' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► caplin.streamlink.CommandSubscription publishToJsonSubject(String subject, Object jsonObject, caplin.streamlink.CommandListener commandListener, Map commandParameters)

Publishes JSON data to a subject.

Returns

{caplin.streamlink.CommandSubscription} Information about the 'publish' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► caplin.streamlink.CommandSubscription publishToSubject(String subject, Map fieldData, caplin.streamlink.CommandListener commandListener, Map commandParameters)

Publishes data to a subject.

Returns

{caplin.streamlink.CommandSubscription} Information about the 'publish' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► void registerJsonProvider( pattern, provider, commandListener)

Registers a provider of json data for the given subject pattern.

Returns

a JsonProviderHandle.

► void registerRecordProvider( pattern, provider, commandListener)

Registers a provider of record data for the given subject pattern.

Returns

a RecordProviderHandle.

► void removeConnectionListener(caplin.streamlink.ConnectionListener connectionListener)

Removes a previously added caplin.streamlink.ConnectionListener from this StreamLink instance. After removal, no further callbacks are received by this ConnectionListener.

► void resume()

Re-establishes the connection to the Liberator to receive updates.

This method can be used as part of your applications lifecycle to conserve battery life and reduce data usage by not receiving data when your application is in the background.

► void snapshot(String subject, caplin.streamlink.SubscriptionListener subscriptionListener, Map subscriptionParameters)

Requests a single update from a subject.

► caplin.streamlink.Subscription subscribe(String subject, caplin.streamlink.SubscriptionListener subscriptionListener, Map subscriptionParameters)

Subscribes to a subject to receive updates.

 // Build an expression for FIELD1 > 0.1 AND FIELD3 = "a a"
 var exp1 = caplin.streamlink.ContainerFilterFactory
   .create("FIELD1", caplin.streamlink.FilterExpressionOperator.GREATER_THAN, "0.1");
 var exp2 = caplin.streamlink.ContainerFilterFactory
   .create("FIELD3", caplin.streamlink.FilterExpressionOperator.EQUAL, "a a");
 var exp1Andexp2 = caplin.streamlink.ContainerFilterFactory
   .createLogical(caplin.streamlink.FilterExpressionLogicalOperator.AND, exp1, exp2);

 var subscription = streamLink.subscribe("/container", subscriptionListener,
                  {"select":
                         {
                             "where": exp1Andexp2.toFilterString(),
                             "orderby": "FIELD1"
                         }
                     });
 

Note: if you subscribe to a container multiple times, then include one or both of the configuration attributes window and select in each subscription to the container. The presence of either of these attributes indicates to StreamLink that the subject is a container, and causes StreamLink to add a sequential container-instance identifier to the subscription request. Liberator uses this identifier to support multiple subscriptions to the same container; without this identifier, only the first subscription to a container will have a container instance and receive updates. If you don't want to window or filter a container, then specify a window with a large size, for example window:{start:0, size:999999999}.

Returns

{caplin.streamlink.Subscription} Information about the subscription. You can unsubscribe (stop receiving updates) from a subscription using the unsubscribe() method on the returned Subscription object.

► caplin.streamlink.CommandSubscription throttleEverything(caplin.streamlink.ThrottleCommand throttleCommand, caplin.streamlink.CommandListener commandListener, Map commandParameters)

Throttles all the currently subscribed subjects, reducing the number of updates that are sent every second.

For a fuller explanation of throttling, refer to the 'Throttling' section of the document StreamLink Overview.

Returns

{caplin.streamlink.CommandSubscription} Information about the 'throttle' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.

► caplin.streamlink.CommandSubscription throttleSubject(String subject, caplin.streamlink.ThrottleCommand throttleCommand, caplin.streamlink.CommandListener commandListener, Map commandParameters)

Throttles the specified subject, reducing the number of updates that are sent every second.

For a fuller explanation of throttling, refer to the 'Throttling' section of the document StreamLink Overview.

Returns

{caplin.streamlink.CommandSubscription} Information about the 'throttle' command. If the commandParameters made the command persistent, you can subsequently cancel this by calling the CommandSubscription's unPersist() method.