Package com.mypurecloud.sdk.v2.model

Class BotFlowSession

java.lang.Object
com.mypurecloud.sdk.v2.model.BotFlowSession
All Implemented Interfaces:
Serializable
public class BotFlowSession extends Object implements Serializable
BotFlowSession
See Also:

  • Constructor Details

    • BotFlowSession

      public BotFlowSession()

    • BotFlowSession

      public BotFlowSession(Boolean initWithEmptyList)

  • Method Details

    • id

      public BotFlowSession id(String id)
      The ID of the bot session.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • flow

      public BotFlowSession flow(Entity flow)
      The flow associated to this bot session.

    • getFlow

      public Entity getFlow()

    • setFlow

      public void setFlow(Entity flow)

    • conversation

      public BotFlowSession conversation(AddressableEntityRef conversation)
      The conversation details, across potentially multiple Bot Flow sessions.

    • getConversation

      public AddressableEntityRef getConversation()

    • setConversation

      public void setConversation(AddressableEntityRef conversation)

    • channel

      public BotFlowSession channel(BotChannel channel)
      Channel-specific information that describes the message channel/provider.

    • getChannel

      public BotChannel getChannel()

    • setChannel

      public void setChannel(BotChannel channel)

    • language

      public BotFlowSession language(String language)
      The initial language of operation for the session.

    • getLanguage

      public String getLanguage()

    • setLanguage

      public void setLanguage(String language)

    • endLanguage

      public BotFlowSession endLanguage(String endLanguage)
      The language of the session at the time the session ended

    • getEndLanguage

      public String getEndLanguage()

    • setEndLanguage

      public void setEndLanguage(String endLanguage)

    • botResult

      public BotFlowSession botResult(BotFlowSession.BotResultEnum botResult)
      The reason for session termination.

    • getBotResult

      public BotFlowSession.BotResultEnum getBotResult()

    • setBotResult

      public void setBotResult(BotFlowSession.BotResultEnum botResult)

    • botResultCategory

      public BotFlowSession botResultCategory(BotFlowSession.BotResultCategoryEnum botResultCategory)
      The category of result for the session.

    • getBotResultCategory

      public BotFlowSession.BotResultCategoryEnum getBotResultCategory()

    • setBotResultCategory

      public void setBotResultCategory(BotFlowSession.BotResultCategoryEnum botResultCategory)

    • dateCreated

      public BotFlowSession dateCreated(Date dateCreated)
      Timestamp indicating when the session 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 BotFlowSession dateCompleted(Date dateCompleted)
      Timestamp indicating when the session 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)

    • 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