Package com.mypurecloud.sdk.v2.model

Class ScreenMonitoring

java.lang.Object

com.mypurecloud.sdk.v2.model.ScreenMonitoring

All Implemented Interfaces:

Serializable

public class ScreenMonitoring
extends Object
implements Serializable

ScreenMonitoring

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScreenMonitoring.DisconnectTypeEnum	System defined string indicating what caused the communication to disconnect.
static enum	ScreenMonitoring.InitialStateEnum	The initial connection state of this communication.
static enum	ScreenMonitoring.MonitoringTypeEnum	The screen monitoring type.
static enum	ScreenMonitoring.StateEnum	The connection state of this communication.

Constructor Summary

Constructors

Constructor	Description
ScreenMonitoring()
ScreenMonitoring(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ScreenMonitoring	connectedTime(Date connectedTime)	The timestamp when this communication was connected in the cloud clock.
ScreenMonitoring	count(Long count)	Number of Screen Monitoring sessions the targetUserId is involved in.
ScreenMonitoring	disconnectedTime(Date disconnectedTime)	The timestamp when this communication disconnected from the conversation in the provider clock.
ScreenMonitoring	disconnectType(ScreenMonitoring.DisconnectTypeEnum disconnectType)	System defined string indicating what caused the communication to disconnect.
boolean	equals(Object o)
Date	getConnectedTime()
Long	getCount()
Date	getDisconnectedTime()
ScreenMonitoring.DisconnectTypeEnum	getDisconnectType()
String	getId()
ScreenMonitoring.InitialStateEnum	getInitialState()
ScreenMonitoring.MonitoringTypeEnum	getMonitoringType()
String	getProvider()
AddressableEntityRef	getScreenMonitoring()
List<Segment>	getSegments()
ScreenMonitoring.StateEnum	getState()
AddressableEntityRef	getTargetUser()
int	hashCode()
ScreenMonitoring	id(String id)	A globally unique identifier for this communication.
ScreenMonitoring	initialState(ScreenMonitoring.InitialStateEnum initialState)	The initial connection state of this communication.
ScreenMonitoring	monitoringType(ScreenMonitoring.MonitoringTypeEnum monitoringType)	The screen monitoring type.
ScreenMonitoring	provider(String provider)	The source provider of Screen Monitoring media.
ScreenMonitoring	screenMonitoring(AddressableEntityRef screenMonitoring)	Screen Monitoring identifier unique to the sourceUserId-targetUserId pair.
ScreenMonitoring	segments(List<Segment> segments)	The time line of the participant's Screen Monitoring media, divided into activity segments.
void	setConnectedTime(Date connectedTime)
void	setCount(Long count)
void	setDisconnectedTime(Date disconnectedTime)
void	setDisconnectType(ScreenMonitoring.DisconnectTypeEnum disconnectType)
void	setId(String id)
void	setInitialState(ScreenMonitoring.InitialStateEnum initialState)
void	setMonitoringType(ScreenMonitoring.MonitoringTypeEnum monitoringType)
void	setProvider(String provider)
void	setScreenMonitoring(AddressableEntityRef screenMonitoring)
void	setSegments(List<Segment> segments)
void	setState(ScreenMonitoring.StateEnum state)
void	setTargetUser(AddressableEntityRef targetUser)
ScreenMonitoring	state(ScreenMonitoring.StateEnum state)	The connection state of this communication.
ScreenMonitoring	targetUser(AddressableEntityRef targetUser)	The user participant who is being screen monitored.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScreenMonitoring

public ScreenMonitoring()

ScreenMonitoring

public ScreenMonitoring(Boolean initWithEmptyList)

Method Details

id

public ScreenMonitoring id(String id)

A globally unique identifier for this communication.

getId

public String getId()

setId

public void setId(String id)

initialState

public ScreenMonitoring initialState(ScreenMonitoring.InitialStateEnum initialState)

The initial connection state of this communication.

getInitialState

public ScreenMonitoring.InitialStateEnum getInitialState()

setInitialState

public void setInitialState(ScreenMonitoring.InitialStateEnum initialState)

state

public ScreenMonitoring state(ScreenMonitoring.StateEnum state)

The connection state of this communication.

getState

public ScreenMonitoring.StateEnum getState()

setState

public void setState(ScreenMonitoring.StateEnum state)

segments

public ScreenMonitoring segments(List<Segment> segments)

The time line of the participant's Screen Monitoring media, divided into activity segments.

getSegments

public List<Segment> getSegments()

setSegments

public void setSegments(List<Segment> segments)

disconnectType

public ScreenMonitoring disconnectType(ScreenMonitoring.DisconnectTypeEnum disconnectType)

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

getDisconnectType

public ScreenMonitoring.DisconnectTypeEnum getDisconnectType()

setDisconnectType

public void setDisconnectType(ScreenMonitoring.DisconnectTypeEnum disconnectType)

provider

public ScreenMonitoring provider(String provider)

The source provider of Screen Monitoring media.

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

targetUser

public ScreenMonitoring targetUser(AddressableEntityRef targetUser)

The user participant who is being screen monitored.

getTargetUser

public AddressableEntityRef getTargetUser()

setTargetUser

public void setTargetUser(AddressableEntityRef targetUser)

screenMonitoring

public ScreenMonitoring screenMonitoring(AddressableEntityRef screenMonitoring)

Screen Monitoring identifier unique to the sourceUserId-targetUserId pair.

getScreenMonitoring

public AddressableEntityRef getScreenMonitoring()

setScreenMonitoring

public void setScreenMonitoring(AddressableEntityRef screenMonitoring)

monitoringType

public ScreenMonitoring monitoringType(ScreenMonitoring.MonitoringTypeEnum monitoringType)

The screen monitoring type.

getMonitoringType

public ScreenMonitoring.MonitoringTypeEnum getMonitoringType()

setMonitoringType

public void setMonitoringType(ScreenMonitoring.MonitoringTypeEnum monitoringType)

count

public ScreenMonitoring count(Long count)

Number of Screen Monitoring sessions the targetUserId is involved in.

getCount

public Long getCount()

setCount

public void setCount(Long count)

connectedTime

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

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