Show Hide

Contents

User Object

The User object is used to obtain information about a specific CIC user, such as the list of user, station, line, and workgroup queues that the user can view and modify, the user's status, logged in state, etc.

Methods

None

Callbacks

User.errorHandler	Name of the script function to be invoked by when an internal error occurs in the User object.
User.statusChangeHandler	Name of the script function to be called when the agent's status changes.
User.userChangeHandler	Name of the script function to be called when any of the agent's configuration attributes changes, except the agent's status.
User.userLoginChangeHandler	Name of the script function to be called when the agent logs in or out of the system. Login will be true on a login message and false on a logout message.

Properties

User.canListen	Determines if the agent can listen in on calls.
User.canMakePrivate	Determines if the agent's calls can be made private.
User.canRecord	Determines if the agent can record calls.
User.extension	The agent's CIC extension number.
User.id	The CIC user name of this agent.
User.isDND	Determines if the agent's status is in a Do Not Disturb state.
User.isLoggedIn	Determines if the agent is logged in.
User.isOnPhone	Determines if the agent is on the phone.
User.lastError	This property returns a string describing an error condition affecting the User object.
User.lastErrorId	This property returns the number of an error condition affecting the User object.
User.name	The CIC display name of the agent.
User.statusMessage	Sets or returns the agent's status indicator (e.g. Available).
User.untilDateTime	The date and time that the agent will return from an unavailable status condition.

Enumerations

User.startAccessibleQueuesEnum	Returns an enumeration of all accessible queues (e.g., user queues or workgroups with queues) the current agent has rights to view and modify.
User.startAvailableCampaignObjectEnum	Returns an enumeration of campaigns which are available for agent to logon to.
User.startAvailableStatusMessagesEnum	Returns an enumeration of available status messages.
User.startLoggedInStationsEnum	Returns an enumeration of the logged in stations for this agent.
User.startViewableWorkgroupsEnum	Returns an enumeration of all workgroups the agent has rights to view.
User.startWorkgroupsEnum	Creates a list of workgroups the current agent is a member of.