Interface SubscriptionStatusEvent


  • public interface SubscriptionStatusEvent

    Provides information about a change in the state of a subscription.

    The SubscriptionStatusEvent will be provided on a onSubscriptionStatus callback to a SubscriptionListener.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getFields()
      Returns any fields associated with the status event.
      SubscriptionStatusType getStatus()
      Returns the new status of the subject of the subscription.
      java.lang.String getStatusMessage()
      Returns the new status message of the subject of the subscription.
      java.lang.String getSubject()
      Returns the subject of the subscription to which the event relates.
    • Method Detail

      • getSubject

        java.lang.String getSubject()

        Returns the subject of the subscription to which the event relates.

        Returns:
        The subject.
      • getStatus

        SubscriptionStatusType getStatus()

        Returns the new status of the subject of the subscription.

        Returns:
        The new status.
      • getStatusMessage

        java.lang.String getStatusMessage()

        Returns the new status message of the subject of the subscription.

        Returns:
        The new status message.
      • getFields

        java.util.Map<java.lang.String,​java.lang.String> getFields()

        Returns any fields associated with the status event.

        The fields may contain metadata related to the event, the known keys are "code" and "status".

        Returns:
        the fields