getMpnSubscriptions method

List<MpnSubscription> getMpnSubscriptions(
  1. String? filter
)

Inquiry method that returns a collection of the existing MPN subscription with a specified status.

Can return both objects created by the user, via MpnSubscription constructors, and objects created by the client, to represent pre-existing MPN subscriptions.
Note that objects in the collection may be substituted at any time with equivalent ones: do not rely on pointer matching, instead rely on the MpnSubscription.getSubscriptionId value to verify the equivalence of two MpnSubscription objects. Substitutions may happen when an MPN subscription is modified, or when it is coalesced with a pre-existing subscription.

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 The collection is available once an MpnDevice registration has been requested, but reflects the actual server's collection only after an MpnDeviceListener.onSubscriptionsUpdated event has been notified.

  • filter An MPN subscription status name to be used to select the MPN subscriptions to return. If null all existing MPN subscriptions are returned. Possible filter values are:
  • ALL or null
  • TRIGGERED
  • SUBSCRIBED

Returns the collection of MpnSubscription with the specified status.

Throws IllegalArgumentException if the given filter is not valid.

Throws IllegalStateException if there is no MPN device registered.

Implementation

List<MpnSubscription> getMpnSubscriptions(String? filter) {
  return _getMpnSubscriptions(filter).cast<MpnSubscription>();
}