Class describes single user. More...

Public Member Functions
ResultCode	sendScreenPop (KVList data, string stepId=null)
	Sends a screenpop to that user. More...

override string	ToString ()
	Returns string representation of the object. More...

Properties
string	id `[get]`
	Unique user ID. More...

string	teamId `[get]`
	ID of the team the user belongs to. More...

Team?	team `[get]`
	Reference to the Team object the user belongs to. More...

string	loginId `[get]`
	User login ID (username). More...

string	firstName `[get]`
	User's first name. More...

string	lastName `[get]`
	User's last name. More...

string	fullName `[get]`
	User's full name. Composed from first and last name accordign to configured display name format. More...

string	number `[get]`
	Phone number the user is currently logged in with. More...

bool	isLogged `[get]`
	Specifies if user is curretnly logged in. More...

bool	isAgent `[get]`
	Specifies if user can perform agent activities (get interactions from the queue). More...

UserState	state `[get]`
	Specifies current state of the user. More...

Detailed Description

Class describes single user.

Member Function Documentation

◆ sendScreenPop()

ResultCode ADAPI.User.sendScreenPop	(	KVList	data,
		string	stepId = `null`
	)

Sends a screenpop to that user.

Parameters

data	Screenpop data. Actual content is defined by client application.
stepId	ID of teh interaction step teh screenpop is associated with.

Returns

◆ ToString()

override string ADAPI.User.ToString ( )

Returns string representation of the object.

Property Documentation

◆ firstName

string ADAPI.User.firstName

get

User's first name.

◆ fullName

string ADAPI.User.fullName

get

User's full name. Composed from first and last name accordign to configured display name format.

◆ id

string ADAPI.User.id

get

Unique user ID.

◆ isAgent

bool ADAPI.User.isAgent

get

Specifies if user can perform agent activities (get interactions from the queue).

◆ isLogged

bool ADAPI.User.isLogged

get

Specifies if user is curretnly logged in.

◆ lastName

string ADAPI.User.lastName

get

User's last name.

◆ loginId

string ADAPI.User.loginId

get

User login ID (username).

◆ number

string ADAPI.User.number

get

Phone number the user is currently logged in with.

◆ state

UserState ADAPI.User.state

get

Specifies current state of the user.

◆ team

Team? ADAPI.User.team

get

Reference to the Team object the user belongs to.

◆ teamId

string ADAPI.User.teamId

get

ID of the team the user belongs to.

The documentation for this class was generated from the following file:

Branches/5.5.1/Client/AgentDesktopApi/ADAPI/AuxClasses.cs

Public Member Functions

Properties