@microsoft/teams-js 2.31.0-beta.1 → 2.31.0

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.
Files changed (183) hide show
  1. package/README.md +4 -4
  2. package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +11 -1
  3. package/dist/esm/packages/teams-js/dts/internal/appIdValidation.d.ts +10 -0
  4. package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +11 -1
  5. package/dist/esm/packages/teams-js/dts/internal/hostToAppTelemetry.d.ts +51 -0
  6. package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +11 -0
  7. package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +5 -0
  8. package/dist/esm/packages/teams-js/dts/internal/pagesHelpers.d.ts +24 -0
  9. package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +23 -1
  10. package/dist/esm/packages/teams-js/dts/internal/uint8array-extras/uint8array-extras.d.ts +6 -0
  11. package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +20 -1
  12. package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +2 -2
  13. package/dist/esm/packages/teams-js/dts/internal/visualMediaHelpers.d.ts +14 -0
  14. package/dist/esm/packages/teams-js/dts/internal/webStorageHelpers.d.ts +4 -0
  15. package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +61 -61
  16. package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +48 -48
  17. package/dist/esm/packages/teams-js/dts/private/copilot/copilot.d.ts +2 -0
  18. package/dist/esm/packages/teams-js/dts/private/copilot/eligibility.d.ts +29 -0
  19. package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +355 -349
  20. package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +70 -68
  21. package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +104 -105
  22. package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +41 -42
  23. package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +113 -114
  24. package/dist/esm/packages/teams-js/dts/private/files.d.ts +590 -582
  25. package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts +42 -0
  26. package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts +134 -0
  27. package/dist/esm/packages/teams-js/dts/private/index.d.ts +19 -18
  28. package/dist/esm/packages/teams-js/dts/private/logs.d.ts +31 -25
  29. package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +147 -142
  30. package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts +39 -0
  31. package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts +28 -0
  32. package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts +39 -0
  33. package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +31 -25
  34. package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +69 -70
  35. package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +219 -214
  36. package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/fullTrust.d.ts +31 -0
  37. package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/joinedTeams.d.ts +30 -0
  38. package/dist/esm/packages/teams-js/dts/private/teams/teams.d.ts +63 -0
  39. package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +192 -186
  40. package/dist/esm/packages/teams-js/dts/public/app/app.d.ts +21 -2
  41. package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +3 -2
  42. package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +1 -1
  43. package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +6 -0
  44. package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +2 -1
  45. package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +1 -0
  46. package/dist/esm/packages/teams-js/dts/public/call.d.ts +1 -0
  47. package/dist/esm/packages/teams-js/dts/public/chat.d.ts +4 -0
  48. package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +1 -0
  49. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +0 -4
  50. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +3 -2
  51. package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +0 -13
  52. package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +2 -1
  53. package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +3 -2
  54. package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +2 -1
  55. package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +3 -2
  56. package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +6 -0
  57. package/dist/esm/packages/teams-js/dts/public/index.d.ts +9 -9
  58. package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +11 -0
  59. package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +1 -0
  60. package/dist/esm/packages/teams-js/dts/public/location.d.ts +4 -3
  61. package/dist/esm/packages/teams-js/dts/public/mail.d.ts +1 -0
  62. package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +1 -0
  63. package/dist/esm/packages/teams-js/dts/public/media.d.ts +0 -3
  64. package/dist/esm/packages/teams-js/dts/public/meeting/appShareButton.d.ts +51 -0
  65. package/dist/esm/packages/teams-js/dts/public/meeting/meeting.d.ts +854 -0
  66. package/dist/esm/packages/teams-js/dts/public/menus.d.ts +1 -0
  67. package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +8 -0
  68. package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +2 -1
  69. package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +1 -0
  70. package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts +30 -0
  71. package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts +44 -0
  72. package/dist/esm/packages/teams-js/dts/public/pages/config.d.ts +123 -0
  73. package/dist/esm/packages/teams-js/dts/public/pages/currentApp.d.ts +46 -0
  74. package/dist/esm/packages/teams-js/dts/public/pages/fullTrust.d.ts +33 -0
  75. package/dist/esm/packages/teams-js/dts/public/pages/pages.d.ts +253 -0
  76. package/dist/esm/packages/teams-js/dts/public/pages/tabs.d.ts +32 -0
  77. package/dist/esm/packages/teams-js/dts/public/profile.d.ts +81 -103
  78. package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +3 -0
  79. package/dist/esm/packages/teams-js/dts/public/search.d.ts +9 -0
  80. package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +1 -0
  81. package/dist/esm/packages/teams-js/dts/public/settings.d.ts +4 -3
  82. package/dist/esm/packages/teams-js/dts/public/sharing/history.d.ts +47 -0
  83. package/dist/esm/packages/teams-js/dts/public/sharing/sharing.d.ts +76 -0
  84. package/dist/esm/packages/teams-js/dts/public/stageView/self.d.ts +23 -0
  85. package/dist/esm/packages/teams-js/dts/public/stageView/stageView.d.ts +81 -0
  86. package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +0 -8
  87. package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +4 -0
  88. package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +2 -1
  89. package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +209 -210
  90. package/dist/esm/packages/teams-js/dts/public/visualMedia/image.d.ts +64 -0
  91. package/dist/esm/packages/teams-js/dts/public/visualMedia/visualMedia.d.ts +116 -0
  92. package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +20 -22
  93. package/dist/esm/packages/teams-js/src/index.js +1 -1
  94. package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -1
  95. package/dist/esm/packages/teams-js/src/internal/appIdValidation.js +1 -1
  96. package/dist/esm/packages/teams-js/src/internal/communication.js +1 -1
  97. package/dist/esm/packages/teams-js/src/internal/handlers.js +1 -1
  98. package/dist/esm/packages/teams-js/src/internal/hostToAppTelemetry.js +1 -0
  99. package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -1
  100. package/dist/esm/packages/teams-js/src/internal/messageObjects.js +1 -1
  101. package/dist/esm/packages/teams-js/src/internal/pagesHelpers.js +1 -0
  102. package/dist/esm/packages/teams-js/src/internal/uint8array-extras/uint8array-extras.js +1 -0
  103. package/dist/esm/packages/teams-js/src/internal/utils.js +1 -1
  104. package/dist/esm/packages/teams-js/src/internal/validOrigins.js +1 -1
  105. package/dist/esm/packages/teams-js/src/internal/videoEffectsUtils.js +1 -1
  106. package/dist/esm/packages/teams-js/src/internal/visualMediaHelpers.js +1 -0
  107. package/dist/esm/packages/teams-js/src/internal/webStorageHelpers.js +1 -0
  108. package/dist/esm/packages/teams-js/src/private/appEntity.js +1 -1
  109. package/dist/esm/packages/teams-js/src/private/conversations.js +1 -1
  110. package/dist/esm/packages/teams-js/src/private/copilot/copilot.js +1 -0
  111. package/dist/esm/packages/teams-js/src/private/copilot/eligibility.js +1 -0
  112. package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
  113. package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -1
  114. package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -1
  115. package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -1
  116. package/dist/esm/packages/teams-js/src/private/externalAppCommands.js +1 -1
  117. package/dist/esm/packages/teams-js/src/private/files.js +1 -1
  118. package/dist/esm/packages/teams-js/src/private/hostEntity/hostEntity.js +1 -0
  119. package/dist/esm/packages/teams-js/src/private/hostEntity/tab.js +1 -0
  120. package/dist/esm/packages/teams-js/src/private/logs.js +1 -1
  121. package/dist/esm/packages/teams-js/src/private/meetingRoom.js +1 -1
  122. package/dist/esm/packages/teams-js/src/private/messageChannels/dataLayer.js +1 -0
  123. package/dist/esm/packages/teams-js/src/private/messageChannels/messageChannels.js +1 -0
  124. package/dist/esm/packages/teams-js/src/private/messageChannels/telemetry.js +1 -0
  125. package/dist/esm/packages/teams-js/src/private/notifications.js +1 -1
  126. package/dist/esm/packages/teams-js/src/private/otherAppStateChange.js +1 -1
  127. package/dist/esm/packages/teams-js/src/private/remoteCamera.js +1 -1
  128. package/dist/esm/packages/teams-js/src/private/teams/fullTrust/fullTrust.js +1 -0
  129. package/dist/esm/packages/teams-js/src/private/teams/fullTrust/joinedTeams.js +1 -0
  130. package/dist/esm/packages/teams-js/src/private/teams/teams.js +1 -0
  131. package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -1
  132. package/dist/esm/packages/teams-js/src/public/app/app.js +1 -1
  133. package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
  134. package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
  135. package/dist/esm/packages/teams-js/src/public/meeting/appShareButton.js +1 -0
  136. package/dist/esm/packages/teams-js/src/public/meeting/meeting.js +1 -0
  137. package/dist/esm/packages/teams-js/src/public/navigation.js +1 -1
  138. package/dist/esm/packages/teams-js/src/public/pages/appButton.js +1 -0
  139. package/dist/esm/packages/teams-js/src/public/pages/backStack.js +1 -0
  140. package/dist/esm/packages/teams-js/src/public/pages/config.js +1 -0
  141. package/dist/esm/packages/teams-js/src/public/pages/currentApp.js +1 -0
  142. package/dist/esm/packages/teams-js/src/public/pages/fullTrust.js +1 -0
  143. package/dist/esm/packages/teams-js/src/public/pages/pages.js +1 -0
  144. package/dist/esm/packages/teams-js/src/public/pages/tabs.js +1 -0
  145. package/dist/esm/packages/teams-js/src/public/profile.js +1 -1
  146. package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
  147. package/dist/esm/packages/teams-js/src/public/runtime.js +1 -1
  148. package/dist/esm/packages/teams-js/src/public/settings.js +1 -1
  149. package/dist/esm/packages/teams-js/src/public/sharing/history.js +1 -0
  150. package/dist/esm/packages/teams-js/src/public/sharing/sharing.js +1 -0
  151. package/dist/esm/packages/teams-js/src/public/stageView/self.js +1 -0
  152. package/dist/esm/packages/teams-js/src/public/stageView/stageView.js +1 -0
  153. package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
  154. package/dist/esm/packages/teams-js/src/public/version.js +1 -1
  155. package/dist/esm/packages/teams-js/src/public/videoEffects.js +1 -1
  156. package/dist/esm/packages/teams-js/src/public/visualMedia/image.js +1 -0
  157. package/dist/esm/packages/teams-js/src/public/visualMedia/visualMedia.js +1 -0
  158. package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
  159. package/dist/umd/MicrosoftTeams.d.ts +5755 -5161
  160. package/dist/umd/MicrosoftTeams.js +6258 -6439
  161. package/dist/umd/MicrosoftTeams.js.map +1 -1
  162. package/dist/umd/MicrosoftTeams.min.js +1 -1
  163. package/dist/umd/MicrosoftTeams.min.js.map +1 -1
  164. package/package.json +50 -1
  165. package/dist/esm/packages/teams-js/dts/private/copilot.d.ts +0 -39
  166. package/dist/esm/packages/teams-js/dts/private/hostEntity.d.ts +0 -176
  167. package/dist/esm/packages/teams-js/dts/private/messageChannels.d.ts +0 -107
  168. package/dist/esm/packages/teams-js/dts/private/teams.d.ts +0 -116
  169. package/dist/esm/packages/teams-js/dts/public/meeting.d.ts +0 -906
  170. package/dist/esm/packages/teams-js/dts/public/pages.d.ts +0 -574
  171. package/dist/esm/packages/teams-js/dts/public/sharing.d.ts +0 -124
  172. package/dist/esm/packages/teams-js/dts/public/stageView.d.ts +0 -104
  173. package/dist/esm/packages/teams-js/dts/public/visualMedia.d.ts +0 -192
  174. package/dist/esm/packages/teams-js/src/private/copilot.js +0 -1
  175. package/dist/esm/packages/teams-js/src/private/hostEntity.js +0 -1
  176. package/dist/esm/packages/teams-js/src/private/messageChannels.js +0 -1
  177. package/dist/esm/packages/teams-js/src/private/teams.js +0 -1
  178. package/dist/esm/packages/teams-js/src/public/meeting.js +0 -1
  179. package/dist/esm/packages/teams-js/src/public/pages.js +0 -1
  180. package/dist/esm/packages/teams-js/src/public/sharing.js +0 -1
  181. package/dist/esm/packages/teams-js/src/public/stageView.js +0 -1
  182. package/dist/esm/packages/teams-js/src/public/visualMedia.js +0 -1
  183. /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 { videoEffects } from '../public/videoEffects';
3
- export declare namespace videoEffectsEx {
4
- const frameProcessingTimeoutInMs = 2000;
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
- * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
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
- enum ErrorLevel {
14
- Fatal = "fatal",
15
- Warn = "warn"
16
- }
42
+ requireCameraStream?: boolean;
17
43
  /**
18
44
  * @hidden
19
- * Video frame configuration supplied to the host to customize the generated video frame parameters
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
- interface VideoFrameConfig extends videoEffects.VideoFrameConfig {
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
- * Represents a video frame
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
- interface VideoBufferData extends videoEffects.VideoBufferData {
64
- /**
65
- * @hidden
66
- * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
67
- * @beta
68
- *
69
- * @internal
70
- * Limited to Microsoft-internal use
71
- */
72
- audioInferenceResult?: Uint8Array;
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 callback will be called on every frame when running on the supported host.
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
- type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
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
- * Video frame data extracted from the media stream. More properties may be added in the future.
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
- type VideoFrameData = videoEffects.VideoFrameData & {
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
- * The callback will be called on every frame when running on the supported host.
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
- type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<videoEffects.VideoFrame>;
126
- /**
127
- * @hidden
128
- * @beta
129
- * Callbacks and configuration supplied to the host to process the video frames.
130
- * @internal
131
- * Limited to Microsoft-internal use
132
- */
133
- type RegisterForVideoFrameParameters = {
134
- /**
135
- * Callback function to process the video frames extracted from a media stream.
136
- */
137
- videoFrameHandler: VideoFrameHandler;
138
- /**
139
- * Callback function to process the video frames shared by the host.
140
- */
141
- videoBufferHandler: VideoBufferHandler;
142
- /**
143
- * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
144
- */
145
- config: VideoFrameConfig;
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
- * @hidden
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
- function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
144
+ videoFrameHandler: VideoFrameHandler;
160
145
  /**
161
- * @hidden
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
- function notifySelectedVideoEffectChanged(effectChangeType: videoEffects.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
148
+ videoBufferHandler: VideoBufferHandler;
174
149
  /**
175
- * @hidden
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
- function registerForVideoEffect(callback: VideoEffectCallBack): void;
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
- * @hidden
186
- * Personalized video effect
187
- * @beta
188
- *
189
- * @internal
190
- * Limited to Microsoft-internal use
201
+ * Personalized effect id
191
202
  */
192
- interface PersonalizedEffect {
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
- * @hidden
212
- * Send personalized effects to Teams client
213
- * @beta
214
- *
215
- * @internal
216
- * Limited to Microsoft-internal use
205
+ * Display name
217
206
  */
218
- function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
207
+ name: string;
219
208
  /**
220
- * @hidden
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
- function isSupported(): boolean;
211
+ type: string;
233
212
  /**
234
- * @hidden
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
- function notifyFatalError(errorMessage: string): void;
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,10 @@
1
+ /**
2
+ * Module to interact with app initialization and lifecycle.
3
+ * @module
4
+ */
5
+ import * as appHelpers from '../../internal/appHelpers';
1
6
  import { ChannelType, FrameContexts, HostClientType, HostName, TeamType, UserTeamRole } from '../constants';
2
- import { ActionInfo, FileOpenPreference, LocaleInfo } from '../interfaces';
7
+ import { ActionInfo, FileOpenPreference, HostToAppPerformanceMetrics, LocaleInfo } from '../interfaces';
3
8
  import * as lifecycle from './lifecycle';
4
9
  /** App Initialization Messages */
5
10
  export declare const Messages: {
@@ -451,6 +456,10 @@ export interface Context {
451
456
  * This function is passed to registerOnThemeHandler. It is called every time the user changes their theme.
452
457
  */
453
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;
454
463
  /**
455
464
  * Checks whether the Teams client SDK has been initialized.
456
465
  * @returns whether the Teams client SDK has been initialized.
@@ -503,7 +512,7 @@ export declare function notifyAppLoaded(): void;
503
512
  /**
504
513
  * Notifies the frame that app initialization is successful and is ready for user interaction.
505
514
  */
506
- export declare function notifySuccess(): void;
515
+ export declare function notifySuccess(): Promise<appHelpers.NotifySuccessResponse>;
507
516
  /**
508
517
  * Notifies the frame that app initialization has failed and to show an error page in its place.
509
518
  *
@@ -526,6 +535,15 @@ export declare function notifyExpectedFailure(expectedFailureRequest: IExpectedF
526
535
  * @param handler - The handler to invoke when the user changes their theme.
527
536
  */
528
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;
529
547
  /**
530
548
  * This function opens deep links to other modules in the host such as chats or channels or
531
549
  * general-purpose links (to external websites). It should not be used for navigating to your
@@ -559,3 +577,4 @@ export declare function registerOnThemeChangeHandler(handler: themeHandler): voi
559
577
  */
560
578
  export declare function openLink(deepLink: string): Promise<void>;
561
579
  export { lifecycle };
580
+ export { NotifySuccessResponse } from '../../internal/appHelpers';
@@ -1,13 +1,14 @@
1
- import { ResumeContext } from '../interfaces';
2
1
  /**
3
- * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
2
+ * A module for enabling the suspension or delayed termination of an app when the user navigates away.
4
3
  * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
5
4
  * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
6
5
  * Please note that selecting suspension doesn't guarantee prevention of background termination.
7
6
  * The outcome is influenced by factors such as available memory and the number of suspended apps.
8
7
  *
9
8
  * @beta
9
+ * @module
10
10
  */
11
+ import { ResumeContext } from '../interfaces';
11
12
  /**
12
13
  * Register on resume handler function type
13
14
  *
@@ -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(): void} instead.
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,3 +1,9 @@
1
+ /**
2
+ * Module to interact with the authentication-specific part of the SDK.
3
+ *
4
+ * This object is used for starting or completing authentication flows.
5
+ * @module
6
+ */
1
7
  /**
2
8
  * @hidden
3
9
  * @internal
@@ -1,7 +1,8 @@
1
1
  /**
2
- * Namespace to interact with the barcode scanning-specific part of the SDK.
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.
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Interact with the user's calendar, including opening calendar items and composing meetings.
3
+ * @module
3
4
  */
4
5
  /**
5
6
  * Opens a calendar item.
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Used to interact with call functionality, including starting calls with other users.
3
+ * @module
3
4
  */
4
5
  /** Modalities that can be associated with a call. */
5
6
  export declare enum CallModalities {
@@ -1,3 +1,7 @@
1
+ /**
2
+ * Describes information needed to start a chat
3
+ * @module
4
+ */
1
5
  interface OpenChatRequest {
2
6
  /**
3
7
  * An optional message used when initiating chat
@@ -2,6 +2,7 @@
2
2
  * Interact with the system clipboard
3
3
  *
4
4
  * @beta
5
+ * @module
5
6
  */
6
7
  /**
7
8
  * Function to copy data to clipboard.
@@ -1,10 +1,6 @@
1
1
  import { AdaptiveCardDialogInfo } from '../../interfaces';
2
2
  import { DialogSubmitHandler } from '../dialog';
3
3
  import * as bot from './bot';
4
- /**
5
- * Subcapability for interacting with adaptive card dialogs
6
- * @beta
7
- */
8
4
  /**
9
5
  * Allows app to open an adaptive card based dialog.
10
6
  *
@@ -1,10 +1,11 @@
1
- import { BotAdaptiveCardDialogInfo } from '../../interfaces';
2
- import { DialogSubmitHandler } from '../dialog';
3
1
  /**
4
2
  * Module for interaction with adaptive card dialogs that need to communicate with the bot framework
5
3
  *
6
4
  * @beta
5
+ * @module
7
6
  */
7
+ import { BotAdaptiveCardDialogInfo } from '../../interfaces';
8
+ import { DialogSubmitHandler } from '../dialog';
8
9
  /**
9
10
  * Allows an app to open an adaptive card-based dialog module using bot.
10
11
  *
@@ -1,19 +1,6 @@
1
1
  import * as adaptiveCard from './adaptiveCard/adaptiveCard';
2
2
  import * as update from './update';
3
3
  import * as url from './url/url';
4
- /**
5
- * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
6
- * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
7
- * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
8
- * - For URL dialogs, use the functions and interfaces in the {@link url} module.
9
- * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
10
- * - For Adaptive Card dialogs, use the functions and interfaces in the {@link adaptiveCard} module.
11
- *
12
- * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
13
- * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
14
- *
15
- * @beta
16
- */
17
4
  /**
18
5
  * Data Structure to represent the SDK response when dialog closes
19
6
  *
@@ -1,9 +1,10 @@
1
- import { DialogSize } from '../interfaces';
2
1
  /**
3
2
  * Module to update the dialog
4
3
  *
5
4
  * @beta
5
+ * @module
6
6
  */
7
+ import { DialogSize } from '../interfaces';
7
8
  /**
8
9
  * Update dimensions - height/width of a dialog.
9
10
  *
@@ -1,10 +1,11 @@
1
- import { BotUrlDialogInfo } from '../../interfaces';
2
- import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
3
1
  /**
4
2
  * Module to open a dialog that sends results to the bot framework
5
3
  *
6
4
  * @beta
5
+ * @module
7
6
  */
7
+ import { BotUrlDialogInfo } from '../../interfaces';
8
+ import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
8
9
  /**
9
10
  * Allows an app to open a dialog that sends submitted data to a bot.
10
11
  *
@@ -1,4 +1,3 @@
1
- import { PostMessageChannel } from '../dialog';
2
1
  /**
3
2
  * Subcapability that allows communication between the dialog and the parent app.
4
3
  *
@@ -6,7 +5,9 @@ import { PostMessageChannel } from '../dialog';
6
5
  * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
7
6
  *
8
7
  * @beta
8
+ * @module
9
9
  */
10
+ import { PostMessageChannel } from '../dialog';
10
11
  /**
11
12
  * Send message to the parent from dialog
12
13
  *