Caplin.StreamLink.IJsonSubscriptionParameters Interface Reference

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

Inheritance diagram for Caplin.StreamLink.IJsonSubscriptionParameters:

Public Member Functions
Caplin.StreamLink.IJsonSubscriptionParameters	SetFilter (string filter)
	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. More...

Detailed Description

Defines the parameters used for Json subscriptions.

To create an instance of JsonSubscriptionParameters, use the IStreamLink.CreateJsonSubscriptionParameters method.

Member Function Documentation

Caplin.StreamLink.IJsonSubscriptionParameters Caplin.StreamLink.IJsonSubscriptionParameters.SetFilter

(

string

filter

)

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 https://goessner.net/articles/JsonPath/.

Parameters

filter

The filter string.

Returns

The updated IJsonSubscriptionParameters object to permit a fluent style.