-
Notifications
You must be signed in to change notification settings - Fork 195
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added externalAppCardActionsForCEA APIs (#2507)
* CEC Card API changes * address comments * rename CEC to CEA * address comments * address comments * delete test log * address comments for adding hidden tag * Update packages/teams-js/src/private/externalAppCardActionsForCEA.ts Co-authored-by: Trevor Harris <[email protected]> * using sendAndUnwrap function * add beta tag --------- Co-authored-by: Trevor Harris <[email protected]>
- Loading branch information
1 parent
60eb045
commit 57ea793
Showing
12 changed files
with
516 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
apps/teams-test-app/src/components/privateApis/ExternalAppCardActionsForCEAAPIs.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| import { AppId, externalAppCardActionsForCEA, IAdaptiveCardActionSubmit } from '@microsoft/teams-js'; | ||
| import React from 'react'; | ||
|
|
||
| import { ApiWithoutInput, ApiWithTextInput } from '../utils'; | ||
| import { ModuleWrapper } from '../utils/ModuleWrapper'; | ||
|
|
||
| const CheckExternalAppCardActionsForCEACapability = (): React.ReactElement => | ||
| ApiWithoutInput({ | ||
| name: 'checkExternalAppCardActionsForCEACapability', | ||
| title: 'Check External App Card Actions For CEA Capability', | ||
| onClick: async () => | ||
| `External App Card Actions For CEA module ${ | ||
| externalAppCardActionsForCEA.isSupported() ? 'is' : 'is not' | ||
| } supported`, | ||
| }); | ||
|
|
||
| const CECProcessActionSubmit = (): React.ReactElement => | ||
| ApiWithTextInput<{ | ||
| appId: AppId; | ||
| conversationId: string; | ||
| actionSubmitPayload: IAdaptiveCardActionSubmit; | ||
| }>({ | ||
| name: 'processActionSubmitForCEA', | ||
| title: 'Process Action Submit For CEA', | ||
| onClick: { | ||
| validateInput: (input) => { | ||
| if (!input.appId) { | ||
| throw new Error('appId is required'); | ||
| } | ||
| if (!input.actionSubmitPayload) { | ||
| throw new Error('actionSubmitPayload is required'); | ||
| } | ||
| }, | ||
| submit: async (input) => { | ||
| await externalAppCardActionsForCEA.processActionSubmit( | ||
| input.appId, | ||
| input.conversationId, | ||
| input.actionSubmitPayload, | ||
| ); | ||
| return 'Completed'; | ||
| }, | ||
| }, | ||
| defaultInput: JSON.stringify({ | ||
| appId: 'b7f8c0a0-6c1d-4a9a-9c0a-2c3f1c0a3b0a', | ||
| actionSubmitPayload: { | ||
| id: 'submitId', | ||
| data: 'data1', | ||
| }, | ||
| }), | ||
| }); | ||
|
|
||
| const CECProcessActionOpenUrl = (): React.ReactElement => | ||
| ApiWithTextInput<{ | ||
| appId: AppId; | ||
| conversationId: string; | ||
| url: string; | ||
| }>({ | ||
| name: 'processActionOpenUrlForCEA', | ||
| title: 'Process Action Open Url For CEA', | ||
| onClick: { | ||
| validateInput: (input) => { | ||
| if (!input.appId) { | ||
| throw new Error('appId is required'); | ||
| } | ||
| if (!input.url) { | ||
| throw new Error('url is required'); | ||
| } | ||
| }, | ||
| submit: async (input) => { | ||
| const result = await externalAppCardActionsForCEA.processActionOpenUrl( | ||
| input.appId, | ||
| input.conversationId, | ||
| new URL(input.url), | ||
| ); | ||
| return JSON.stringify(result); | ||
| }, | ||
| }, | ||
| defaultInput: JSON.stringify({ | ||
| appId: 'b7f8c0a0-6c1d-4a9a-9c0a-2c3f1c0a3b0a', | ||
| url: 'https://www.example.com', | ||
| }), | ||
| }); | ||
|
|
||
| const ExternalAppCardActionsForCEAAPIs = (): React.ReactElement => ( | ||
| <ModuleWrapper title="External App Card Actions For CEA"> | ||
| <CheckExternalAppCardActionsForCEACapability /> | ||
| <CECProcessActionSubmit /> | ||
| <CECProcessActionOpenUrl /> | ||
| </ModuleWrapper> | ||
| ); | ||
|
|
||
| export default ExternalAppCardActionsForCEAAPIs; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
change/@microsoft-teams-js-75e3c524-ba26-4b6a-b01b-9a1f0e315d91.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "minor", | ||
| "comment": "Added APIs for `externalAppCardActionsForCEA` capability.", | ||
| "packageName": "@microsoft/teams-js", | ||
| "email": "[email protected]", | ||
| "dependentChangeType": "patch" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
packages/teams-js/src/private/externalAppCardActionsForCEA.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| import { sendAndUnwrap, sendMessageToParentAsync } from '../internal/communication'; | ||
| import { ensureInitialized } from '../internal/internalAPIs'; | ||
| import { ApiName, ApiVersionNumber, getApiVersionTag } from '../internal/telemetry'; | ||
| import { validateId } from '../internal/utils'; | ||
| import { AppId } from '../public'; | ||
| import { errorNotSupportedOnPlatform, FrameContexts } from '../public/constants'; | ||
| import { runtime } from '../public/runtime'; | ||
| import { ActionOpenUrlError, ActionOpenUrlType, ActionSubmitError, IAdaptiveCardActionSubmit } from './interfaces'; | ||
|
|
||
| /** | ||
| * All of APIs in this capability file should send out API version v2 ONLY | ||
| */ | ||
| const externalAppCardActionsTelemetryVersionNumber: ApiVersionNumber = ApiVersionNumber.V_2; | ||
| /** | ||
| * @beta | ||
| * @hidden | ||
| * Namespace to delegate adaptive card action for Custom Engine Agent execution to the host | ||
| * @internal | ||
| * Limited to Microsoft-internal use | ||
| */ | ||
| export namespace externalAppCardActionsForCEA { | ||
| /** | ||
| * @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 async function processActionOpenUrl( | ||
| appId: AppId, | ||
| conversationId: string, | ||
| url: URL, | ||
| ): Promise<ActionOpenUrlType> { | ||
| ensureInitialized(runtime, FrameContexts.content); | ||
| if (!isSupported()) { | ||
| throw errorNotSupportedOnPlatform; | ||
| } | ||
| validateId(conversationId, new Error('conversation id is not valid.')); | ||
| const [error, response] = await sendMessageToParentAsync<[ActionOpenUrlError, ActionOpenUrlType]>( | ||
| getApiVersionTag( | ||
| externalAppCardActionsTelemetryVersionNumber, | ||
| ApiName.ExternalAppCardActionsForCEA_ProcessActionOpenUrl, | ||
| ), | ||
| ApiName.ExternalAppCardActionsForCEA_ProcessActionOpenUrl, | ||
| [appId, url.href, conversationId], | ||
| ); | ||
| if (error) { | ||
| throw error; | ||
| } else { | ||
| return response; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @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 async function processActionSubmit( | ||
| appId: AppId, | ||
| conversationId: string, | ||
| actionSubmitPayload: IAdaptiveCardActionSubmit, | ||
| ): Promise<void> { | ||
| ensureInitialized(runtime, FrameContexts.content); | ||
| if (!isSupported()) { | ||
| throw errorNotSupportedOnPlatform; | ||
| } | ||
| validateId(conversationId, new Error('conversation id is not valid.')); | ||
| const error = await sendAndUnwrap<ActionSubmitError | undefined>( | ||
| getApiVersionTag( | ||
| externalAppCardActionsTelemetryVersionNumber, | ||
| ApiName.ExternalAppCardActionsForCEA_ProcessActionSubmit, | ||
| ), | ||
| ApiName.ExternalAppCardActionsForCEA_ProcessActionSubmit, | ||
| [appId, conversationId, actionSubmitPayload], | ||
| ); | ||
| if (error) { | ||
| throw error; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @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 function isSupported(): boolean { | ||
| return ensureInitialized(runtime) && runtime.supports.externalAppCardActionsForCEA ? true : false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.