stageView module

Package:

@microsoft/teams-js

Note

This namespace 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.

Namespace to interact with the stage view specific part of the SDK.

Interfaces

StageViewParams

Parameters to open a stage view.

Enums

StageViewOpenMode

The open mode for stage content.

Functions

isSupported()	Checks if stageView capability is supported by the host
open(StageViewParams)	Opens a stage view to display a Teams application

Function Details

isSupported()

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.

Checks if stageView capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the stageView capability is supported

open(StageViewParams)

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.

Opens a stage view to display a Teams application

function open(stageViewParams: StageViewParams): Promise<void>

Parameters

stageViewParams

StageViewParams

The parameters to pass into the stage view.

Returns

Promise<void>

Promise that resolves or rejects with an error once the stage view is closed.