appInstallDialog module

Package:

@microsoft/teams-js

Interfaces

OpenAppInstallDialogParams

Represents set of parameters needed to open the appInstallDialog.

Functions

isSupported()	Checks if the appInstallDialog capability is supported by the host
openAppInstallDialog(OpenAppInstallDialogParams)	Displays a dialog box that allows users to install a specific app within the host environment.

Function Details

isSupported()

Checks if the appInstallDialog capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the appInstallDialog capability is supported

openAppInstallDialog(OpenAppInstallDialogParams)

Displays a dialog box that allows users to install a specific app within the host environment.

function openAppInstallDialog(openAPPInstallDialogParams: OpenAppInstallDialogParams): Promise<void>

Parameters

openAPPInstallDialogParams

OpenAppInstallDialogParams

See OpenAppInstallDialogParams for more information.

Returns

Promise<void>