Context interface

Personal app icon y coordinate position

appIconPosition?: number

Property Value

ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data.

appLaunchId?: string

Property Value

Unique ID for the current session for use in correlating telemetry data.

appSessionId?: string

Property Value

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

channelId?: string

Property Value

The name for the channel with which the content is associated.

channelName?: string

Property Value

The relative path to the SharePoint folder associated with the channel.

channelRelativeUrl?: string

Property Value

The type of the channel with which the content is associated.

channelType?: ChannelType

Property Value

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

chatId?: string

Property Value

The OneNote section ID that is linked to the channel.

defaultOneNoteSectionId?: string

Property Value

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

entityId: string

Property Value

The context where tab url is loaded (content, task, setting, remove, sidePanel).

frameContext?: FrameContexts

Property Value

The Office 365 group ID for the team with which the content is associated. This field is available only when the identity permission is requested in the manifest.

groupId?: string

Property Value

The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead), * surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays

hostClientType?: HostClientType

Property Value

The AAD group ID of the host team.

hostTeamGroupId?: string

Property Value

The tenant ID of the host team.

hostTeamTenantId?: string

Property Value

Represents whether calling is allowed for the current logged in User

isCallingAllowed?: boolean

Property Value

Indication whether the tab is in full-screen mode.

isFullScreen?: boolean

Property Value

Indication whether the tab is in a pop out window

isMultiWindow?: boolean

Property Value

Represents whether PSTN calling is allowed for the current logged in User

isPSTNCallingAllowed?: boolean

Property Value

Indicates whether team is archived. Apps should use this as a signal to prevent any changes to content associated with archived teams.

isTeamArchived?: boolean

Property Value

The current locale that the user has configured for the app formatted as languageId-countryId (for example, en-us).

locale: string

Property Value

A value suitable for use as a login_hint when authenticating with Azure AD. Because a malicious party can run your content in a browser, this value should be used only as a hint as to who the user is and never as proof of identity. This field is available only when the identity permission is requested in the manifest.

loginHint?: string

Property Value

Meeting Id used by tab when running in meeting context

meetingId?: string

Property Value

The SharePoint my site domain associated with the user.

mySiteDomain?: string

Property Value

The SharePoint relative path to the current users mysite

mySitePath?: string

Property Value

More detailed locale info from the user's OS if available. Can be used together with the @microsoft/globe NPM package to ensure your app respects the user's OS date and time format configuration.

osLocaleInfo?: LocaleInfo

Property Value

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

parentMessageId?: string

Property Value

Current ring ID

ringId?: string

Property Value

Unique ID for the current Teams session for use in correlating telemetry data.

sessionId?: string

Property Value

SharePoint context. This is only available when hosted in SharePoint.

sharepoint?: any

Property Value

Source origin from where the tab is opened

sourceOrigin?: string

Property Value

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

subEntityId?: string

Property Value

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

teamId?: string

Property Value

The name for the team with which the content is associated.

teamName?: string

Property Value

The domain of the root SharePoint site associated with the team.

teamSiteDomain?: string

Property Value

Teamsite ID, aka sharepoint site id.

teamSiteId?: string

Property Value

The relative path to the SharePoint site associated with the team.

teamSitePath?: string

Property Value

The root SharePoint site associated with the team.

teamSiteUrl?: string

Property Value

Team Template ID if there was a Team Template associated with the creation of the team.

teamTemplateId?: string

Property Value

The type of the team.

teamType?: TeamType

Property Value

The type of license for the current users tenant.

tenantSKU?: string

Property Value

The current UI theme.

theme?: string

Property Value

The Azure AD tenant ID of the current user. Because a malicious party can run your content in a browser, this value should be used only as a hint as to who the user is and never as proof of identity. This field is available only when the identity permission is requested in the manifest.

tid?: string

Property Value

upn?: string

Property Value

Time when the user clicked on the tab

userClickTime?: number

Property Value

Where the user prefers the file to be opened from by default during file open.

userFileOpenPreference?: FileOpenPreference

Property Value

The license type for the current user.

userLicenseType?: string

Property Value

The Azure AD object id of the current user. Because a malicious party run your content in a browser, this value should be used only as a hint as to who the user is and never as proof of identity. This field is available only when the identity permission is requested in the manifest.

userObjectId?: string

Property Value

The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users). Because a malicious party run your content in a browser, this value should be used only as a hint as to who the user is and never as proof of identity. This field is available only when the identity permission is requested in the manifest.

userPrincipalName?: string

Property Value

The user's role in the team. Because a malicious party can run your content in a browser, this value should be used only as a hint as to the user's role, and never as proof of her role.

userTeamRole?: UserTeamRole

Property Value