Class UnbluTeamsApi

Provides read access to the account's teams

Index

Constructors

Methods

Constructors

constructor

new UnbluTeamsApi(
teamsModule: TeamsModule,
apiStateProvider: ApiStateProvider,
): UnbluTeamsApi
Parameters
- teamsModule: TeamsModule
- apiStateProvider: ApiStateProvider
Returns UnbluTeamsApi
- Defined in agent-embedded-js-api/src/unblu-teams-api.ts:13

Methods

get

get(teamId: string): Promise<Team>
Returns the team with the given ID.

The name and description of the team are returned in the agent's language if a translation for them exists.
Parameters
- teamId: string
  The ID of the team to return
Returns Promise<Team>
The team with the given ID

Throws
UnbluApiError with type UnbluErrorType.ILLEGAL_STATE if the API instance is deinitialized.

Throws
UnbluApiError with type UnbluErrorType.INVALID_FUNCTION_ARGUMENTS if the team doesn't exist or can't be accessed.
- Defined in agent-embedded-js-api/src/unblu-teams-api.ts:29

getTeams

getTeams(): Promise<Team[]>
Returns a list of all teams of the account.

The name and description of each team are returned in the agent's language if a translation for them exists.

Returns Promise<Team[]>
A list of all teams of the account

Throws
UnbluApiError with type UnbluErrorType.ILLEGAL_STATE if the API instance is deinitialized.
- Defined in agent-embedded-js-api/src/unblu-teams-api.ts:43