IClientContext interface

Package:

@microsoft/teams.apps

Properties

appId	This ID is the unique identifier assigned to the app after deployment and is critical for ensuring the correct app instance is recognized across hosts.
appSessionId	Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.
authToken	The MSAL entra token.
channelId	The Microsoft Teams ID for the channel with which the content is associated.
chatId	The Microsoft Teams ID for the chat with which the content is associated.
meetingId	Meeting Id used by tab when running in meeting context
messageId	The ID of the parent message from which this task module was launched. This is only available in task modules launched from bot cards.
pageId	The developer-defined unique ID for the page this content points to.
subPageId	The developer-defined unique ID for the sub-page this content points to. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.
teamId	The Microsoft Teams ID for the team with which the content is associated.
tenantId	The Microsoft Entra tenant ID of the current user.
userId	The Microsoft Entra object id of the current user.

Property Details

appId

This ID is the unique identifier assigned to the app after deployment and is critical for ensuring the correct app instance is recognized across hosts.

appId?: string

Property Value

string

appSessionId

Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.

appSessionId: string

Property Value

string

authToken

The MSAL entra token.

authToken?: string

Property Value

string

channelId

The Microsoft Teams ID for the channel with which the content is associated.

channelId?: string

Property Value

string

chatId

The Microsoft Teams ID for the chat with which the content is associated.

chatId?: string

Property Value

string

meetingId

Meeting Id used by tab when running in meeting context

meetingId?: string

Property Value

string

messageId

The ID of the parent message from which this task module was launched. This is only available in task modules launched from bot cards.

messageId?: string

Property Value

string

pageId

The developer-defined unique ID for the page this content points to.

pageId: string

Property Value

string

subPageId

The developer-defined unique ID for the sub-page this content points to. This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.

subPageId?: string

Property Value

string

teamId

The Microsoft Teams ID for the team with which the content is associated.

teamId?: string

Property Value

string

tenantId

The Microsoft Entra tenant ID of the current user.

tenantId?: string

Property Value

string

userId

The Microsoft Entra object id of the current user.

userId?: string

Property Value

string