Class describes a team of users. More...

Public Member Functions
void	requestMembers (bool includeLoggedOut)
	Requests detailed information about team members. The AgentPlace.teamMembersReceivedCallback event is raised once the results are received from the server. More...

void	subscribe ()
	Subscribe to receive nofitications about team's users status changes. Only one subscription is allowed at time, meaning calling sunscribe() on team object will autiomatically cancel existing subscription on another team (if any). More...

void	unsubscribe ()
	Cancels the subscription for that team members. More...

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

string	name `[get]`
	Team display name. More...

int	usersCount `[get]`
	Number of users in that team. More...

bool	isSupervised `[get]`
	Specifies if teh user who owns API session may supervise the team. More...

SortedDictionary< string, User >	members `[get]`
	Collection of team members (users). More...

Detailed Description

Class describes a team of users.

Member Function Documentation

◆ requestMembers()

void ADAPI.Team.requestMembers ( bool includeLoggedOut )

Requests detailed information about team members. The AgentPlace.teamMembersReceivedCallback event is raised once the results are received from the server.

Parameters

includeLoggedOut Specifies if information about users who are logged out should also be included. If False, only teams members whoc are currently logged in will be considered

◆ subscribe()

void ADAPI.Team.subscribe ( )

Subscribe to receive nofitications about team's users status changes. Only one subscription is allowed at time, meaning calling sunscribe() on team object will autiomatically cancel existing subscription on another team (if any).

◆ unsubscribe()

void ADAPI.Team.unsubscribe ( )

Cancels the subscription for that team members.

Property Documentation

◆ id

string ADAPI.Team.id

get

Unique team ID.

◆ isSupervised

bool ADAPI.Team.isSupervised

get

Specifies if teh user who owns API session may supervise the team.

◆ members

SortedDictionary<string, User> ADAPI.Team.members

get

Collection of team members (users).

◆ name

string ADAPI.Team.name

get

Team display name.

◆ usersCount

int ADAPI.Team.usersCount

get

Number of users in that team.

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

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

Public Member Functions

Properties