MpnSubscriptionExt extension
Methods
-
addListener(
MpnSubscriptionListener listener) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Adds a listener that will receive events from the MpnSubscription instance. -
getActualNotificationFormat(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that gets the JSON structure used by the Sever to send notifications. -
getActualTriggerExpression(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that gets the trigger expression evaluated by the Sever. -
getDataAdapter(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the name of the Data Adapter specified for this MpnSubscription through setDataAdapter. -
getFields(
) → List< String> ? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the "Field List" specified for this MpnSubscription. -
getFieldSchema(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the field schema specified for this MpnSubscription. -
getItemGroup(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the item group specified for this MpnSubscription. -
getItems(
) → List< String> ? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the "Item List" specified for this MpnSubscription. -
getListeners(
) → List< MpnSubscriptionListener> -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Returns the list containing the MpnSubscriptionListener instances that were added to this MpnSubscription. -
getMode(
) → String -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the mode specified for this MpnSubscription. -
getNotificationFormat(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that gets the JSON structure requested by the user to be used as the format of push notifications. -
getRequestedBufferSize(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the buffer size, configured though setRequestedBufferSize, to be requested to the Server for this MpnSubscription. -
getRequestedMaxFrequency(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that can be used to read the max frequency, configured through setRequestedMaxFrequency, to be requested to the Server for this MpnSubscription. -
getStatus(
) → String -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
The status of the subscription. -
getStatusTimestamp(
) → int -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
The server-side timestamp of the subscription status. -
getSubscriptionId(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
The server-side unique persistent ID of the MPN subscription. -
getTriggerExpression(
) → String? -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Inquiry method that gets the trigger expression requested by the user. -
isActive(
) → bool -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Checks if the MpnSubscription is currently "active" or not. -
isSubscribed(
) → bool -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Checks if the MpnSubscription is currently subscribed to through the server or not. -
isTriggered(
) → bool -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Checks if the MpnSubscription is currently triggered or not. -
removeListener(
MpnSubscriptionListener listener) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Removes a listener from the MpnSubscription instance so that it will not receive events anymore. -
setDataAdapter(
String? dataAdapter) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
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 MpnSubscription. -
setFields(
List< String> ? fields) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server. -
setFieldSchema(
String? schemaName) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server. -
setItemGroup(
String? groupName) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the "Item Group" to be subscribed to through Lightstreamer Server. -
setItems(
List< String> ? items) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the "Item List" to be subscribed to through Lightstreamer Server. -
setNotificationFormat(
String format) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Sets the JSON structure to be used as the format of push notifications. -
setRequestedBufferSize(
String? size) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the length to be requested to Lightstreamer Server for the internal queuing buffers for the items in the MpnSubscription. -
setRequestedMaxFrequency(
String? freq) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the MpnSubscription. -
setTriggerExpression(
String? trigger) → void -
Available on MpnSubscription, provided by the MpnSubscriptionExt extension
Sets the boolean expression that will be evaluated against each update and will act as a trigger to deliver the push notification.