adaptiveCard 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.

Subcapability for interacting with adaptive card dialogs

Functions

isSupported()	Checks if dialog.adaptiveCard module is supported by the host
open(AdaptiveCardDialogInfo, DialogSubmitHandler)	Allows app to open an adaptive card based dialog.

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 dialog.adaptiveCard module is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether dialog.adaptiveCard module is supported

open(AdaptiveCardDialogInfo, DialogSubmitHandler)

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.

Allows app to open an adaptive card based dialog.

function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler)

Parameters

adaptiveCardDialogInfo

AdaptiveCardDialogInfo

An object containing the parameters of the dialog module AdaptiveCardDialogInfo.

submitHandler

DialogSubmitHandler

Handler that triggers when a dialog calls the submit(string | object, string | string[]) function or when the user closes the dialog.

Remarks

This function cannot be called from inside of a dialog