com.caplin.streamlink

Interface RecordSubscriptionParameters

All Superinterfaces:

SubscriptionParameters

All Known Subinterfaces:

ContainerSubscriptionParameters

public interface RecordSubscriptionParameters
extends SubscriptionParameters

Defines the parameters used for Record subscriptions.

To create an instance of RecordSubscriptionParameters, use the com.caplin.streamlink.StreamLink.createRecordSubscriptionParameters() method.

Method Summary

Methods

Modifier and Type	Method and Description
RecordSubscriptionParameters	setFields(java.util.List<java.lang.String> fields) Sets the record fields that will be requested when a subscription is made using these parameters.
RecordSubscriptionParameters	setFilter(java.lang.String filter, boolean isImage) Sets the filter that restricts the the information returned by the subscription.

Method Detail

setFields

RecordSubscriptionParameters setFields(java.util.List<java.lang.String> fields)

Sets the record fields that will be requested when a subscription is made using these parameters.

If no fields are defined, then your SubscriptionListener receives all fields that are available for the subject.

Parameters:

fields - The record fields to be requested.

Returns:

The updated RecordSubscriptionParameters object to permit a fluent style.

setFilter

RecordSubscriptionParameters setFilter(java.lang.String filter,
                                     boolean isImage)

Sets the filter that restricts the the information returned by the subscription. The filtering is performed by the Liberator, rather than the client, so that bandwidth and client side processing are reduced.

For more details on the format of the filter string, please see the StreamLink Overview document.

Parameters:

filter - The filter string.

isImage - true if the filter string should only be applied to the initial record data (image) supplied in response to the subscription request, false if the filter string should be applied to the initial record and every subsequent update.

Returns:

The updated RecordSubscriptionParameters object to permit a fluent style.