Package com.zendesk.sunshine_conversations_client.model

Class Field

  • public class Field
extends java.lang.Object
    Properties that can be expected to receive inside a form or formResponse message field.

    • Field Detail

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_NAME

        public static final java.lang.String JSON_PROPERTY_NAME
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LABEL

        public static final java.lang.String JSON_PROPERTY_LABEL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_PLACEHOLDER

        public static final java.lang.String JSON_PROPERTY_PLACEHOLDER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MIN_SIZE

        public static final java.lang.String JSON_PROPERTY_MIN_SIZE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MAX_SIZE

        public static final java.lang.String JSON_PROPERTY_MAX_SIZE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TEXT

        public static final java.lang.String JSON_PROPERTY_TEXT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_EMAIL

        public static final java.lang.String JSON_PROPERTY_EMAIL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SELECT

        public static final java.lang.String JSON_PROPERTY_SELECT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_OPTIONS

        public static final java.lang.String JSON_PROPERTY_OPTIONS
        See Also:
        Constant Field Values

    • Constructor Detail

      • Field

        public Field()

    • Method Detail

      • getType

        public Field.TypeEnum getType()
        The field type.
        Returns:
        type

      • name

        public Field name​(java.lang.String name)

      • getName

        public java.lang.String getName()
        The name of the field. Must be unique per form or formResponse.
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • label

        public Field label​(java.lang.String label)

      • getLabel

        public java.lang.String getLabel()
        The label of the field. What the field is displayed as on Web Messenger.
        Returns:
        label

      • setLabel

        public void setLabel​(java.lang.String label)

      • placeholder

        public Field placeholder​(java.lang.String placeholder)

      • getPlaceholder

        @Nullable
public java.lang.String getPlaceholder()
        Placeholder text for the field. Form message only.
        Returns:
        placeholder

      • setPlaceholder

        public void setPlaceholder​(java.lang.String placeholder)

      • minSize

        public Field minSize​(java.lang.Integer minSize)

      • getMinSize

        @Nullable
public java.lang.Integer getMinSize()
        The minimum allowed length for the response for a field of type text. Form message only. minimum: 1 maximum: 128
        Returns:
        minSize

      • setMinSize

        public void setMinSize​(java.lang.Integer minSize)

      • maxSize

        public Field maxSize​(java.lang.Integer maxSize)

      • getMaxSize

        @Nullable
public java.lang.Integer getMaxSize()
        The maximum allowed length for the response for a field of type text. Form message only. minimum: 1 maximum: 128
        Returns:
        maxSize

      • setMaxSize

        public void setMaxSize​(java.lang.Integer maxSize)

      • text

        public Field text​(java.lang.String text)

      • getText

        @Nullable
public java.lang.String getText()
        Specifies the response for a text field.
        Returns:
        text

      • setText

        public void setText​(java.lang.String text)

      • email

        public Field email​(java.lang.String email)

      • getEmail

        @Nullable
public java.lang.String getEmail()
        Specifies the response for a email field.
        Returns:
        email

      • setEmail

        public void setEmail​(java.lang.String email)

      • select

        public Field select​(java.util.List<java.lang.Object> select)

      • addSelectItem

        public Field addSelectItem​(java.lang.Object selectItem)

      • getSelect

        @Nullable
public java.util.List<java.lang.Object> getSelect()
        Array of objects representing the response for a field of type select. Form and formResponse messages only.
        Returns:
        select

      • setSelect

        public void setSelect​(java.util.List<java.lang.Object> select)

      • options

        public Field options​(java.util.List<java.lang.Object> options)

      • addOptionsItem

        public Field addOptionsItem​(java.lang.Object optionsItem)

      • getOptions

        @Nullable
public java.util.List<java.lang.Object> getOptions()
        Array of objects representing options for a field of type select.
        Returns:
        options

      • setOptions

        public void setOptions​(java.util.List<java.lang.Object> options)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object