Class TeamService

Class to perform get agents by team id

Hierarchy

TeamService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TeamService(): TeamService

- Defined in agent-sdk/src/lib/directory/service/team-service.ts:25
Create instance of CXoneAuth
```
@example
const TeamService = new TeamService();
```
Returns TeamService

Properties

Private auth

auth: CXoneAuth

Protected logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Methods

getTeamById

getTeamById(fetchAgentByTeamIdReq: TeamsAgentRequest): Promise<Team | CXoneSdkError>

- Defined in agent-sdk/src/lib/directory/service/team-service.ts:37
Used to get the agent list details based on the team id
example
```
this.TeamService.getTeamById("123456");
```
Parameters
- fetchAgentByTeamIdReq: TeamsAgentRequest
Returns Promise<Team | CXoneSdkError>

getTeamDetailsById

getTeamDetailsById(teamId?: string): Promise<Team | CXoneSdkError>

- Defined in agent-sdk/src/lib/directory/service/team-service.ts:95
Used to get team details based on team id
example
```
this.TeamService.getTeamDetailsById("123456");
```
Parameters
- Optional teamId: string
  
  team id to fetch details
Returns Promise<Team | CXoneSdkError>

Private searchAgents

searchAgents(team: Team, searchText: string, offset: number, limit: number): Team

- Defined in agent-sdk/src/lib/directory/service/team-service.ts:70
Used to get the agent list details based on the team id
example
Parameters
- team: Team
- searchText: string
- offset: number
- limit: number
Returns Team

Generated using TypeDoc