Package com.mypurecloud.sdk.v2.model

Class Cobrowsesession

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

  • Constructor Details

    • Cobrowsesession

      public Cobrowsesession()

    • Cobrowsesession

      public Cobrowsesession(Boolean initWithEmptyList)

  • Method Details

    • state

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

    • getState

      public Cobrowsesession.StateEnum getState()

    • setState

      public void setState(Cobrowsesession.StateEnum state)

    • initialState

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

    • getInitialState

      public Cobrowsesession.InitialStateEnum getInitialState()

    • setInitialState

      public void setInitialState(Cobrowsesession.InitialStateEnum initialState)

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • disconnectType

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

    • getDisconnectType

      public Cobrowsesession.DisconnectTypeEnum getDisconnectType()

    • setDisconnectType

      public void setDisconnectType(Cobrowsesession.DisconnectTypeEnum disconnectType)

    • self

      public Cobrowsesession self(Address self)
      Address and name data for a call endpoint.

    • getSelf

      public Address getSelf()

    • setSelf

      public void setSelf(Address self)

    • cobrowseSessionId

      public Cobrowsesession cobrowseSessionId(String cobrowseSessionId)
      The co-browse session ID.

    • getCobrowseSessionId

      public String getCobrowseSessionId()

    • setCobrowseSessionId

      public void setCobrowseSessionId(String cobrowseSessionId)

    • cobrowseRole

      public Cobrowsesession cobrowseRole(String cobrowseRole)
      This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).

    • getCobrowseRole

      public String getCobrowseRole()

    • setCobrowseRole

      public void setCobrowseRole(String cobrowseRole)

    • controlling

      public Cobrowsesession controlling(List<String> controlling)
      ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).

    • getControlling

      public List<String> getControlling()

    • setControlling

      public void setControlling(List<String> controlling)

    • viewerUrl

      public Cobrowsesession viewerUrl(String viewerUrl)
      The URL that can be used to open co-browse session in web browser.

    • getViewerUrl

      public String getViewerUrl()

    • setViewerUrl

      public void setViewerUrl(String viewerUrl)

    • providerEventTime

      public Cobrowsesession providerEventTime(Date providerEventTime)
      The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getProviderEventTime

      public Date getProviderEventTime()

    • setProviderEventTime

      public void setProviderEventTime(Date providerEventTime)

    • startAlertingTime

      public Cobrowsesession 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 Cobrowsesession 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 Cobrowsesession 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 Cobrowsesession provider(String provider)
      The source provider for the co-browse session.

    • getProvider

      public String getProvider()

    • setProvider

      public void setProvider(String provider)

    • peerId

      public Cobrowsesession 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)

    • segments

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

    • getSegments

      public List<Segment> getSegments()

    • setSegments

      public void setSegments(List<Segment> segments)

    • wrapup

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

    • getWrapup

      public Wrapup getWrapup()

    • setWrapup

      public void setWrapup(Wrapup wrapup)

    • afterCallWork

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

    • getAfterCallWork

      public AfterCallWork getAfterCallWork()

    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)

    • afterCallWorkRequired

      public Cobrowsesession 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)

    • 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