Share via

DialogInfo interface

  • Reference
Package:
@microsoft/teams-js

Data structure to describe dialog information

Properties

card

JSON defining an adaptive card.
completionBotId

Specifies a bot ID to send the result of the user's interaction with the task module. If specified, the bot will receive a task/complete invoke event with a JSON object in the event payload.
fallbackUrl

If client doesnt support the URL, the URL that needs to be opened in the browser.
height

The requested height of the webview/iframe.
title

Title of the task module.
url

The url to be rendered in the webview/iframe.
width

The requested width of the webview/iframe.

Property Details

card

JSON defining an adaptive card.

card?: string

Property Value

string

completionBotId

Specifies a bot ID to send the result of the user's interaction with the task module. If specified, the bot will receive a task/complete invoke event with a JSON object in the event payload.

completionBotId?: string

Property Value

string

fallbackUrl

If client doesnt support the URL, the URL that needs to be opened in the browser.

fallbackUrl?: string

Property Value

string

height

The requested height of the webview/iframe.

height?: number | DialogDimension

Property Value

number | DialogDimension

title

Title of the task module.

title?: string

Property Value

string

url

The url to be rendered in the webview/iframe.

url?: string

Property Value

string

Remarks

The domain of the url must match at least one of the valid domains specified in the validDomains block of the manifest

width

The requested width of the webview/iframe.

width?: number | DialogDimension

Property Value

number | DialogDimension