Agent Place class. Derived from AgentSession and provides high level API functionality. More...

Inheritance diagram for ADAPI.AgentPlace:

Public Member Functions
delegate void	ErrorCallback (AgentPlace session, Item item, ResultCode err, string msg)
	Raised when error occures. More...

delegate void	ConnectionUp (AgentPlace session)
	Raised when connection to the server is established. More...

delegate void	ConnectionDown (AgentPlace session)
	Raised when connection to the server is lost. More...

delegate void	LoggedInCallback (AgentPlace session, bool bSucceded, ResultCode err, string reason, bool afterReconnect)
	Raised when login is completed (successfully or unsuccessfully). More...

delegate void	LoggedOutCallback (AgentPlace session, bool bWaitForCloseSessionEvent)
	Raised when session is logged out. More...

delegate void	StateChangedCallback (AgentPlace session, UserState state)
	Raised when user's ACD state changed. More...

delegate void	SoftphoneStatusCallback (AgentPlace session, bool up, string error)
	Raised when user's soft phone status changed. More...

delegate void	AudioDeviceChangedCallback (AgentPlace session, string inDevice, string outDevice)
	Raised when input or output audio device is changed. More...

delegate void	PhoneCapabilitiesChangedCallback (AgentPlace session, PhoneCapabilities caps)
	Raised when user's phone capabilities changed More...

delegate void	PhoneSnapshotReceivedCallback (AgentPlace session)
	Raised when user's phone snapshot received. More...

delegate void	ItemArrivedCallback (AgentPlace session, Item item)
	Raised when new item (interaction) is arrived. More...

delegate void	ItemDispositionsReadyCallback (AgentPlace session, Item item)
	Raised when service dispositions list is received. The event is raised as result of Service.requestDispositions(). More...

delegate void	ItemWorkitemDataReadyCallback (AgentPlace session, Item item)
	TBD More...

delegate void	ItemChangedCallback (AgentPlace session, Item item)
	Raised when one of user's Items has changed. More...

delegate void	ItemCompletedCallback (AgentPlace session, Item item)
	Raised when one of user's items is completed and being deleted. More...

delegate void	ItemPopupShownCallback (AgentPlace session, Item item)
	Raised when the inbound item popup notification window is shown. More...

delegate void	ItemPopupClosedCallback (AgentPlace session, Item item, PopupAction action)
	Raised when the inbound item popup notification window is closed. More...

delegate void	CallOfferedCallback (AgentPlace session, Call call)
	Raised when new incoming call is offered on the phone device the user is logged with. More...

delegate void	CallDialingCallback (AgentPlace session, Call call)
	Raised when outbound call initiated by AgentPlace.makeCall() is started. More...

delegate void	CallConnectedCallback (AgentPlace session, Call call)
	Raised when inbound or outbound call is answered (connected). More...

delegate void	CallMutedCallback (AgentPlace session, Call call)
	Raised when call is muted (the user's microphone is inactive). More...

delegate void	CallUnmutedCallback (AgentPlace session, Call call)
	Raised when call mute is cancelled (the user's microphone is active). More...

delegate void	CallLocalHeldCallback (AgentPlace session, Call call)
	Raised when call is placed on hold by user as result of Call.hold() request. More...

delegate void	CallLocalResumedCallback (AgentPlace session, Call call)
	Raised when call is resumed from hold by user as result of Call.resume() request. More...

delegate void	CallRemoteHeldCallback (AgentPlace session, Call call)
	Raised when call is placed on hold by remote party. More...

delegate void	CallRemoteResumedCallback (AgentPlace session, Call call)
	Raised when call is resumed from hold by remote party. More...

delegate void	CallDigitCallback (AgentPlace session, Call call, string digit)
	Raised when DTMF digit is received on call. More...

delegate void	CallDisconnectedCallback (AgentPlace session, Call call, CallDisconnectCause cause, string message)
	Raised when call is disconnected. More...

delegate void	CallPartyAddedCallback (AgentPlace session, Call call, CallParty party)
	Raised when new party is added to the call. More...

delegate void	CallPartyChangedCallback (AgentPlace session, Call call, CallParty party)
	Raised when existing call party changed. More...

delegate void	CallPartyRemovedCallback (AgentPlace session, Call call, CallParty party)
	Raised when existign call party left call. More...

delegate void	CallRecordingChangedCallback (AgentPlace session, Call call)
	Raised when call recording status is changed (recording started or stopped). Use Call.isRecording to check recording status. More...

delegate void	CallDataChangedCallback (AgentPlace session, Call call)
	Raised when call data changed. More...

delegate void	CallAudioQualityAlertCallback (AgentPlace session, Call call, bool ok)
	Raised when the audio quality alert is received from the softphone for the call. More...

delegate void	DirectoryItemsReceivedCallback (AgentPlace session, DirectoryCategory cat)
	Raised when the list of items for directory category is received. Sent as response to the DirectoryCategory.requestItems() request. More...

delegate void	TeamMembersReceivedCallback (AgentPlace session, Team team)
	Raised when the list of members for the team is received. Sent as response to Team.requestMembers() request. More...

delegate void	UserInfoUpdatedCallback (AgentPlace session, User user)
	Raised when the user's attributes changed. More...

delegate void	ScreenpopReceivedCallback (AgentPlace session, User fromUser, Item item, KVList data)
	Raised when screenpop initiation request is received. More...

delegate void	RecentAddedCallback (AgentPlace session, Recent recent)
	Raised when new Recent object is added into the Recents collection. More...

delegate void	ScreenRecordingStarted (AgentPlace session)
	Raised when screen recording is started. Only one screen recording is allowed at the same time. More...

delegate void	ScreenRecordingCompleted (AgentPlace session)
	Raised when screen recording is completed. More...

delegate void	ScreenRecordingMuted (AgentPlace session)
	Raised when screen recording is muted. More...

delegate void	ScreenRecordingUnmuted (AgentPlace session)
	Raised when screen recording is unmuted. More...

	AgentPlace ()
	Class constructor. More...

Call	call (string callId)
	Returns the Call object with specified ID, if any. More...

Item	item (string itemId)
	Returns the Item object with specified ID, if any. More...

Team	team (string teamId)
	Returns the Team object with specified ID, if any. More...

User	user (string userId)
	Returns the User object with specified ID, if any. More...

Service	service (string serviceId)
	Returns the Service object with specified ID, if any. More...

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

ResultCode	setReady ()
	Changes user's ACD state to Ready. More...

ResultCode	setNotReady (string reason)
	Changes user's ACD state to Not Ready with specified reason. More...

ResultCode	clearState (string reason)
	Clears user's ACD state. More...

ResultCode	makeCall (string dnis, Service service, string globalInteractionId, out Item outItem)
	Initiates outbound phone call. More...

Favorite	addToFavorites (string name, string number)
	Adds the entry in user's Favorites list. More...

ResultCode	removeFromFavorites (string number)
	Removes entry from user's Favorites list. More...

bool	isFavorite (string number)
	Checks if the phone number is already present in user's Favorites list. More...

ResultCode	muteScreenRecording ()
	Mutes screen recording. When muted, the screen snapshot at the moment of mute is recorded until it is unmuted. More...

ResultCode	unmuteScreenRecording ()
	Stops muting the screen recording. More...

Public Member Functions inherited from ADAPI.AgentSession
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...

Static Public Member Functions
static void	staticInit (string appName, string appVersion, string appPath)
	Static one-time initialization of the API. Must be called before instantiating AgentPlace object. More...

static void	staticTerminate ()
	Statis one-time deinitialization of the API. Should be called before application ends. More...

Properties
LicenseStatus	licenseStatus `[get]`
	Returns license status of the product. More...

string	licensedTo `[get]`
	Returns name of the licensee of the product. More...

string	remoteAddress `[get]`
	Returns the IP address of the client as it is seen by teh server (public IP address). More...

string	tenantId `[get]`
	Returns ID of the tenant the logged user belongs to. More...

string	phoneNumber `[get]`
	Returns the phone number the user is logged in with, if any. More...

string	audioInDevice `[get]`
	Returns name of the input audio device for the softphone (microphone). More...

string	audioOutDevice `[get]`
	Returns name of the output audio device for the softphone (speakers). More...

List< AgentStateReason >	notReadyReasons `[get]`
	Returns list of not ready reasons. More...

List< AgentStateReason >	notReadySystemReasons `[get]`
	Returns list of system not ready reasons. More...

DisplayNameFormat	displayNameFormat `[get]`
	Returns the format type for display name. More...

string	serverVersion `[get]`
	Returns version of the server the session is logged into. More...

string	serverComments `[get]`
	Returns the comments string of the server the session is logged into. More...

string	firstName `[get]`
	Returns logged user's first name. More...

string	lastName `[get]`
	Returns logged user's last name. More...

string	fullName `[get]`
	Returns logged user's full name, formatted per configuration. More...

string	nickName `[get]`
	Returns logged user's nick name per configuration. More...

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

UserState	state `[get]`
	Returns current user's state. More...

bool	isScreenRecording `[get]`
	Returns True if user screen is currently being recorded More...

bool	isScreenRecordingMuted `[get]`
	Returns True if user screen is currently being recorded More...

PhoneCapabilities	phoneCapabilities `[get]`
	Returns the capabilities of the phone the user is logged in with. More...

SortedDictionary< string, Recent >	recents `[get]`
	Returns the collection of Recent items for the logged user. More...

SortedDictionary< string, Favorite >	favorites `[get]`
	Returns the collection of Favorite items for the logged user. More...

SortedDictionary< string, DirectoryCategory >	directoryCategories `[get]`
	Returns the collection of the directory categories. The list of directory categories is available immediately after session is successfully logged in. More...

SortedDictionary< string, Team >	teams `[get]`
	Returns the collection of Teams. The list of teams is available immediately after session is successfully logged in. More...

SortedDictionary< string, User >	users `[get]`
	Returns the collection of Users. The list of users is empty after login and is updated every time client application requests the user details with Team.requestMembers() method. More...

SortedDictionary< string, Call >	calls `[get]`
	Returns the collection of voice calls currently present on the phone the user is logged in with. More...

SortedDictionary< string, Item >	items `[get]`
	Returns collection of the items currently associated with logged user. More...

Item	activeItem `[get]`
	Returns active item. Only one item can be active at any time. More...

SortedDictionary< string, Service >	services `[get]`
	Returns the collection of the services. More...

SortedDictionary< string, Service >	userServices `[get]`
	Returns the collection of Services the currently logged user is associated with (can handle these services). More...

List< Privilege >	privileges `[get]`
	Returns the collection of currently logged user's privileges. More...

Properties inherited from ADAPI.AgentSession
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...

Events
ErrorCallback	errorCallback
	Raised when error occures. More...

ConnectionUp	connectionUp
	Raised when connection to the server is established. More...

ConnectionDown	connectionDown
	Raised when connection to the server is lost. More...

LoggedInCallback	loggedInCallback
	Raised when login is completed (successfully or unsuccessfully). More...

LoggedOutCallback	loggedOutCallback
	Raised when session is logged out. More...

StateChangedCallback	stateChangedCallback
	Raised when user's ACD state changed. More...

SoftphoneStatusCallback	softphoneStatusCallback
	Raised when user's soft phone status changed. More...

AudioDeviceChangedCallback	audioDeviceChangedCallback
	Raised when input or output audio device is changed. More...

PhoneCapabilitiesChangedCallback	phoneCapabilitiesChangedCallback
	Raised when user's phone capabilities changed More...

PhoneSnapshotReceivedCallback	phoneSnapshotReceivedCallback
	Raised when user's phone snapshot received. More...

ItemArrivedCallback	itemArrivedCallback
	Raised when new item (interaction) is arrived. More...

ItemDispositionsReadyCallback	itemDispositionsReadyCallback
	Raised when service dispositions list is received. This event is raised as result of Service.requestDispositions() method. More...

ItemWorkitemDataReadyCallback	itemWorkitemDataReadyCallback
	TBD More...

ItemChangedCallback	itemChangedCallback
	Raised when one of user's Items has changed. More...

ItemCompletedCallback	itemCompletedCallback
	Raised when one of user's items is completed and being deleted. More...

ItemPopupShownCallback	itemPopupShownCallback
	Raised when the inbound item popup notification window is shown. More...

ItemPopupClosedCallback	itemPopupClosedCallback
	Raised when the inbound item popup notification window is closed. More...

CallOfferedCallback	callOfferedCallback
	Raised when new incoming call is offered on the phone device the user is logged with. More...

CallDialingCallback	callDialingCallback
	Raised when outbound call initiated by AgentPlace.makeCall() is started. More...

CallConnectedCallback	callConnectedCallback
	Raised when inbound or outbound call is answered (connected). More...

CallMutedCallback	callMutedCallback
	Raised when call is muted (the user's microphone is inactive). More...

CallUnmutedCallback	callUnmutedCallback
	Raised when call mute is cancelled (the user's microphone is active). More...

CallLocalHeldCallback	callLocalHeldCallback
	Raised when call is placed on hold by user as result of Call.hold() request. More...

CallLocalResumedCallback	callLocalResumedCallback
	Raised when call is resumed from hold by user as result of Call.resume() request. More...

CallRemoteHeldCallback	callRemoteHeldCallback
	Raised when call is placed on hold by remote party. More...

CallRemoteResumedCallback	callRemoteResumedCallback
	Raised when call is resumed from hold by remote party. More...

CallDigitCallback	callDigitCallback
	Raised when DTMF digit is received on call. More...

CallDisconnectedCallback	callDisconnectedCallback
	Raised when call is disconnected. More...

CallPartyAddedCallback	callPartyAddedCallback
	Raised when new party is added to the call. More...

CallPartyChangedCallback	callPartyChangedCallback
	Raised when existing call party changed. More...

CallPartyRemovedCallback	callPartyRemovedCallback
	Raised when existign call party left call. More...

CallRecordingChangedCallback	callRecordingChangedCallback
	Raised when call recording status is changed (recording started or stopped). Use Call.isRecording to check recording status. More...

CallDataChangedCallback	callDataChangedCallback
	Raised when call data changed. More...

CallAudioQualityAlertCallback	callAudioQualityAlertCallback
	Raised when the audio quality alert is received from the softphone for the call. More...

DirectoryItemsReceivedCallback	directoryItemsReceivedCallback
	Raised when the list of items for directory category is received. Sent as response to the DirectoryCategory.requestItems() request. More...

TeamMembersReceivedCallback	teamMembersReceivedCallback
	Raised when the list of members for the team is received. Sent as response to Team.requestMembers() request. More...

UserInfoUpdatedCallback	userInfoUpdatedCallback
	Raised when the user's attributes changed. More...

ScreenpopReceivedCallback	screenpopReceivedCallback
	Raised when screenpop initiation request is received. More...

RecentAddedCallback	recentAddedCallback
	Raised when new Recent object is added into the Recents collection. More...

ScreenRecordingStarted	screenRecordingStarted
	Raised when screen recording is started. Only one screen recording is allowed at the same time. More...

ScreenRecordingCompleted	screenRecordingCompleted
	Raised when screen recording is completed. More...

ScreenRecordingMuted	screenRecordingMuted
	Raised when screen recording is muted. More...

ScreenRecordingUnmuted	screenRecordingUnmuted
	Raised when screen recording is unmuted. More...

Detailed Description

Agent Place class. Derived from AgentSession and provides high level API functionality.

Constructor & Destructor Documentation

◆ AgentPlace()

ADAPI.AgentPlace.AgentPlace ( )

Class constructor.

Member Function Documentation

◆ addToFavorites()

Favorite ADAPI.AgentPlace.addToFavorites	(	string	name,
		string	number
	)

Adds the entry in user's Favorites list.

Parameters

name	Entry display name
number	Entry phone number

Returns: Result code.

◆ AudioDeviceChangedCallback()

delegate void ADAPI.AgentPlace.AudioDeviceChangedCallback	(	AgentPlace	session,
		string	inDevice,
		string	outDevice
	)

Raised when input or output audio device is changed.

Parameters

session	Reference to the AgentSession object which raised the event
inDevice	Input audio device name
outDevice	Output audio device name

◆ call()

Call ADAPI.AgentPlace.call ( string callId )

Returns the Call object with specified ID, if any.

Parameters

callId ID of the call

Returns

◆ CallAudioQualityAlertCallback()

delegate void ADAPI.AgentPlace.CallAudioQualityAlertCallback	(	AgentPlace	session,
		Call	call,
		bool	ok
	)

Raised when the audio quality alert is received from the softphone for the call.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
ok	If True the voice quality is normal, otherwise it is bad

◆ CallConnectedCallback()

delegate void ADAPI.AgentPlace.CallConnectedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when inbound or outbound call is answered (connected).

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallDataChangedCallback()

delegate void ADAPI.AgentPlace.CallDataChangedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call data changed.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallDialingCallback()

delegate void ADAPI.AgentPlace.CallDialingCallback	(	AgentPlace	session,
		Call	call
	)

Raised when outbound call initiated by AgentPlace.makeCall() is started.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the outbound Call object

◆ CallDigitCallback()

delegate void ADAPI.AgentPlace.CallDigitCallback	(	AgentPlace	session,
		Call	call,
		string	digit
	)

Raised when DTMF digit is received on call.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
digit	The DTMF digit

◆ CallDisconnectedCallback()

delegate void ADAPI.AgentPlace.CallDisconnectedCallback	(	AgentPlace	session,
		Call	call,
		CallDisconnectCause	cause,
		string	message
	)

Raised when call is disconnected.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
cause	The cause for the call disconnect
message	The message (SIP response text) of the disconnect

◆ CallLocalHeldCallback()

delegate void ADAPI.AgentPlace.CallLocalHeldCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call is placed on hold by user as result of Call.hold() request.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallLocalResumedCallback()

delegate void ADAPI.AgentPlace.CallLocalResumedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call is resumed from hold by user as result of Call.resume() request.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallMutedCallback()

delegate void ADAPI.AgentPlace.CallMutedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call is muted (the user's microphone is inactive).

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallOfferedCallback()

delegate void ADAPI.AgentPlace.CallOfferedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when new incoming call is offered on the phone device the user is logged with.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the new Call object

◆ CallPartyAddedCallback()

delegate void ADAPI.AgentPlace.CallPartyAddedCallback	(	AgentPlace	session,
		Call	call,
		CallParty	party
	)

Raised when new party is added to the call.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
party	Newly added CallParty object

◆ CallPartyChangedCallback()

delegate void ADAPI.AgentPlace.CallPartyChangedCallback	(	AgentPlace	session,
		Call	call,
		CallParty	party
	)

Raised when existing call party changed.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
party	Changed CallParty object

◆ CallPartyRemovedCallback()

delegate void ADAPI.AgentPlace.CallPartyRemovedCallback	(	AgentPlace	session,
		Call	call,
		CallParty	party
	)

Raised when existign call party left call.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object
party	Left CallParty object

◆ CallRecordingChangedCallback()

delegate void ADAPI.AgentPlace.CallRecordingChangedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call recording status is changed (recording started or stopped). Use Call.isRecording to check recording status.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallRemoteHeldCallback()

delegate void ADAPI.AgentPlace.CallRemoteHeldCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call is placed on hold by remote party.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallRemoteResumedCallback()

delegate void ADAPI.AgentPlace.CallRemoteResumedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call is resumed from hold by remote party.

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ CallUnmutedCallback()

delegate void ADAPI.AgentPlace.CallUnmutedCallback	(	AgentPlace	session,
		Call	call
	)

Raised when call mute is cancelled (the user's microphone is active).

Parameters

session	Reference to the AgentSession object which raised the event
call	Reference to the Call object

◆ clearState()

ResultCode ADAPI.AgentPlace.clearState ( string reason )

Clears user's ACD state.

Returns: Result code.

◆ ConnectionDown()

delegate void ADAPI.AgentPlace.ConnectionDown ( AgentPlace session )

Raised when connection to the server is lost.

Parameters

session Reference to the AgentSession object which raised the event

◆ ConnectionUp()

delegate void ADAPI.AgentPlace.ConnectionUp ( AgentPlace session )

Raised when connection to the server is established.

Parameters

session Reference to the AgentSession object which raised the event

◆ DirectoryItemsReceivedCallback()

delegate void ADAPI.AgentPlace.DirectoryItemsReceivedCallback	(	AgentPlace	session,
		DirectoryCategory	cat
	)

Raised when the list of items for directory category is received. Sent as response to the DirectoryCategory.requestItems() request.

Parameters

session	Reference to the AgentSession object which raised the event
cat	Reference to the DirectoryCategory object. Use DirectoryCategory.items to access the items

◆ ErrorCallback()

delegate void ADAPI.AgentPlace.ErrorCallback	(	AgentPlace	session,
		Item	item,
		ResultCode	err,
		string	msg
	)

Raised when error occures.

Parameters

session	Reference to the AgentSession object which raised the event
item	Optional Item object which is related to error
err	Error code
msg	Error description

◆ isFavorite()

bool ADAPI.AgentPlace.isFavorite ( string number )

Checks if the phone number is already present in user's Favorites list.

Parameters

number The phone number to check

Returns: True if phone is in Favorites.

◆ item()

Item ADAPI.AgentPlace.item ( string itemId )

Returns the Item object with specified ID, if any.

Parameters

itemId ID of the item

Returns

◆ ItemArrivedCallback()

delegate void ADAPI.AgentPlace.ItemArrivedCallback	(	AgentPlace	session,
		Item	item
	)

Raised when new item (interaction) is arrived.

Parameters

session	Reference to the AgentSession object which raised the event
item	The Item object

◆ ItemChangedCallback()

delegate void ADAPI.AgentPlace.ItemChangedCallback	(	AgentPlace	session,
		Item	item
	)

Raised when one of user's Items has changed.

Parameters

session	Reference to the AgentSession object which raised the event
item	Reference to the changed Item object

◆ ItemCompletedCallback()

delegate void ADAPI.AgentPlace.ItemCompletedCallback	(	AgentPlace	session,
		Item	item
	)

Raised when one of user's items is completed and being deleted.

Parameters

session	Reference to the AgentSession object which raised the event
item	Reference to the completed Item object

◆ ItemDispositionsReadyCallback()

delegate void ADAPI.AgentPlace.ItemDispositionsReadyCallback	(	AgentPlace	session,
		Item	item
	)

Raised when service dispositions list is received. The event is raised as result of Service.requestDispositions().

Parameters

session	Reference to the AgentSession object which raised the event
item	Reference to the Item object. The event is raised for every Item which is associated with particular service

◆ ItemPopupClosedCallback()

delegate void ADAPI.AgentPlace.ItemPopupClosedCallback	(	AgentPlace	session,
		Item	item,
		PopupAction	action
	)

Raised when the inbound item popup notification window is closed.

Parameters

session	Reference to the AgentSession object which raised the event
item	Reference to teh Item object the inbound notification was opened for
action	The reason for popup notification being closed

◆ ItemPopupShownCallback()

delegate void ADAPI.AgentPlace.ItemPopupShownCallback	(	AgentPlace	session,
		Item	item
	)

Raised when the inbound item popup notification window is shown.

Parameters

session	Reference to the AgentSession object which raised the event
item	Reference to teh Item object the inbound notification was opened for

◆ ItemWorkitemDataReadyCallback()

delegate void ADAPI.AgentPlace.ItemWorkitemDataReadyCallback	(	AgentPlace	session,
		Item	item
	)

TBD

Parameters

session	Reference to the AgentSession object which raised the event
item

◆ LoggedInCallback()

delegate void ADAPI.AgentPlace.LoggedInCallback	(	AgentPlace	session,
		bool	bSucceded,
		ResultCode	err,
		string	reason,
		bool	afterReconnect
	)

Raised when login is completed (successfully or unsuccessfully).

Parameters

session	Reference to the AgentSession object which raised the event
bSucceded	If True the session is successfully logged in; otherwise login failed
err	For failed login, error code
reason	For failed login, error description

◆ LoggedOutCallback()

delegate void ADAPI.AgentPlace.LoggedOutCallback	(	AgentPlace	session,
		bool	bWaitForCloseSessionEvent
	)

Raised when session is logged out.

Parameters

session	Reference to the AgentSession object which raised the event
bWaitForCloseSessionEvent	???

◆ logout()

override ResultCode ADAPI.AgentPlace.logout ( )

virtual

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

Reimplemented from ADAPI.AgentSession.

◆ makeCall()

ResultCode ADAPI.AgentPlace.makeCall	(	string	dnis,
		Service	service,
		string	globalInteractionId,
		out Item	outItem
	)

Initiates outbound phone call.

Parameters

dnis	Destination phone number
service	Optional ID of the service the new call should be associated with
outItem	Newly created Item object

Returns: Result code.

◆ muteScreenRecording()

ResultCode ADAPI.AgentPlace.muteScreenRecording ( )

Mutes screen recording. When muted, the screen snapshot at the moment of mute is recorded until it is unmuted.

Returns

◆ PhoneCapabilitiesChangedCallback()

delegate void ADAPI.AgentPlace.PhoneCapabilitiesChangedCallback	(	AgentPlace	session,
		PhoneCapabilities	caps
	)

Raised when user's phone capabilities changed

Parameters

session	Reference to the AgentSession object which raised the event
caps	Phone's new capabilities

◆ PhoneSnapshotReceivedCallback()

delegate void ADAPI.AgentPlace.PhoneSnapshotReceivedCallback ( AgentPlace session )

Raised when user's phone snapshot received.

Parameters

session Reference to the AgentSession object which raised the event

◆ RecentAddedCallback()

delegate void ADAPI.AgentPlace.RecentAddedCallback	(	AgentPlace	session,
		Recent	recent
	)

Raised when new Recent object is added into the Recents collection.

Parameters

session	Reference to the AgentSession object which raised the event
recent	Reference to the new Recent object

◆ removeFromFavorites()

ResultCode ADAPI.AgentPlace.removeFromFavorites ( string number )

Removes entry from user's Favorites list.

Parameters

number Phone number to remove from Favorites

Returns: Result code.

◆ ScreenpopReceivedCallback()

delegate void ADAPI.AgentPlace.ScreenpopReceivedCallback	(	AgentPlace	session,
		User	fromUser,
		Item	item,
		KVList	data
	)

Raised when screenpop initiation request is received.

Parameters

session	Reference to the AgentSession object which raised the event
fromUser	Reference to the User object who sent the screenpop request
item	Reference to the Item object the screenpop is related to
data	Screenpop data

◆ ScreenRecordingCompleted()

delegate void ADAPI.AgentPlace.ScreenRecordingCompleted ( AgentPlace session )

Raised when screen recording is completed.

Parameters

session Reference to the AgentSession object which raised the event

◆ ScreenRecordingMuted()

delegate void ADAPI.AgentPlace.ScreenRecordingMuted ( AgentPlace session )

Raised when screen recording is muted.

Parameters

session Reference to the AgentSession object which raised the event

◆ ScreenRecordingStarted()

delegate void ADAPI.AgentPlace.ScreenRecordingStarted ( AgentPlace session )

Raised when screen recording is started. Only one screen recording is allowed at the same time.

Parameters

session Reference to the AgentSession object which raised the event

◆ ScreenRecordingUnmuted()

delegate void ADAPI.AgentPlace.ScreenRecordingUnmuted ( AgentPlace session )

Raised when screen recording is unmuted.

Parameters

session Reference to the AgentSession object which raised the event

◆ service()

Service ADAPI.AgentPlace.service ( string serviceId )

Returns the Service object with specified ID, if any.

Parameters

serviceId ID of the service

Returns

◆ setNotReady()

ResultCode ADAPI.AgentPlace.setNotReady ( string reason )

Changes user's ACD state to Not Ready with specified reason.

Parameters

reason Optional reason

Returns: Result code.

◆ setReady()

ResultCode ADAPI.AgentPlace.setReady ( )

Changes user's ACD state to Ready.

Returns: Result code.

◆ SoftphoneStatusCallback()

delegate void ADAPI.AgentPlace.SoftphoneStatusCallback	(	AgentPlace	session,
		bool	up,
		string	error
	)

Raised when user's soft phone status changed.

Parameters

session	Reference to the AgentSession object which raised the event
up	If True, the softphone is up and running, otherwise softphone is inoperable
error	Error description

◆ StateChangedCallback()

delegate void ADAPI.AgentPlace.StateChangedCallback	(	AgentPlace	session,
		UserState	state
	)

Raised when user's ACD state changed.

Parameters

session	Reference to the AgentSession object which raised the event
state	User's new ACD state

◆ staticInit()

static void ADAPI.AgentPlace.staticInit	(	string	appName,
		string	appVersion,
		string	appPath
	)

static

Static one-time initialization of the API. Must be called before instantiating AgentPlace object.

Parameters

appName	Client application name for logging purposes
appVersion	Client application version for logging purposes
appPath	Full absolute path to the client application directory

◆ staticTerminate()

static void ADAPI.AgentPlace.staticTerminate ( )

static

Statis one-time deinitialization of the API. Should be called before application ends.

◆ team()

Team ADAPI.AgentPlace.team ( string teamId )

Returns the Team object with specified ID, if any.

Parameters

teamId ID of the team

Returns

◆ TeamMembersReceivedCallback()

delegate void ADAPI.AgentPlace.TeamMembersReceivedCallback	(	AgentPlace	session,
		Team	team
	)

Raised when the list of members for the team is received. Sent as response to Team.requestMembers() request.

Parameters

session	Reference to the AgentSession object which raised the event
team	Reference to the Team object. Use Team.members to access the list of members (users) in the team

◆ unmuteScreenRecording()

ResultCode ADAPI.AgentPlace.unmuteScreenRecording ( )

Stops muting the screen recording.

Returns

◆ user()

User ADAPI.AgentPlace.user ( string userId )

Returns the User object with specified ID, if any.

Parameters

userId ID of the user

Returns

◆ UserInfoUpdatedCallback()

delegate void ADAPI.AgentPlace.UserInfoUpdatedCallback	(	AgentPlace	session,
		User	user
	)

Raised when the user's attributes changed.

Parameters

session	Reference to the AgentSession object which raised the event
user	Reference to the User object.

Property Documentation

◆ activeItem

Item ADAPI.AgentPlace.activeItem

get

Returns active item. Only one item can be active at any time.

◆ audioInDevice

string ADAPI.AgentPlace.audioInDevice

get

Returns name of the input audio device for the softphone (microphone).

◆ audioOutDevice

string ADAPI.AgentPlace.audioOutDevice

get

Returns name of the output audio device for the softphone (speakers).

◆ calls

SortedDictionary<string, Call> ADAPI.AgentPlace.calls

get

Returns the collection of voice calls currently present on the phone the user is logged in with.

◆ directoryCategories

SortedDictionary<string, DirectoryCategory> ADAPI.AgentPlace.directoryCategories

get

Returns the collection of the directory categories. The list of directory categories is available immediately after session is successfully logged in.

◆ displayNameFormat

DisplayNameFormat ADAPI.AgentPlace.displayNameFormat

get

Returns the format type for display name.

◆ favorites

SortedDictionary<string, Favorite> ADAPI.AgentPlace.favorites

get

Returns the collection of Favorite items for the logged user.

◆ firstName

string ADAPI.AgentPlace.firstName

get

Returns logged user's first name.

◆ fullName

string ADAPI.AgentPlace.fullName

get

Returns logged user's full name, formatted per configuration.

◆ isScreenRecording

bool ADAPI.AgentPlace.isScreenRecording

get

Returns True if user screen is currently being recorded

◆ isScreenRecordingMuted

bool ADAPI.AgentPlace.isScreenRecordingMuted

get

Returns True if user screen is currently being recorded

◆ items

SortedDictionary<string, Item> ADAPI.AgentPlace.items

get

Returns collection of the items currently associated with logged user.

◆ lastName

string ADAPI.AgentPlace.lastName

get

Returns logged user's last name.

◆ licensedTo

string ADAPI.AgentPlace.licensedTo

get

Returns name of the licensee of the product.

◆ licenseStatus

LicenseStatus ADAPI.AgentPlace.licenseStatus

get

Returns license status of the product.

◆ nickName

string ADAPI.AgentPlace.nickName

get

Returns logged user's nick name per configuration.

◆ notReadyReasons

List<AgentStateReason> ADAPI.AgentPlace.notReadyReasons

get

Returns list of not ready reasons.

◆ notReadySystemReasons

List<AgentStateReason> ADAPI.AgentPlace.notReadySystemReasons

get

Returns list of system not ready reasons.

◆ phoneCapabilities

PhoneCapabilities ADAPI.AgentPlace.phoneCapabilities

get

Returns the capabilities of the phone the user is logged in with.

◆ phoneNumber

string ADAPI.AgentPlace.phoneNumber

get

Returns the phone number the user is logged in with, if any.

◆ privileges

List<Privilege> ADAPI.AgentPlace.privileges

get

Returns the collection of currently logged user's privileges.

◆ recents

SortedDictionary<string, Recent> ADAPI.AgentPlace.recents

get

Returns the collection of Recent items for the logged user.

◆ remoteAddress

string ADAPI.AgentPlace.remoteAddress

get

Returns the IP address of the client as it is seen by teh server (public IP address).

◆ serverComments

string ADAPI.AgentPlace.serverComments

get

Returns the comments string of the server the session is logged into.

◆ serverVersion

string ADAPI.AgentPlace.serverVersion

get

Returns version of the server the session is logged into.

◆ services

SortedDictionary<string, Service> ADAPI.AgentPlace.services

get

Returns the collection of the services.

◆ state

UserState ADAPI.AgentPlace.state

get

Returns current user's state.

◆ teamId

string ADAPI.AgentPlace.teamId

get

Returns ID of the team the logged user belongs to.

◆ teams

SortedDictionary<string, Team> ADAPI.AgentPlace.teams

get

Returns the collection of Teams. The list of teams is available immediately after session is successfully logged in.

◆ tenantId

string ADAPI.AgentPlace.tenantId

get

Returns ID of the tenant the logged user belongs to.

◆ users

SortedDictionary<string, User> ADAPI.AgentPlace.users

get

Returns the collection of Users. The list of users is empty after login and is updated every time client application requests the user details with Team.requestMembers() method.

◆ userServices

SortedDictionary<string, Service> ADAPI.AgentPlace.userServices

get

Returns the collection of Services the currently logged user is associated with (can handle these services).

Event Documentation

◆ audioDeviceChangedCallback

AudioDeviceChangedCallback ADAPI.AgentPlace.audioDeviceChangedCallback

Raised when input or output audio device is changed.

◆ callAudioQualityAlertCallback

CallAudioQualityAlertCallback ADAPI.AgentPlace.callAudioQualityAlertCallback

Raised when the audio quality alert is received from the softphone for the call.

◆ callConnectedCallback

CallConnectedCallback ADAPI.AgentPlace.callConnectedCallback

Raised when inbound or outbound call is answered (connected).

◆ callDataChangedCallback

CallDataChangedCallback ADAPI.AgentPlace.callDataChangedCallback

Raised when call data changed.

◆ callDialingCallback

CallDialingCallback ADAPI.AgentPlace.callDialingCallback

Raised when outbound call initiated by AgentPlace.makeCall() is started.

◆ callDigitCallback

CallDigitCallback ADAPI.AgentPlace.callDigitCallback

Raised when DTMF digit is received on call.

◆ callDisconnectedCallback

CallDisconnectedCallback ADAPI.AgentPlace.callDisconnectedCallback

Raised when call is disconnected.

◆ callLocalHeldCallback

CallLocalHeldCallback ADAPI.AgentPlace.callLocalHeldCallback

Raised when call is placed on hold by user as result of Call.hold() request.

◆ callLocalResumedCallback

CallLocalResumedCallback ADAPI.AgentPlace.callLocalResumedCallback

Raised when call is resumed from hold by user as result of Call.resume() request.

◆ callMutedCallback

CallMutedCallback ADAPI.AgentPlace.callMutedCallback

Raised when call is muted (the user's microphone is inactive).

◆ callOfferedCallback

CallOfferedCallback ADAPI.AgentPlace.callOfferedCallback

Raised when new incoming call is offered on the phone device the user is logged with.

◆ callPartyAddedCallback

CallPartyAddedCallback ADAPI.AgentPlace.callPartyAddedCallback

Raised when new party is added to the call.

◆ callPartyChangedCallback

CallPartyChangedCallback ADAPI.AgentPlace.callPartyChangedCallback

Raised when existing call party changed.

◆ callPartyRemovedCallback

CallPartyRemovedCallback ADAPI.AgentPlace.callPartyRemovedCallback

Raised when existign call party left call.

◆ callRecordingChangedCallback

CallRecordingChangedCallback ADAPI.AgentPlace.callRecordingChangedCallback

Raised when call recording status is changed (recording started or stopped). Use Call.isRecording to check recording status.

◆ callRemoteHeldCallback

CallRemoteHeldCallback ADAPI.AgentPlace.callRemoteHeldCallback

Raised when call is placed on hold by remote party.

◆ callRemoteResumedCallback

CallRemoteResumedCallback ADAPI.AgentPlace.callRemoteResumedCallback

Raised when call is resumed from hold by remote party.

◆ callUnmutedCallback

CallUnmutedCallback ADAPI.AgentPlace.callUnmutedCallback

Raised when call mute is cancelled (the user's microphone is active).

◆ connectionDown

ConnectionDown ADAPI.AgentPlace.connectionDown

Raised when connection to the server is lost.

Parameters

session Reference to the AgentSession object which raised the event

◆ connectionUp

ConnectionUp ADAPI.AgentPlace.connectionUp

Raised when connection to the server is established.

Parameters

session Reference to the AgentSession object which raised the event

◆ directoryItemsReceivedCallback

DirectoryItemsReceivedCallback ADAPI.AgentPlace.directoryItemsReceivedCallback

Raised when the list of items for directory category is received. Sent as response to the DirectoryCategory.requestItems() request.

◆ errorCallback

ErrorCallback ADAPI.AgentPlace.errorCallback

Raised when error occures.

◆ itemArrivedCallback

ItemArrivedCallback ADAPI.AgentPlace.itemArrivedCallback

Raised when new item (interaction) is arrived.

◆ itemChangedCallback

ItemChangedCallback ADAPI.AgentPlace.itemChangedCallback

Raised when one of user's Items has changed.

◆ itemCompletedCallback

ItemCompletedCallback ADAPI.AgentPlace.itemCompletedCallback

Raised when one of user's items is completed and being deleted.

◆ itemDispositionsReadyCallback

ItemDispositionsReadyCallback ADAPI.AgentPlace.itemDispositionsReadyCallback

Raised when service dispositions list is received. This event is raised as result of Service.requestDispositions() method.

◆ itemPopupClosedCallback

ItemPopupClosedCallback ADAPI.AgentPlace.itemPopupClosedCallback

Raised when the inbound item popup notification window is closed.

◆ itemPopupShownCallback

ItemPopupShownCallback ADAPI.AgentPlace.itemPopupShownCallback

Raised when the inbound item popup notification window is shown.

◆ itemWorkitemDataReadyCallback

ItemWorkitemDataReadyCallback ADAPI.AgentPlace.itemWorkitemDataReadyCallback

TBD

◆ loggedInCallback

LoggedInCallback ADAPI.AgentPlace.loggedInCallback

Raised when login is completed (successfully or unsuccessfully).

◆ loggedOutCallback

LoggedOutCallback ADAPI.AgentPlace.loggedOutCallback

Raised when session is logged out.

◆ phoneCapabilitiesChangedCallback

PhoneCapabilitiesChangedCallback ADAPI.AgentPlace.phoneCapabilitiesChangedCallback

Raised when user's phone capabilities changed

◆ phoneSnapshotReceivedCallback

PhoneSnapshotReceivedCallback ADAPI.AgentPlace.phoneSnapshotReceivedCallback

Raised when user's phone snapshot received.

◆ recentAddedCallback

RecentAddedCallback ADAPI.AgentPlace.recentAddedCallback

Raised when new Recent object is added into the Recents collection.

◆ screenpopReceivedCallback

ScreenpopReceivedCallback ADAPI.AgentPlace.screenpopReceivedCallback

Raised when screenpop initiation request is received.

◆ screenRecordingCompleted

ScreenRecordingCompleted ADAPI.AgentPlace.screenRecordingCompleted

Raised when screen recording is completed.

◆ screenRecordingMuted

ScreenRecordingMuted ADAPI.AgentPlace.screenRecordingMuted

Raised when screen recording is muted.

◆ screenRecordingStarted

ScreenRecordingStarted ADAPI.AgentPlace.screenRecordingStarted

Raised when screen recording is started. Only one screen recording is allowed at the same time.

◆ screenRecordingUnmuted

ScreenRecordingUnmuted ADAPI.AgentPlace.screenRecordingUnmuted

Raised when screen recording is unmuted.

◆ softphoneStatusCallback

SoftphoneStatusCallback ADAPI.AgentPlace.softphoneStatusCallback

Raised when user's soft phone status changed.

◆ stateChangedCallback

StateChangedCallback ADAPI.AgentPlace.stateChangedCallback

Raised when user's ACD state changed.

◆ teamMembersReceivedCallback

TeamMembersReceivedCallback ADAPI.AgentPlace.teamMembersReceivedCallback

Raised when the list of members for the team is received. Sent as response to Team.requestMembers() request.

◆ userInfoUpdatedCallback

UserInfoUpdatedCallback ADAPI.AgentPlace.userInfoUpdatedCallback

Raised when the user's attributes changed.

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

/Users/avl/projects/Branches/5.3.16/Client/AgentDesktopApi/ADAPI/AgentPlace.cs
/Users/avl/projects/Branches/5.3.16/Client/AgentDesktopApi/ADAPI/AgentPlaceImplementation.cs

Public Member Functions

Static Public Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ AgentPlace()

Member Function Documentation

◆ addToFavorites()

◆ AudioDeviceChangedCallback()

◆ call()

◆ CallAudioQualityAlertCallback()

◆ CallConnectedCallback()

◆ CallDataChangedCallback()

◆ CallDialingCallback()

◆ CallDigitCallback()

◆ CallDisconnectedCallback()

◆ CallLocalHeldCallback()

◆ CallLocalResumedCallback()

◆ CallMutedCallback()

◆ CallOfferedCallback()

◆ CallPartyAddedCallback()

◆ CallPartyChangedCallback()

◆ CallPartyRemovedCallback()

◆ CallRecordingChangedCallback()

◆ CallRemoteHeldCallback()

◆ CallRemoteResumedCallback()

◆ CallUnmutedCallback()

◆ clearState()

◆ ConnectionDown()

◆ ConnectionUp()

◆ DirectoryItemsReceivedCallback()

◆ ErrorCallback()

◆ isFavorite()

◆ item()

◆ ItemArrivedCallback()

◆ ItemChangedCallback()

◆ ItemCompletedCallback()

◆ ItemDispositionsReadyCallback()

◆ ItemPopupClosedCallback()

◆ ItemPopupShownCallback()

◆ ItemWorkitemDataReadyCallback()

◆ LoggedInCallback()

◆ LoggedOutCallback()

◆ logout()

◆ makeCall()

◆ muteScreenRecording()

◆ PhoneCapabilitiesChangedCallback()

◆ PhoneSnapshotReceivedCallback()

◆ RecentAddedCallback()

◆ removeFromFavorites()

◆ ScreenpopReceivedCallback()

◆ ScreenRecordingCompleted()

◆ ScreenRecordingMuted()

◆ ScreenRecordingStarted()

◆ ScreenRecordingUnmuted()

◆ service()

◆ setNotReady()

◆ setReady()

◆ SoftphoneStatusCallback()

◆ StateChangedCallback()

◆ staticInit()

◆ staticTerminate()

◆ team()

◆ TeamMembersReceivedCallback()

◆ unmuteScreenRecording()

◆ user()

◆ UserInfoUpdatedCallback()

Property Documentation

◆ activeItem

◆ audioInDevice

◆ audioOutDevice

◆ calls

◆ directoryCategories

◆ displayNameFormat

◆ favorites

◆ firstName

◆ fullName

◆ isScreenRecording

◆ isScreenRecordingMuted