unsubscribeMpnSubscriptions method

Future<void> unsubscribeMpnSubscriptions([ String? filter ])

Operation method that unsubscribes all the MPN subscriptions with a specified status from the server's MPN Module.

By specifying a status filter it is possible to unsubscribe multiple MPN subscriptions at once. E.g. by passing TRIGGERED it is possible to unsubscribe all triggered MPN subscriptions. This operation removes the involved MPN subscriptions from the list of "active" subscriptions.

General Edition Note MPN is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle Multiple unsubscription can be requested at any time. Once done the involved MPN subscriptions immediately exit the "active" state.
Note that forwarding of the unsubscription to the server is made in a separate thread.
The unsubscription will be notified through an MpnSubscriptionListener.onUnsubscription event to all involved MPN subscriptions.

• filter A status name to be used to select the MPN subscriptions to unsubscribe. If null all existing MPN subscriptions are unsubscribed. Possible filter values are:
• ALL or null
• TRIGGERED
• SUBSCRIBED

Throws IllegalArgumentException if the given filter is not valid.

Throws IllegalStateException if there is no MPN device registered.

• See subscribe
• See unsubscribe

⚠ WARNING ⚠ The completion of the returned Future indicates that the operation has been accepted and is in progress, but not necessarily completed. To receive notifications about events generated by the operation, it is necessary to register an MpnSubscriptionListener.

Implementation

Future<void> unsubscribeMpnSubscriptions([ String? filter ]) async {
  var arguments = <String, dynamic>{
    'filter': filter
  };
  return await _invokeMethod('unsubscribeMpnSubscriptions', arguments);
}