SubscriptionExt extension

on

Methods

addListener(SubscriptionListener listener) → void
Adds a listener that will receive events from the Subscription instance.
getCommandPosition() → int
Returns the position of the "command" field in a COMMAND Subscription.
getCommandSecondLevelDataAdapter() → String?
Inquiry method that can be used to read the second-level Data Adapter name configured through setCommandSecondLevelDataAdapter.
getCommandSecondLevelFields() → List<String>?
Inquiry method that can be used to read the "Field List" specified for second-level Subscriptions.
getCommandSecondLevelFieldSchema() → String?
Inquiry method that can be used to read the "Field Schema" specified for second-level Subscriptions.
getCommandValue(StringOrInt itemNameOrPosition, String keyValue, StringOrInt fieldNameOrPosition) → String?
Returns the latest value received for the specified item/key/field combination.
getDataAdapter() → String?
Inquiry method that can be used to read the name of the Data Adapter specified for this Subscription through setDataAdapter.
getFields() → List<String>?
Inquiry method that can be used to read the "Field List" specified for this Subscription.
getFieldSchema() → String?
Inquiry method that can be used to read the field schema specified for this Subscription.
getItemGroup() → String?
Inquiry method that can be used to read the item group specified for this Subscription.
getItems() → List<String>?
Inquiry method that can be used to read the "Item List" specified for this Subscription.
getKeyPosition() → int
Returns the position of the "key" field in a COMMAND Subscription.
getListeners() → List<SubscriptionListener>
Returns a list containing the SubscriptionListener instances that were added to this client.
getMode() → String
Inquiry method that can be used to read the mode specified for this Subscription.
getRequestedBufferSize() → String?
Inquiry method that can be used to read the buffer size, configured though setRequestedBufferSize, to be requested to the Server for this Subscription.
getRequestedMaxFrequency() → String?
Inquiry method that can be used to read the max frequency, configured through setRequestedMaxFrequency, to be requested to the Server for this Subscription.
getRequestedSnapshot() → String?
Inquiry method that can be used to read the snapshot preferences, configured through setRequestedSnapshot, to be requested to the Server for this Subscription.
getSelector() → String?
Inquiry method that can be used to read the selector name
specified for this Subscription through setSelector.
getValue(StringOrInt itemNameOrPosition, StringOrInt fieldNameOrPosition) → String?
Returns the latest value received for the specified item/field pair.
isActive() → bool
Inquiry method that checks if the Subscription is currently "active" or not.
isSubscribed() → bool
Inquiry method that checks if the Subscription is currently subscribed to through the server or not.
removeListener(SubscriptionListener listener) → void
Removes a listener from the Subscription instance so that it will not receive events anymore.
setCommandSecondLevelDataAdapter(String? dataAdapter) → void
Setter method that sets the name of the second-level Data Adapter (within the Adapter Set used by the current session) that supplies all the second-level items.
setCommandSecondLevelFields(List<String>? fields) → void
Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server for the second-level items.
setCommandSecondLevelFieldSchema(String? schemaName) → void
Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server for the second-level items.
setDataAdapter(String? dataAdapter) → void
Setter method that sets the name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items for this Subscription.
setFields(List<String>? fields) → void
Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server.
setFieldSchema(String? schemaName) → void
Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server.
setItemGroup(String? groupName) → void
Setter method that sets the "Item Group" to be subscribed to through Lightstreamer Server.
setItems(List<String>? items) → void
Setter method that sets the "Item List" to be subscribed to through Lightstreamer Server.
setRequestedBufferSize(String? size) → void
Setter method that sets the length to be requested to Lightstreamer Server for the internal queuing buffers for the items in the Subscription.
setRequestedMaxFrequency(String? freq) → void
Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the Subscription.
setRequestedSnapshot(String? isRequired) → void
Setter method that enables/disables snapshot delivery request for the items in the Subscription.
setSelector(String? selector) → void
Setter method that sets the selector name for all the items in the Subscription. The selector is a filter on the updates received.