@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
49 lines (48 loc) • 2.24 kB
TypeScript
/**
* @beta
* @hidden
* Module to delegate adaptive card action for Custom Engine Agent execution to the host
* @internal
* Limited to Microsoft-internal use
* @module
*/
import { AppId } from '../public';
import * as externalAppCardActions from './externalAppCardActions';
/**
* @beta
* @hidden
* Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
* @internal
* Limited to Microsoft-internal use
* @param appId ID of the application the request is intended for. This must be a UUID
* @param conversationId To tell the bot what conversation the calls are coming from
* @param url The URL to open
* @throws Error if the response has not successfully completed
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
*/
export declare function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<externalAppCardActions.ActionOpenUrlType>;
/**
* @beta
* @hidden
* Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
* @internal
* Limited to Microsoft-internal use
* @param appId ID of the application the request is intended for. This must be a UUID
* @param conversationId To tell the bot what conversation the calls are coming from
* @param actionSubmitPayload The Adaptive Card Action.Submit payload
* @throws Error if host notifies of an error
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
*/
export declare function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: externalAppCardActions.IAdaptiveCardActionSubmit): Promise<void>;
/**
* @beta
* @hidden
* Checks if the externalAppCardActionsForCEA capability is supported by the host
* @returns boolean to represent whether externalAppCardActions capability is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function isSupported(): boolean;