Context interface

Package:

@microsoft/teams-js

Represents structure of the received context message.

Properties

actionInfo	Content Action Info
app	Properties about the current session for your app
channel	When running in the context of a Teams channel, provides information about the channel, else undefined
chat	When running in the context of a Teams chat, provides information about the chat, else undefined
dialogParameters	When processActionCommand activates a dialog, this dialog should automatically fill in some fields with information. This information comes from M365 and is given to processActionCommand as extractedParameters. App developers need to use these extractedParameters in their dialog. They help pre-fill the dialog with necessary information (dialogParameters) along with other details. If there's no key/value pairs passed, the object will be empty in the case
meeting	When running in the context of a Teams meeting, provides information about the meeting, else undefined
page	Info about the current page context hosting your app
sharepoint	When hosted in SharePoint, this is the SharePoint PageContext, else undefined
sharePointSite	When running in Teams for an organization with a tenant, provides information about the SharePoint site associated with the team. Will be undefined when not running in Teams for an organization with a tenant.
team	When running in Teams, provides information about the Team context in which your app is running. Will be undefined when not running in Teams.
user	Info about the currently logged in user running the app. If the current user is not logged in/authenticated (e.g. a meeting app running for an anonymously-joined partcipant) this will be undefined.

Property Details

actionInfo

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Content Action Info

actionInfo?: ActionInfo

Property Value

ActionInfo

app

Properties about the current session for your app

app: AppInfo

Property Value

AppInfo

channel

When running in the context of a Teams channel, provides information about the channel, else undefined

channel?: ChannelInfo

Property Value

ChannelInfo

chat

When running in the context of a Teams chat, provides information about the chat, else undefined

chat?: ChatInfo

Property Value

ChatInfo

dialogParameters

When processActionCommand activates a dialog, this dialog should automatically fill in some fields with information. This information comes from M365 and is given to processActionCommand as extractedParameters. App developers need to use these extractedParameters in their dialog. They help pre-fill the dialog with necessary information (dialogParameters) along with other details. If there's no key/value pairs passed, the object will be empty in the case

dialogParameters: Record<string, string>

Property Value

Record<string, string>

meeting

When running in the context of a Teams meeting, provides information about the meeting, else undefined

meeting?: MeetingInfo

Property Value

MeetingInfo

page

Info about the current page context hosting your app

page: PageInfo

Property Value

PageInfo

sharepoint

When hosted in SharePoint, this is the SharePoint PageContext, else undefined

sharepoint?: any

Property Value

any

sharePointSite

When running in Teams for an organization with a tenant, provides information about the SharePoint site associated with the team. Will be undefined when not running in Teams for an organization with a tenant.

sharePointSite?: SharePointSiteInfo

Property Value

SharePointSiteInfo

team

When running in Teams, provides information about the Team context in which your app is running. Will be undefined when not running in Teams.

team?: TeamInfo

Property Value

TeamInfo

user

Info about the currently logged in user running the app. If the current user is not logged in/authenticated (e.g. a meeting app running for an anonymously-joined partcipant) this will be undefined.

user?: UserInfo

Property Value

UserInfo