In-App UI

JavaScript

SDK

MsTeamsClient

MsTeamsClient reference

Complete reference for the Microsoft Teams client in the Knock JavaScript SDK.

Client for interacting with Microsoft Teams integration operations in the Knock API.

Constructor

Initializes a new Microsoft Teams client instance.

Parameters:

instanceKnock

The Knock client instance to use for API requests.

Returns: MsTeamsClient

Methods

`authCheck`

Checks the authentication status for a Microsoft Teams channel integration.

Parameters:

tenantstring

The tenant identifier to check authentication for.

knockChannelIdstring

The Knock channel ID for the Microsoft Teams integration.

Returns: Promise<ApiResponse>

Example:

`getTeams`

Retrieves available Microsoft Teams teams for the authenticated integration.

Parameters:

knockChannelIdstring

The Knock channel ID for the Microsoft Teams integration.

tenantstring

The tenant identifier.

queryOptionsMsTeamsTeamQueryOptions

Optional Microsoft Graph API query parameters for filtering and pagination.

Query Options:

$filterstring

OData filter expression to filter teams (e.g., 'displayName eq 'Marketing Team').

$selectstring

Comma-separated list of properties to include in the response.

$topnumber

Maximum number of teams to return.

$skiptokenstring

Pagination token for retrieving the next set of results.

Returns: Promise<GetMsTeamsTeamsResponse>

Example:

`getChannels`

Retrieves available Microsoft Teams channels for a specific team.

Parameters:

knockChannelIdstring

The Knock channel ID for the Microsoft Teams integration.

teamIdstring

The Microsoft Teams team ID to get channels for.

tenantstring

The tenant identifier.

queryOptionsMsTeamsChannelQueryOptions

Optional Microsoft Graph API query parameters for filtering.

Query Options:

$filterstring

OData filter expression to filter channels (e.g., 'membershipType eq 'standard').

$selectstring

Comma-separated list of properties to include in the response.

Returns: Promise<GetMsTeamsChannelsResponse>

Example:

`revokeAccessToken`

Revokes the access token for a Microsoft Teams integration, effectively disconnecting it.

Parameters:

tenantstring

The tenant identifier.

knockChannelIdstring

The Knock channel ID for the Microsoft Teams integration to revoke access for.

Returns: Promise<ApiResponse>

Example: