com.caplin.streamlink

Interface FreeFormSubscriptionParameters

All Superinterfaces:

SubscriptionParameters

public interface FreeFormSubscriptionParameters
extends SubscriptionParameters

A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers.

To create an instance of FreeFormSubscriptionParameters call the com.caplin.streamlink.StreamLink.createFreeFormSubscriptionParameters() method.

In this version of StreamLink, FreeFormSubscriptionParameters can be used to define filter expressions for filtering news headlines. For more information about news headlines, and the syntax and rules for defining news filter expressions, see the "News filtering" section of the StreamLink Overview.

Method Summary

Methods

Modifier and Type	Method and Description
FreeFormSubscriptionParameters	setParameters(java.lang.String parameters) Sets the parameters using a free-form string.

Method Detail

setParameters

FreeFormSubscriptionParameters setParameters(java.lang.String parameters)

Sets the parameters using a free-form string.

Parameters:

parameters - The parameters.

Returns:

The updated FreeFormSubscriptionParameters instance (to permit a fluent programming style).