The agent session class. Manages connection to the server, authentication and transport. The AgentSession objects cannot be instantiated directly, create AgentPlace object instead. More...

Inheritance diagram for ADAPI.AgentSession:

Public Member Functions
void	loginNoPhone (string adHost, string loginId, string domain, string password, bool force=false)
	Opens connection to the server, authenticates the user for the session without phone device. More...

void	loginOnDefaultPhone (string adHost, string loginId, string domain, string password, bool isSoftphone, bool force=false)
	Opens connection to the server, authenticates the user for the session with default phone device specified in user's configuration. More...

void	loginOnHardPhone (string adHost, string loginId, string domain, string password, string phoneNum, bool isInternal, bool force=false)
	Opens connection to the server, authenticates the user for the session with non-default hardphone device. More...

void	loginOnVirtualPhone (string adHost, string loginId, string domain, string password, bool force=false)
	Opens connection to the server, authenticates the user for the session with no phone. User then should dial into the authentication scenario to provide the phone number. More...

void	resetPassword (string adHost, string loginId, string domain)
	Resets user password. More...

virtual ResultCode	logout ()
	Logs user session out and closes the connection to the server. More...

Properties
bool	loggedIn `[get]`
	If True the session is valid and logged in. More...

bool	loggedOut `[get]`
	If True the session is logged out. More...

string	userId `[get]`
	Configuration ID of the currently logged user. More...

string	loginId `[get]`
	Login ID (username) of the currently logged user. More...

string	adHost `[get]`
	Computer name of the Agent Web Server associated with the session. More...

Detailed Description

The agent session class. Manages connection to the server, authentication and transport. The AgentSession objects cannot be instantiated directly, create AgentPlace object instead.

Member Function Documentation

◆ loginNoPhone()

void ADAPI.AgentSession.loginNoPhone	(	string	adHost,
		string	loginId,
		string	domain,
		string	password,
		bool	force = `false`
	)

Opens connection to the server, authenticates the user for the session without phone device.

Parameters

adHost	The name or IP address of the computer which runs the Agent Web Server
loginId	User's login ID
domain	Tenant domain
password	User's password
force	Specifies if the session should be forecefully opened if the same user is already logged in from another computer. The existing user session will be forcefully logged out once new session is authenticated. Default is False

◆ loginOnDefaultPhone()

void ADAPI.AgentSession.loginOnDefaultPhone	(	string	adHost,
		string	loginId,
		string	domain,
		string	password,
		bool	isSoftphone,
		bool	force = `false`
	)

Opens connection to the server, authenticates the user for the session with default phone device specified in user's configuration.

Parameters

adHost	The name or IP address of the computer which runs the Agent Web Server
loginId	User's login ID
domain	Tenant domain
password	User's password
isSoftphone	If True the user will be logged with default softphone per configuration. Otherwise the user is logged with default hardphone
force	Specifies if the session should be forecefully opened if the same user is already logged in from another computer. The existing user session will be forcefully logged out once new session is authenticated. Default is False

◆ loginOnHardPhone()

void ADAPI.AgentSession.loginOnHardPhone	(	string	adHost,
		string	loginId,
		string	domain,
		string	password,
		string	phoneNum,
		bool	isInternal,
		bool	force = `false`
	)

Opens connection to the server, authenticates the user for the session with non-default hardphone device.

Parameters

adHost	The name or IP address of the computer which runs the Agent Web Server
loginId	User's login ID
domain	Tenant domain
password	User's password
phoneNum	The phone number user should be logged in with
isInternal	If True the phone is internal SIP extension. Otherwise the phone is external (PSTN) phone
force	Specifies if the session should be forecefully opened if the same user is already logged in from another computer. The existing user session will be forcefully logged out once new session is authenticated. Default is False

◆ loginOnVirtualPhone()

void ADAPI.AgentSession.loginOnVirtualPhone	(	string	adHost,
		string	loginId,
		string	domain,
		string	password,
		bool	force = `false`
	)

Opens connection to the server, authenticates the user for the session with no phone. User then should dial into the authentication scenario to provide the phone number.

Parameters

adHost	The name or IP address of the computer which runs the Agent Web Server
loginId	User's login ID
domain	Tenant domain
password	User's password
force	Specifies if the session should be forecefully opened if the same user is already logged in from another computer. The existing user session will be forcefully logged out once new session is authenticated. Default is False

◆ logout()

virtual ResultCode ADAPI.AgentSession.logout ( )

virtual

Logs user session out and closes the connection to the server.

Returns: Result code.

Reimplemented in ADAPI.AgentPlace.

◆ resetPassword()

void ADAPI.AgentSession.resetPassword	(	string	adHost,
		string	loginId,
		string	domain
	)

Resets user password.

Parameters

adHost	The name or IP address of the computer which runs the Agent Web Server
loginId	User's login ID
domain	Tenant domain

Property Documentation

◆ adHost

string ADAPI.AgentSession.adHost

get

Computer name of the Agent Web Server associated with the session.

◆ loggedIn

bool ADAPI.AgentSession.loggedIn

get

If True the session is valid and logged in.

◆ loggedOut

bool ADAPI.AgentSession.loggedOut

get

If True the session is logged out.

◆ loginId

string ADAPI.AgentSession.loginId

get

Login ID (username) of the currently logged user.

◆ userId

string ADAPI.AgentSession.userId

get

Configuration ID of the currently logged user.

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

/Users/avl/projects/Branches/5.3.16/Client/AgentDesktopApi/ADAPI/AgentSession.cs
/Users/avl/projects/Branches/5.3.16/Client/AgentDesktopApi/ADAPI/AgentSessionImplementation.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ loginNoPhone()

◆ loginOnDefaultPhone()

◆ loginOnHardPhone()

◆ loginOnVirtualPhone()

◆ logout()

◆ resetPassword()

Property Documentation

◆ adHost

◆ loggedIn

◆ loggedOut

◆ loginId

◆ userId