StreamLink.NET  8.0.1-8.0.1-1132-88354a9
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | List of all members
Caplin.StreamLink.IJsonSubscriptionParameters Interface Reference

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

Inheritance diagram for Caplin.StreamLink.IJsonSubscriptionParameters:
Caplin.StreamLink.ISubscriptionParameters

Public Member Functions

Caplin.StreamLink.IJsonSubscriptionParameters AddHeader (string name, string value)
 For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are added will be the order in which they are applied to the REST operation. More...
 
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.AddHeader ( string  name,
string  value 
)

For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are added will be the order in which they are applied to the REST operation.

Parameters
namethe name of the HTTP header
valuethe value of the header
Returns
The updated IJsonSubscriptionParameters object to permit a fluent style.
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
filterThe filter string.
Returns
The updated IJsonSubscriptionParameters object to permit a fluent style.

Generated on Mon Feb 26 2024 19:57:57 for StreamLink.NET