TabInstance interface

Package:

@microsoft/teams-js

Represents information about a tab instance

Properties

channelId	The Microsoft Teams ID for the channel with which the content is associated.
channelIsFavorite	Is this tab in a favorite channel?
channelName	The name for the channel with which the content is associated.
entityId	The developer-defined unique ID for the entity this content points to.
groupId	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.
lastViewUnixEpochTime	Last viewed time of this tab. null means unknown
tabName	The name of the tab
teamId	The Microsoft Teams ID for the team with which the content is associated.
teamIsFavorite	Is this tab in a favorite team?
teamName	The name for the team with which the content is associated.
url	Content URL of this tab
websiteUrl	Website URL of this tab

Property Details

channelId

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

channelId?: string

Property Value

string

channelIsFavorite

Is this tab in a favorite channel?

channelIsFavorite?: boolean

Property Value

boolean

channelName

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

channelName?: string

Property Value

string

entityId

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

entityId?: string

Property Value

string

groupId

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

string

lastViewUnixEpochTime

Last viewed time of this tab. null means unknown

lastViewUnixEpochTime?: string

Property Value

string

tabName

The name of the tab

tabName: string

Property Value

string

teamId

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

teamId?: string

Property Value

string

teamIsFavorite

Is this tab in a favorite team?

teamIsFavorite?: boolean

Property Value

boolean

teamName

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

teamName?: string

Property Value

string

url

Content URL of this tab

url?: string

Property Value

string

websiteUrl

Website URL of this tab

websiteUrl?: string

Property Value

string