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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +1 -1
  2. package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts +32 -0
  3. package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts +1 -1
  4. package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts +2 -2
  5. package/dist/esm/packages/teams-js/dts/public/{app.d.ts → app/app.d.ts} +13 -44
  6. package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +40 -0
  7. package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +1 -1
  8. package/dist/esm/packages/teams-js/dts/public/chat.d.ts +26 -28
  9. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +30 -0
  10. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +26 -0
  11. package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +69 -0
  12. package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +23 -0
  13. package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +29 -0
  14. package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +49 -0
  15. package/dist/esm/packages/teams-js/dts/public/dialog/url/url.d.ts +60 -0
  16. package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +67 -0
  17. package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +27 -0
  18. package/dist/esm/packages/teams-js/dts/public/index.d.ts +20 -18
  19. package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +12 -1
  20. package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +134 -136
  21. package/dist/esm/packages/teams-js/dts/public/location.d.ts +72 -74
  22. package/dist/esm/packages/teams-js/dts/public/mail.d.ts +79 -81
  23. package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +314 -316
  24. package/dist/esm/packages/teams-js/dts/public/media.d.ts +425 -427
  25. package/dist/esm/packages/teams-js/dts/public/menus.d.ts +164 -166
  26. package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +48 -50
  27. package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +9 -11
  28. package/dist/esm/packages/teams-js/dts/public/people.d.ts +61 -63
  29. package/dist/esm/packages/teams-js/dts/public/search.d.ts +76 -86
  30. package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +25 -27
  31. package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +52 -54
  32. package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +74 -76
  33. package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +96 -98
  34. package/dist/esm/packages/teams-js/src/index.js +1 -1
  35. package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -1
  36. package/dist/esm/packages/teams-js/src/internal/deepLinkUtilities.js +1 -1
  37. package/dist/esm/packages/teams-js/src/internal/dialogHelpers.js +1 -0
  38. package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -1
  39. package/dist/esm/packages/teams-js/src/internal/mediaUtil.js +1 -1
  40. package/dist/esm/packages/teams-js/src/public/app/app.js +1 -0
  41. package/dist/esm/packages/teams-js/src/public/app/lifecycle.js +1 -0
  42. package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
  43. package/dist/esm/packages/teams-js/src/public/chat.js +1 -1
  44. package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/adaptiveCard.js +1 -0
  45. package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/bot.js +1 -0
  46. package/dist/esm/packages/teams-js/src/public/dialog/dialog.js +1 -0
  47. package/dist/esm/packages/teams-js/src/public/dialog/update.js +1 -0
  48. package/dist/esm/packages/teams-js/src/public/dialog/url/bot.js +1 -0
  49. package/dist/esm/packages/teams-js/src/public/dialog/url/parentCommunication.js +1 -0
  50. package/dist/esm/packages/teams-js/src/public/dialog/url/url.js +1 -0
  51. package/dist/esm/packages/teams-js/src/public/geoLocation/geoLocation.js +1 -0
  52. package/dist/esm/packages/teams-js/src/public/geoLocation/map.js +1 -0
  53. package/dist/esm/packages/teams-js/src/public/liveShareHost.js +1 -1
  54. package/dist/esm/packages/teams-js/src/public/location.js +1 -1
  55. package/dist/esm/packages/teams-js/src/public/mail.js +1 -1
  56. package/dist/esm/packages/teams-js/src/public/marketplace.js +1 -1
  57. package/dist/esm/packages/teams-js/src/public/media.js +1 -1
  58. package/dist/esm/packages/teams-js/src/public/menus.js +1 -1
  59. package/dist/esm/packages/teams-js/src/public/monetization.js +1 -1
  60. package/dist/esm/packages/teams-js/src/public/nestedAppAuth.js +1 -1
  61. package/dist/esm/packages/teams-js/src/public/people.js +1 -1
  62. package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
  63. package/dist/esm/packages/teams-js/src/public/search.js +1 -1
  64. package/dist/esm/packages/teams-js/src/public/secondaryBrowser.js +1 -1
  65. package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
  66. package/dist/esm/packages/teams-js/src/public/teamsAPIs.js +1 -1
  67. package/dist/esm/packages/teams-js/src/public/thirdPartyCloudStorage.js +1 -1
  68. package/dist/esm/packages/teams-js/src/public/version.js +1 -1
  69. package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
  70. package/dist/umd/MicrosoftTeams.d.ts +2219 -2022
  71. package/dist/umd/MicrosoftTeams.js +2397 -2244
  72. package/dist/umd/MicrosoftTeams.js.map +1 -1
  73. package/dist/umd/MicrosoftTeams.min.js +1 -1
  74. package/dist/umd/MicrosoftTeams.min.js.map +1 -1
  75. package/package.json +1 -1
  76. package/dist/esm/packages/teams-js/dts/public/dialog.d.ts +0 -286
  77. package/dist/esm/packages/teams-js/dts/public/geoLocation.d.ts +0 -100
  78. package/dist/esm/packages/teams-js/src/public/app.js +0 -1
  79. package/dist/esm/packages/teams-js/src/public/dialog.js +0 -1
  80. package/dist/esm/packages/teams-js/src/public/geoLocation.js +0 -1
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@microsoft/teams-js","author":"Microsoft Teams","version":"2.31.0-beta.0","description":"Microsoft Client SDK for building app for Microsoft hosts","repository":{"directory":"packages/teams-js","type":"git","url":"https://github.com/OfficeDev/microsoft-teams-library-js"},"main":"./dist/umd/MicrosoftTeams.min.js","typings":"./dist/umd/MicrosoftTeams.d.ts","module":"./dist/esm/packages/teams-js/src/index.js","type":"module","scripts":{"build":"pnpm clean && pnpm lint && pnpm build-rollup && pnpm build-webpack && pnpm docs:validate","build-rollup":"pnpm clean && rollup -c","build-webpack":"webpack","clean":"rimraf ./dist","docs":"pnpm typedoc","docs:validate":"pnpm typedoc --emit none","lint":"pnpm eslint ./src ./test --max-warnings 0 --fix --ext .ts","prettier":"prettier --write '**/*.{ts,js,css,html}'","test":"jest","test:verbose":"pnpm test -- --verbose false --silent false"},"dependencies":{"base64-js":"^1.3.1","debug":"^4.3.3"},"devDependencies":{"@types/debug":"^4.1.7"},"sideEffects":["src/internal/communication.ts","src/internal/nestedAppAuthUtils.ts","src/internal/utils.ts","src/internal/videoEffectsUtils.ts","src/private/constants.ts","src/private/interfaces.ts","src/public/constants.ts","src/public/handlers.ts","src/public/interfaces.ts"],"license":"MIT","files":["dist/**","LICENSE","README.md"]}
1
+ {"name":"@microsoft/teams-js","author":"Microsoft Teams","version":"2.31.0-beta.1","description":"Microsoft Client SDK for building app for Microsoft hosts","repository":{"directory":"packages/teams-js","type":"git","url":"https://github.com/OfficeDev/microsoft-teams-library-js"},"main":"./dist/umd/MicrosoftTeams.min.js","typings":"./dist/umd/MicrosoftTeams.d.ts","module":"./dist/esm/packages/teams-js/src/index.js","type":"module","scripts":{"build":"pnpm clean && pnpm lint && pnpm build-rollup && pnpm build-webpack && pnpm docs:validate","build-rollup":"pnpm clean && rollup -c","build-webpack":"webpack","clean":"rimraf ./dist","docs":"pnpm typedoc","docs:validate":"pnpm typedoc --emit none","lint":"pnpm eslint ./src ./test --max-warnings 0 --fix --ext .ts","prettier":"prettier --write '**/*.{ts,js,css,html}'","test":"jest","test:verbose":"pnpm test -- --verbose false --silent false"},"dependencies":{"base64-js":"^1.3.1","debug":"^4.3.3"},"devDependencies":{"@types/debug":"^4.1.7"},"sideEffects":["src/internal/communication.ts","src/internal/nestedAppAuthUtils.ts","src/internal/utils.ts","src/internal/videoEffectsUtils.ts","src/private/constants.ts","src/private/interfaces.ts","src/public/constants.ts","src/public/handlers.ts","src/public/interfaces.ts"],"license":"MIT","files":["dist/**","LICENSE","README.md"]}
@@ -1,286 +0,0 @@
1
- import { AdaptiveCardDialogInfo, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, DialogInfo, DialogSize, UrlDialogInfo } from './interfaces';
2
- export declare function updateResizeHelper(apiVersionTag: string, dimensions: DialogSize): void;
3
- export declare function urlOpenHelper(apiVersionTag: string, urlDialogInfo: UrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
4
- export declare function botUrlOpenHelper(apiVersionTag: string, urlDialogInfo: BotUrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
5
- export declare function urlSubmitHelper(apiVersionTag: string, result?: string | object, appIds?: string | string[]): void;
6
- /**
7
- * 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.
8
- * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
9
- * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
10
- * - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
11
- * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
12
- * - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
13
- *
14
- * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
15
- * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
16
- *
17
- * @beta
18
- */
19
- export declare namespace dialog {
20
- /**
21
- * Data Structure to represent the SDK response when dialog closes
22
- *
23
- * @beta
24
- */
25
- interface ISdkResponse {
26
- /**
27
- * Error in case there is a failure before dialog submission
28
- */
29
- err?: string;
30
- /**
31
- * Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
32
- * was called.
33
- * If the dialog was closed by the user without submitting (e.g., using a control in the corner
34
- * of the dialog), this value will be `undefined` here.
35
- */
36
- result?: string | object;
37
- }
38
- /**
39
- * Handler used to receive and process messages sent between a dialog and the app that launched it
40
- * @beta
41
- */
42
- type PostMessageChannel = (message: any) => void;
43
- /**
44
- * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
45
- * or an error if the dialog was closed by the user.
46
- *
47
- * @see {@linkcode ISdkResponse}
48
- *
49
- * @beta
50
- */
51
- type DialogSubmitHandler = (result: ISdkResponse) => void;
52
- /**
53
- * @hidden
54
- * Hide from docs because this function is only used during initialization
55
- *
56
- * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
57
- * Function is called during app initialization
58
- * @internal
59
- * Limited to Microsoft-internal use
60
- *
61
- * @beta
62
- */
63
- function initialize(): void;
64
- namespace url {
65
- /**
66
- * Allows app to open a url based dialog.
67
- *
68
- * @remarks
69
- * This function cannot be called from inside of a dialog
70
- *
71
- * @param urlDialogInfo - An object containing the parameters of the dialog module.
72
- * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
73
- * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
74
- *
75
- * @beta
76
- */
77
- function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
78
- /**
79
- * Submit the dialog module and close the dialog
80
- *
81
- * @remarks
82
- * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
83
- *
84
- * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
85
- * If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
86
- *
87
- * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
88
- *
89
- * @beta
90
- */
91
- function submit(result?: string | object, appIds?: string | string[]): void;
92
- /**
93
- * Subcapability that allows communication between the dialog and the parent app.
94
- *
95
- * @remarks
96
- * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
97
- *
98
- * @beta
99
- */
100
- namespace parentCommunication {
101
- /**
102
- * Send message to the parent from dialog
103
- *
104
- * @remarks
105
- * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
106
- *
107
- * @param message - The message to send to the parent
108
- *
109
- * @beta
110
- */
111
- function sendMessageToParentFromDialog(message: any): void;
112
- /**
113
- * Send message to the dialog from the parent
114
- *
115
- * @param message - The message to send
116
- *
117
- * @beta
118
- */
119
- function sendMessageToDialog(message: any): void;
120
- /**
121
- * Register a listener that will be triggered when a message is received from the app that opened the dialog.
122
- *
123
- * @remarks
124
- * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
125
- *
126
- * @param listener - The listener that will be triggered.
127
- *
128
- * @beta
129
- */
130
- function registerOnMessageFromParent(listener: PostMessageChannel): void;
131
- /**
132
- * Checks if dialog.url.parentCommunication capability is supported by the host
133
- *
134
- * @returns boolean to represent whether dialog.url.parentCommunication capability is supported
135
- *
136
- * @throws Error if {@linkcode app.initialize} has not successfully completed
137
- *
138
- * @beta
139
- */
140
- function isSupported(): boolean;
141
- }
142
- /**
143
- * Checks if dialog.url module is supported by the host
144
- *
145
- * @returns boolean to represent whether dialog.url module is supported
146
- *
147
- * @throws Error if {@linkcode app.initialize} has not successfully completed
148
- *
149
- * @beta
150
- */
151
- function isSupported(): boolean;
152
- /**
153
- * Namespace to open a dialog that sends results to the bot framework
154
- *
155
- * @beta
156
- */
157
- namespace bot {
158
- /**
159
- * Allows an app to open a dialog that sends submitted data to a bot.
160
- *
161
- * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
162
- * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
163
- * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
164
- *
165
- * @returns a function that can be used to send messages to the dialog.
166
- *
167
- * @beta
168
- */
169
- function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
170
- /**
171
- * Checks if dialog.url.bot capability is supported by the host
172
- *
173
- * @returns boolean to represent whether dialog.url.bot is supported
174
- *
175
- * @throws Error if {@linkcode app.initialize} has not successfully completed
176
- *
177
- * @beta
178
- */
179
- function isSupported(): boolean;
180
- }
181
- /**
182
- * @hidden
183
- *
184
- * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
185
- *
186
- * @internal
187
- * Limited to Microsoft-internal use
188
- */
189
- function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
190
- /**
191
- * @hidden
192
- *
193
- * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
194
- *
195
- * @internal
196
- * Limited to Microsoft-internal use
197
- */
198
- function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
199
- }
200
- /**
201
- * This function currently serves no purpose and should not be used. All functionality that used
202
- * to be covered by this method is now in subcapabilities and those isSupported methods should be
203
- * used directly.
204
- *
205
- * @hidden
206
- */
207
- function isSupported(): boolean;
208
- /**
209
- * Namespace to update the dialog
210
- *
211
- * @beta
212
- */
213
- namespace update {
214
- /**
215
- * Update dimensions - height/width of a dialog.
216
- *
217
- * @param dimensions - An object containing width and height properties.
218
- *
219
- * @beta
220
- */
221
- function resize(dimensions: DialogSize): void;
222
- /**
223
- * Checks if dialog.update capability is supported by the host
224
- * @returns boolean to represent whether dialog.update capabilty is supported
225
- *
226
- * @throws Error if {@linkcode app.initialize} has not successfully completed
227
- *
228
- * @beta
229
- */
230
- function isSupported(): boolean;
231
- }
232
- /**
233
- * Subcapability for interacting with adaptive card dialogs
234
- * @beta
235
- */
236
- namespace adaptiveCard {
237
- /**
238
- * Allows app to open an adaptive card based dialog.
239
- *
240
- * @remarks
241
- * This function cannot be called from inside of a dialog
242
- *
243
- * @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
244
- * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode url.submit} function or when the user closes the dialog.
245
- *
246
- * @beta
247
- */
248
- function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
249
- /**
250
- * Checks if dialog.adaptiveCard module is supported by the host
251
- *
252
- * @returns boolean to represent whether dialog.adaptiveCard module is supported
253
- *
254
- * @throws Error if {@linkcode app.initialize} has not successfully completed
255
- *
256
- * @beta
257
- */
258
- function isSupported(): boolean;
259
- /**
260
- * Namespace for interaction with adaptive card dialogs that need to communicate with the bot framework
261
- *
262
- * @beta
263
- */
264
- namespace bot {
265
- /**
266
- * Allows an app to open an adaptive card-based dialog module using bot.
267
- *
268
- * @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
269
- * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
270
- *
271
- * @beta
272
- */
273
- function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
274
- /**
275
- * Checks if dialog.adaptiveCard.bot capability is supported by the host
276
- *
277
- * @returns boolean to represent whether dialog.adaptiveCard.bot is supported
278
- *
279
- * @throws Error if {@linkcode app.initialize} has not successfully completed
280
- *
281
- * @beta
282
- */
283
- function isSupported(): boolean;
284
- }
285
- }
286
- }
@@ -1,100 +0,0 @@
1
- /**
2
- * Namespace to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
3
- *
4
- * @beta
5
- */
6
- export declare namespace geoLocation {
7
- /**
8
- * Data struture to represent the location information
9
- *
10
- * @beta
11
- */
12
- interface Location {
13
- /**
14
- Latitude of the location
15
- */
16
- latitude: number;
17
- /**
18
- Longitude of the location
19
- */
20
- longitude: number;
21
- /**
22
- Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
23
- @remarks
24
- This property is only in scope for mobile
25
- */
26
- accuracy?: number;
27
- /**
28
- Time stamp when the location was captured
29
- */
30
- timestamp?: number;
31
- }
32
- /**
33
- * Fetches current user coordinates
34
- * @returns Promise that will resolve with {@link geoLocation.Location} object or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
35
- *
36
- * @beta
37
- */
38
- function getCurrentLocation(): Promise<Location>;
39
- /**
40
- * Checks whether or not location has user permission
41
- *
42
- * @returns Promise that will resolve with true if the user had granted the app permission to location information, or with false otherwise,
43
- * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
44
- *
45
- * @beta
46
- */
47
- function hasPermission(): Promise<boolean>;
48
- /**
49
- * Requests user permission for location
50
- *
51
- * @returns true if the user consented permission for location, false otherwise
52
- * @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
53
- * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
54
- *
55
- * @beta
56
- */
57
- function requestPermission(): Promise<boolean>;
58
- /**
59
- * Checks if geoLocation capability is supported by the host
60
- * @returns boolean to represent whether geoLocation is supported
61
- *
62
- * @throws Error if {@linkcode app.initialize} has not successfully completed
63
- *
64
- * @beta
65
- */
66
- function isSupported(): boolean;
67
- /**
68
- * Namespace to interact with the location on map module-specific part of the SDK.
69
- *
70
- * @beta
71
- */
72
- namespace map {
73
- /**
74
- * Allows user to choose location on map
75
- *
76
- * @returns Promise that will resolve with {@link geoLocation.Location} object chosen by the user or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
77
- *
78
- * @beta
79
- */
80
- function chooseLocation(): Promise<Location>;
81
- /**
82
- * Shows the location on map corresponding to the given coordinates
83
- *
84
- * @param location - Location to be shown on the map
85
- * @returns Promise that resolves when the location dialog has been closed or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
86
- *
87
- * @beta
88
- */
89
- function showLocation(location: Location): Promise<void>;
90
- /**
91
- * Checks if geoLocation.map capability is supported by the host
92
- * @returns boolean to represent whether geoLocation.map is supported
93
- *
94
- * @throws Error if {@linkcode app.initialize} has not successfully completed
95
- *
96
- * @beta
97
- */
98
- function isSupported(): boolean;
99
- }
100
- }
@@ -1 +0,0 @@
1
- import{appInitializeHelper as e,notifyAppLoadedHelper as i,notifySuccessHelper as t,notifyFailureHelper as n,notifyExpectedFailureHelper as a,registerOnThemeChangeHandlerHelper as o,openLinkHelper as r}from"../internal/appHelpers.js";import{uninitializeCommunication as s,sendAndUnwrap as l,Communication as m}from"../internal/communication.js";import{GlobalVars as d}from"../internal/globalVars.js";import{uninitializeHandlers as p,registerBeforeSuspendOrTerminateHandler as u,registerOnResumeHandler as c}from"../internal/handlers.js";import{ensureInitializeCalled as f,ensureInitialized as h}from"../internal/internalAPIs.js";import{getLogger as g,getApiVersionTag as I}from"../internal/telemetry.js";import{inServerSideRenderingEnvironment as y}from"../internal/utils.js";import{prefetchOriginsFromCDN as S}from"../internal/validOrigins.js";import{messageChannels as T}from"../private/messageChannels.js";import{HostName as P,HostClientType as C}from"./constants.js";import{runtime as v}from"./runtime.js";import{version as w}from"./version.js";const O="v2",j=g("app"),N={AppLoaded:"appInitialization.appLoaded",Success:"appInitialization.success",Failure:"appInitialization.failure",ExpectedFailure:"appInitialization.expectedFailure"};var b,F,L;function x(){return d.initializeCompleted}function A(){return d.frameContext}function D(i){return S(),e(I(O,"app.initialize"),i)}function z(e){m.currentWindow=e}function H(){d.initializeCalled&&(p(),d.initializeCalled=!1,d.initializeCompleted=!1,d.initializePromise=void 0,d.additionalValidOrigins=[],d.frameContext=void 0,d.hostClientType=void 0,d.isFramelessWindow=!1,T.telemetry._clearTelemetryPort(),T.dataLayer._clearDataLayerPort(),s())}function E(){return new Promise((e=>{f(),e(l(I(O,"app.getContext"),"getContext"))})).then((e=>function(e){var i;const t={actionInfo:e.actionInfo,app:{locale:e.locale,sessionId:e.appSessionId?e.appSessionId:"",theme:e.theme?e.theme:"default",iconPositionVertical:e.appIconPosition,osLocaleInfo:e.osLocaleInfo,parentMessageId:e.parentMessageId,userClickTime:e.userClickTime,userFileOpenPreference:e.userFileOpenPreference,host:{name:e.hostName?e.hostName:P.teams,clientType:e.hostClientType?e.hostClientType:C.web,sessionId:e.sessionId?e.sessionId:"",ringId:e.ringId},appLaunchId:e.appLaunchId},page:{id:e.entityId,frameContext:e.frameContext?e.frameContext:d.frameContext,subPageId:e.subEntityId,isFullScreen:e.isFullScreen,isMultiWindow:e.isMultiWindow,isBackgroundLoad:e.isBackgroundLoad,sourceOrigin:e.sourceOrigin},user:{id:null!==(i=e.userObjectId)&&void 0!==i?i:"",displayName:e.userDisplayName,isCallingAllowed:e.isCallingAllowed,isPSTNCallingAllowed:e.isPSTNCallingAllowed,licenseType:e.userLicenseType,loginHint:e.loginHint,userPrincipalName:e.userPrincipalName,tenant:e.tid?{id:e.tid,teamsSku:e.tenantSKU}:void 0},channel:e.channelId?{id:e.channelId,displayName:e.channelName,relativeUrl:e.channelRelativeUrl,membershipType:e.channelType,defaultOneNoteSectionId:e.defaultOneNoteSectionId,ownerGroupId:e.hostTeamGroupId,ownerTenantId:e.hostTeamTenantId}:void 0,chat:e.chatId?{id:e.chatId}:void 0,meeting:e.meetingId?{id:e.meetingId}:void 0,sharepoint:e.sharepoint,team:e.teamId?{internalId:e.teamId,displayName:e.teamName,type:e.teamType,groupId:e.groupId,templateId:e.teamTemplateId,isArchived:e.isTeamArchived,userRole:e.userTeamRole}:void 0,sharePointSite:e.teamSiteUrl||e.teamSiteDomain||e.teamSitePath||e.mySitePath||e.mySiteDomain?{teamSiteUrl:e.teamSiteUrl,teamSiteDomain:e.teamSiteDomain,teamSitePath:e.teamSitePath,teamSiteId:e.teamSiteId,mySitePath:e.mySitePath,mySiteDomain:e.mySiteDomain}:void 0,dialogParameters:e.dialogParameters||{}};return t}(e)))}function k(){f(),i(I(O,"app.notifyAppLoaded"))}function U(){f(),t(I(O,"app.notifySuccess"))}function B(e){f(),n(I(O,"app.notifyFailure"),e)}function R(e){f(),a(I(O,"app.notifyExpectedFailure"),e)}function M(e){o(I(O,"app.registerOnThemeChangeHandler"),e)}function W(e){return r(I(O,"app.openLink"),e)}!function(e){e.AuthFailed="AuthFailed",e.Timeout="Timeout",e.Other="Other"}(b||(b={})),function(e){e.PermissionError="PermissionError",e.NotFound="NotFound",e.Throttling="Throttling",e.Offline="Offline",e.Other="Other"}(F||(F={})),j("teamsjs instance is version %s, starting at %s UTC (%s local)",w,(new Date).toISOString(),(new Date).toLocaleString()),function(){if(y())return;const e=document.getElementsByTagName("script"),i=e&&e[e.length-1]&&e[e.length-1].src,t="Today, teamsjs can only be used from a single script or you may see undefined behavior. This log line is used to help detect cases where teamsjs is loaded multiple times -- it is always written. The presence of the log itself does not indicate a multi-load situation, but multiples of these log lines will. If you would like to use teamjs from more than one script at the same time, please open an issue at https://github.com/OfficeDev/microsoft-teams-library-js/issues";i&&0!==i.length?j("teamsjs is being used from %s. %s",i,t):j("teamsjs is being used from a script tag embedded directly in your html. %s",t)}(),function(e){e.registerBeforeSuspendOrTerminateHandler=function(e){if(!e)throw new Error("[app.lifecycle.registerBeforeSuspendOrTerminateHandler] Handler cannot be null");h(v),u(e)},e.registerOnResumeHandler=function(e){if(!e)throw new Error("[app.lifecycle.registerOnResumeHandler] Handler cannot be null");h(v),c(e)}}(L||(L={}));export{F as ExpectedFailureReason,b as FailedReason,N as Messages,z as _initialize,H as _uninitialize,E as getContext,A as getFrameContext,D as initialize,x as isInitialized,L as lifecycle,k as notifyAppLoaded,R as notifyExpectedFailure,B as notifyFailure,U as notifySuccess,W as openLink,M as registerOnThemeChangeHandler};
@@ -1 +0,0 @@
1
- import{sendMessageToParent as o}from"../internal/communication.js";import{GlobalVars as t}from"../internal/globalVars.js";import{registerHandler as e,removeHandler as r}from"../internal/handlers.js";import{ensureInitialized as n}from"../internal/internalAPIs.js";import{getApiVersionTag as i}from"../internal/telemetry.js";import{isHostAdaptiveCardSchemaVersionUnsupported as a}from"../internal/utils.js";import{FrameContexts as s,errorNotSupportedOnPlatform as l,DialogDimension as u}from"./constants.js";import{runtime as d}from"./runtime.js";const p="v2";function g(t,e){if(n(d,s.content,s.sidePanel,s.task,s.meetingStage),!h.update.isSupported())throw l;o(t,"tasks.updateTask",[e])}function c(t,a,u,g){if(n(d,s.content,s.sidePanel,s.meetingStage),!h.url.isSupported())throw l;g&&e(i(p,"dialog.url.registerMessageForParentHandler"),"messageForParent",g);const c=h.url.getDialogInfoFromUrlDialogInfo(a);o(t,"tasks.startTask",[c],((o,t)=>{null==u||u({err:o,result:t}),r("messageForParent")}))}function m(t,a,u,g){if(n(d,s.content,s.sidePanel,s.meetingStage),!h.url.bot.isSupported())throw l;g&&e(i(p,"dialog.url.bot.registerMessageForParentHandler"),"messageForParent",g);const c=h.url.getDialogInfoFromBotUrlDialogInfo(a);o(t,"tasks.startTask",[c],((o,t)=>{null==u||u({err:o,result:t}),r("messageForParent")}))}function f(t,e,r){if(n(d,s.task),!h.url.isSupported())throw l;o(t,"tasks.completeTask",[e,r?Array.isArray(r)?r:[r]:[]])}var h;!function(h){const S=[];function C(o){t.frameContext&&(t.frameContext===s.task?S.push(o):r("messageForChild"))}var v;h.initialize=function(){e(i(p,"dialog.registerMessageForChildHandler"),"messageForChild",C,!1)},function(t){var a;function g(o){return{url:o.url,height:o.size?o.size.height:u.Small,width:o.size?o.size.width:u.Small,title:o.title,fallbackUrl:o.fallbackUrl}}t.open=function(o,t,e){c(i(p,"dialog.url.open"),o,t,e)},t.submit=function(o,t){f(i(p,"dialog.url.submit"),o,t)},function(t){function a(){var o,t;return n(d)&&!!(null===(t=null===(o=d.supports.dialog)||void 0===o?void 0:o.url)||void 0===t?void 0:t.parentCommunication)}t.sendMessageToParentFromDialog=function(t){if(n(d,s.task),!a())throw l;o(i(p,"dialog.url.parentCommunication.sendMessageToParentFromDialog"),"messageForParent",[t])},t.sendMessageToDialog=function(t){if(n(d,s.content,s.sidePanel,s.meetingStage),!a())throw l;o(i(p,"dialog.url.parentCommunication.sendMessageToDialog"),"messageForChild",[t])},t.registerOnMessageFromParent=function(o){if(n(d,s.task),!a())throw l;for(r("messageForChild"),e(i(p,"dialog.url.parentCommunication.registerMessageForChildHandler"),"messageForChild",o),S.reverse();S.length>0;){o(S.pop())}},t.isSupported=a}(t.parentCommunication||(t.parentCommunication={})),t.isSupported=function(){return n(d)&&void 0!==(d.supports.dialog&&d.supports.dialog.url)},(a=t.bot||(t.bot={})).open=function(o,t,e){m(i(p,"dialog.url.bot.open"),o,t,e)},a.isSupported=function(){return n(d)&&void 0!==(d.supports.dialog&&d.supports.dialog.url&&d.supports.dialog.url.bot)},t.getDialogInfoFromUrlDialogInfo=g,t.getDialogInfoFromBotUrlDialogInfo=function(o){const t=g(o);return t.completionBotId=o.completionBotId,t}}(h.url||(h.url={})),h.isSupported=function(){return!(!n(d)||!d.supports.dialog)},(v=h.update||(h.update={})).resize=function(o){g(i(p,"dialog.update.resize"),o)},v.isSupported=function(){return!(!n(d)||!d.supports.dialog||!d.supports.dialog.update)},function(t){function e(){const o=d.hostVersionsInfo&&d.hostVersionsInfo.adaptiveCardSchemaVersion&&!a(d.hostVersionsInfo.adaptiveCardSchemaVersion);return n(d)&&void 0!==(o&&d.supports.dialog&&d.supports.dialog.card)}function r(o){return{card:o.card,height:o.size?o.size.height:u.Small,width:o.size?o.size.width:u.Small,title:o.title}}t.open=function(t,a){if(n(d,s.content,s.sidePanel,s.meetingStage),!e())throw l;const u=r(t);o(i(p,"dialog.adaptiveCard.open"),"tasks.startTask",[u],((o,t)=>{null==a||a({err:o,result:t})}))},t.isSupported=e,function(t){function e(){const o=d.hostVersionsInfo&&d.hostVersionsInfo.adaptiveCardSchemaVersion&&!a(d.hostVersionsInfo.adaptiveCardSchemaVersion);return n(d)&&void 0!==(o&&d.supports.dialog&&d.supports.dialog.card&&d.supports.dialog.card.bot)}t.open=function(t,a){if(n(d,s.content,s.sidePanel,s.meetingStage),!e())throw l;const u=function(o){const t=r(o);return t.completionBotId=o.completionBotId,t}(t);o(i(p,"dialog.adaptiveCard.bot.open"),"tasks.startTask",[u],((o,t)=>{null==a||a({err:o,result:t})}))},t.isSupported=e}(t.bot||(t.bot={}))}(h.adaptiveCard||(h.adaptiveCard={}))}(h||(h={}));export{m as botUrlOpenHelper,h as dialog,g as updateResizeHelper,c as urlOpenHelper,f as urlSubmitHelper};
@@ -1 +0,0 @@
1
- import{sendAndHandleSdkError as o}from"../internal/communication.js";import{ensureInitialized as t}from"../internal/internalAPIs.js";import{getApiVersionTag as n}from"../internal/telemetry.js";import{FrameContexts as i,errorNotSupportedOnPlatform as r}from"./constants.js";import{DevicePermission as s,ErrorCode as e}from"./interfaces.js";import{runtime as a}from"./runtime.js";const c="v2";var p;!function(p){function m(){return!!(t(a)&&a.supports.geoLocation&&a.supports.permissions)}p.getCurrentLocation=function(){if(t(a,i.content,i.task),!m())throw r;return o(n(c,"geoLocation.getCurrentLocation"),"location.getLocation",{allowChooseLocation:!1,showMap:!1})},p.hasPermission=function(){if(t(a,i.content,i.task),!m())throw r;const e=s.GeoLocation;return new Promise((t=>{t(o(n(c,"geoLocation.hasPermission"),"permissions.has",e))}))},p.requestPermission=function(){if(t(a,i.content,i.task),!m())throw r;const e=s.GeoLocation;return new Promise((t=>{t(o(n(c,"geoLocation.requestPermission"),"permissions.request",e))}))},p.isSupported=m,function(s){function p(){return!!(t(a)&&a.supports.geoLocation&&a.supports.geoLocation.map&&a.supports.permissions)}s.chooseLocation=function(){if(t(a,i.content,i.task),!p())throw r;return o(n(c,"geoLocation.map.chooseLocation"),"location.getLocation",{allowChooseLocation:!0,showMap:!0})},s.showLocation=function(s){if(t(a,i.content,i.task),!p())throw r;if(!s)throw{errorCode:e.INVALID_ARGUMENTS};return o(n(c,"geoLocation.showLocation"),"location.showLocation",s)},s.isSupported=p}(p.map||(p.map={}))}(p||(p={}));export{p as geoLocation};