Package com.mypurecloud.sdk.v2.model

Class RecordingForm

java.lang.Object

com.mypurecloud.sdk.v2.model.RecordingForm

All Implemented Interfaces:

Serializable

public class RecordingForm
extends Object
implements Serializable

RecordingForm

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RecordingForm()
RecordingForm(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
RecordingForm	cannedResponseId(String cannedResponseId)	The id of the canned response which was used to create the form.
boolean	equals(Object o)
RecordingForm	formPages(List<RecordingFormPage> formPages)	Form pages.
String	getCannedResponseId()
List<RecordingFormPage>	getFormPages()
RecordingIntroduction	getIntroduction()
String	getOriginatingMessageId()
ReceivedReplyMessage	getReceivedMessage()
ReceivedReplyMessage	getReplyMessage()
List<RecordingFormResponseComponent>	getResponse()
int	hashCode()
RecordingForm	introduction(RecordingIntroduction introduction)	The introduction component, used to give an intro into what the form entails.
RecordingForm	originatingMessageId(String originatingMessageId)	Reference to the id of the original message.
RecordingForm	receivedMessage(ReceivedReplyMessage receivedMessage)	Defines the initial prompt message structure containing title and subtitle fields that are displayed to the end user when a form requires completion.
RecordingForm	replyMessage(ReceivedReplyMessage replyMessage)	The reply message after the user has filled out the form received.
RecordingForm	response(List<RecordingFormResponseComponent> response)	Content of the payload included in the Form response.
void	setCannedResponseId(String cannedResponseId)
void	setFormPages(List<RecordingFormPage> formPages)
void	setIntroduction(RecordingIntroduction introduction)
void	setOriginatingMessageId(String originatingMessageId)
void	setReceivedMessage(ReceivedReplyMessage receivedMessage)
void	setReplyMessage(ReceivedReplyMessage replyMessage)
void	setResponse(List<RecordingFormResponseComponent> response)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RecordingForm

public RecordingForm()

RecordingForm

public RecordingForm(Boolean initWithEmptyList)

Method Details

introduction

public RecordingForm introduction(RecordingIntroduction introduction)

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

getIntroduction

public RecordingIntroduction getIntroduction()

setIntroduction

public void setIntroduction(RecordingIntroduction introduction)

formPages

public RecordingForm formPages(List<RecordingFormPage> formPages)

Form pages.

getFormPages

public List<RecordingFormPage> getFormPages()

setFormPages

public void setFormPages(List<RecordingFormPage> formPages)

receivedMessage

public RecordingForm receivedMessage(ReceivedReplyMessage receivedMessage)

Defines the initial prompt message structure containing title and subtitle fields that are displayed to the end user when a form requires completion.

getReceivedMessage

public ReceivedReplyMessage getReceivedMessage()

setReceivedMessage

public void setReceivedMessage(ReceivedReplyMessage receivedMessage)

replyMessage

public RecordingForm replyMessage(ReceivedReplyMessage replyMessage)

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

getReplyMessage

public ReceivedReplyMessage getReplyMessage()

setReplyMessage

public void setReplyMessage(ReceivedReplyMessage replyMessage)

response

public RecordingForm response(List<RecordingFormResponseComponent> response)

Content of the payload included in the Form response.

getResponse

public List<RecordingFormResponseComponent> getResponse()

setResponse

public void setResponse(List<RecordingFormResponseComponent> response)

originatingMessageId

public RecordingForm originatingMessageId(String originatingMessageId)

Reference to the id of the original message.

getOriginatingMessageId

public String getOriginatingMessageId()

setOriginatingMessageId

public void setOriginatingMessageId(String originatingMessageId)

cannedResponseId

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