Package com.zendesk.sunshine_conversations_client.model

Class FormMessage

java.lang.Object

com.zendesk.sunshine_conversations_client.model.FormMessage

All Implemented Interfaces:

Content

public class FormMessage
extends java.lang.Object
implements Content

A form type message without text or actions. Only supported in the Web SDK.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_BLOCK_CHAT_INPUT
static java.lang.String	JSON_PROPERTY_FIELDS
static java.lang.String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
FormMessage()

Method Summary

Modifier and Type	Method	Description
FormMessage	addFieldsItem(Field fieldsItem)
FormMessage	blockChatInput(java.lang.Boolean blockChatInput)
boolean	equals(java.lang.Object o)
FormMessage	fields(java.util.List<Field> fields)
java.lang.Boolean	getBlockChatInput()	true if the message should block the chat input on Web Messenger.
java.util.List<Field>	getFields()	An array of objects representing fields associated with the message.
java.lang.String	getType()	The type of message.
int	hashCode()
void	setBlockChatInput(java.lang.Boolean blockChatInput)
void	setFields(java.util.List<Field> fields)
void	setType(java.lang.String type)
java.lang.String	toString()
FormMessage	type(java.lang.String 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_BLOCK_CHAT_INPUT

public static final java.lang.String JSON_PROPERTY_BLOCK_CHAT_INPUT

See Also:

Constant Field Values

JSON_PROPERTY_FIELDS

public static final java.lang.String JSON_PROPERTY_FIELDS

See Also:

Constant Field Values

Constructor Detail

FormMessage

public FormMessage()

Method Detail

type

public FormMessage type(java.lang.String type)

getType

public java.lang.String getType()

The type of message.

Specified by:

getType in interface Content

Returns:

type

setType

public void setType(java.lang.String type)

blockChatInput

public FormMessage blockChatInput(java.lang.Boolean blockChatInput)

getBlockChatInput

@Nullable
public java.lang.Boolean getBlockChatInput()

true if the message should block the chat input on Web Messenger.

Returns:

blockChatInput

setBlockChatInput

public void setBlockChatInput(java.lang.Boolean blockChatInput)

fields

public FormMessage fields(java.util.List<Field> fields)

addFieldsItem

public FormMessage addFieldsItem(Field fieldsItem)

getFields

public java.util.List<Field> getFields()

An array of objects representing fields associated with the message. Only present in form and formResponse messages.

Returns:

fields

setFields

public void setFields(java.util.List<Field> fields)

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