public interface SessionI
SessionI
interface represents an active authenticated session with the server.
Once a signin is successful, the client application will receive an instance of the new SessionI
through the
SessionListenerI
that is passed to the ClientI.signin(java.lang.String, java.lang.String, com.avaya.ccs.api.SessionListenerI, com.avaya.ccs.api.ClientListenerI)
method. Once the application has obtained the new
SessionI
instance, the application can then proceed to request access to the objects it is interested in by invoking;
openUsers(com.avaya.ccs.api.UserListenerI)
for UserI
objectsopenResources(com.avaya.ccs.api.ResourceListenerI)
for ResourceI
objectsopenInteractions(com.avaya.ccs.api.InteractionListenerI)
for InteractionI
objects
In general, call control or agent control applications should always open the relevant paths to these objects on receipt of a
new SessionI
instance. For High Availability switchovers, a new SessionI
instance will be created and sent to
the application once the Standby Contact Center server takes over the Active role. It is also up to the application to open the
relevant paths to the objects it is interested in on receipt of a new SessionI
object at switchover time.
Modifier and Type | Method and Description |
---|---|
InteractionI |
findInteraction(java.lang.String id) |
ResourceI |
findResource(java.lang.String id) |
UserI |
findUser(java.lang.String id) |
CodeListI |
getAfterCallWorkCodes()
A
CodeListI object with type CodeType.ACW holding a list of ContactCenterCodeI objects representing
the current after call work codes administered in the Contact Center. |
com.avaya.ccs.core.Client |
getClient()
Get the
Client object associated with this Session . |
java.lang.String |
getId()
A unique identifier for the
SessionI instance. |
java.util.List<InteractionI> |
getInteractions() |
java.lang.String |
getLastLoginTime()
The server time of the last successful login for the currently connected user.
|
CodeListI |
getNotReadyReasonCodes()
A
CodeListI object with type CodeType.NRRC holding a list of ContactCenterCodeI objects
representing the current not ready reason codes administered in the Contact Center. |
int |
getNumUsers() |
java.util.List<ResourceI> |
getResources() |
java.util.List<UserI> |
getUsers() |
java.lang.String |
getVersion() |
void |
openInteractions(InteractionListenerI interactionListener)
Opens the
InteractionI path with the server to start the flow of events for all interactions associated with the
SessionI . |
void |
openResources(ResourceListenerI resourceListener)
Opens the
ResourceI path with the server to start the flow of events for all resources associated with the
SessionI . |
void |
openUsers(UserListenerI userListener)
Opens the
UserI path with the server to start the flow of events for all users associated with the SessionI
. |
java.lang.String getId()
SessionI
instance.
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.
This property is available for access after the application has received a NotificationType.DELETE
notification for
this SessionI
object.
SessionI
instanceint getNumUsers() throws ObjectInvalidException
SessionI
instanceObjectInvalidException
- if the SessionI
instance has been deletedjava.lang.String getVersion() throws ObjectInvalidException
ObjectInvalidException
- if the SessionI
instance has been deletedjava.lang.String getLastLoginTime() throws ObjectInvalidException
The value of the property is a String object containing the Universal Coordinated Time (UTC) server time of the previous successful login by the same user or null if the user has never previously signed in.
ObjectInvalidException
- if the SessionI
instance has been deletedCodeListI getNotReadyReasonCodes() throws ObjectInvalidException
CodeListI
object with type CodeType.NRRC
holding a list of ContactCenterCodeI
objects
representing the current not ready reason codes administered in the Contact Center.CodeList
object allowing access to the codesObjectInvalidException
- if the SessionI
instance has been deletedCodeListI getAfterCallWorkCodes() throws ObjectInvalidException
CodeListI
object with type CodeType.ACW
holding a list of ContactCenterCodeI
objects representing
the current after call work codes administered in the Contact Center.CodeList
object allowing access to the codesObjectInvalidException
- if the SessionI
instance has been deletedvoid openUsers(UserListenerI userListener) throws InvalidArgumentException, ObjectInvalidException
UserI
path with the server to start the flow of events for all users associated with the SessionI
.
The UserI
objects and subsequent notifications for these objects are sent to the application through the
UserListenerI.onUserEvent(com.avaya.ccs.api.NotificationEventI<com.avaya.ccs.api.UserI>)
method
userListener
- notifies the application of user level eventsInvalidArgumentException
- if the mandatory UserListenerI
argument is not suppliedObjectInvalidException
- if the SessionI
has been deletedjava.util.List<UserI> getUsers() throws ObjectInvalidException
UserI
objects in the SessionI
ObjectInvalidException
- if the SessionI
has been deletedUserI findUser(java.lang.String id) throws InvalidArgumentException, ObjectInvalidException
id
- of the UserI
object to findUserI
object if found in the SessionI
and null
if the UserI
is not foundInvalidArgumentException
- if the supplied id argument is null
or an empty stringObjectInvalidException
- if the SessionI
has been deletedvoid openResources(ResourceListenerI resourceListener) throws InvalidArgumentException, ObjectInvalidException
ResourceI
path with the server to start the flow of events for all resources associated with the
SessionI
.
The ResourceI
objects and subsequent notifications for these objects are sent to the application through the
ResourceListenerI.onResourceEvent(com.avaya.ccs.api.NotificationEventI<com.avaya.ccs.api.ResourceI>)
method
resourceListener
- notifies the application of resource level eventsInvalidArgumentException
- if the mandatory ResourceListenerI
argument is not suppliedObjectInvalidException
- if the SessionI
has been deletedcom.avaya.ccs.core.Client getClient()
Client
object associated with this Session
.java.util.List<ResourceI> getResources() throws ObjectInvalidException
ResourceI
objects in the SessionI
ObjectInvalidException
- if the SessionI
has been deletedResourceI findResource(java.lang.String id) throws InvalidArgumentException, ObjectInvalidException
id
- of the ResourceI
object to findResourceI
object if found in the SessionI
and null
if the ResourceI
is not
foundInvalidArgumentException
- if the supplied id argument is null
or an empty stringObjectInvalidException
- if the SessionI
has been deletedvoid openInteractions(InteractionListenerI interactionListener) throws InvalidArgumentException, ObjectInvalidException
InteractionI
path with the server to start the flow of events for all interactions associated with the
SessionI
.
The InteractionI
objects and subsequent notifications for these objects are sent to the application through the
InteractionListenerI.onInteractionEvent(com.avaya.ccs.api.NotificationEventI<com.avaya.ccs.api.InteractionI>)
method
interactionListener
- notifies the application of interaction level eventsInvalidArgumentException
- if the mandatory InteractionListenerI
argument is not suppliedObjectInvalidException
- if the SessionI
has been deletedjava.util.List<InteractionI> getInteractions() throws ObjectInvalidException
InteractionI
objects in the SessionI
ObjectInvalidException
- if the SessionI
has been deletedInteractionI findInteraction(java.lang.String id) throws InvalidArgumentException, ObjectInvalidException
id
- of the InteractionI
object to findInteractionI
object if found in the SessionI
and null
if the InteractionI
is
not foundInvalidArgumentException
- if the supplied id argument is null
or an empty stringObjectInvalidException
- if the SessionI
has been deleted