Package com.mypurecloud.sdk.v2.model

Class ReportingTurn

java.lang.Object

com.mypurecloud.sdk.v2.model.ReportingTurn

All Implemented Interfaces:

Serializable

public class ReportingTurn
extends Object
implements Serializable

ReportingTurn

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReportingTurn.AskActionResultEnum	Result of the bot flow 'ask' action.

Constructor Summary

Constructors

Constructor	Description
ReportingTurn()
ReportingTurn(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ReportingTurn	askAction(ReportingTurnAction askAction)	The bot flow 'ask' action associated with this reporting turn (e.g.
ReportingTurn	askActionResult(ReportingTurn.AskActionResultEnum askActionResult)	Result of the bot flow 'ask' action.
ReportingTurn	botPrompts(List<String> botPrompts)	The bot prompts associated with this reporting turn.
ReportingTurn	conversation(AddressableEntityRef conversation)	The conversation details, across potentially multiple Bot Flow sessions.
ReportingTurn	dateCompleted(Date dateCompleted)	Timestamp indicating when the original turn was completed.
ReportingTurn	dateCreated(Date dateCreated)	Timestamp indicating when the original turn was created.
boolean	equals(Object o)
ReportingTurnAction	getAskAction()
ReportingTurn.AskActionResultEnum	getAskActionResult()
List<String>	getBotPrompts()
AddressableEntityRef	getConversation()
Date	getDateCompleted()
Date	getDateCreated()
ReportingTurnIntent	getIntent()
ReportingTurnKnowledge	getKnowledge()
ReportingTurnKnowledgeEvents	getKnowledgeBaseEvents()
SessionEndDetails	getSessionEndDetails()
String	getSessionId()
String	getUserInput()
int	hashCode()
ReportingTurn	intent(ReportingTurnIntent intent)	The intent and associated slots detected during this reporting turn.
ReportingTurn	knowledge(ReportingTurnKnowledge knowledge)	The knowledge data captured during this reporting turn.
ReportingTurn	knowledgeBaseEvents(ReportingTurnKnowledgeEvents knowledgeBaseEvents)	The knowledge data captured during this reporting turn.
ReportingTurn	sessionEndDetails(SessionEndDetails sessionEndDetails)	The details related to end of bot flow session.
ReportingTurn	sessionId(String sessionId)	The bot session ID that this reporting turn is grouped under.
void	setAskAction(ReportingTurnAction askAction)
void	setAskActionResult(ReportingTurn.AskActionResultEnum askActionResult)
void	setBotPrompts(List<String> botPrompts)
void	setConversation(AddressableEntityRef conversation)
void	setDateCompleted(Date dateCompleted)
void	setDateCreated(Date dateCreated)
void	setIntent(ReportingTurnIntent intent)
void	setKnowledge(ReportingTurnKnowledge knowledge)
void	setKnowledgeBaseEvents(ReportingTurnKnowledgeEvents knowledgeBaseEvents)
void	setSessionEndDetails(SessionEndDetails sessionEndDetails)
void	setSessionId(String sessionId)
void	setUserInput(String userInput)
String	toString()
ReportingTurn	userInput(String userInput)	The chosen user input associated with this reporting turn.

Methods inherited from class java.lang.Object

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

Constructor Details

ReportingTurn

public ReportingTurn()

ReportingTurn

public ReportingTurn(Boolean initWithEmptyList)

Method Details

userInput

public ReportingTurn userInput(String userInput)

The chosen user input associated with this reporting turn.

getUserInput

public String getUserInput()

setUserInput

public void setUserInput(String userInput)

botPrompts

public ReportingTurn botPrompts(List<String> botPrompts)

The bot prompts associated with this reporting turn.

getBotPrompts

public List<String> getBotPrompts()

setBotPrompts

public void setBotPrompts(List<String> botPrompts)

sessionId

public ReportingTurn sessionId(String sessionId)

The bot session ID that this reporting turn is grouped under.

getSessionId

public String getSessionId()

setSessionId

public void setSessionId(String sessionId)

conversation

public ReportingTurn conversation(AddressableEntityRef conversation)

The conversation details, across potentially multiple Bot Flow sessions.

getConversation

public AddressableEntityRef getConversation()

setConversation

public void setConversation(AddressableEntityRef conversation)

askAction

public ReportingTurn askAction(ReportingTurnAction askAction)

The bot flow 'ask' action associated with this reporting turn (e.g. AskForIntent).

getAskAction

public ReportingTurnAction getAskAction()

setAskAction

public void setAskAction(ReportingTurnAction askAction)

intent

public ReportingTurn intent(ReportingTurnIntent intent)

The intent and associated slots detected during this reporting turn.

getIntent

public ReportingTurnIntent getIntent()

setIntent

public void setIntent(ReportingTurnIntent intent)

knowledge

public ReportingTurn knowledge(ReportingTurnKnowledge knowledge)

The knowledge data captured during this reporting turn.

getKnowledge

public ReportingTurnKnowledge getKnowledge()

setKnowledge

public void setKnowledge(ReportingTurnKnowledge knowledge)

knowledgeBaseEvents

public ReportingTurn knowledgeBaseEvents(ReportingTurnKnowledgeEvents knowledgeBaseEvents)

The knowledge data captured during this reporting turn.

getKnowledgeBaseEvents

public ReportingTurnKnowledgeEvents getKnowledgeBaseEvents()

setKnowledgeBaseEvents

public void setKnowledgeBaseEvents(ReportingTurnKnowledgeEvents knowledgeBaseEvents)

dateCreated

public ReportingTurn dateCreated(Date dateCreated)

Timestamp indicating when the original turn was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

dateCompleted

public ReportingTurn dateCompleted(Date dateCompleted)

Timestamp indicating when the original turn was completed. Note: The 'interval' query param uses this timestamp to filter the output. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateCompleted

public Date getDateCompleted()

setDateCompleted

public void setDateCompleted(Date dateCompleted)

askActionResult

public ReportingTurn askActionResult(ReportingTurn.AskActionResultEnum askActionResult)

Result of the bot flow 'ask' action.

getAskActionResult

public ReportingTurn.AskActionResultEnum getAskActionResult()

setAskActionResult

public void setAskActionResult(ReportingTurn.AskActionResultEnum askActionResult)

sessionEndDetails

public ReportingTurn sessionEndDetails(SessionEndDetails sessionEndDetails)

The details related to end of bot flow session.

getSessionEndDetails

public SessionEndDetails getSessionEndDetails()

setSessionEndDetails

public void setSessionEndDetails(SessionEndDetails sessionEndDetails)

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