@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
26 lines (25 loc) • 1.12 kB
TypeScript
/**
* Module to open a dialog that sends results to the bot framework
*
* @module
*/
import { BotUrlDialogInfo } from '../../interfaces';
import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
/**
* Allows an app to open a dialog that sends submitted data to a bot.
*
* @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
*
* @returns a function that can be used to send messages to the dialog.
*/
export declare function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
/**
* Checks if dialog.url.bot capability is supported by the host
*
* @returns boolean to represent whether dialog.url.bot is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*/
export declare function isSupported(): boolean;