Package com.mypurecloud.sdk.v2.model

Class TextBotFlowTurnResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.TextBotFlowTurnResponse

All Implemented Interfaces:

Serializable

public class TextBotFlowTurnResponse
extends Object
implements Serializable

Information related to a success bot flow turn request.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextBotFlowTurnResponse.NextActionTypeEnum	Indicates the suggested next action.

Constructor Summary

Constructors

Constructor	Description
TextBotFlowTurnResponse()
TextBotFlowTurnResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getId()
TextBotDisconnectAction	getNextActionDisconnect()
TextBotExitAction	getNextActionExit()
TextBotFlowTurnResponse.NextActionTypeEnum	getNextActionType()
TextBotWaitForInputAction	getNextActionWaitForInput()
TextBotTurnReference	getPreviousTurn()
TextBotOutputPrompts	getPrompts()
int	hashCode()
TextBotFlowTurnResponse	id(String id)	The ID of the bot flow turn.
TextBotFlowTurnResponse	nextActionDisconnect(TextBotDisconnectAction nextActionDisconnect)	The next action directive for this turn if it is a Disconnect type.
TextBotFlowTurnResponse	nextActionExit(TextBotExitAction nextActionExit)	The next action directive for this turn if it is an Exit type.
TextBotFlowTurnResponse	nextActionType(TextBotFlowTurnResponse.NextActionTypeEnum nextActionType)	Indicates the suggested next action.
TextBotFlowTurnResponse	nextActionWaitForInput(TextBotWaitForInputAction nextActionWaitForInput)	The next action directive for this turn if it is a WaitForInput type.
TextBotFlowTurnResponse	previousTurn(TextBotTurnReference previousTurn)	The reference to a previous turn, if applicable.
TextBotFlowTurnResponse	prompts(TextBotOutputPrompts prompts)	The output prompts for this turn.
void	setId(String id)
void	setNextActionDisconnect(TextBotDisconnectAction nextActionDisconnect)
void	setNextActionExit(TextBotExitAction nextActionExit)
void	setNextActionType(TextBotFlowTurnResponse.NextActionTypeEnum nextActionType)
void	setNextActionWaitForInput(TextBotWaitForInputAction nextActionWaitForInput)
void	setPreviousTurn(TextBotTurnReference previousTurn)
void	setPrompts(TextBotOutputPrompts prompts)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TextBotFlowTurnResponse

public TextBotFlowTurnResponse()

TextBotFlowTurnResponse

public TextBotFlowTurnResponse(Boolean initWithEmptyList)

Method Details

id

public TextBotFlowTurnResponse id(String id)

The ID of the bot flow turn. If additional turns are needed, supply this ID as the previous turn in your next turn request.

getId

public String getId()

setId

public void setId(String id)

previousTurn

public TextBotFlowTurnResponse previousTurn(TextBotTurnReference previousTurn)

The reference to a previous turn, if applicable.

getPreviousTurn

public TextBotTurnReference getPreviousTurn()

setPreviousTurn

public void setPreviousTurn(TextBotTurnReference previousTurn)

prompts

public TextBotFlowTurnResponse prompts(TextBotOutputPrompts prompts)

The output prompts for this turn.

getPrompts

public TextBotOutputPrompts getPrompts()

setPrompts

public void setPrompts(TextBotOutputPrompts prompts)

nextActionType

public TextBotFlowTurnResponse nextActionType(TextBotFlowTurnResponse.NextActionTypeEnum nextActionType)

Indicates the suggested next action. If appropriate, the matching output event object includes additional information.

getNextActionType

public TextBotFlowTurnResponse.NextActionTypeEnum getNextActionType()

setNextActionType

public void setNextActionType(TextBotFlowTurnResponse.NextActionTypeEnum nextActionType)

nextActionDisconnect

public TextBotFlowTurnResponse nextActionDisconnect(TextBotDisconnectAction nextActionDisconnect)

The next action directive for this turn if it is a Disconnect type.

getNextActionDisconnect

public TextBotDisconnectAction getNextActionDisconnect()

setNextActionDisconnect

public void setNextActionDisconnect(TextBotDisconnectAction nextActionDisconnect)

nextActionWaitForInput

public TextBotFlowTurnResponse nextActionWaitForInput(TextBotWaitForInputAction nextActionWaitForInput)

The next action directive for this turn if it is a WaitForInput type.

getNextActionWaitForInput

public TextBotWaitForInputAction getNextActionWaitForInput()

setNextActionWaitForInput

public void setNextActionWaitForInput(TextBotWaitForInputAction nextActionWaitForInput)

nextActionExit

public TextBotFlowTurnResponse nextActionExit(TextBotExitAction nextActionExit)

The next action directive for this turn if it is an Exit type.

getNextActionExit

public TextBotExitAction getNextActionExit()

setNextActionExit

public void setNextActionExit(TextBotExitAction nextActionExit)

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