Package 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 {@link com.caplin.streamlink.StreamLink.createRecordSubscriptionParameters()} method.

  • Method Details

    • setFields

      RecordSubscriptionParameters setFields(List<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(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 should be evaluated on the fields in the cached object (image) after the update is applied to the image, false if it should be evaluated only on the changed fields in the record update.
      Returns:
      The updated RecordSubscriptionParameters object to permit a fluent style.