Package com.mypurecloud.sdk.v2.model

Class ConversationChat

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

  • Constructor Details

    • ConversationChat

      public ConversationChat()

    • ConversationChat

      public ConversationChat(Boolean initWithEmptyList)

  • Method Details

    • state

      public ConversationChat state(ConversationChat.StateEnum state)
      The connection state of this communication.

    • getState

      public ConversationChat.StateEnum getState()

    • setState

      public void setState(ConversationChat.StateEnum state)

    • initialState

      public ConversationChat initialState(ConversationChat.InitialStateEnum initialState)
      The initial connection state of this communication.

    • getInitialState

      public ConversationChat.InitialStateEnum getInitialState()

    • setInitialState

      public void setInitialState(ConversationChat.InitialStateEnum initialState)

    • id

      public ConversationChat id(String id)
      A globally unique identifier for this communication.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • roomId

      public ConversationChat roomId(String roomId)
      The room id for the chat.

    • getRoomId

      public String getRoomId()

    • setRoomId

      public void setRoomId(String roomId)

    • recordingId

      public ConversationChat recordingId(String recordingId)
      A globally unique identifier for the recording associated with this chat.

    • getRecordingId

      public String getRecordingId()

    • setRecordingId

      public void setRecordingId(String recordingId)

    • segments

      public ConversationChat segments(List<Segment> segments)
      The time line of the participant's chat, divided into activity segments.

    • getSegments

      public List<Segment> getSegments()

    • setSegments

      public void setSegments(List<Segment> segments)

    • held

      public ConversationChat held(Boolean held)
      True if this call is held and the person on this side hears silence.

    • getHeld

      public Boolean getHeld()

    • setHeld

      public void setHeld(Boolean held)

    • direction

      public ConversationChat direction(ConversationChat.DirectionEnum direction)
      The direction of the chat

    • getDirection

      public ConversationChat.DirectionEnum getDirection()

    • setDirection

      public void setDirection(ConversationChat.DirectionEnum direction)

    • disconnectType

      public ConversationChat disconnectType(ConversationChat.DisconnectTypeEnum disconnectType)
      System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

    • getDisconnectType

      public ConversationChat.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(ConversationChat.DisconnectTypeEnum disconnectType)

    • startHoldTime

      public ConversationChat startHoldTime(Date startHoldTime)
      The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getStartHoldTime

      public Date getStartHoldTime()

    • setStartHoldTime

      public void setStartHoldTime(Date startHoldTime)

    • startAlertingTime

      public ConversationChat startAlertingTime(Date startAlertingTime)
      The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getStartAlertingTime

      public Date getStartAlertingTime()

    • setStartAlertingTime

      public void setStartAlertingTime(Date startAlertingTime)

    • connectedTime

      public ConversationChat connectedTime(Date connectedTime)
      The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getConnectedTime

      public Date getConnectedTime()

    • setConnectedTime

      public void setConnectedTime(Date connectedTime)

    • disconnectedTime

      public ConversationChat disconnectedTime(Date disconnectedTime)
      The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDisconnectedTime

      public Date getDisconnectedTime()

    • setDisconnectedTime

      public void setDisconnectedTime(Date disconnectedTime)

    • provider

      public ConversationChat provider(String provider)
      The source provider for the email.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • scriptId

      public ConversationChat scriptId(String scriptId)
      The UUID of the script to use.

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • peerId

      public ConversationChat peerId(String peerId)
      The id of the peer communication corresponding to a matching leg for this communication.

    • getPeerId

      public String getPeerId()

    • setPeerId

      public void setPeerId(String peerId)

    • avatarImageUrl

      public ConversationChat avatarImageUrl(String avatarImageUrl)
      If available, the URI to the avatar image of this communication.

    • getAvatarImageUrl

      public String getAvatarImageUrl()

    • setAvatarImageUrl

      public void setAvatarImageUrl(String avatarImageUrl)

    • journeyContext

      public ConversationChat journeyContext(JourneyContext journeyContext)
      A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).

    • getJourneyContext

      public JourneyContext getJourneyContext()

    • setJourneyContext

      public void setJourneyContext(JourneyContext journeyContext)

    • wrapup

      public ConversationChat wrapup(Wrapup wrapup)
      Call wrap up or disposition data.

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • afterCallWork

      public ConversationChat afterCallWork(AfterCallWork afterCallWork)
      After-call work for the communication.

    • getAfterCallWork

      public AfterCallWork getAfterCallWork()

    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)

    • afterCallWorkRequired

      public ConversationChat afterCallWorkRequired(Boolean afterCallWorkRequired)
      Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.

    • getAfterCallWorkRequired

      public Boolean getAfterCallWorkRequired()

    • setAfterCallWorkRequired

      public void setAfterCallWorkRequired(Boolean afterCallWorkRequired)

    • queueMediaSettings

      public ConversationChat queueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)
      Represents the queue settings for this media type.

    • getQueueMediaSettings

      public ConversationQueueMediaSettings getQueueMediaSettings()

    • setQueueMediaSettings

      public void setQueueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)

    • 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