Package zendesk.chat

Enum PreChatFormFieldStatus

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

    public enum PreChatFormFieldStatus
extends java.lang.Enum<PreChatFormFieldStatus>
    Enum describing the possible statuses of the fields of the pre-Chat form.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      HIDDEN
      The field is hidden.
      OPTIONAL
      The field is optional.
      REQUIRED
      The field is required.

    • Method Summary

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

      • REQUIRED

        public static final PreChatFormFieldStatus REQUIRED
        The field is required. It must have a valid value set on it before the Form can proceed to the next FormField, or mark itself as complete.

      • OPTIONAL

        public static final PreChatFormFieldStatus OPTIONAL
        The field is optional. It will be presented as a question in the form, but with an option to skip the question. A value is not required to be set on it before the Form can proceed to the next FormField or mark itself as complete. However, any value set on the field must still pass the field's validation. This is the default status.

      • HIDDEN

        public static final PreChatFormFieldStatus HIDDEN
        The field is hidden. It will not be shown to the end-user. No value will be set, and the Form will not consider the field when assessing its completeness.

    • Method Detail

      • values

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

      • valueOf

        public static PreChatFormFieldStatus 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