Package com.zendesk.sunshine_conversations_client.model

Class FormMessageField

java.lang.Object

com.zendesk.sunshine_conversations_client.model.FormMessageField

public class FormMessageField
extends java.lang.Object

FormMessageField

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormMessageField.TypeEnum	The field type.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_EMAIL
static java.lang.String	JSON_PROPERTY_LABEL
static java.lang.String	JSON_PROPERTY_MAX_SIZE
static java.lang.String	JSON_PROPERTY_MIN_SIZE
static java.lang.String	JSON_PROPERTY_NAME
static java.lang.String	JSON_PROPERTY_OPTIONS
static java.lang.String	JSON_PROPERTY_PLACEHOLDER
static java.lang.String	JSON_PROPERTY_SELECT
static java.lang.String	JSON_PROPERTY_TEXT
static java.lang.String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
FormMessageField()

Method Summary

Modifier and Type	Method	Description
FormMessageField	addOptionsItem(java.lang.Object optionsItem)
FormMessageField	addSelectItem(java.lang.Object selectItem)
FormMessageField	email(java.lang.String email)
boolean	equals(java.lang.Object o)
java.lang.String	getEmail()	Specifies the response for a email field.
java.lang.String	getLabel()	The label of the field.
java.lang.Integer	getMaxSize()	The maximum allowed length for the response for a field of type text.
java.lang.Integer	getMinSize()	The minimum allowed length for the response for a field of type text.
java.lang.String	getName()	The name of the field.
java.util.List<java.lang.Object>	getOptions()	Array of objects representing options for a field of type select.
java.lang.String	getPlaceholder()	Placeholder text for the field.
java.util.List<java.lang.Object>	getSelect()	Array of objects representing the response for a field of type select.
java.lang.String	getText()	Specifies the response for a text field.
FormMessageField.TypeEnum	getType()	The field type.
int	hashCode()
FormMessageField	label(java.lang.String label)
FormMessageField	maxSize(java.lang.Integer maxSize)
FormMessageField	minSize(java.lang.Integer minSize)
FormMessageField	name(java.lang.String name)
FormMessageField	options(java.util.List<java.lang.Object> options)
FormMessageField	placeholder(java.lang.String placeholder)
FormMessageField	select(java.util.List<java.lang.Object> select)
void	setEmail(java.lang.String email)
void	setLabel(java.lang.String label)
void	setMaxSize(java.lang.Integer maxSize)
void	setMinSize(java.lang.Integer minSize)
void	setName(java.lang.String name)
void	setOptions(java.util.List<java.lang.Object> options)
void	setPlaceholder(java.lang.String placeholder)
void	setSelect(java.util.List<java.lang.Object> select)
void	setText(java.lang.String text)
void	setType(FormMessageField.TypeEnum type)
FormMessageField	text(java.lang.String text)
java.lang.String	toString()
FormMessageField	type(FormMessageField.TypeEnum type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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_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_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_OPTIONS

public static final java.lang.String JSON_PROPERTY_OPTIONS

See Also:

Constant Field Values

Constructor Detail

FormMessageField

public FormMessageField()

Method Detail

type

public FormMessageField type(FormMessageField.TypeEnum type)

getType

public FormMessageField.TypeEnum getType()

The field type.

Returns:

type

setType

public void setType(FormMessageField.TypeEnum type)

name

public FormMessageField 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 FormMessageField 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)

text

public FormMessageField 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 FormMessageField 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 FormMessageField select(java.util.List<java.lang.Object> select)

addSelectItem

public FormMessageField 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)

placeholder

public FormMessageField 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 FormMessageField 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: 256

Returns:

minSize

setMinSize

public void setMinSize(java.lang.Integer minSize)

maxSize

public FormMessageField 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: 256

Returns:

maxSize

setMaxSize

public void setMaxSize(java.lang.Integer maxSize)

options

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

addOptionsItem

public FormMessageField 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