Provides access to parameters to be used when requesting a record from the Liberator.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public interface IRecordSubscriptionParameters : ISubscriptionParameters
Public Interface IRecordSubscriptionParameters _ Implements ISubscriptionParameters
public interface class IRecordSubscriptionParameters : ISubscriptionParameters
Members
All Members | Methods | Properties | |||
Icon | Member | Description |
---|---|---|
Fields |
Gets the fields to be requested when a IRecordSubscription is subscribed to.
| |
Filter |
Gets the filter applied to records for a IRecordSubscription used to filter
the updates that reach IRecordSubscriptionListener associated with the subscription.
| |
ToParameterString()()() |
Converts the ISubscriptionParameters into a string representation.
(Inherited from ISubscriptionParameters.) |
Remarks
Parameters are used to specify which fields and under which conditions updates should be received by the application.
Filter Syntax
The filter allows one or more of the object fields to be restricted, reducing the number of field updates that will be received. For example the filter "dLast > 50) & (dVolumeAcc > 1000)" will mean that updates will only be recieved when dLast is greater than 50 and dVolumeAcc is greater than 1000. For further information on the filtering syntax see the StreamLink Overview document.