Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method.
More...
Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method.
The ContainerSubscriptionParameters is passed as a parameter to the subscribe method in the IStreamLink.
Allow selection, sorting and grouping of containers.
- Example: params.select('bid>123&ask<122', "bid ASC NUMBER, ask DESC NUMBER", "bid" )
- The static ContainerFilterFactory can be used to build a FilterExpression whose toFilterString method will generate a where clause in the required format.
- Note: this method will only work if the backend has the Caplin Refiner installed.
- The following example shows how to build an expression for FIELD1 > 0.1 AND FIELD3 = "a a"
IContainerSubscriptionParameters containerSubscriptionParameters = streamlink.CreateContainerSubscriptionParameters();
containerSubscriptionParameters.Select(exp1Andexp2.ToFilterString(), "FIELD1", null);
ISubscription subscription = streamlink.Subscribe("/container", subscriptionListener, containerSubscriptionParameters);
- Parameters
-
where | The where clause, in the form required by Caplin Refiner (example 'bid>123&ask<222'). |
- Parameters
-
orderBy | The sorting order of the returned container in the form: field [ASC or DESC] [NUMBER or TEXT], ... example: bid DESC NUMBER,ask ASC NUMBER |
- Parameters
-
groupBy | The group by clause in the form: field example: bid |
- Returns
- The update ContainerSubscriptionParameters object to permit a fluent programming style.
Sets the subscription to keep elements in the container that are inaccessible.
- The update ContainerSubscriptionParameters object to permit a fluent programming style.
Sets the subscription to provide only the container structure (no constituent images or updates).
- The update ContainerSubscriptionParameters object to permit a fluent programming style.
Sets the size of the container window.
- Parameters
-
start | The index of the first container element within the window, where the first container element has an index value of 0 (zero). |
- Parameters
-
size | The maximum number of container elements within the window. |
- Returns
- The update ContainerSubscriptionParameters object to permit a fluent programming style.