StageViewParams interface

Package:

@microsoft/teams-js

Parameters to open a stage view.

Properties

appId	The ID of the Teams application to be opened.
contentUrl	The URL of the content to display.
entityId	The entity ID of the Teams application content being opened.
openMode	The open mode for stage content. Optional param: if not passed, hosts can choose their default openMode. If a host does not support any specific openMode, It will fallback to StageViewOpenMode.modal.
threadId	The chat or channel ID.
title	The title to give the stage view.
websiteUrl	The Teams application website URL.

Property Details

appId

The ID of the Teams application to be opened.

appId: string

Property Value

string

contentUrl

The URL of the content to display.

contentUrl: string

Property Value

string

entityId

The entity ID of the Teams application content being opened.

entityId?: string

Property Value

string

openMode

The open mode for stage content. Optional param: if not passed, hosts can choose their default openMode. If a host does not support any specific openMode, It will fallback to StageViewOpenMode.modal.

openMode?: StageViewOpenMode

Property Value

StageViewOpenMode

threadId

The chat or channel ID.

threadId: string

Property Value

string

title

The title to give the stage view.

title?: string

Property Value

string

websiteUrl

The Teams application website URL.

websiteUrl?: string

Property Value

string