TeamInfo interface

Package:

@microsoft/teams-js

Represents Team information.

Properties

displayName	The name for the team with which the content is associated.
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.
internalId	The Microsoft Teams ID for the team with which the content is associated.
isArchived	Indicates whether team is archived. Apps should use this as a signal to prevent any changes to content associated with archived teams.
templateId	Team Template ID if there was a Team Template associated with the creation of the team.
type	The type of the team.
userRole	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.

Property Details

displayName

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

displayName?: 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

internalId

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

internalId: string

Property Value

string

isArchived

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

isArchived?: boolean

Property Value

boolean

templateId

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

templateId?: string

Property Value

string

type

The type of the team.

type?: TeamType

Property Value

TeamType

userRole

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.

userRole?: UserTeamRole

Property Value

UserTeamRole