Defines the parameters used for Record subscriptions. More...

Inheritance diagram for Caplin.StreamLink.IRecordSubscriptionParameters:

Public Member Functions
Caplin.StreamLink.IRecordSubscriptionParameters	SetFields (IList< string > fields)
	Sets the record fields that will be requested when a subscription is made using these parameters. More...

Caplin.StreamLink.IRecordSubscriptionParameters	SetFilter (string filter, bool isImage)
	Sets the filter that restricts the the information returned by the subscription. The filtering is More...

Detailed Description

Defines the parameters used for Record subscriptions.

To create an instance of RecordSubscriptionParameters, use the IStreamLink.CreateRecordSubscriptionParameters method.

Member Function Documentation

Caplin.StreamLink.IRecordSubscriptionParameters Caplin.StreamLink.IRecordSubscriptionParameters.SetFields ( IList< string > fields )

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

Parameters

fields The record fields to be requested.
Returns
The updated IRecordSubscriptionParameters object to permit a fluent style.

Caplin.StreamLink.IRecordSubscriptionParameters Caplin.StreamLink.IRecordSubscriptionParameters.SetFilter	(	string	filter,
		bool	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.
Parameters

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 IRecordSubscriptionParameters object to permit a fluent style.