Package com.mypurecloud.sdk.v2.model

Class ConversationContentForm

java.lang.Object

com.mypurecloud.sdk.v2.model.ConversationContentForm

All Implemented Interfaces:

Serializable

public class ConversationContentForm
extends Object
implements Serializable

Form content object.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConversationContentForm()
ConversationContentForm(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ConversationContentForm	cannedResponseId(String cannedResponseId)	The id of the canned response which was used to create the form.
boolean	equals(Object o)
ConversationContentForm	formPages(List<ConversationFormPage> formPages)	Form pages
String	getCannedResponseId()
List<ConversationFormPage>	getFormPages()
ConversationContentIntroduction	getIntroduction()
String	getOriginatingMessageId()
ConversationContentReceivedReplyMessage	getReceivedMessage()
ConversationContentReceivedReplyMessage	getReplyMessage()
List<ConversationFormResponseComponent>	getResponse()
Boolean	getShowSummary()
int	hashCode()
ConversationContentForm	introduction(ConversationContentIntroduction introduction)	The intro component, used to give an intro into what the form entails
ConversationContentForm	originatingMessageId(String originatingMessageId)	Reference to the ID of the original message.
ConversationContentForm	receivedMessage(ConversationContentReceivedReplyMessage receivedMessage)	The message prompt to fill out the form received.
ConversationContentForm	replyMessage(ConversationContentReceivedReplyMessage replyMessage)	The reply message after the user has filled out the form received.
ConversationContentForm	response(List<ConversationFormResponseComponent> response)	Content of the payload included in the Form response.
void	setCannedResponseId(String cannedResponseId)
void	setFormPages(List<ConversationFormPage> formPages)
void	setIntroduction(ConversationContentIntroduction introduction)
void	setOriginatingMessageId(String originatingMessageId)
void	setReceivedMessage(ConversationContentReceivedReplyMessage receivedMessage)
void	setReplyMessage(ConversationContentReceivedReplyMessage replyMessage)
void	setResponse(List<ConversationFormResponseComponent> response)
void	setShowSummary(Boolean showSummary)
ConversationContentForm	showSummary(Boolean showSummary)	Show summary at end of form submission.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConversationContentForm

public ConversationContentForm()

ConversationContentForm

public ConversationContentForm(Boolean initWithEmptyList)

Method Details

introduction

public ConversationContentForm introduction(ConversationContentIntroduction introduction)

The intro component, used to give an intro into what the form entails

getIntroduction

public ConversationContentIntroduction getIntroduction()

setIntroduction

public void setIntroduction(ConversationContentIntroduction introduction)

formPages

public ConversationContentForm formPages(List<ConversationFormPage> formPages)

Form pages

getFormPages

public List<ConversationFormPage> getFormPages()

setFormPages

public void setFormPages(List<ConversationFormPage> formPages)

receivedMessage

public ConversationContentForm receivedMessage(ConversationContentReceivedReplyMessage receivedMessage)

The message prompt to fill out the form received.

getReceivedMessage

public ConversationContentReceivedReplyMessage getReceivedMessage()

setReceivedMessage

public void setReceivedMessage(ConversationContentReceivedReplyMessage receivedMessage)

replyMessage

public ConversationContentForm replyMessage(ConversationContentReceivedReplyMessage replyMessage)

The reply message after the user has filled out the form received.

getReplyMessage

public ConversationContentReceivedReplyMessage getReplyMessage()

setReplyMessage

public void setReplyMessage(ConversationContentReceivedReplyMessage replyMessage)

showSummary

public ConversationContentForm showSummary(Boolean showSummary)

Show summary at end of form submission.

getShowSummary

public Boolean getShowSummary()

setShowSummary

public void setShowSummary(Boolean showSummary)

response

public ConversationContentForm response(List<ConversationFormResponseComponent> response)

Content of the payload included in the Form response.

getResponse

public List<ConversationFormResponseComponent> getResponse()

setResponse

public void setResponse(List<ConversationFormResponseComponent> response)

originatingMessageId

public ConversationContentForm originatingMessageId(String originatingMessageId)

Reference to the ID of the original message.

getOriginatingMessageId

public String getOriginatingMessageId()

setOriginatingMessageId

public void setOriginatingMessageId(String originatingMessageId)

cannedResponseId

public ConversationContentForm cannedResponseId(String cannedResponseId)

The id of the canned response which was used to create the form.

getCannedResponseId

public String getCannedResponseId()

setCannedResponseId

public void setCannedResponseId(String cannedResponseId)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object