public interface MonitoredUserI
MonitoredUserI
object represents a user that is being monitored by a supervisor in the Contact Center (from the
supervisors point of view). The MonitoredUserI
object shares a subset of properties with the UserI
object and
only provides properties and methods that are appropriate for a supervisor who is monitoring their assigned users. The
MonitoredUserI
objects methods allow the supervisor to invoke supervisor operations on the users that they are
monitoring.Modifier and Type | Method and Description |
---|---|
boolean |
canForceLogout() |
boolean |
canForceNotReady() |
boolean |
canForceReady() |
void |
forceLogout()
Allows the supervisor to force logout the user from the Contact Center.
|
void |
forceNotReady()
Allows the supervisor to force the user into
UserState.NotReady (if not already in UserState#NotReady ) with
an optional Not Ready Reason code. |
void |
forceReady()
Allows the supervisor to force the user into
UserState.Ready . |
ContactCenterCodeI |
getCode()
This property provides the
ContactCenterCodeI currently associated with the user that this MonitoredUserI
represents. |
java.util.List<ContactType> |
getContactTypes() |
java.lang.String |
getFirstName() |
java.lang.String |
getFullName() |
java.lang.String |
getId()
A unique identifier for the
MonitoredUserI object. |
java.lang.String |
getLastName() |
java.lang.String |
getLoginId() |
java.util.List<MonitoredInteractionI> |
getMonitoredInteractions()
If the supervisor is currently monitoring the interactions of this
MonitoredUserI via
monitorInteractions(com.avaya.ccs.api.MonitoredInteractionListenerI) then this method will return a list of the current MonitoredInteractionI
objects associated with this MonitoredUserI . |
UserState |
getState()
|
java.lang.String |
getSupervisorId() |
UserI |
getSupervisorUser() |
boolean |
hasContactType(ContactType contactType)
Determines if a particular
ContactType is assigned to the user in Contact Center administration |
void |
monitorInteractions(MonitoredInteractionListenerI listener)
This method starts monitoring the interactions of this
MonitoredUserI . |
void |
unmonitorInteractions()
This method stops monitoring interactions at this
MonitoredUserI . |
boolean canForceLogout() throws ObjectInvalidException
true
if the MonitoredUserI
can be logged out of the Contact Center by the supervisor invoking the
forceLogout()
method.ObjectInvalidException
- if the MonitoredUserI
object has been deletedboolean canForceNotReady() throws ObjectInvalidException
true
if the MonitoredUserI
can be forced into UserState.NotReady
by the supervisor invoking
forceNotReady()
.ObjectInvalidException
- if the MonitoredUserI
object has been deletedboolean canForceReady() throws ObjectInvalidException
true
if the MonitoredUserI
can be forced into UserState.Ready
by the supervisor invoking
forceReady()
.ObjectInvalidException
- if the MonitoredUserI
object has been deletedjava.util.List<ContactType> getContactTypes() throws ObjectInvalidException
ContactType
that this MonitoredUserI
is capable of handlingObjectInvalidException
- if the MonitoredUserI
object has been deletedjava.lang.String getFirstName() throws ObjectInvalidException
MonitoredUserI
represents as provisioned in Contact Center
administrationObjectInvalidException
- if the MonitoredUserI
has been deletedjava.lang.String getLastName() throws ObjectInvalidException
MonitoredUserI
represents as provisioned in Contact Center
administrationObjectInvalidException
- if the MonitoredUserI
has been deletedjava.lang.String getFullName() throws ObjectInvalidException
ObjectInvalidException
- if the MonitoredUserI
has been deletedjava.lang.String getLoginId() throws ObjectInvalidException
ObjectInvalidException
- if the MonitoredUserI
has been deletedjava.lang.String getId()
MonitoredUserI
object.
Identifier values are only guaranteed to be unique among objects of the same type. Client applications should not rely on the value of the ID property for anything other than uniquely identifying an instance of a particular object type, as the actual value of the ID property may be changed in future releases. The id property is the only property that can be accessed after the object is deleted.
MonitoredUserI
objectjava.lang.String getSupervisorId() throws ObjectInvalidException
ObjectInvalidException
- if the MonitoredUserI
has been deletedUserI getSupervisorUser() throws ObjectInvalidException
UserI
object of the supervisor that is monitoring this MonitoredUserI
ObjectInvalidException
- if the MonitoredUserI
has been deletedUserState getState()
UserState
of the UserI
object that this MonitoredUserI
object represents.
This property is available for access after the application has received a NotificationType.DELETE
notification for
this MonitoredUserI
object and will return UserState.Invalid
.
ContactCenterCodeI getCode() throws ObjectInvalidException
ContactCenterCodeI
currently associated with the user that this MonitoredUserI
represents.
This will be either a Not Ready Reason or After Call Work code depending upon the current state of the user. These
ContactCenterCodeI
are used to provide fine-grained accounting of how the user's time was spent throughout the day.
ContactCenterCodeI
object or null
if no code is set on this MonitoredUserI
ObjectInvalidException
- if the MonitoredUserI
has been deletedboolean hasContactType(ContactType contactType) throws ObjectInvalidException, InvalidArgumentException
ContactType
is assigned to the user in Contact Center administrationcontactType
- the ContactType
to checktrue
if the ContactType
is found on the MonitoredUserI
, false
if notObjectInvalidException
- if the MonitoredUserI
has been deletedInvalidArgumentException
- if the supplied ContactType
argument is nullvoid forceLogout() throws ObjectInvalidException
Allows the supervisor to force logout the user from the Contact Center. This method is useful for allowing supervisors to logout a user that has left for the day and has forgotten to log out.
Possible errors for this method are listed below. Most errors can be prevented by querying the
canForceLogout()
method to determine when it is possible to invoke this method. If the meaning of the
error code in the context of this method differs significantly from the generic description given for that error code, then
a context-specific meaning is given.
Error Codes | Context Specific Meaning / Notes |
---|---|
ErrorCode.InvalidAgentState |
The user that is represented by the MonitoredUserI is not logged in |
ObjectInvalidException
- if the MonitoredUserI
has been deletedvoid forceNotReady() throws ObjectInvalidException
UserState.NotReady
(if not already in UserState#NotReady
) with
an optional Not Ready Reason code.
The list of valid Not Ready Reason codes can be obtained by invoking SessionI.getNotReadyReasonCodes()
. Possible
errors for this method are listed below. Most errors can be prevented by querying the
canForceNotReady()
method to determine when it is possible to invoke this method and by obtaining the
list of valid Not Ready Reason codes. If the meaning of the error code in the context of this method differs significantly
from the generic description given for that error code, then a context-specific meaning is given.
Error Codes | Context Specific Meaning / Notes |
---|---|
ErrorCode.InvalidAgentState |
The user represented by this MonitoredUserI is not logged in |
ErrorCode.InvalidParameter |
The not ready code parameter specifies an invalid not ready reason code (e.g. contains non-numeric characters). |
ErrorCode.ParameterOutOfRange |
The not ready code parameter specifies a not ready reason code that is too long. |
ObjectInvalidException
- if the MonitoredUserI
has been deletedvoid forceReady() throws ObjectInvalidException
UserState.Ready
.
Possible errors for this method are listed below. Most errors can be prevented by querying the
canForceReady()
method to determine when it is possible to invoke this method. If the meaning of the
error code in the context of this method differs significantly from the generic description given for that error code, then
a context-specific meaning is given.
Error Codes | Context Specific Meaning / Notes |
---|---|
ErrorCode.InvalidAgentState |
The user represented by this MonitoredUserI is not logged in |
ObjectInvalidException
- if the MonitoredUserI
has been deletedjava.util.List<MonitoredInteractionI> getMonitoredInteractions() throws ObjectInvalidException
MonitoredUserI
via
monitorInteractions(com.avaya.ccs.api.MonitoredInteractionListenerI)
then this method will return a list of the current MonitoredInteractionI
objects associated with this MonitoredUserI
.ObjectInvalidException
- if the MonitoredUserI
has been deletedvoid monitorInteractions(MonitoredInteractionListenerI listener) throws ObjectInvalidException, InvalidArgumentException
MonitoredUserI
.
On invocation of the MonitoredUserI#monitorInteractions
method, the application will be sent a
NotificationEventI
for each interaction at the MonitoredUserI
that the supervisor is monitoring as well as
any subsequent interactions at this MonitoredUserI
(while the supervisor is monitoring their interactions). These
NotificationEventI
objects are delivered to the application via the
MonitoredInteractionListenerI.onMonitoredInteractionEvent(com.avaya.ccs.api.NotificationEventI<com.avaya.ccs.api.MonitoredInteractionI>)
listener method. To stop monitoring this users
interactions, unmonitorInteractions()
should be invoked.
listener
- notifies the application of monitored interaction level events for this monitored userObjectInvalidException
- if the MonitoredInteractionI
has been deletedInvalidArgumentException
- if the mandatory MonitoredInteractionListenerI
argument is null
void unmonitorInteractions() throws ObjectInvalidException
MonitoredUserI
.
All MonitoredInteractionI
objects associated with this MonitoredUserI
are deleted and a
NotificationType.DELETE
notification is received for each MonitoredInteractionI
object. No further events
will be received for MonitoredInteractionI
objects for this MonitoredUserI
. The
getMonitoredInteractions()
list will also be cleared.
ObjectInvalidException
- if the MonitoredInteractionI
has been deleted