@microsoft/teams-js 2.31.0-beta.1 → 2.31.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +4 -4
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +11 -1
- package/dist/esm/packages/teams-js/dts/internal/appIdValidation.d.ts +10 -0
- package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +11 -1
- package/dist/esm/packages/teams-js/dts/internal/hostToAppTelemetry.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +11 -0
- package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +5 -0
- package/dist/esm/packages/teams-js/dts/internal/pagesHelpers.d.ts +24 -0
- package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +23 -1
- package/dist/esm/packages/teams-js/dts/internal/uint8array-extras/uint8array-extras.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +20 -1
- package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +2 -2
- package/dist/esm/packages/teams-js/dts/internal/visualMediaHelpers.d.ts +14 -0
- package/dist/esm/packages/teams-js/dts/internal/webStorageHelpers.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +61 -61
- package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +48 -48
- package/dist/esm/packages/teams-js/dts/private/copilot/copilot.d.ts +2 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/eligibility.d.ts +29 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +355 -349
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +70 -68
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +104 -105
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +41 -42
- package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +113 -114
- package/dist/esm/packages/teams-js/dts/private/files.d.ts +590 -582
- package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts +42 -0
- package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts +134 -0
- package/dist/esm/packages/teams-js/dts/private/index.d.ts +19 -18
- package/dist/esm/packages/teams-js/dts/private/logs.d.ts +31 -25
- package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +147 -142
- package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts +28 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +31 -25
- package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +69 -70
- package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +219 -214
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/fullTrust.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/joinedTeams.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/private/teams/teams.d.ts +63 -0
- package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +192 -186
- package/dist/esm/packages/teams-js/dts/public/app/app.d.ts +21 -2
- package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +3 -2
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +1 -1
- package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/call.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/chat.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +0 -4
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +3 -2
- package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +0 -13
- package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +3 -2
- package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +3 -2
- package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +9 -9
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +11 -0
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +4 -3
- package/dist/esm/packages/teams-js/dts/public/mail.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +0 -3
- package/dist/esm/packages/teams-js/dts/public/meeting/appShareButton.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/public/meeting/meeting.d.ts +854 -0
- package/dist/esm/packages/teams-js/dts/public/menus.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +8 -0
- package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts +44 -0
- package/dist/esm/packages/teams-js/dts/public/pages/config.d.ts +123 -0
- package/dist/esm/packages/teams-js/dts/public/pages/currentApp.d.ts +46 -0
- package/dist/esm/packages/teams-js/dts/public/pages/fullTrust.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/pages/pages.d.ts +253 -0
- package/dist/esm/packages/teams-js/dts/public/pages/tabs.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/public/profile.d.ts +81 -103
- package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +3 -0
- package/dist/esm/packages/teams-js/dts/public/search.d.ts +9 -0
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/settings.d.ts +4 -3
- package/dist/esm/packages/teams-js/dts/public/sharing/history.d.ts +47 -0
- package/dist/esm/packages/teams-js/dts/public/sharing/sharing.d.ts +76 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/self.d.ts +23 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/stageView.d.ts +81 -0
- package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +0 -8
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +209 -210
- package/dist/esm/packages/teams-js/dts/public/visualMedia/image.d.ts +64 -0
- package/dist/esm/packages/teams-js/dts/public/visualMedia/visualMedia.d.ts +116 -0
- package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +20 -22
- package/dist/esm/packages/teams-js/src/index.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/appIdValidation.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/communication.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/handlers.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/hostToAppTelemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/messageObjects.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/pagesHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/uint8array-extras/uint8array-extras.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/utils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/validOrigins.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/videoEffectsUtils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/visualMediaHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/webStorageHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/private/appEntity.js +1 -1
- package/dist/esm/packages/teams-js/src/private/conversations.js +1 -1
- package/dist/esm/packages/teams-js/src/private/copilot/copilot.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/eligibility.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCommands.js +1 -1
- package/dist/esm/packages/teams-js/src/private/files.js +1 -1
- package/dist/esm/packages/teams-js/src/private/hostEntity/hostEntity.js +1 -0
- package/dist/esm/packages/teams-js/src/private/hostEntity/tab.js +1 -0
- package/dist/esm/packages/teams-js/src/private/logs.js +1 -1
- package/dist/esm/packages/teams-js/src/private/meetingRoom.js +1 -1
- package/dist/esm/packages/teams-js/src/private/messageChannels/dataLayer.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/messageChannels.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/telemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/private/notifications.js +1 -1
- package/dist/esm/packages/teams-js/src/private/otherAppStateChange.js +1 -1
- package/dist/esm/packages/teams-js/src/private/remoteCamera.js +1 -1
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/joinedTeams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/teams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -1
- package/dist/esm/packages/teams-js/src/public/app/app.js +1 -1
- package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
- package/dist/esm/packages/teams-js/src/public/meeting/appShareButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/meeting/meeting.js +1 -0
- package/dist/esm/packages/teams-js/src/public/navigation.js +1 -1
- package/dist/esm/packages/teams-js/src/public/pages/appButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/backStack.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/config.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/currentApp.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/pages.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/tabs.js +1 -0
- package/dist/esm/packages/teams-js/src/public/profile.js +1 -1
- package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
- package/dist/esm/packages/teams-js/src/public/runtime.js +1 -1
- package/dist/esm/packages/teams-js/src/public/settings.js +1 -1
- package/dist/esm/packages/teams-js/src/public/sharing/history.js +1 -0
- package/dist/esm/packages/teams-js/src/public/sharing/sharing.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/self.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/stageView.js +1 -0
- package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
- package/dist/esm/packages/teams-js/src/public/version.js +1 -1
- package/dist/esm/packages/teams-js/src/public/videoEffects.js +1 -1
- package/dist/esm/packages/teams-js/src/public/visualMedia/image.js +1 -0
- package/dist/esm/packages/teams-js/src/public/visualMedia/visualMedia.js +1 -0
- package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
- package/dist/umd/MicrosoftTeams.d.ts +5755 -5161
- package/dist/umd/MicrosoftTeams.js +6258 -6439
- package/dist/umd/MicrosoftTeams.js.map +1 -1
- package/dist/umd/MicrosoftTeams.min.js +1 -1
- package/dist/umd/MicrosoftTeams.min.js.map +1 -1
- package/package.json +50 -1
- package/dist/esm/packages/teams-js/dts/private/copilot.d.ts +0 -39
- package/dist/esm/packages/teams-js/dts/private/hostEntity.d.ts +0 -176
- package/dist/esm/packages/teams-js/dts/private/messageChannels.d.ts +0 -107
- package/dist/esm/packages/teams-js/dts/private/teams.d.ts +0 -116
- package/dist/esm/packages/teams-js/dts/public/meeting.d.ts +0 -906
- package/dist/esm/packages/teams-js/dts/public/pages.d.ts +0 -574
- package/dist/esm/packages/teams-js/dts/public/sharing.d.ts +0 -124
- package/dist/esm/packages/teams-js/dts/public/stageView.d.ts +0 -104
- package/dist/esm/packages/teams-js/dts/public/visualMedia.d.ts +0 -192
- package/dist/esm/packages/teams-js/src/private/copilot.js +0 -1
- package/dist/esm/packages/teams-js/src/private/hostEntity.js +0 -1
- package/dist/esm/packages/teams-js/src/private/messageChannels.js +0 -1
- package/dist/esm/packages/teams-js/src/private/teams.js +0 -1
- package/dist/esm/packages/teams-js/src/public/meeting.js +0 -1
- package/dist/esm/packages/teams-js/src/public/pages.js +0 -1
- package/dist/esm/packages/teams-js/src/public/sharing.js +0 -1
- package/dist/esm/packages/teams-js/src/public/stageView.js +0 -1
- package/dist/esm/packages/teams-js/src/public/visualMedia.js +0 -1
- /package/dist/esm/node_modules/.pnpm/{@rollup_plugin-typescript@11.1.6_rollup@4.24.0_tslib@2.6.3_typescript@4.9.5 → @rollup_plugin-typescript@11.1.6_rollup@4.24.4_tslib@2.6.3_typescript@4.9.5}/node_modules/tslib/tslib.es6.js +0 -0
@@ -1,75 +1,77 @@
|
|
1
1
|
import { AppId } from '../public';
|
2
|
-
import
|
2
|
+
import * as externalAppAuthentication from './externalAppAuthentication';
|
3
3
|
/**
|
4
|
+
* @beta
|
5
|
+
* @hidden
|
6
|
+
* Signals to the host to perform SSO authentication for the application specified by the app ID, and then send the authResult to the application backend.
|
7
|
+
* @internal
|
8
|
+
* Limited to Microsoft-internal use
|
9
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
10
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
11
|
+
* @param authTokenRequest Parameters for SSO authentication
|
12
|
+
* @throws InvokeError if the host encounters an error while authenticating
|
13
|
+
* @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
|
14
|
+
*/
|
15
|
+
export declare function authenticateWithSSO(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters): Promise<void>;
|
16
|
+
/**
|
17
|
+
* @beta
|
4
18
|
* @hidden
|
5
|
-
*
|
19
|
+
* Signals to the host to perform authentication using the given authentication parameters and then send the auth result to the application backend.
|
6
20
|
* @internal
|
7
21
|
* Limited to Microsoft-internal use
|
22
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
23
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
24
|
+
* @param authenticateParameters Parameters for the authentication pop-up
|
25
|
+
* @throws InvokeError if the host encounters an error while authenticating
|
26
|
+
* @returns A promise that resolves from the application backend and rejects with InvokeError if the host encounters an error while authenticating
|
27
|
+
*/
|
28
|
+
export declare function authenticateWithOauth(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters): Promise<void>;
|
29
|
+
/**
|
30
|
+
* @beta
|
31
|
+
* @hidden
|
32
|
+
* Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application backend with the authentication result.
|
33
|
+
* @internal
|
34
|
+
* Limited to Microsoft-internal use
|
35
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
36
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
37
|
+
* @param authenticateParameters Parameters for the authentication pop-up
|
38
|
+
* @param originalRequestInfo Information about the original request that should be resent
|
39
|
+
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
40
|
+
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
41
|
+
*/
|
42
|
+
export declare function authenticateAndResendRequest(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
43
|
+
/**
|
8
44
|
* @beta
|
45
|
+
* @hidden
|
46
|
+
* Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result and originalRequestInfo
|
47
|
+
* @internal
|
48
|
+
* Limited to Microsoft-internal use
|
49
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
50
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
51
|
+
* @param authTokenRequest Parameters for SSO authentication
|
52
|
+
* @param originalRequestInfo Information about the original request that should be resent
|
53
|
+
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
54
|
+
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
55
|
+
*/
|
56
|
+
export declare function authenticateWithSSOAndResendRequest(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
57
|
+
/**
|
58
|
+
* @beta
|
59
|
+
* @hidden
|
60
|
+
* Checks if the externalAppAuthenticationForCEA capability is supported by the host
|
61
|
+
* @returns boolean to represent whether externalAppAuthenticationForCEA capability is supported
|
62
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
63
|
+
* @internal
|
64
|
+
* Limited to Microsoft-internal use
|
65
|
+
*/
|
66
|
+
export declare function isSupported(): boolean;
|
67
|
+
/**
|
68
|
+
* @hidden
|
69
|
+
* Checks if the input is valid
|
70
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
71
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
72
|
+
|
73
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
74
|
+
* @internal
|
75
|
+
* Limited to Microsoft-internal use
|
9
76
|
*/
|
10
|
-
export declare
|
11
|
-
/**
|
12
|
-
* @beta
|
13
|
-
* @hidden
|
14
|
-
* Signals to the host to perform SSO authentication for the application specified by the app ID, and then send the authResult to the application backend.
|
15
|
-
* @internal
|
16
|
-
* Limited to Microsoft-internal use
|
17
|
-
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
18
|
-
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
19
|
-
* @param authTokenRequest Parameters for SSO authentication
|
20
|
-
* @throws InvokeError if the host encounters an error while authenticating
|
21
|
-
* @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
|
22
|
-
*/
|
23
|
-
function authenticateWithSSO(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters): Promise<void>;
|
24
|
-
/**
|
25
|
-
* @beta
|
26
|
-
* @hidden
|
27
|
-
* Signals to the host to perform authentication using the given authentication parameters and then send the auth result to the application backend.
|
28
|
-
* @internal
|
29
|
-
* Limited to Microsoft-internal use
|
30
|
-
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
31
|
-
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
32
|
-
* @param authenticateParameters Parameters for the authentication pop-up
|
33
|
-
* @throws InvokeError if the host encounters an error while authenticating
|
34
|
-
* @returns A promise that resolves from the application backend and rejects with InvokeError if the host encounters an error while authenticating
|
35
|
-
*/
|
36
|
-
function authenticateWithOauth(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters): Promise<void>;
|
37
|
-
/**
|
38
|
-
* @beta
|
39
|
-
* @hidden
|
40
|
-
* Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application backend with the authentication result.
|
41
|
-
* @internal
|
42
|
-
* Limited to Microsoft-internal use
|
43
|
-
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
44
|
-
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
45
|
-
* @param authenticateParameters Parameters for the authentication pop-up
|
46
|
-
* @param originalRequestInfo Information about the original request that should be resent
|
47
|
-
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
48
|
-
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
49
|
-
*/
|
50
|
-
function authenticateAndResendRequest(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
51
|
-
/**
|
52
|
-
* @beta
|
53
|
-
* @hidden
|
54
|
-
* Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result and originalRequestInfo
|
55
|
-
* @internal
|
56
|
-
* Limited to Microsoft-internal use
|
57
|
-
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
58
|
-
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
59
|
-
* @param authTokenRequest Parameters for SSO authentication
|
60
|
-
* @param originalRequestInfo Information about the original request that should be resent
|
61
|
-
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
62
|
-
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
63
|
-
*/
|
64
|
-
function authenticateWithSSOAndResendRequest(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
65
|
-
/**
|
66
|
-
* @beta
|
67
|
-
* @hidden
|
68
|
-
* Checks if the externalAppAuthenticationForCEA capability is supported by the host
|
69
|
-
* @returns boolean to represent whether externalAppAuthenticationForCEA capability is supported
|
70
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
71
|
-
* @internal
|
72
|
-
* Limited to Microsoft-internal use
|
73
|
-
*/
|
74
|
-
function isSupported(): boolean;
|
75
|
-
}
|
77
|
+
export declare function validateInput(appId: AppId, conversationId: string): void;
|
@@ -1,112 +1,111 @@
|
|
1
|
+
/**
|
2
|
+
* @hidden
|
3
|
+
* Module to delegate adaptive card action execution to the host
|
4
|
+
* @internal
|
5
|
+
* Limited to Microsoft-internal use
|
6
|
+
* @module
|
7
|
+
*/
|
1
8
|
import { ExternalAppErrorCode } from './constants';
|
2
9
|
/**
|
3
10
|
* @hidden
|
4
|
-
*
|
11
|
+
* The type of deeplink action that was executed by the host
|
12
|
+
* @internal
|
13
|
+
* Limited to Microsoft-internal use
|
14
|
+
*/
|
15
|
+
export declare enum ActionOpenUrlType {
|
16
|
+
DeepLinkDialog = "DeepLinkDialog",
|
17
|
+
DeepLinkOther = "DeepLinkOther",
|
18
|
+
DeepLinkStageView = "DeepLinkStageView",
|
19
|
+
GenericUrl = "GenericUrl"
|
20
|
+
}
|
21
|
+
/**
|
22
|
+
* @beta
|
23
|
+
* @hidden
|
24
|
+
* Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
25
|
+
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
26
|
+
*
|
27
|
+
* @internal
|
28
|
+
* Limited to Microsoft-internal use
|
29
|
+
*/
|
30
|
+
export interface ActionOpenUrlError {
|
31
|
+
errorCode: ActionOpenUrlErrorCode;
|
32
|
+
message?: string;
|
33
|
+
}
|
34
|
+
/**
|
35
|
+
* @beta
|
36
|
+
* @hidden
|
37
|
+
* Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
38
|
+
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
39
|
+
*
|
40
|
+
* @internal
|
41
|
+
* Limited to Microsoft-internal use
|
42
|
+
*/
|
43
|
+
export declare enum ActionOpenUrlErrorCode {
|
44
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
45
|
+
INVALID_LINK = "INVALID_LINK",
|
46
|
+
NOT_SUPPORTED = "NOT_SUPPORTED"
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* @beta
|
50
|
+
* @hidden
|
51
|
+
* The payload that is used when executing an Adaptive Card Action.Submit
|
52
|
+
*
|
5
53
|
* @internal
|
6
54
|
* Limited to Microsoft-internal use
|
7
55
|
*/
|
8
|
-
export
|
9
|
-
|
10
|
-
|
11
|
-
* The type of deeplink action that was executed by the host
|
12
|
-
* @internal
|
13
|
-
* Limited to Microsoft-internal use
|
14
|
-
*/
|
15
|
-
enum ActionOpenUrlType {
|
16
|
-
DeepLinkDialog = "DeepLinkDialog",
|
17
|
-
DeepLinkOther = "DeepLinkOther",
|
18
|
-
DeepLinkStageView = "DeepLinkStageView",
|
19
|
-
GenericUrl = "GenericUrl"
|
20
|
-
}
|
21
|
-
/**
|
22
|
-
* @beta
|
23
|
-
* @hidden
|
24
|
-
* Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
25
|
-
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
26
|
-
*
|
27
|
-
* @internal
|
28
|
-
* Limited to Microsoft-internal use
|
29
|
-
*/
|
30
|
-
interface ActionOpenUrlError {
|
31
|
-
errorCode: ActionOpenUrlErrorCode;
|
32
|
-
message?: string;
|
33
|
-
}
|
34
|
-
/**
|
35
|
-
* @beta
|
36
|
-
* @hidden
|
37
|
-
* Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
38
|
-
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
39
|
-
*
|
40
|
-
* @internal
|
41
|
-
* Limited to Microsoft-internal use
|
42
|
-
*/
|
43
|
-
enum ActionOpenUrlErrorCode {
|
44
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
45
|
-
INVALID_LINK = "INVALID_LINK",
|
46
|
-
NOT_SUPPORTED = "NOT_SUPPORTED"
|
47
|
-
}
|
48
|
-
/**
|
49
|
-
* @beta
|
50
|
-
* @hidden
|
51
|
-
* The payload that is used when executing an Adaptive Card Action.Submit
|
52
|
-
*
|
53
|
-
* @internal
|
54
|
-
* Limited to Microsoft-internal use
|
55
|
-
*/
|
56
|
-
interface IAdaptiveCardActionSubmit {
|
57
|
-
id: string;
|
58
|
-
data: string | Record<string, unknown>;
|
59
|
-
}
|
60
|
-
/**
|
61
|
-
* @beta
|
62
|
-
* @hidden
|
63
|
-
* Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
|
64
|
-
* and IExternalAppCardActionForCEAService.handleActionSubmit
|
65
|
-
*
|
66
|
-
* @internal
|
67
|
-
* Limited to Microsoft-internal use
|
68
|
-
*/
|
69
|
-
interface ActionSubmitError {
|
70
|
-
errorCode: ExternalAppErrorCode;
|
71
|
-
message?: string;
|
72
|
-
}
|
73
|
-
/**
|
74
|
-
* @beta
|
75
|
-
* @hidden
|
76
|
-
* Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
|
77
|
-
* @internal
|
78
|
-
* Limited to Microsoft-internal use
|
79
|
-
* @param appId ID of the application the request is intended for. This must be a UUID
|
80
|
-
* @param actionSubmitPayload The Adaptive Card Action.Submit payload
|
81
|
-
* @param cardActionsConfig The card actions configuration. This indicates which subtypes should be handled by this API
|
82
|
-
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
|
83
|
-
*/
|
84
|
-
function processActionSubmit(appId: string, actionSubmitPayload: IAdaptiveCardActionSubmit): Promise<void>;
|
85
|
-
/**
|
86
|
-
* @beta
|
87
|
-
* @hidden
|
88
|
-
* Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
|
89
|
-
* If `fromElement` is not provided, the information from the manifest is used to determine whether the URL can
|
90
|
-
* be processed by the host. Deep link URLs for plugins are not supported and will result in an error.
|
91
|
-
* @internal
|
92
|
-
* Limited to Microsoft-internal use
|
93
|
-
* @param appId ID of the application the request is intended for. This must be a UUID
|
94
|
-
* @param url The URL to open
|
95
|
-
* @param fromElement The element on behalf of which the M365 app is making the request.
|
96
|
-
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
|
97
|
-
*/
|
98
|
-
function processActionOpenUrl(appId: string, url: URL, fromElement?: {
|
99
|
-
name: 'composeExtensions' | 'plugins';
|
100
|
-
}): Promise<ActionOpenUrlType>;
|
101
|
-
/**
|
102
|
-
* @hidden
|
103
|
-
* Checks if the externalAppCardActions capability is supported by the host
|
104
|
-
* @returns boolean to represent whether externalAppCardActions capability is supported
|
105
|
-
*
|
106
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
107
|
-
*
|
108
|
-
* @internal
|
109
|
-
* Limited to Microsoft-internal use
|
110
|
-
*/
|
111
|
-
function isSupported(): boolean;
|
56
|
+
export interface IAdaptiveCardActionSubmit {
|
57
|
+
id: string;
|
58
|
+
data: string | Record<string, unknown>;
|
112
59
|
}
|
60
|
+
/**
|
61
|
+
* @beta
|
62
|
+
* @hidden
|
63
|
+
* Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
|
64
|
+
* and IExternalAppCardActionForCEAService.handleActionSubmit
|
65
|
+
*
|
66
|
+
* @internal
|
67
|
+
* Limited to Microsoft-internal use
|
68
|
+
*/
|
69
|
+
export interface ActionSubmitError {
|
70
|
+
errorCode: ExternalAppErrorCode;
|
71
|
+
message?: string;
|
72
|
+
}
|
73
|
+
/**
|
74
|
+
* @beta
|
75
|
+
* @hidden
|
76
|
+
* Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
|
77
|
+
* @internal
|
78
|
+
* Limited to Microsoft-internal use
|
79
|
+
* @param appId ID of the application the request is intended for. This must be a UUID
|
80
|
+
* @param actionSubmitPayload The Adaptive Card Action.Submit payload
|
81
|
+
* @param cardActionsConfig The card actions configuration. This indicates which subtypes should be handled by this API
|
82
|
+
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
|
83
|
+
*/
|
84
|
+
export declare function processActionSubmit(appId: string, actionSubmitPayload: IAdaptiveCardActionSubmit): Promise<void>;
|
85
|
+
/**
|
86
|
+
* @beta
|
87
|
+
* @hidden
|
88
|
+
* Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
|
89
|
+
* If `fromElement` is not provided, the information from the manifest is used to determine whether the URL can
|
90
|
+
* be processed by the host. Deep link URLs for plugins are not supported and will result in an error.
|
91
|
+
* @internal
|
92
|
+
* Limited to Microsoft-internal use
|
93
|
+
* @param appId ID of the application the request is intended for. This must be a UUID
|
94
|
+
* @param url The URL to open
|
95
|
+
* @param fromElement The element on behalf of which the M365 app is making the request.
|
96
|
+
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
|
97
|
+
*/
|
98
|
+
export declare function processActionOpenUrl(appId: string, url: URL, fromElement?: {
|
99
|
+
name: 'composeExtensions' | 'plugins';
|
100
|
+
}): Promise<ActionOpenUrlType>;
|
101
|
+
/**
|
102
|
+
* @hidden
|
103
|
+
* Checks if the externalAppCardActions capability is supported by the host
|
104
|
+
* @returns boolean to represent whether externalAppCardActions capability is supported
|
105
|
+
*
|
106
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
107
|
+
*
|
108
|
+
* @internal
|
109
|
+
* Limited to Microsoft-internal use
|
110
|
+
*/
|
111
|
+
export declare function isSupported(): boolean;
|
@@ -1,49 +1,48 @@
|
|
1
|
+
/**
|
2
|
+
* @beta
|
3
|
+
* @hidden
|
4
|
+
* Module to delegate adaptive card action for Custom Engine Agent execution to the host
|
5
|
+
* @internal
|
6
|
+
* Limited to Microsoft-internal use
|
7
|
+
* @module
|
8
|
+
*/
|
1
9
|
import { AppId } from '../public';
|
2
|
-
import
|
10
|
+
import * as externalAppCardActions from './externalAppCardActions';
|
11
|
+
/**
|
12
|
+
* @beta
|
13
|
+
* @hidden
|
14
|
+
* Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
|
15
|
+
* @internal
|
16
|
+
* Limited to Microsoft-internal use
|
17
|
+
* @param appId ID of the application the request is intended for. This must be a UUID
|
18
|
+
* @param conversationId To tell the bot what conversation the calls are coming from
|
19
|
+
* @param url The URL to open
|
20
|
+
* @throws Error if the response has not successfully completed
|
21
|
+
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
|
22
|
+
*/
|
23
|
+
export declare function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<externalAppCardActions.ActionOpenUrlType>;
|
24
|
+
/**
|
25
|
+
* @beta
|
26
|
+
* @hidden
|
27
|
+
* Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
|
28
|
+
* @internal
|
29
|
+
* Limited to Microsoft-internal use
|
30
|
+
* @param appId ID of the application the request is intended for. This must be a UUID
|
31
|
+
* @param conversationId To tell the bot what conversation the calls are coming from
|
32
|
+
* @param actionSubmitPayload The Adaptive Card Action.Submit payload
|
33
|
+
* @throws Error if host notifies of an error
|
34
|
+
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
|
35
|
+
*/
|
36
|
+
export declare function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: externalAppCardActions.IAdaptiveCardActionSubmit): Promise<void>;
|
3
37
|
/**
|
4
38
|
* @beta
|
5
39
|
* @hidden
|
6
|
-
*
|
40
|
+
* Checks if the externalAppCardActionsForCEA capability is supported by the host
|
41
|
+
* @returns boolean to represent whether externalAppCardActions capability is supported
|
42
|
+
*
|
43
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
44
|
+
*
|
7
45
|
* @internal
|
8
46
|
* Limited to Microsoft-internal use
|
9
47
|
*/
|
10
|
-
export declare
|
11
|
-
/**
|
12
|
-
* @beta
|
13
|
-
* @hidden
|
14
|
-
* Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID.
|
15
|
-
* @internal
|
16
|
-
* Limited to Microsoft-internal use
|
17
|
-
* @param appId ID of the application the request is intended for. This must be a UUID
|
18
|
-
* @param conversationId To tell the bot what conversation the calls are coming from
|
19
|
-
* @param url The URL to open
|
20
|
-
* @throws Error if the response has not successfully completed
|
21
|
-
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
|
22
|
-
*/
|
23
|
-
function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<externalAppCardActions.ActionOpenUrlType>;
|
24
|
-
/**
|
25
|
-
* @beta
|
26
|
-
* @hidden
|
27
|
-
* Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
|
28
|
-
* @internal
|
29
|
-
* Limited to Microsoft-internal use
|
30
|
-
* @param appId ID of the application the request is intended for. This must be a UUID
|
31
|
-
* @param conversationId To tell the bot what conversation the calls are coming from
|
32
|
-
* @param actionSubmitPayload The Adaptive Card Action.Submit payload
|
33
|
-
* @throws Error if host notifies of an error
|
34
|
-
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
|
35
|
-
*/
|
36
|
-
function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: externalAppCardActions.IAdaptiveCardActionSubmit): Promise<void>;
|
37
|
-
/**
|
38
|
-
* @beta
|
39
|
-
* @hidden
|
40
|
-
* Checks if the externalAppCardActionsForCEA capability is supported by the host
|
41
|
-
* @returns boolean to represent whether externalAppCardActions capability is supported
|
42
|
-
*
|
43
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
44
|
-
*
|
45
|
-
* @internal
|
46
|
-
* Limited to Microsoft-internal use
|
47
|
-
*/
|
48
|
-
function isSupported(): boolean;
|
49
|
-
}
|
48
|
+
export declare function isSupported(): boolean;
|
@@ -1,123 +1,122 @@
|
|
1
|
+
/**
|
2
|
+
* @hidden
|
3
|
+
* Module to delegate the ActionCommand to the host
|
4
|
+
* @internal
|
5
|
+
* Limited to Microsoft-internal use
|
6
|
+
*
|
7
|
+
* @beta
|
8
|
+
* @module
|
9
|
+
*/
|
1
10
|
import { ExternalAppErrorCode } from './constants';
|
2
|
-
import
|
11
|
+
import * as externalAppAuthentication from './externalAppAuthentication';
|
12
|
+
/**
|
13
|
+
* @hidden
|
14
|
+
* The payload of IActionCommandResponse
|
15
|
+
*
|
16
|
+
* @internal
|
17
|
+
* Limited to Microsoft-internal use
|
18
|
+
*
|
19
|
+
* @beta
|
20
|
+
*/
|
21
|
+
export type IActionCommandResponse = ITextActionCommandResponse | ICardActionCommandResponse;
|
22
|
+
/**
|
23
|
+
* @hidden
|
24
|
+
* The payload of IBaseActionCommandResponse
|
25
|
+
*
|
26
|
+
* @internal
|
27
|
+
* Limited to Microsoft-internal use
|
28
|
+
*
|
29
|
+
* @beta
|
30
|
+
*/
|
31
|
+
export interface IBaseActionCommandResponse {
|
32
|
+
taskModuleClosedReason: TaskModuleClosedReason;
|
33
|
+
}
|
34
|
+
/**
|
35
|
+
* @hidden
|
36
|
+
* The text result type
|
37
|
+
*
|
38
|
+
* @internal
|
39
|
+
* Limited to Microsoft-internal use
|
40
|
+
*
|
41
|
+
* @beta
|
42
|
+
*/
|
43
|
+
export interface ITextActionCommandResponse extends IBaseActionCommandResponse {
|
44
|
+
resultType: 'text';
|
45
|
+
text: string | undefined;
|
46
|
+
}
|
47
|
+
/**
|
48
|
+
* @hidden
|
49
|
+
* The card result type
|
50
|
+
*
|
51
|
+
* @internal
|
52
|
+
* Limited to Microsoft-internal use
|
53
|
+
*
|
54
|
+
* @beta
|
55
|
+
*/
|
56
|
+
export interface ICardActionCommandResponse extends IBaseActionCommandResponse {
|
57
|
+
resultType: 'card';
|
58
|
+
attachmentLayout: externalAppAuthentication.AttachmentLayout;
|
59
|
+
attachments: externalAppAuthentication.QueryMessageExtensionAttachment[];
|
60
|
+
}
|
61
|
+
/**
|
62
|
+
* @hidden
|
63
|
+
* The result type for the ActionCommandResultType
|
64
|
+
*
|
65
|
+
* @internal
|
66
|
+
* Limited to Microsoft-internal use
|
67
|
+
*
|
68
|
+
* @beta
|
69
|
+
*/
|
70
|
+
export type ActionCommandResultType = 'card' | 'text';
|
3
71
|
/**
|
4
72
|
* @hidden
|
5
|
-
*
|
73
|
+
* The reason for the TaskModuleClosedReason
|
74
|
+
*
|
6
75
|
* @internal
|
7
76
|
* Limited to Microsoft-internal use
|
8
77
|
*
|
9
78
|
* @beta
|
10
79
|
*/
|
11
|
-
export
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
*
|
26
|
-
* @internal
|
27
|
-
* Limited to Microsoft-internal use
|
28
|
-
*
|
29
|
-
* @beta
|
30
|
-
*/
|
31
|
-
interface IBaseActionCommandResponse {
|
32
|
-
taskModuleClosedReason: TaskModuleClosedReason;
|
33
|
-
}
|
34
|
-
/**
|
35
|
-
* @hidden
|
36
|
-
* The text result type
|
37
|
-
*
|
38
|
-
* @internal
|
39
|
-
* Limited to Microsoft-internal use
|
40
|
-
*
|
41
|
-
* @beta
|
42
|
-
*/
|
43
|
-
interface ITextActionCommandResponse extends IBaseActionCommandResponse {
|
44
|
-
resultType: 'text';
|
45
|
-
text: string | undefined;
|
46
|
-
}
|
47
|
-
/**
|
48
|
-
* @hidden
|
49
|
-
* The card result type
|
50
|
-
*
|
51
|
-
* @internal
|
52
|
-
* Limited to Microsoft-internal use
|
53
|
-
*
|
54
|
-
* @beta
|
55
|
-
*/
|
56
|
-
interface ICardActionCommandResponse extends IBaseActionCommandResponse {
|
57
|
-
resultType: 'card';
|
58
|
-
attachmentLayout: externalAppAuthentication.AttachmentLayout;
|
59
|
-
attachments: externalAppAuthentication.QueryMessageExtensionAttachment[];
|
60
|
-
}
|
61
|
-
/**
|
62
|
-
* @hidden
|
63
|
-
* The result type for the ActionCommandResultType
|
64
|
-
*
|
65
|
-
* @internal
|
66
|
-
* Limited to Microsoft-internal use
|
67
|
-
*
|
68
|
-
* @beta
|
69
|
-
*/
|
70
|
-
type ActionCommandResultType = 'card' | 'text';
|
71
|
-
/**
|
72
|
-
* @hidden
|
73
|
-
* The reason for the TaskModuleClosedReason
|
74
|
-
*
|
75
|
-
* @internal
|
76
|
-
* Limited to Microsoft-internal use
|
77
|
-
*
|
78
|
-
* @beta
|
79
|
-
*/
|
80
|
-
type TaskModuleClosedReason = 'Done' | 'CancelledByUser';
|
81
|
-
/**
|
82
|
-
*
|
83
|
-
* @hidden
|
84
|
-
* Error that can be thrown from IExternalAppCommandsService.processActionCommand
|
85
|
-
*
|
86
|
-
* @internal
|
87
|
-
* Limited to Microsoft-internal use
|
88
|
-
*
|
89
|
-
* @beta
|
90
|
-
*/
|
91
|
-
interface ActionCommandError {
|
92
|
-
errorCode: ExternalAppErrorCode;
|
93
|
-
message?: string;
|
94
|
-
}
|
95
|
-
/**
|
96
|
-
* @internal
|
97
|
-
* Limited to Microsoft-internal use
|
98
|
-
* @hidden
|
99
|
-
* This API delegates an ActionCommand request to the host for the application with the provided following parameters:
|
100
|
-
*
|
101
|
-
* @param appId ID of the application the request is intended for. This must be a UUID
|
102
|
-
* @param commandId extensibilityProvider use this ID to look up the command declared by ActionME
|
103
|
-
* @param extractedParameters are the key-value pairs that the dialog will be prepopulated with
|
104
|
-
*
|
105
|
-
* @returns Promise that resolves with the {@link IActionCommandResponse} when the request is completed and rejects with {@link ActionCommandError} if the request fails
|
106
|
-
*
|
107
|
-
* @beta
|
108
|
-
*/
|
109
|
-
function processActionCommand(appId: string, commandId: string, extractedParameters: Record<string, string>): Promise<IActionCommandResponse>;
|
110
|
-
/**
|
111
|
-
* @hidden
|
112
|
-
* Checks if the externalAppCommands capability is supported by the host
|
113
|
-
* @returns boolean to represent whether externalAppCommands capability is supported
|
114
|
-
*
|
115
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
116
|
-
*
|
117
|
-
* @internal
|
118
|
-
* Limited to Microsoft-internal use
|
119
|
-
*
|
120
|
-
* @beta
|
121
|
-
*/
|
122
|
-
function isSupported(): boolean;
|
80
|
+
export type TaskModuleClosedReason = 'Done' | 'CancelledByUser';
|
81
|
+
/**
|
82
|
+
*
|
83
|
+
* @hidden
|
84
|
+
* Error that can be thrown from IExternalAppCommandsService.processActionCommand
|
85
|
+
*
|
86
|
+
* @internal
|
87
|
+
* Limited to Microsoft-internal use
|
88
|
+
*
|
89
|
+
* @beta
|
90
|
+
*/
|
91
|
+
export interface ActionCommandError {
|
92
|
+
errorCode: ExternalAppErrorCode;
|
93
|
+
message?: string;
|
123
94
|
}
|
95
|
+
/**
|
96
|
+
* @internal
|
97
|
+
* Limited to Microsoft-internal use
|
98
|
+
* @hidden
|
99
|
+
* This API delegates an ActionCommand request to the host for the application with the provided following parameters:
|
100
|
+
*
|
101
|
+
* @param appId ID of the application the request is intended for. This must be a UUID
|
102
|
+
* @param commandId extensibilityProvider use this ID to look up the command declared by ActionME
|
103
|
+
* @param extractedParameters are the key-value pairs that the dialog will be prepopulated with
|
104
|
+
*
|
105
|
+
* @returns Promise that resolves with the {@link IActionCommandResponse} when the request is completed and rejects with {@link ActionCommandError} if the request fails
|
106
|
+
*
|
107
|
+
* @beta
|
108
|
+
*/
|
109
|
+
export declare function processActionCommand(appId: string, commandId: string, extractedParameters: Record<string, string>): Promise<IActionCommandResponse>;
|
110
|
+
/**
|
111
|
+
* @hidden
|
112
|
+
* Checks if the externalAppCommands capability is supported by the host
|
113
|
+
* @returns boolean to represent whether externalAppCommands capability is supported
|
114
|
+
*
|
115
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
116
|
+
*
|
117
|
+
* @internal
|
118
|
+
* Limited to Microsoft-internal use
|
119
|
+
*
|
120
|
+
* @beta
|
121
|
+
*/
|
122
|
+
export declare function isSupported(): boolean;
|