getStatus method

String getStatus()

The status of the subscription.

The status can be:

  • UNKNOWN: when the MPN subscription has just been created or deleted (i.e. unsubscribed). In this status [isActive], [isSubscribed] and [isTriggered] are all false.
  • ACTIVE: when the MPN susbcription has been submitted to the server, but no confirm has been received yet. In this status [isActive] is true, [isSubscribed] and [isTriggered] are false.
  • SUBSCRIBED: when the MPN subscription has been successfully subscribed on the server. If a trigger expression is set, it has not been evaluated to true yet. In this status [isActive] and [isSubscribed] are true, [isTriggered] is false.
  • TRIGGERED: when the MPN subscription has a trigger expression set, has been successfully subscribed on the server and the trigger expression has been evaluated to true at least once. In this status [isActive], [isSubscribed] and [isTriggered] are all true.

Lifecycle This method can be called at any time.

Returns the status of the subscription.

Implementation

external String getStatus();