Package com.mypurecloud.sdk.v2.model

Class Response

java.lang.Object

com.mypurecloud.sdk.v2.model.Response

All Implemented Interfaces:

Serializable

public class Response
extends Object
implements Serializable

Contains information about a response.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Response.InteractionTypeEnum	The interaction type for this response.
static enum	Response.ResponseTypeEnum	The response type represented by the response.

Constructor Summary

Constructors

Constructor	Description
Response()
Response(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
Response	assets(List<RmsAssetAddressableRef> assets)	Assets used in the response
boolean	equals(Object o)
Response	footer(FooterTemplate footer)	Footer template definition for responseType.Footer.
List<RmsAssetAddressableRef>	getAssets()
User	getCreatedBy()
Date	getDateCreated()
FooterTemplate	getFooter()
String	getId()
Response.InteractionTypeEnum	getInteractionType()
List<DomainEntityRef>	getLibraries()
MessagingTemplate	getMessagingTemplate()
String	getName()
Response.ResponseTypeEnum	getResponseType()
String	getSelfUri()
List<ResponseSubstitution>	getSubstitutions()
JsonSchemaDocument	getSubstitutionsSchema()
List<ResponseText>	getTexts()
Integer	getVersion()
int	hashCode()
Response	interactionType(Response.InteractionTypeEnum interactionType)	The interaction type for this response.
Response	libraries(List<DomainEntityRef> libraries)	One or more libraries response is associated with.
Response	messagingTemplate(MessagingTemplate messagingTemplate)	An optional messaging template definition for responseType.MessagingTemplate.
Response	name(String name)
Response	responseType(Response.ResponseTypeEnum responseType)	The response type represented by the response.
void	setAssets(List<RmsAssetAddressableRef> assets)
void	setFooter(FooterTemplate footer)
void	setInteractionType(Response.InteractionTypeEnum interactionType)
void	setLibraries(List<DomainEntityRef> libraries)
void	setMessagingTemplate(MessagingTemplate messagingTemplate)
void	setName(String name)
void	setResponseType(Response.ResponseTypeEnum responseType)
void	setSubstitutions(List<ResponseSubstitution> substitutions)
void	setSubstitutionsSchema(JsonSchemaDocument substitutionsSchema)
void	setTexts(List<ResponseText> texts)
void	setVersion(Integer version)
Response	substitutions(List<ResponseSubstitution> substitutions)	Details about any text substitutions used in the texts for this response.
Response	substitutionsSchema(JsonSchemaDocument substitutionsSchema)	Metadata about the text substitutions in json schema format.
Response	texts(List<ResponseText> texts)	One or more texts associated with the response.
String	toString()
Response	version(Integer version)	Version number required for updates.

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response()

Response

public Response(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public Response name(String name)

getName

public String getName()

setName

public void setName(String name)

version

public Response version(Integer version)

Version number required for updates.

getVersion

public Integer getVersion()

setVersion

public void setVersion(Integer version)

libraries

public Response libraries(List<DomainEntityRef> libraries)

One or more libraries response is associated with.

getLibraries

public List<DomainEntityRef> getLibraries()

setLibraries

public void setLibraries(List<DomainEntityRef> libraries)

texts

public Response texts(List<ResponseText> texts)

One or more texts associated with the response.

getTexts

public List<ResponseText> getTexts()

setTexts

public void setTexts(List<ResponseText> texts)

getCreatedBy

public User getCreatedBy()

getDateCreated

public Date getDateCreated()

interactionType

public Response interactionType(Response.InteractionTypeEnum interactionType)

The interaction type for this response.

getInteractionType

public Response.InteractionTypeEnum getInteractionType()

setInteractionType

public void setInteractionType(Response.InteractionTypeEnum interactionType)

substitutions

public Response substitutions(List<ResponseSubstitution> substitutions)

Details about any text substitutions used in the texts for this response.

getSubstitutions

public List<ResponseSubstitution> getSubstitutions()

setSubstitutions

public void setSubstitutions(List<ResponseSubstitution> substitutions)

substitutionsSchema

public Response substitutionsSchema(JsonSchemaDocument substitutionsSchema)

Metadata about the text substitutions in json schema format.

getSubstitutionsSchema

public JsonSchemaDocument getSubstitutionsSchema()

setSubstitutionsSchema

public void setSubstitutionsSchema(JsonSchemaDocument substitutionsSchema)

responseType

public Response responseType(Response.ResponseTypeEnum responseType)

The response type represented by the response.

getResponseType

public Response.ResponseTypeEnum getResponseType()

setResponseType

public void setResponseType(Response.ResponseTypeEnum responseType)

messagingTemplate

public Response messagingTemplate(MessagingTemplate messagingTemplate)

An optional messaging template definition for responseType.MessagingTemplate.

getMessagingTemplate

public MessagingTemplate getMessagingTemplate()

setMessagingTemplate

public void setMessagingTemplate(MessagingTemplate messagingTemplate)

assets

public Response assets(List<RmsAssetAddressableRef> assets)

Assets used in the response

getAssets

public List<RmsAssetAddressableRef> getAssets()

setAssets

public void setAssets(List<RmsAssetAddressableRef> assets)

footer

public Response footer(FooterTemplate footer)

Footer template definition for responseType.Footer.

getFooter

public FooterTemplate getFooter()

setFooter

public void setFooter(FooterTemplate footer)

getSelfUri

public String getSelfUri()

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