ADAPI.CallParty Class Reference

Class described the single party of phone call. More...

Public Member Functions
bool	isOwned ()
	Specifies if call party belongs to the same scenario the user's belongs to. In case of conference, user may only remove parties which are added by him. More...

Properties
string	id [get]
	Unique ID of the party . More...
Call	call [get]
	Reference to the parent Call object this party belongs to. More...
bool	hold [get]
	Specifies if this party is placed on hold. More...
string	bridgeId [get]
	Returns ID of the bridge the party is added to. More...
string	remoteStepId [get]
	Returns remote interaction step ID. More...
string	userId [get]
	Returns ID of the user associated with party, if any. More...
User?	user [get]
	Reference to the User object associated with the party, if any. More...
PartyConnectMode	mode [get]
	Returns the mode this party is connected to the bridge in. More...
string	name [get]
	Returns party's name. More...
string	number [get]
	Returns party's phone number More...
PhoneType	phoneType [get]
	Returns party phone type. More...
PartyRole	role [get]
	Returns role of the party. More...

Detailed Description

Class described the single party of phone call.

Member Function Documentation

isOwned()

bool ADAPI.CallParty.isOwned

(

)

Specifies if call party belongs to the same scenario the user's belongs to. In case of conference, user may only remove parties which are added by him.

Returns

Property Documentation

bridgeId

string ADAPI.CallParty.bridgeId

get

Returns ID of the bridge the party is added to.

call

Call ADAPI.CallParty.call

get

Reference to the parent Call object this party belongs to.

hold

bool ADAPI.CallParty.hold

get

Specifies if this party is placed on hold.

id

string ADAPI.CallParty.id

get

Unique ID of the party .

mode

PartyConnectMode ADAPI.CallParty.mode

get

Returns the mode this party is connected to the bridge in.

name

string ADAPI.CallParty.name

get

Returns party's name.

number

string ADAPI.CallParty.number

get

Returns party's phone number

phoneType

PhoneType ADAPI.CallParty.phoneType

get

Returns party phone type.

remoteStepId

string ADAPI.CallParty.remoteStepId

get

Returns remote interaction step ID.

role

PartyRole ADAPI.CallParty.role

get

Returns role of the party.

user

User? ADAPI.CallParty.user

get

Reference to the User object associated with the party, if any.

userId

string ADAPI.CallParty.userId

get

Returns ID of the user associated with party, if any.

---

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

• /Users/avl/projects/Branches/5.3.16/Client/AgentDesktopApi/ADAPI/AuxClasses.cs