Caplin.StreamLink.IFreeFormSubscriptionParameters Interface Reference

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

Inheritance diagram for Caplin.StreamLink.IFreeFormSubscriptionParameters:

Public Member Functions
Caplin.StreamLink.IFreeFormSubscriptionParameters	SetParameters (string parameters)
	Sets the parameters using a free-form string. More...

Detailed Description

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 IStreamLink.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.

Member Function Documentation

Caplin.StreamLink.IFreeFormSubscriptionParameters Caplin.StreamLink.IFreeFormSubscriptionParameters.SetParameters

(

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).