Package com.batch.android

Enum BatchMessage.Format

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BatchMessage.Format>
    Enclosing class:
    BatchMessage
    public static enum BatchMessage.Format
extends java.lang.Enum<BatchMessage.Format>
    Formats that can be contained into a BatchMessage.

    This list might evolve in the future

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALERT
      ALERT is simple a system alert
      BANNER
      BANNER is a banner that can be attached on top or bottom of your screen
      FULLSCREEN
      FULLSCREEN is the fullscreen format
      IMAGE
      IMAGE is a modal popup that simply shows an image in an alert (detached) or fullscreen (attached) style
      MODAL
      BANNER is a popup that takes over the screen modally, like a system alert but with a custom style
      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.
      WEBVIEW
      WEBVIEW is a fullscreen format that load an URL into a WebView

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BatchMessage.Format valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BatchMessage.Format[] 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

      • 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.

      • FULLSCREEN

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

      • BANNER

        public static final BatchMessage.Format BANNER
        BANNER is a banner that can be attached on top or bottom of your screen

      • MODAL

        public static final BatchMessage.Format MODAL
        BANNER is a popup that takes over the screen modally, like a system alert but with a custom style

      • 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 Detail

      • values

        public static BatchMessage.Format[] 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 (BatchMessage.Format c : BatchMessage.Format.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BatchMessage.Format 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