BotUrlDialogInfo interface

Package:

@microsoft/teams-js

Data structure to describe dialog information needed to open a bot based dialog.

Extends

UrlDialogInfo

Properties

completionBotId

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

Inherited Properties

fallbackUrl	If client doesnt support the URL, the URL that needs to be opened in the browser.
size	The requested size of the dialog
title	Title of the dialog module.
url	The url to be rendered in the webview/iframe.

Property Details

completionBotId

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

completionBotId: string

Property Value

string

Inherited Property Details

fallbackUrl

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

fallbackUrl?: string

Property Value

string

Inherited From UrlDialogInfo.fallbackUrl

size

The requested size of the dialog

size: DialogSize

Property Value

DialogSize

Inherited From UrlDialogInfo.size

title

Title of the dialog module.

title?: string

Property Value

string

Inherited From UrlDialogInfo.title

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 app manifest

Inherited From UrlDialogInfo.url