Enum Class BatchMessage.Format

java.lang.Object
java.lang.Enum<BatchMessage.Format>
com.batch.android.BatchMessage.Format
All Implemented Interfaces:
Serializable, Comparable<BatchMessage.Format>, java.lang.constant.Constable
Enclosing class:
BatchMessage

public static enum BatchMessage.Format extends Enum<BatchMessage.Format>
Formats that can be contained into a BatchMessage.

This list might evolve in the future

  • 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
    ALERT is simple a system alert
    BANNER is a banner that can be attached on top or bottom of your screen
    FULLSCREEN is the fullscreen format
    IMAGE is a modal popup that simply shows an image in an alert (detached) or fullscreen (attached) style
    BANNER is a popup that takes over the screen modally, like a system alert but with a custom style
    UNKNOWN means that the message is invalid and does not contain any displayable message, or that the format is unknown to this version of the SDK, and might be available in a newer one.
    WEBVIEW is a fullscreen format that load an URL into a WebView
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

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

    • UNKNOWN

      public static final BatchMessage.Format UNKNOWN
      UNKNOWN means that the message is invalid and does not contain any displayable message, or that the format is unknown to this version of the SDK, and might be available in a newer one.
    • ALERT

      public static final BatchMessage.Format ALERT
      ALERT is simple a system alert
    • FULLSCREEN

      public static final BatchMessage.Format FULLSCREEN
      FULLSCREEN is the fullscreen format
    • IMAGE

      public static final BatchMessage.Format IMAGE
      IMAGE is a modal popup that simply shows an image in an alert (detached) or fullscreen (attached) style
    • WEBVIEW

      public static final BatchMessage.Format WEBVIEW
      WEBVIEW is a fullscreen format that load an URL into a WebView
  • Method Details

    • values

      public static BatchMessage.Format[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static BatchMessage.Format valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null