Enum PushNotificationState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PushNotificationState>

    public enum PushNotificationState
    extends java.lang.Enum<PushNotificationState>
    The state of a push notification event.
    Author:
    Christopher Mindus
    • Enum Constant Summary

      Enum Constants 
      Enum ConstantDescription
      CREATED
      The push notification has been created but nothing done with it.
      ERROR
      General error state: depending on where this state is returned, retries may be possible.
      POSTED
      The push notification event has been posted to be sent, but yet nothing else (as errors or such) to report: the notification is on the way...
      SERVICE_STOPPED
      Push service has been stopped.
      SUCCESS
      The push notification has been sent to the push notification end point successfully for distribution.
      UNKNOWN_CLIENT
      Unknown recipient is when the push notification is sent to e.g.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static PushNotificationStatevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PushNotificationState[]values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • CREATED

        public static final PushNotificationState CREATED
        The push notification has been created but nothing done with it.
      • POSTED

        public static final PushNotificationState POSTED
        The push notification event has been posted to be sent, but yet nothing else (as errors or such) to report: the notification is on the way...
      • SUCCESS

        public static final PushNotificationState SUCCESS
        The push notification has been sent to the push notification end point successfully for distribution.
      • UNKNOWN_CLIENT

        public static final PushNotificationState UNKNOWN_CLIENT
        Unknown recipient is when the push notification is sent to e.g. to a client that is not aware that it should receive push notifications, e.g. the user has set receive push notifications to "false" or e.g. that the application has been deleted from the device. In all cases, further push notifications should NOT be sent to the client in question.
      • ERROR

        public static final PushNotificationState ERROR
        General error state: depending on where this state is returned, retries may be possible.
      • SERVICE_STOPPED

        public static final PushNotificationState SERVICE_STOPPED
        Push service has been stopped. The service is generally only stopped when the server stops.
    • Method Detail

      • values

        public static PushNotificationState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PushNotificationState c : PushNotificationState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PushNotificationState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null