Package com.mypurecloud.sdk.v2.model

Class TextBotFlowLaunchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.TextBotFlowLaunchRequest

All Implemented Interfaces:

Serializable

public class TextBotFlowLaunchRequest
extends Object
implements Serializable

Settings for launching an instance of a bot flow.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TextBotFlowLaunchRequest()
TextBotFlowLaunchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
TextBotFlowLaunchRequest	channel(TextBotChannel channel)	Channel information relevant to the bot flow.
TextBotFlowLaunchRequest	conversationId(String conversationId)	A conversation ID to associate with the bot flow, if available.
boolean	equals(Object o)
TextBotFlowLaunchRequest	externalSessionId(String externalSessionId)	The ID of the external session that is associated with the bot flow.
TextBotFlowLaunchRequest	flow(TextBotFlow flow)	Specifies which Bot Flow to launch.
TextBotChannel	getChannel()
String	getConversationId()
String	getExternalSessionId()
TextBotFlow	getFlow()
TextBotInputOutputData	getInputData()
String	getLanguage()
int	hashCode()
TextBotFlowLaunchRequest	inputData(TextBotInputOutputData inputData)	Input values to the flow.
TextBotFlowLaunchRequest	language(String language)	The language that the bot will use in the session.
void	setChannel(TextBotChannel channel)
void	setConversationId(String conversationId)
void	setExternalSessionId(String externalSessionId)
void	setFlow(TextBotFlow flow)
void	setInputData(TextBotInputOutputData inputData)
void	setLanguage(String language)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TextBotFlowLaunchRequest

public TextBotFlowLaunchRequest()

TextBotFlowLaunchRequest

public TextBotFlowLaunchRequest(Boolean initWithEmptyList)

Method Details

flow

public TextBotFlowLaunchRequest flow(TextBotFlow flow)

Specifies which Bot Flow to launch.

getFlow

public TextBotFlow getFlow()

setFlow

public void setFlow(TextBotFlow flow)

externalSessionId

public TextBotFlowLaunchRequest externalSessionId(String externalSessionId)

The ID of the external session that is associated with the bot flow.

getExternalSessionId

public String getExternalSessionId()

setExternalSessionId

public void setExternalSessionId(String externalSessionId)

conversationId

public TextBotFlowLaunchRequest conversationId(String conversationId)

A conversation ID to associate with the bot flow, if available.

getConversationId

public String getConversationId()

setConversationId

public void setConversationId(String conversationId)

inputData

public TextBotFlowLaunchRequest inputData(TextBotInputOutputData inputData)

Input values to the flow. Valid values are defined by the flow's input JSON schema.

getInputData

public TextBotInputOutputData getInputData()

setInputData

public void setInputData(TextBotInputOutputData inputData)

channel

public TextBotFlowLaunchRequest channel(TextBotChannel channel)

Channel information relevant to the bot flow.

getChannel

public TextBotChannel getChannel()

setChannel

public void setChannel(TextBotChannel channel)

language

public TextBotFlowLaunchRequest language(String language)

The language that the bot will use in the session. Validated against list of supported languages and if the value is omitted or is invalid, the default language will be used.

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

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