Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamService

Class to perform get agents by team id

Hierarchy

  • TeamService

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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

  • Used to get the agent list details based on the team id

    example
    this.TeamService.getTeamById("123456");

    Parameters

    Returns Promise<Team | CXoneSdkError>

getTeamDetailsById

  • 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

  • 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