Package com.eatthepath.pushy.apns.util

Enum InterruptionLevel

java.lang.Object
java.lang.Enum<InterruptionLevel>
com.eatthepath.pushy.apns.util.InterruptionLevel
All Implemented Interfaces:
Serializable, Comparable<InterruptionLevel>, java.lang.constant.Constable
public enum InterruptionLevel extends Enum<InterruptionLevel>
An enumeration of interruption levels that may be specified in a notification payload. Interruption levels are supported in iOS 15 and newer.
Since:
0.15
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACTIVE
    According to Apple's Human Interface Guidelines, an active notification contains "information people might appreciate knowing about when it arrives, like a score update on their favorite sports team." If no interruption level is specified, the notification is assumed to have an active interruption level.
    CRITICAL
    According to Apple's Human Interface guidelines, a critical notification contains: …urgent information about personal health and public safety that directly impacts the user and demands their immediate attention.
    PASSIVE
    According to Apple's Human Interface Guidelines, a passive notification contains "information people can view at their leisure, like a restaurant recommendation."
    TIME_SENSITIVE
    According to Apple's Human Interface Guidelines, a time-sensitive notification contains "information that directly impacts the user and requires their immediate attention, like an account security issue or a package delivery."

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getValue()
     
    static InterruptionLevel
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static InterruptionLevel[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PASSIVE

      public static final InterruptionLevel PASSIVE
      According to Apple's Human Interface Guidelines, a passive notification contains "information people can view at their leisure, like a restaurant recommendation."

    • ACTIVE

      public static final InterruptionLevel ACTIVE
      According to Apple's Human Interface Guidelines, an active notification contains "information people might appreciate knowing about when it arrives, like a score update on their favorite sports team." If no interruption level is specified, the notification is assumed to have an active interruption level.

    • TIME_SENSITIVE

      public static final InterruptionLevel TIME_SENSITIVE
      According to Apple's Human Interface Guidelines, a time-sensitive notification contains "information that directly impacts the user and requires their immediate attention, like an account security issue or a package delivery."

    • CRITICAL

      public static final InterruptionLevel CRITICAL
      According to Apple's Human Interface guidelines, a critical notification contains:
      …urgent information about personal health and public safety that directly impacts the user and demands their immediate attention. Critical notifications are extremely rare and typically come from governmental and public agencies or healthcare apps. You must get an entitlement to use the Critical interruption level.

  • Method Details

    • values

      public static InterruptionLevel[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static InterruptionLevel valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()