bot 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 open a dialog that sends results to the bot framework

Functions

isSupported()	Checks if dialog.url.bot capability is supported by the host
open(BotUrlDialogInfo, DialogSubmitHandler, PostMessageChannel)	Allows an app to open a dialog that sends submitted data to a bot.

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.url.bot capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether dialog.url.bot is supported

open(BotUrlDialogInfo, DialogSubmitHandler, PostMessageChannel)

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 an app to open a dialog that sends submitted data to a bot.

function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel)

Parameters

botUrlDialogInfo

BotUrlDialogInfo

An object containing the parameters of the dialog module including completionBotId.

submitHandler

DialogSubmitHandler

Handler that triggers when the dialog has been submitted or closed.

messageFromChildHandler

PostMessageChannel

Handler that triggers if dialog sends a message to the app.