@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +12 -2
- package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts +32 -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/marketplaceUtils.d.ts +1 -1
- package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts +2 -2
- 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 +67 -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.d.ts → app/app.d.ts} +33 -45
- package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +41 -0
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +2 -2
- 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 +30 -28
- 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 +26 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +27 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +56 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +24 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +50 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/url.d.ts +60 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +68 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +29 -27
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +23 -1
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +135 -136
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +75 -76
- package/dist/esm/packages/teams-js/dts/public/mail.d.ts +80 -81
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +315 -316
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +423 -428
- 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 +165 -166
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +56 -50
- package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +10 -11
- 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/people.d.ts +61 -63
- 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 +81 -82
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +26 -27
- 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 +46 -56
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +78 -76
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +98 -99
- 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/communication.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/deepLinkUtilities.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/dialogHelpers.js +1 -0
- 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/mediaUtil.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 -0
- package/dist/esm/packages/teams-js/src/public/app/lifecycle.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/chat.js +1 -1
- package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/adaptiveCard.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/dialog.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/update.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/parentCommunication.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/url.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/geoLocation.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/map.js +1 -0
- package/dist/esm/packages/teams-js/src/public/liveShareHost.js +1 -1
- package/dist/esm/packages/teams-js/src/public/location.js +1 -1
- package/dist/esm/packages/teams-js/src/public/mail.js +1 -1
- package/dist/esm/packages/teams-js/src/public/marketplace.js +1 -1
- package/dist/esm/packages/teams-js/src/public/media.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/menus.js +1 -1
- package/dist/esm/packages/teams-js/src/public/monetization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/navigation.js +1 -1
- package/dist/esm/packages/teams-js/src/public/nestedAppAuth.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/people.js +1 -1
- 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/search.js +1 -1
- package/dist/esm/packages/teams-js/src/public/secondaryBrowser.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/teamsAPIs.js +1 -1
- package/dist/esm/packages/teams-js/src/public/thirdPartyCloudStorage.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 +8195 -7407
- package/dist/umd/MicrosoftTeams.js +12298 -12356
- 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 +1 -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/dialog.d.ts +0 -286
- package/dist/esm/packages/teams-js/dts/public/geoLocation.d.ts +0 -100
- 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/app.js +0 -1
- package/dist/esm/packages/teams-js/src/public/dialog.js +0 -1
- package/dist/esm/packages/teams-js/src/public/geoLocation.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,244 +1,250 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
* Extended video API
|
|
4
|
+
* @internal
|
|
5
|
+
* Limited to Microsoft-internal use
|
|
6
|
+
* @beta
|
|
7
|
+
* @module
|
|
8
|
+
*/
|
|
1
9
|
import { DefaultVideoEffectCallBack as VideoEffectCallBack } from '../internal/videoEffectsUtils';
|
|
2
|
-
import
|
|
3
|
-
export declare
|
|
4
|
-
|
|
10
|
+
import * as videoEffects from '../public/videoEffects';
|
|
11
|
+
export declare const frameProcessingTimeoutInMs = 2000;
|
|
12
|
+
/**
|
|
13
|
+
* @hidden
|
|
14
|
+
* Error level when notifying errors to the host, the host will decide what to do acording to the error level.
|
|
15
|
+
* @beta
|
|
16
|
+
*
|
|
17
|
+
* @internal
|
|
18
|
+
* Limited to Microsoft-internal use
|
|
19
|
+
*/
|
|
20
|
+
export declare enum ErrorLevel {
|
|
21
|
+
Fatal = "fatal",
|
|
22
|
+
Warn = "warn"
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @hidden
|
|
26
|
+
* Video frame configuration supplied to the host to customize the generated video frame parameters
|
|
27
|
+
* @beta
|
|
28
|
+
*
|
|
29
|
+
* @internal
|
|
30
|
+
* Limited to Microsoft-internal use
|
|
31
|
+
*/
|
|
32
|
+
export interface VideoFrameConfig extends videoEffects.VideoFrameConfig {
|
|
5
33
|
/**
|
|
6
34
|
* @hidden
|
|
7
|
-
*
|
|
35
|
+
* Flag to indicate use camera stream to synthesize video frame or not.
|
|
36
|
+
* Default value is true.
|
|
8
37
|
* @beta
|
|
9
38
|
*
|
|
10
39
|
* @internal
|
|
11
40
|
* Limited to Microsoft-internal use
|
|
12
41
|
*/
|
|
13
|
-
|
|
14
|
-
Fatal = "fatal",
|
|
15
|
-
Warn = "warn"
|
|
16
|
-
}
|
|
42
|
+
requireCameraStream?: boolean;
|
|
17
43
|
/**
|
|
18
44
|
* @hidden
|
|
19
|
-
*
|
|
45
|
+
* Machine learning model to run in the host to do audio inference for you
|
|
20
46
|
* @beta
|
|
21
47
|
*
|
|
22
48
|
* @internal
|
|
23
49
|
* Limited to Microsoft-internal use
|
|
24
50
|
*/
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @hidden
|
|
28
|
-
* Flag to indicate use camera stream to synthesize video frame or not.
|
|
29
|
-
* Default value is true.
|
|
30
|
-
* @beta
|
|
31
|
-
*
|
|
32
|
-
* @internal
|
|
33
|
-
* Limited to Microsoft-internal use
|
|
34
|
-
*/
|
|
35
|
-
requireCameraStream?: boolean;
|
|
36
|
-
/**
|
|
37
|
-
* @hidden
|
|
38
|
-
* Machine learning model to run in the host to do audio inference for you
|
|
39
|
-
* @beta
|
|
40
|
-
*
|
|
41
|
-
* @internal
|
|
42
|
-
* Limited to Microsoft-internal use
|
|
43
|
-
*/
|
|
44
|
-
audioInferenceModel?: ArrayBuffer;
|
|
45
|
-
/**
|
|
46
|
-
* @hidden
|
|
47
|
-
* Specifies additional capabilities that should be applied to the video frame
|
|
48
|
-
* @beta
|
|
49
|
-
*
|
|
50
|
-
* @internal
|
|
51
|
-
* Limited to Microsoft-internal use
|
|
52
|
-
*/
|
|
53
|
-
requiredCapabilities?: string[];
|
|
54
|
-
}
|
|
51
|
+
audioInferenceModel?: ArrayBuffer;
|
|
55
52
|
/**
|
|
56
53
|
* @hidden
|
|
57
|
-
*
|
|
54
|
+
* Specifies additional capabilities that should be applied to the video frame
|
|
58
55
|
* @beta
|
|
59
56
|
*
|
|
60
57
|
* @internal
|
|
61
58
|
* Limited to Microsoft-internal use
|
|
62
59
|
*/
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
60
|
+
requiredCapabilities?: string[];
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @hidden
|
|
64
|
+
* Represents a video frame
|
|
65
|
+
* @beta
|
|
66
|
+
*
|
|
67
|
+
* @internal
|
|
68
|
+
* Limited to Microsoft-internal use
|
|
69
|
+
*/
|
|
70
|
+
export interface VideoBufferData extends videoEffects.VideoBufferData {
|
|
74
71
|
/**
|
|
75
72
|
* @hidden
|
|
76
|
-
* The
|
|
77
|
-
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
78
|
-
* The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
|
|
79
|
-
* The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
|
|
73
|
+
* The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
|
|
80
74
|
* @beta
|
|
81
75
|
*
|
|
82
76
|
* @internal
|
|
83
77
|
* Limited to Microsoft-internal use
|
|
84
78
|
*/
|
|
85
|
-
|
|
79
|
+
audioInferenceResult?: Uint8Array;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @hidden
|
|
83
|
+
* The callback will be called on every frame when running on the supported host.
|
|
84
|
+
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
85
|
+
* The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
|
|
86
|
+
* The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
|
|
87
|
+
* @beta
|
|
88
|
+
*
|
|
89
|
+
* @internal
|
|
90
|
+
* Limited to Microsoft-internal use
|
|
91
|
+
*/
|
|
92
|
+
export type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
|
|
93
|
+
/**
|
|
94
|
+
* @hidden
|
|
95
|
+
* Video frame data extracted from the media stream. More properties may be added in the future.
|
|
96
|
+
* @beta
|
|
97
|
+
*
|
|
98
|
+
* @internal
|
|
99
|
+
* Limited to Microsoft-internal use
|
|
100
|
+
*/
|
|
101
|
+
export type VideoFrameData = videoEffects.VideoFrameData & {
|
|
86
102
|
/**
|
|
87
103
|
* @hidden
|
|
88
|
-
*
|
|
104
|
+
* The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
|
|
89
105
|
* @beta
|
|
90
106
|
*
|
|
91
107
|
* @internal
|
|
92
108
|
* Limited to Microsoft-internal use
|
|
93
109
|
*/
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
* @hidden
|
|
97
|
-
* The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
|
|
98
|
-
* @beta
|
|
99
|
-
*
|
|
100
|
-
* @internal
|
|
101
|
-
* Limited to Microsoft-internal use
|
|
102
|
-
*/
|
|
103
|
-
audioInferenceResult?: Uint8Array;
|
|
104
|
-
/**
|
|
105
|
-
* @hidden
|
|
106
|
-
* Additional metadata determined by capabilities specified in {@linkcode VideoFrameConfig.requiredCapabilities}
|
|
107
|
-
* @beta
|
|
108
|
-
*
|
|
109
|
-
* @internal
|
|
110
|
-
* Limited to Microsoft-internal use
|
|
111
|
-
*/
|
|
112
|
-
attributes?: ReadonlyMap<string, Uint8Array>;
|
|
113
|
-
};
|
|
110
|
+
audioInferenceResult?: Uint8Array;
|
|
114
111
|
/**
|
|
115
112
|
* @hidden
|
|
116
|
-
*
|
|
117
|
-
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
118
|
-
* The video app should resolve the promise to notify a successfully processed video frame.
|
|
119
|
-
* The video app should reject the promise to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
|
|
113
|
+
* Additional metadata determined by capabilities specified in {@linkcode VideoFrameConfig.requiredCapabilities}
|
|
120
114
|
* @beta
|
|
121
115
|
*
|
|
122
116
|
* @internal
|
|
123
117
|
* Limited to Microsoft-internal use
|
|
124
118
|
*/
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
119
|
+
attributes?: ReadonlyMap<string, Uint8Array>;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* @hidden
|
|
123
|
+
* The callback will be called on every frame when running on the supported host.
|
|
124
|
+
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
125
|
+
* The video app should resolve the promise to notify a successfully processed video frame.
|
|
126
|
+
* The video app should reject the promise to notify a failure. When the failures accumulate to a certain number(determined by the host), the host will see the app is "frozen" and give the user the option to close the app.
|
|
127
|
+
* @beta
|
|
128
|
+
*
|
|
129
|
+
* @internal
|
|
130
|
+
* Limited to Microsoft-internal use
|
|
131
|
+
*/
|
|
132
|
+
export type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<videoEffects.VideoFrame>;
|
|
133
|
+
/**
|
|
134
|
+
* @hidden
|
|
135
|
+
* @beta
|
|
136
|
+
* Callbacks and configuration supplied to the host to process the video frames.
|
|
137
|
+
* @internal
|
|
138
|
+
* Limited to Microsoft-internal use
|
|
139
|
+
*/
|
|
140
|
+
export type RegisterForVideoFrameParameters = {
|
|
147
141
|
/**
|
|
148
|
-
*
|
|
149
|
-
* Register to process video frames
|
|
150
|
-
* @beta
|
|
151
|
-
*
|
|
152
|
-
* @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
|
|
153
|
-
* To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
|
|
154
|
-
* The host will choose the appropriate callback based on the host's capability.
|
|
155
|
-
*
|
|
156
|
-
* @internal
|
|
157
|
-
* Limited to Microsoft-internal use
|
|
142
|
+
* Callback function to process the video frames extracted from a media stream.
|
|
158
143
|
*/
|
|
159
|
-
|
|
144
|
+
videoFrameHandler: VideoFrameHandler;
|
|
160
145
|
/**
|
|
161
|
-
*
|
|
162
|
-
* Video extension should call this to notify host that the current selected effect parameter changed.
|
|
163
|
-
* If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
|
|
164
|
-
* If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
165
|
-
* @beta
|
|
166
|
-
* @param effectChangeType - the effect change type.
|
|
167
|
-
* @param effectId - Newly selected effect id. {@linkcode VideoEffectCallBack}
|
|
168
|
-
* @param effectParam Variant for the newly selected effect. {@linkcode VideoEffectCallBack}
|
|
169
|
-
*
|
|
170
|
-
* @internal
|
|
171
|
-
* Limited to Microsoft-internal use
|
|
146
|
+
* Callback function to process the video frames shared by the host.
|
|
172
147
|
*/
|
|
173
|
-
|
|
148
|
+
videoBufferHandler: VideoBufferHandler;
|
|
174
149
|
/**
|
|
175
|
-
*
|
|
176
|
-
* Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
|
|
177
|
-
* @beta
|
|
178
|
-
* @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
|
|
179
|
-
*
|
|
180
|
-
* @internal
|
|
181
|
-
* Limited to Microsoft-internal use
|
|
150
|
+
* Video frame configuration supplied to the host to customize the generated video frame parameters, like format
|
|
182
151
|
*/
|
|
183
|
-
|
|
152
|
+
config: VideoFrameConfig;
|
|
153
|
+
};
|
|
154
|
+
/**
|
|
155
|
+
* @hidden
|
|
156
|
+
* Register to process video frames
|
|
157
|
+
* @beta
|
|
158
|
+
*
|
|
159
|
+
* @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
|
|
160
|
+
* To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
|
|
161
|
+
* The host will choose the appropriate callback based on the host's capability.
|
|
162
|
+
*
|
|
163
|
+
* @internal
|
|
164
|
+
* Limited to Microsoft-internal use
|
|
165
|
+
*/
|
|
166
|
+
export declare function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
|
|
167
|
+
/**
|
|
168
|
+
* @hidden
|
|
169
|
+
* Video extension should call this to notify host that the current selected effect parameter changed.
|
|
170
|
+
* If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
|
|
171
|
+
* If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
172
|
+
* @beta
|
|
173
|
+
* @param effectChangeType - the effect change type.
|
|
174
|
+
* @param effectId - Newly selected effect id. {@linkcode VideoEffectCallBack}
|
|
175
|
+
* @param effectParam Variant for the newly selected effect. {@linkcode VideoEffectCallBack}
|
|
176
|
+
*
|
|
177
|
+
* @internal
|
|
178
|
+
* Limited to Microsoft-internal use
|
|
179
|
+
*/
|
|
180
|
+
export declare function notifySelectedVideoEffectChanged(effectChangeType: videoEffects.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
|
|
181
|
+
/**
|
|
182
|
+
* @hidden
|
|
183
|
+
* Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
|
|
184
|
+
* @beta
|
|
185
|
+
* @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
|
|
186
|
+
*
|
|
187
|
+
* @internal
|
|
188
|
+
* Limited to Microsoft-internal use
|
|
189
|
+
*/
|
|
190
|
+
export declare function registerForVideoEffect(callback: VideoEffectCallBack): void;
|
|
191
|
+
/**
|
|
192
|
+
* @hidden
|
|
193
|
+
* Personalized video effect
|
|
194
|
+
* @beta
|
|
195
|
+
*
|
|
196
|
+
* @internal
|
|
197
|
+
* Limited to Microsoft-internal use
|
|
198
|
+
*/
|
|
199
|
+
export interface PersonalizedEffect {
|
|
184
200
|
/**
|
|
185
|
-
*
|
|
186
|
-
* Personalized video effect
|
|
187
|
-
* @beta
|
|
188
|
-
*
|
|
189
|
-
* @internal
|
|
190
|
-
* Limited to Microsoft-internal use
|
|
201
|
+
* Personalized effect id
|
|
191
202
|
*/
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
* Personalized effect id
|
|
195
|
-
*/
|
|
196
|
-
id: string;
|
|
197
|
-
/**
|
|
198
|
-
* Display name
|
|
199
|
-
*/
|
|
200
|
-
name: string;
|
|
201
|
-
/**
|
|
202
|
-
* Effect type defined by app
|
|
203
|
-
*/
|
|
204
|
-
type: string;
|
|
205
|
-
/**
|
|
206
|
-
* Data URI of the thumbnail image content encoded in ASCII format using the base64 scheme
|
|
207
|
-
*/
|
|
208
|
-
thumbnail: string;
|
|
209
|
-
}
|
|
203
|
+
id: string;
|
|
210
204
|
/**
|
|
211
|
-
*
|
|
212
|
-
* Send personalized effects to Teams client
|
|
213
|
-
* @beta
|
|
214
|
-
*
|
|
215
|
-
* @internal
|
|
216
|
-
* Limited to Microsoft-internal use
|
|
205
|
+
* Display name
|
|
217
206
|
*/
|
|
218
|
-
|
|
207
|
+
name: string;
|
|
219
208
|
/**
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
* Checks if video capability is supported by the host
|
|
223
|
-
* @beta
|
|
224
|
-
*
|
|
225
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
226
|
-
*
|
|
227
|
-
* @returns boolean to represent whether the video capability is supported
|
|
228
|
-
*
|
|
229
|
-
* @internal
|
|
230
|
-
* Limited to Microsoft-internal use
|
|
209
|
+
* Effect type defined by app
|
|
231
210
|
*/
|
|
232
|
-
|
|
211
|
+
type: string;
|
|
233
212
|
/**
|
|
234
|
-
*
|
|
235
|
-
* Sending fatal error notification to host. Call this function only when your app meets fatal error and can't continue.
|
|
236
|
-
* The host will stop the video pipeline and terminate this session, and optionally, show an error message to the user.
|
|
237
|
-
* @beta
|
|
238
|
-
* @param errorMessage - The error message that will be sent to the host
|
|
239
|
-
*
|
|
240
|
-
* @internal
|
|
241
|
-
* Limited to Microsoft-internal use
|
|
213
|
+
* Data URI of the thumbnail image content encoded in ASCII format using the base64 scheme
|
|
242
214
|
*/
|
|
243
|
-
|
|
215
|
+
thumbnail: string;
|
|
244
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* @hidden
|
|
219
|
+
* Send personalized effects to Teams client
|
|
220
|
+
* @beta
|
|
221
|
+
*
|
|
222
|
+
* @internal
|
|
223
|
+
* Limited to Microsoft-internal use
|
|
224
|
+
*/
|
|
225
|
+
export declare function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
|
|
226
|
+
/**
|
|
227
|
+
* @hidden
|
|
228
|
+
*
|
|
229
|
+
* Checks if video capability is supported by the host
|
|
230
|
+
* @beta
|
|
231
|
+
*
|
|
232
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
233
|
+
*
|
|
234
|
+
* @returns boolean to represent whether the video capability is supported
|
|
235
|
+
*
|
|
236
|
+
* @internal
|
|
237
|
+
* Limited to Microsoft-internal use
|
|
238
|
+
*/
|
|
239
|
+
export declare function isSupported(): boolean;
|
|
240
|
+
/**
|
|
241
|
+
* @hidden
|
|
242
|
+
* Sending fatal error notification to host. Call this function only when your app meets fatal error and can't continue.
|
|
243
|
+
* The host will stop the video pipeline and terminate this session, and optionally, show an error message to the user.
|
|
244
|
+
* @beta
|
|
245
|
+
* @param errorMessage - The error message that will be sent to the host
|
|
246
|
+
*
|
|
247
|
+
* @internal
|
|
248
|
+
* Limited to Microsoft-internal use
|
|
249
|
+
*/
|
|
250
|
+
export declare function notifyFatalError(errorMessage: string): void;
|
|
@@ -1,5 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Module to interact with app initialization and lifecycle.
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import * as appHelpers from '../../internal/appHelpers';
|
|
6
|
+
import { ChannelType, FrameContexts, HostClientType, HostName, TeamType, UserTeamRole } from '../constants';
|
|
7
|
+
import { ActionInfo, FileOpenPreference, HostToAppPerformanceMetrics, LocaleInfo } from '../interfaces';
|
|
8
|
+
import * as lifecycle from './lifecycle';
|
|
3
9
|
/** App Initialization Messages */
|
|
4
10
|
export declare const Messages: {
|
|
5
11
|
/** App loaded. */
|
|
@@ -112,9 +118,17 @@ export interface AppInfo {
|
|
|
112
118
|
*/
|
|
113
119
|
iconPositionVertical?: number;
|
|
114
120
|
/**
|
|
115
|
-
* Time when the user clicked on the tab
|
|
121
|
+
* Time when the user clicked on the tab using the date.
|
|
122
|
+
*
|
|
123
|
+
* For measuring elapsed time between the moment the user click the tab, use {@link app.AppInfo.userClickTimeV2 | app.Context.app.userClickTimeV2} instead as it uses the performance timer API.
|
|
116
124
|
*/
|
|
117
125
|
userClickTime?: number;
|
|
126
|
+
/**
|
|
127
|
+
* Time when the user click on the app by using the performance timer API. Useful for measuring elapsed time accurately.
|
|
128
|
+
*
|
|
129
|
+
* For displaying the time when the user clicked on the app, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} as it uses the date.
|
|
130
|
+
*/
|
|
131
|
+
userClickTimeV2?: number;
|
|
118
132
|
/**
|
|
119
133
|
* The ID of the parent message from which this task module was launched.
|
|
120
134
|
* This is only available in task modules launched from bot cards.
|
|
@@ -442,6 +456,10 @@ export interface Context {
|
|
|
442
456
|
* This function is passed to registerOnThemeHandler. It is called every time the user changes their theme.
|
|
443
457
|
*/
|
|
444
458
|
export type themeHandler = (theme: string) => void;
|
|
459
|
+
/**
|
|
460
|
+
* This function is passed to registerHostToAppPerformanceMetricsHandler. It is called every time a response is received from the host with metrics for analyzing message delay. See {@link HostToAppPerformanceMetrics} to see which metrics are passed to the handler.
|
|
461
|
+
*/
|
|
462
|
+
export type HostToAppPerformanceMetricsHandler = (metrics: HostToAppPerformanceMetrics) => void;
|
|
445
463
|
/**
|
|
446
464
|
* Checks whether the Teams client SDK has been initialized.
|
|
447
465
|
* @returns whether the Teams client SDK has been initialized.
|
|
@@ -494,7 +512,7 @@ export declare function notifyAppLoaded(): void;
|
|
|
494
512
|
/**
|
|
495
513
|
* Notifies the frame that app initialization is successful and is ready for user interaction.
|
|
496
514
|
*/
|
|
497
|
-
export declare function notifySuccess():
|
|
515
|
+
export declare function notifySuccess(): Promise<appHelpers.NotifySuccessResponse>;
|
|
498
516
|
/**
|
|
499
517
|
* Notifies the frame that app initialization has failed and to show an error page in its place.
|
|
500
518
|
*
|
|
@@ -517,6 +535,15 @@ export declare function notifyExpectedFailure(expectedFailureRequest: IExpectedF
|
|
|
517
535
|
* @param handler - The handler to invoke when the user changes their theme.
|
|
518
536
|
*/
|
|
519
537
|
export declare function registerOnThemeChangeHandler(handler: themeHandler): void;
|
|
538
|
+
/**
|
|
539
|
+
* Registers a function for handling data of host to app message delay.
|
|
540
|
+
*
|
|
541
|
+
* @remarks
|
|
542
|
+
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
543
|
+
*
|
|
544
|
+
* @param handler - The handler to invoke when the metrics are available on each function response.
|
|
545
|
+
*/
|
|
546
|
+
export declare function registerHostToAppPerformanceMetricsHandler(handler: HostToAppPerformanceMetricsHandler): void;
|
|
520
547
|
/**
|
|
521
548
|
* This function opens deep links to other modules in the host such as chats or channels or
|
|
522
549
|
* general-purpose links (to external websites). It should not be used for navigating to your
|
|
@@ -549,44 +576,5 @@ export declare function registerOnThemeChangeHandler(handler: themeHandler): voi
|
|
|
549
576
|
* does not necessarily indicate whether the target loaded successfully.
|
|
550
577
|
*/
|
|
551
578
|
export declare function openLink(deepLink: string): Promise<void>;
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
* When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
|
|
555
|
-
* When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
|
|
556
|
-
* Please note that selecting suspension doesn't guarantee prevention of background termination.
|
|
557
|
-
* The outcome is influenced by factors such as available memory and the number of suspended apps.
|
|
558
|
-
*
|
|
559
|
-
* @beta
|
|
560
|
-
*/
|
|
561
|
-
export declare namespace lifecycle {
|
|
562
|
-
/**
|
|
563
|
-
* Register on resume handler function type
|
|
564
|
-
*
|
|
565
|
-
* @param context - Data structure to be used to pass the context to the app.
|
|
566
|
-
*/
|
|
567
|
-
type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
|
|
568
|
-
/**
|
|
569
|
-
* Register before suspendOrTerminate handler function type
|
|
570
|
-
*
|
|
571
|
-
* @returns void
|
|
572
|
-
*/
|
|
573
|
-
type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
|
|
574
|
-
/**
|
|
575
|
-
* Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
|
|
576
|
-
* the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
|
|
577
|
-
*
|
|
578
|
-
* @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
|
|
579
|
-
* Upon returning, the app will be suspended or terminated.
|
|
580
|
-
*
|
|
581
|
-
*/
|
|
582
|
-
function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
|
|
583
|
-
/**
|
|
584
|
-
* Registers a handler to be called when the page has been requested to resume from being suspended.
|
|
585
|
-
*
|
|
586
|
-
* @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
|
|
587
|
-
* the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
|
|
588
|
-
*
|
|
589
|
-
* @beta
|
|
590
|
-
*/
|
|
591
|
-
function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
|
|
592
|
-
}
|
|
579
|
+
export { lifecycle };
|
|
580
|
+
export { NotifySuccessResponse } from '../../internal/appHelpers';
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A module for enabling the suspension or delayed termination of an app when the user navigates away.
|
|
3
|
+
* When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
|
|
4
|
+
* When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
|
|
5
|
+
* Please note that selecting suspension doesn't guarantee prevention of background termination.
|
|
6
|
+
* The outcome is influenced by factors such as available memory and the number of suspended apps.
|
|
7
|
+
*
|
|
8
|
+
* @beta
|
|
9
|
+
* @module
|
|
10
|
+
*/
|
|
11
|
+
import { ResumeContext } from '../interfaces';
|
|
12
|
+
/**
|
|
13
|
+
* Register on resume handler function type
|
|
14
|
+
*
|
|
15
|
+
* @param context - Data structure to be used to pass the context to the app.
|
|
16
|
+
*/
|
|
17
|
+
export type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
|
|
18
|
+
/**
|
|
19
|
+
* Register before suspendOrTerminate handler function type
|
|
20
|
+
*
|
|
21
|
+
* @returns void
|
|
22
|
+
*/
|
|
23
|
+
export type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
|
|
24
|
+
/**
|
|
25
|
+
* Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
|
|
26
|
+
* the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
|
|
27
|
+
*
|
|
28
|
+
* @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
|
|
29
|
+
* Upon returning, the app will be suspended or terminated.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
export declare function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
|
|
33
|
+
/**
|
|
34
|
+
* Registers a handler to be called when the page has been requested to resume from being suspended.
|
|
35
|
+
*
|
|
36
|
+
* @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
|
|
37
|
+
* the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
|
|
38
|
+
*
|
|
39
|
+
* @beta
|
|
40
|
+
*/
|
|
41
|
+
export declare function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ExpectedFailureReason, FailedReason, IExpectedFailureRequest, IFailedRequest, Messages } from './app';
|
|
1
|
+
import { ExpectedFailureReason, FailedReason, IExpectedFailureRequest, IFailedRequest, Messages } from './app/app';
|
|
2
2
|
/**
|
|
3
3
|
* @deprecated
|
|
4
4
|
* As of TeamsJS v2.0.0, please use {@link app.Messages} instead.
|
|
@@ -33,7 +33,7 @@ export { IExpectedFailureRequest };
|
|
|
33
33
|
export declare function notifyAppLoaded(): void;
|
|
34
34
|
/**
|
|
35
35
|
* @deprecated
|
|
36
|
-
* As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess():
|
|
36
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess(): Promise<NotifySuccessResponse>} instead.
|
|
37
37
|
*
|
|
38
38
|
* Notifies the frame that app initialization is successful and is ready for user interaction.
|
|
39
39
|
*/
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Module to interact with the barcode scanning-specific part of the SDK.
|
|
3
3
|
*
|
|
4
4
|
* @beta
|
|
5
|
+
* @module
|
|
5
6
|
*/
|
|
6
7
|
/**
|
|
7
8
|
* Data structure to customize the barcode scanning experience in scanBarCode API.
|