Partager via

dialog module

  • Reference
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.

This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and Adaptive Card dialogs. Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.

  • URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
    • For URL dialogs, use the functions and interfaces in the url namespace.
  • Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
    • For Adaptive Card dialogs, use the functions and interfaces in the adaptiveCard namespace.

Interfaces

ISdkResponse

Data Structure to represent the SDK response when dialog closes

Type Aliases

DialogSubmitHandler

Handler used for receiving results when a dialog closes, either the value passed by submit(string | object, string | string[]) or an error if the dialog was closed by the user.

See ISdkResponse
PostMessageChannel

Handler used to receive and process messages sent between a dialog and the app that launched it