@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.
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +1 -1
- package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts +32 -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/public/{app.d.ts → app/app.d.ts} +13 -44
- package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +40 -0
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +1 -1
- package/dist/esm/packages/teams-js/dts/public/chat.d.ts +26 -28
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +26 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +69 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +23 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +29 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +49 -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 +67 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +27 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +20 -18
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +12 -1
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +134 -136
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +72 -74
- package/dist/esm/packages/teams-js/dts/public/mail.d.ts +79 -81
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +314 -316
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +425 -427
- package/dist/esm/packages/teams-js/dts/public/menus.d.ts +164 -166
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +48 -50
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +9 -11
- package/dist/esm/packages/teams-js/dts/public/people.d.ts +61 -63
- package/dist/esm/packages/teams-js/dts/public/search.d.ts +76 -86
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +25 -27
- package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +52 -54
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +74 -76
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +96 -98
- 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/deepLinkUtilities.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/dialogHelpers.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/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/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/menus.js +1 -1
- package/dist/esm/packages/teams-js/src/public/monetization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/nestedAppAuth.js +1 -1
- package/dist/esm/packages/teams-js/src/public/people.js +1 -1
- package/dist/esm/packages/teams-js/src/public/publicAPIs.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/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/webStorage.js +1 -1
- package/dist/umd/MicrosoftTeams.d.ts +2219 -2022
- package/dist/umd/MicrosoftTeams.js +2397 -2244
- 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/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/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
@@ -790,9 +790,20 @@ interface Context$1 {
|
|
790
790
|
* @deprecated
|
791
791
|
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} instead
|
792
792
|
*
|
793
|
-
* Time when the user clicked on the tab
|
793
|
+
* Time when the user clicked on the tab using the date.
|
794
|
+
*
|
795
|
+
* 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.
|
794
796
|
*/
|
795
797
|
userClickTime?: number;
|
798
|
+
/**
|
799
|
+
* @deprecated
|
800
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTimeV2 | app.Context.app.userClickTimeV2} instead
|
801
|
+
*
|
802
|
+
* Time when the user click on the app by using the performance timer API. Useful for measuring elapsed time accurately.
|
803
|
+
*
|
804
|
+
* 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.
|
805
|
+
*/
|
806
|
+
userClickTimeV2?: number;
|
796
807
|
/**
|
797
808
|
* @deprecated
|
798
809
|
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.templateId | app.Context.team.templateId} instead
|
@@ -2187,7 +2198,7 @@ declare namespace externalAppAuthentication {
|
|
2187
2198
|
* @internal
|
2188
2199
|
* Limited to Microsoft-internal use; automatically called when library is initialized
|
2189
2200
|
*/
|
2190
|
-
declare function initialize$
|
2201
|
+
declare function initialize$4(): void;
|
2191
2202
|
/**
|
2192
2203
|
* @deprecated
|
2193
2204
|
* As of TeamsJS v2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
|
@@ -2606,7 +2617,55 @@ declare const authentication_d_getAuthToken: typeof getAuthToken;
|
|
2606
2617
|
declare const authentication_d_getUser: typeof getUser;
|
2607
2618
|
declare const authentication_d_registerAuthenticationHandlers: typeof registerAuthenticationHandlers;
|
2608
2619
|
declare namespace authentication_d {
|
2609
|
-
export { type authentication_d_AuthTokenRequest as AuthTokenRequest, type authentication_d_AuthTokenRequestParameters as AuthTokenRequestParameters, type authentication_d_AuthenticateParameters as AuthenticateParameters, type authentication_d_AuthenticatePopUpParameters as AuthenticatePopUpParameters, authentication_d_DataResidency as DataResidency, type authentication_d_LegacyCallBacks as LegacyCallBacks, type authentication_d_UserProfile as UserProfile, type authentication_d_UserRequest as UserRequest, authentication_d_authenticate as authenticate, authentication_d_getAuthToken as getAuthToken, authentication_d_getUser as getUser, initialize$
|
2620
|
+
export { type authentication_d_AuthTokenRequest as AuthTokenRequest, type authentication_d_AuthTokenRequestParameters as AuthTokenRequestParameters, type authentication_d_AuthenticateParameters as AuthenticateParameters, type authentication_d_AuthenticatePopUpParameters as AuthenticatePopUpParameters, authentication_d_DataResidency as DataResidency, type authentication_d_LegacyCallBacks as LegacyCallBacks, type authentication_d_UserProfile as UserProfile, type authentication_d_UserRequest as UserRequest, authentication_d_authenticate as authenticate, authentication_d_getAuthToken as getAuthToken, authentication_d_getUser as getUser, initialize$4 as initialize, notifyFailure$2 as notifyFailure, notifySuccess$2 as notifySuccess, authentication_d_registerAuthenticationHandlers as registerAuthenticationHandlers };
|
2621
|
+
}
|
2622
|
+
|
2623
|
+
/**
|
2624
|
+
* A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
|
2625
|
+
* When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
|
2626
|
+
* When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
|
2627
|
+
* Please note that selecting suspension doesn't guarantee prevention of background termination.
|
2628
|
+
* The outcome is influenced by factors such as available memory and the number of suspended apps.
|
2629
|
+
*
|
2630
|
+
* @beta
|
2631
|
+
*/
|
2632
|
+
/**
|
2633
|
+
* Register on resume handler function type
|
2634
|
+
*
|
2635
|
+
* @param context - Data structure to be used to pass the context to the app.
|
2636
|
+
*/
|
2637
|
+
type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
|
2638
|
+
/**
|
2639
|
+
* Register before suspendOrTerminate handler function type
|
2640
|
+
*
|
2641
|
+
* @returns void
|
2642
|
+
*/
|
2643
|
+
type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
|
2644
|
+
/**
|
2645
|
+
* Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
|
2646
|
+
* the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
|
2647
|
+
*
|
2648
|
+
* @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
|
2649
|
+
* Upon returning, the app will be suspended or terminated.
|
2650
|
+
*
|
2651
|
+
*/
|
2652
|
+
declare function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
|
2653
|
+
/**
|
2654
|
+
* Registers a handler to be called when the page has been requested to resume from being suspended.
|
2655
|
+
*
|
2656
|
+
* @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
|
2657
|
+
* the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
|
2658
|
+
*
|
2659
|
+
* @beta
|
2660
|
+
*/
|
2661
|
+
declare function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
|
2662
|
+
|
2663
|
+
declare const lifecycle_d_registerBeforeSuspendOrTerminateHandler: typeof registerBeforeSuspendOrTerminateHandler;
|
2664
|
+
type lifecycle_d_registerBeforeSuspendOrTerminateHandlerFunctionType = registerBeforeSuspendOrTerminateHandlerFunctionType;
|
2665
|
+
declare const lifecycle_d_registerOnResumeHandler: typeof registerOnResumeHandler;
|
2666
|
+
type lifecycle_d_registerOnResumeHandlerFunctionType = registerOnResumeHandlerFunctionType;
|
2667
|
+
declare namespace lifecycle_d {
|
2668
|
+
export { lifecycle_d_registerBeforeSuspendOrTerminateHandler as registerBeforeSuspendOrTerminateHandler, type lifecycle_d_registerBeforeSuspendOrTerminateHandlerFunctionType as registerBeforeSuspendOrTerminateHandlerFunctionType, lifecycle_d_registerOnResumeHandler as registerOnResumeHandler, type lifecycle_d_registerOnResumeHandlerFunctionType as registerOnResumeHandlerFunctionType };
|
2610
2669
|
}
|
2611
2670
|
|
2612
2671
|
/** App Initialization Messages */
|
@@ -2721,9 +2780,17 @@ interface AppInfo {
|
|
2721
2780
|
*/
|
2722
2781
|
iconPositionVertical?: number;
|
2723
2782
|
/**
|
2724
|
-
* Time when the user clicked on the tab
|
2783
|
+
* Time when the user clicked on the tab using the date.
|
2784
|
+
*
|
2785
|
+
* 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.
|
2725
2786
|
*/
|
2726
2787
|
userClickTime?: number;
|
2788
|
+
/**
|
2789
|
+
* Time when the user click on the app by using the performance timer API. Useful for measuring elapsed time accurately.
|
2790
|
+
*
|
2791
|
+
* 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.
|
2792
|
+
*/
|
2793
|
+
userClickTimeV2?: number;
|
2727
2794
|
/**
|
2728
2795
|
* The ID of the parent message from which this task module was launched.
|
2729
2796
|
* This is only available in task modules launched from bot cards.
|
@@ -3073,7 +3140,7 @@ declare function getFrameContext(): FrameContexts | undefined;
|
|
3073
3140
|
* Any domains passed in the array must have the https: protocol on the string otherwise they will be ignored. Example: https://www.example.com
|
3074
3141
|
* @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
|
3075
3142
|
*/
|
3076
|
-
declare function initialize$
|
3143
|
+
declare function initialize$3(validMessageOrigins?: string[]): Promise<void>;
|
3077
3144
|
/**
|
3078
3145
|
* @hidden
|
3079
3146
|
* Undocumented function used to set a mock window for unit tests
|
@@ -3157,48 +3224,7 @@ declare function registerOnThemeChangeHandler$1(handler: themeHandler): void;
|
|
3157
3224
|
* @returns `Promise` that will be fulfilled when the navigation has initiated. A successful `Promise` resolution
|
3158
3225
|
* does not necessarily indicate whether the target loaded successfully.
|
3159
3226
|
*/
|
3160
|
-
declare function openLink(deepLink: string): Promise<void>;
|
3161
|
-
/**
|
3162
|
-
* A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
|
3163
|
-
* When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
|
3164
|
-
* When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
|
3165
|
-
* Please note that selecting suspension doesn't guarantee prevention of background termination.
|
3166
|
-
* The outcome is influenced by factors such as available memory and the number of suspended apps.
|
3167
|
-
*
|
3168
|
-
* @beta
|
3169
|
-
*/
|
3170
|
-
declare namespace lifecycle {
|
3171
|
-
/**
|
3172
|
-
* Register on resume handler function type
|
3173
|
-
*
|
3174
|
-
* @param context - Data structure to be used to pass the context to the app.
|
3175
|
-
*/
|
3176
|
-
type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
|
3177
|
-
/**
|
3178
|
-
* Register before suspendOrTerminate handler function type
|
3179
|
-
*
|
3180
|
-
* @returns void
|
3181
|
-
*/
|
3182
|
-
type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
|
3183
|
-
/**
|
3184
|
-
* Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
|
3185
|
-
* the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
|
3186
|
-
*
|
3187
|
-
* @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
|
3188
|
-
* Upon returning, the app will be suspended or terminated.
|
3189
|
-
*
|
3190
|
-
*/
|
3191
|
-
function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
|
3192
|
-
/**
|
3193
|
-
* Registers a handler to be called when the page has been requested to resume from being suspended.
|
3194
|
-
*
|
3195
|
-
* @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
|
3196
|
-
* the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
|
3197
|
-
*
|
3198
|
-
* @beta
|
3199
|
-
*/
|
3200
|
-
function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
|
3201
|
-
}
|
3227
|
+
declare function openLink(deepLink: string): Promise<void>;
|
3202
3228
|
|
3203
3229
|
type app_d_AppHostInfo = AppHostInfo;
|
3204
3230
|
type app_d_AppInfo = AppInfo;
|
@@ -3222,11 +3248,10 @@ declare const app_d__initialize: typeof _initialize;
|
|
3222
3248
|
declare const app_d__uninitialize: typeof _uninitialize;
|
3223
3249
|
declare const app_d_getFrameContext: typeof getFrameContext;
|
3224
3250
|
declare const app_d_isInitialized: typeof isInitialized;
|
3225
|
-
declare const app_d_lifecycle: typeof lifecycle;
|
3226
3251
|
declare const app_d_openLink: typeof openLink;
|
3227
3252
|
type app_d_themeHandler = themeHandler;
|
3228
3253
|
declare namespace app_d {
|
3229
|
-
export { type app_d_AppHostInfo as AppHostInfo, type app_d_AppInfo as AppInfo, type app_d_ChannelInfo as ChannelInfo, type app_d_ChatInfo as ChatInfo, type app_d_Context as Context, app_d_ExpectedFailureReason as ExpectedFailureReason, app_d_FailedReason as FailedReason, type app_d_IExpectedFailureRequest as IExpectedFailureRequest, type app_d_IFailedRequest as IFailedRequest, type app_d_MeetingInfo as MeetingInfo, app_d_Messages as Messages, type app_d_PageInfo as PageInfo, type app_d_SharePointSiteInfo as SharePointSiteInfo, type app_d_TeamInfo as TeamInfo, type app_d_TenantInfo as TenantInfo, type app_d_UserInfo as UserInfo, app_d__initialize as _initialize, app_d__uninitialize as _uninitialize, getContext$1 as getContext, app_d_getFrameContext as getFrameContext, initialize$
|
3254
|
+
export { type app_d_AppHostInfo as AppHostInfo, type app_d_AppInfo as AppInfo, type app_d_ChannelInfo as ChannelInfo, type app_d_ChatInfo as ChatInfo, type app_d_Context as Context, app_d_ExpectedFailureReason as ExpectedFailureReason, app_d_FailedReason as FailedReason, type app_d_IExpectedFailureRequest as IExpectedFailureRequest, type app_d_IFailedRequest as IFailedRequest, type app_d_MeetingInfo as MeetingInfo, app_d_Messages as Messages, type app_d_PageInfo as PageInfo, type app_d_SharePointSiteInfo as SharePointSiteInfo, type app_d_TeamInfo as TeamInfo, type app_d_TenantInfo as TenantInfo, type app_d_UserInfo as UserInfo, app_d__initialize as _initialize, app_d__uninitialize as _uninitialize, getContext$1 as getContext, app_d_getFrameContext as getFrameContext, initialize$3 as initialize, app_d_isInitialized as isInitialized, lifecycle_d as lifecycle, notifyAppLoaded$1 as notifyAppLoaded, notifyExpectedFailure$1 as notifyExpectedFailure, notifyFailure$1 as notifyFailure, notifySuccess$1 as notifySuccess, app_d_openLink as openLink, registerOnThemeChangeHandler$1 as registerOnThemeChangeHandler, type app_d_themeHandler as themeHandler };
|
3230
3255
|
}
|
3231
3256
|
|
3232
3257
|
/**
|
@@ -3292,12 +3317,12 @@ declare function openAppInstallDialog(openAPPInstallDialogParams: OpenAppInstall
|
|
3292
3317
|
*
|
3293
3318
|
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3294
3319
|
*/
|
3295
|
-
declare function isSupported$
|
3320
|
+
declare function isSupported$p(): boolean;
|
3296
3321
|
|
3297
3322
|
type appInstallDialog_d_OpenAppInstallDialogParams = OpenAppInstallDialogParams;
|
3298
3323
|
declare const appInstallDialog_d_openAppInstallDialog: typeof openAppInstallDialog;
|
3299
3324
|
declare namespace appInstallDialog_d {
|
3300
|
-
export { type appInstallDialog_d_OpenAppInstallDialogParams as OpenAppInstallDialogParams, isSupported$
|
3325
|
+
export { type appInstallDialog_d_OpenAppInstallDialogParams as OpenAppInstallDialogParams, isSupported$p as isSupported, appInstallDialog_d_openAppInstallDialog as openAppInstallDialog };
|
3301
3326
|
}
|
3302
3327
|
|
3303
3328
|
/**
|
@@ -3311,7 +3336,7 @@ declare namespace appInstallDialog_d {
|
|
3311
3336
|
*
|
3312
3337
|
* @beta
|
3313
3338
|
*/
|
3314
|
-
interface BarCodeConfig {
|
3339
|
+
interface BarCodeConfig$1 {
|
3315
3340
|
/**
|
3316
3341
|
* Optional; designates the scan timeout interval in seconds.
|
3317
3342
|
* Default value is 30 seconds, max allowed value is 60 seconds.
|
@@ -3327,7 +3352,7 @@ interface BarCodeConfig {
|
|
3327
3352
|
*
|
3328
3353
|
* @beta
|
3329
3354
|
*/
|
3330
|
-
declare function scanBarCode(barCodeConfig: BarCodeConfig): Promise<string>;
|
3355
|
+
declare function scanBarCode$1(barCodeConfig: BarCodeConfig$1): Promise<string>;
|
3331
3356
|
/**
|
3332
3357
|
* Checks whether or not media has user permission
|
3333
3358
|
*
|
@@ -3335,7 +3360,7 @@ declare function scanBarCode(barCodeConfig: BarCodeConfig): Promise<string>;
|
|
3335
3360
|
*
|
3336
3361
|
* @beta
|
3337
3362
|
*/
|
3338
|
-
declare function hasPermission(): Promise<boolean>;
|
3363
|
+
declare function hasPermission$2(): Promise<boolean>;
|
3339
3364
|
/**
|
3340
3365
|
* Requests user permission for media
|
3341
3366
|
*
|
@@ -3343,7 +3368,7 @@ declare function hasPermission(): Promise<boolean>;
|
|
3343
3368
|
*
|
3344
3369
|
* @beta
|
3345
3370
|
*/
|
3346
|
-
declare function requestPermission(): Promise<boolean>;
|
3371
|
+
declare function requestPermission$2(): Promise<boolean>;
|
3347
3372
|
/**
|
3348
3373
|
* Checks if barCode capability is supported by the host
|
3349
3374
|
* @returns boolean to represent whether the barCode capability is supported
|
@@ -3352,14 +3377,10 @@ declare function requestPermission(): Promise<boolean>;
|
|
3352
3377
|
*
|
3353
3378
|
* @beta
|
3354
3379
|
*/
|
3355
|
-
declare function isSupported$
|
3380
|
+
declare function isSupported$o(): boolean;
|
3356
3381
|
|
3357
|
-
type barCode_d_BarCodeConfig = BarCodeConfig;
|
3358
|
-
declare const barCode_d_hasPermission: typeof hasPermission;
|
3359
|
-
declare const barCode_d_requestPermission: typeof requestPermission;
|
3360
|
-
declare const barCode_d_scanBarCode: typeof scanBarCode;
|
3361
3382
|
declare namespace barCode_d {
|
3362
|
-
export { type
|
3383
|
+
export { type BarCodeConfig$1 as BarCodeConfig, hasPermission$2 as hasPermission, isSupported$o as isSupported, requestPermission$2 as requestPermission, scanBarCode$1 as scanBarCode };
|
3363
3384
|
}
|
3364
3385
|
|
3365
3386
|
interface OpenChatRequest {
|
@@ -3399,33 +3420,39 @@ interface OpenGroupChatRequest extends OpenChatRequest {
|
|
3399
3420
|
/**
|
3400
3421
|
* Contains functionality to start chat with others
|
3401
3422
|
*/
|
3402
|
-
|
3403
|
-
|
3404
|
-
|
3405
|
-
|
3406
|
-
|
3407
|
-
|
3408
|
-
|
3409
|
-
|
3410
|
-
|
3411
|
-
|
3412
|
-
|
3413
|
-
|
3414
|
-
|
3415
|
-
|
3416
|
-
|
3417
|
-
|
3418
|
-
|
3419
|
-
|
3420
|
-
|
3421
|
-
|
3422
|
-
|
3423
|
-
|
3424
|
-
|
3425
|
-
|
3426
|
-
|
3427
|
-
|
3428
|
-
|
3423
|
+
/**
|
3424
|
+
* Allows the user to open a chat with a single user and allows
|
3425
|
+
* for the user to specify the message they wish to send.
|
3426
|
+
*
|
3427
|
+
* @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
|
3428
|
+
*
|
3429
|
+
* @returns Promise resolved upon completion
|
3430
|
+
*/
|
3431
|
+
declare function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
|
3432
|
+
/**
|
3433
|
+
* Allows the user to create a chat with multiple users (2+) and allows
|
3434
|
+
* for the user to specify a message and name the topic of the conversation. If
|
3435
|
+
* only 1 user is provided into users array default back to origin openChat.
|
3436
|
+
*
|
3437
|
+
* @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
|
3438
|
+
*
|
3439
|
+
* @returns Promise resolved upon completion
|
3440
|
+
*/
|
3441
|
+
declare function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
|
3442
|
+
/**
|
3443
|
+
* Checks if the chat capability is supported by the host
|
3444
|
+
* @returns boolean to represent whether the chat capability is supported
|
3445
|
+
*
|
3446
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3447
|
+
*/
|
3448
|
+
declare function isSupported$n(): boolean;
|
3449
|
+
|
3450
|
+
type chat_d_OpenGroupChatRequest = OpenGroupChatRequest;
|
3451
|
+
type chat_d_OpenSingleChatRequest = OpenSingleChatRequest;
|
3452
|
+
declare const chat_d_openChat: typeof openChat;
|
3453
|
+
declare const chat_d_openGroupChat: typeof openGroupChat;
|
3454
|
+
declare namespace chat_d {
|
3455
|
+
export { type chat_d_OpenGroupChatRequest as OpenGroupChatRequest, type chat_d_OpenSingleChatRequest as OpenSingleChatRequest, isSupported$n as isSupported, chat_d_openChat as openChat, chat_d_openGroupChat as openGroupChat };
|
3429
3456
|
}
|
3430
3457
|
|
3431
3458
|
/**
|
@@ -3461,310 +3488,375 @@ declare function read(): Promise<Blob>;
|
|
3461
3488
|
*
|
3462
3489
|
* @beta
|
3463
3490
|
*/
|
3464
|
-
declare function isSupported$
|
3491
|
+
declare function isSupported$m(): boolean;
|
3465
3492
|
|
3466
3493
|
declare const clipboard_d_read: typeof read;
|
3467
3494
|
declare const clipboard_d_write: typeof write;
|
3468
3495
|
declare namespace clipboard_d {
|
3469
|
-
export { isSupported$
|
3496
|
+
export { isSupported$m as isSupported, clipboard_d_read as read, clipboard_d_write as write };
|
3497
|
+
}
|
3498
|
+
|
3499
|
+
/**
|
3500
|
+
* Module for interaction with adaptive card dialogs that need to communicate with the bot framework
|
3501
|
+
*
|
3502
|
+
* @beta
|
3503
|
+
*/
|
3504
|
+
/**
|
3505
|
+
* Allows an app to open an adaptive card-based dialog module using bot.
|
3506
|
+
*
|
3507
|
+
* @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
|
3508
|
+
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
|
3509
|
+
*
|
3510
|
+
* @beta
|
3511
|
+
*/
|
3512
|
+
declare function open$4(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
|
3513
|
+
/**
|
3514
|
+
* Checks if dialog.adaptiveCard.bot capability is supported by the host
|
3515
|
+
*
|
3516
|
+
* @returns boolean to represent whether dialog.adaptiveCard.bot is supported
|
3517
|
+
*
|
3518
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3519
|
+
*
|
3520
|
+
* @beta
|
3521
|
+
*/
|
3522
|
+
declare function isSupported$l(): boolean;
|
3523
|
+
|
3524
|
+
declare namespace bot_d$1 {
|
3525
|
+
export { isSupported$l as isSupported, open$4 as open };
|
3526
|
+
}
|
3527
|
+
|
3528
|
+
/**
|
3529
|
+
* Subcapability for interacting with adaptive card dialogs
|
3530
|
+
* @beta
|
3531
|
+
*/
|
3532
|
+
/**
|
3533
|
+
* Allows app to open an adaptive card based dialog.
|
3534
|
+
*
|
3535
|
+
* @remarks
|
3536
|
+
* This function cannot be called from inside of a dialog
|
3537
|
+
*
|
3538
|
+
* @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
|
3539
|
+
* @param submitHandler - Handler that triggers when a dialog fires an [Action.Submit](https://adaptivecards.io/explorer/Action.Submit.html) or when the user closes the dialog.
|
3540
|
+
*
|
3541
|
+
* @beta
|
3542
|
+
*/
|
3543
|
+
declare function open$3(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
|
3544
|
+
/**
|
3545
|
+
* Checks if dialog.adaptiveCard module is supported by the host
|
3546
|
+
*
|
3547
|
+
* @returns boolean to represent whether dialog.adaptiveCard module is supported
|
3548
|
+
*
|
3549
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3550
|
+
*
|
3551
|
+
* @beta
|
3552
|
+
*/
|
3553
|
+
declare function isSupported$k(): boolean;
|
3554
|
+
|
3555
|
+
declare namespace adaptiveCard_d {
|
3556
|
+
export { bot_d$1 as bot, isSupported$k as isSupported, open$3 as open };
|
3557
|
+
}
|
3558
|
+
|
3559
|
+
/**
|
3560
|
+
* Module to update the dialog
|
3561
|
+
*
|
3562
|
+
* @beta
|
3563
|
+
*/
|
3564
|
+
/**
|
3565
|
+
* Update dimensions - height/width of a dialog.
|
3566
|
+
*
|
3567
|
+
* @param dimensions - An object containing width and height properties.
|
3568
|
+
*
|
3569
|
+
* @beta
|
3570
|
+
*/
|
3571
|
+
declare function resize(dimensions: DialogSize): void;
|
3572
|
+
/**
|
3573
|
+
* Checks if dialog.update capability is supported by the host
|
3574
|
+
* @returns boolean to represent whether dialog.update capabilty is supported
|
3575
|
+
*
|
3576
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3577
|
+
*
|
3578
|
+
* @beta
|
3579
|
+
*/
|
3580
|
+
declare function isSupported$j(): boolean;
|
3581
|
+
|
3582
|
+
declare const update_d_resize: typeof resize;
|
3583
|
+
declare namespace update_d {
|
3584
|
+
export { isSupported$j as isSupported, update_d_resize as resize };
|
3585
|
+
}
|
3586
|
+
|
3587
|
+
/**
|
3588
|
+
* Module to open a dialog that sends results to the bot framework
|
3589
|
+
*
|
3590
|
+
* @beta
|
3591
|
+
*/
|
3592
|
+
/**
|
3593
|
+
* Allows an app to open a dialog that sends submitted data to a bot.
|
3594
|
+
*
|
3595
|
+
* @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
|
3596
|
+
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
|
3597
|
+
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
|
3598
|
+
*
|
3599
|
+
* @returns a function that can be used to send messages to the dialog.
|
3600
|
+
*
|
3601
|
+
* @beta
|
3602
|
+
*/
|
3603
|
+
declare function open$2(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
|
3604
|
+
/**
|
3605
|
+
* Checks if dialog.url.bot capability is supported by the host
|
3606
|
+
*
|
3607
|
+
* @returns boolean to represent whether dialog.url.bot is supported
|
3608
|
+
*
|
3609
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3610
|
+
*
|
3611
|
+
* @beta
|
3612
|
+
*/
|
3613
|
+
declare function isSupported$i(): boolean;
|
3614
|
+
|
3615
|
+
declare namespace bot_d {
|
3616
|
+
export { isSupported$i as isSupported, open$2 as open };
|
3617
|
+
}
|
3618
|
+
|
3619
|
+
/**
|
3620
|
+
* Subcapability that allows communication between the dialog and the parent app.
|
3621
|
+
*
|
3622
|
+
* @remarks
|
3623
|
+
* Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
|
3624
|
+
*
|
3625
|
+
* @beta
|
3626
|
+
*/
|
3627
|
+
/**
|
3628
|
+
* Send message to the parent from dialog
|
3629
|
+
*
|
3630
|
+
* @remarks
|
3631
|
+
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3632
|
+
*
|
3633
|
+
* @param message - The message to send to the parent
|
3634
|
+
*
|
3635
|
+
* @beta
|
3636
|
+
*/
|
3637
|
+
declare function sendMessageToParentFromDialog(message: any): void;
|
3638
|
+
/**
|
3639
|
+
* Send message to the dialog from the parent
|
3640
|
+
*
|
3641
|
+
* @param message - The message to send
|
3642
|
+
*
|
3643
|
+
* @beta
|
3644
|
+
*/
|
3645
|
+
declare function sendMessageToDialog(message: any): void;
|
3646
|
+
/**
|
3647
|
+
* Register a listener that will be triggered when a message is received from the app that opened the dialog.
|
3648
|
+
*
|
3649
|
+
* @remarks
|
3650
|
+
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3651
|
+
*
|
3652
|
+
* @param listener - The listener that will be triggered.
|
3653
|
+
*
|
3654
|
+
* @beta
|
3655
|
+
*/
|
3656
|
+
declare function registerOnMessageFromParent(listener: PostMessageChannel): void;
|
3657
|
+
/**
|
3658
|
+
* Checks if dialog.url.parentCommunication capability is supported by the host
|
3659
|
+
*
|
3660
|
+
* @returns boolean to represent whether dialog.url.parentCommunication capability is supported
|
3661
|
+
*
|
3662
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3663
|
+
*
|
3664
|
+
* @beta
|
3665
|
+
*/
|
3666
|
+
declare function isSupported$h(): boolean;
|
3667
|
+
|
3668
|
+
declare const parentCommunication_d_registerOnMessageFromParent: typeof registerOnMessageFromParent;
|
3669
|
+
declare const parentCommunication_d_sendMessageToDialog: typeof sendMessageToDialog;
|
3670
|
+
declare const parentCommunication_d_sendMessageToParentFromDialog: typeof sendMessageToParentFromDialog;
|
3671
|
+
declare namespace parentCommunication_d {
|
3672
|
+
export { isSupported$h as isSupported, parentCommunication_d_registerOnMessageFromParent as registerOnMessageFromParent, parentCommunication_d_sendMessageToDialog as sendMessageToDialog, parentCommunication_d_sendMessageToParentFromDialog as sendMessageToParentFromDialog };
|
3673
|
+
}
|
3674
|
+
|
3675
|
+
/**
|
3676
|
+
* Allows app to open a url based dialog.
|
3677
|
+
*
|
3678
|
+
* @remarks
|
3679
|
+
* This function cannot be called from inside of a dialog
|
3680
|
+
*
|
3681
|
+
* @param urlDialogInfo - An object containing the parameters of the dialog module.
|
3682
|
+
* @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
|
3683
|
+
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
|
3684
|
+
*
|
3685
|
+
* @beta
|
3686
|
+
*/
|
3687
|
+
declare function open$1(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
|
3688
|
+
/**
|
3689
|
+
* Submit the dialog module and close the dialog
|
3690
|
+
*
|
3691
|
+
* @remarks
|
3692
|
+
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3693
|
+
*
|
3694
|
+
* @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
|
3695
|
+
* If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
|
3696
|
+
*
|
3697
|
+
* @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.
|
3698
|
+
*
|
3699
|
+
* @beta
|
3700
|
+
*/
|
3701
|
+
declare function submit(result?: string | object, appIds?: string | string[]): void;
|
3702
|
+
/**
|
3703
|
+
* Checks if dialog.url module is supported by the host
|
3704
|
+
*
|
3705
|
+
* @returns boolean to represent whether dialog.url module is supported
|
3706
|
+
*
|
3707
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3708
|
+
*
|
3709
|
+
* @beta
|
3710
|
+
*/
|
3711
|
+
declare function isSupported$g(): boolean;
|
3712
|
+
/**
|
3713
|
+
* @hidden
|
3714
|
+
*
|
3715
|
+
* Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
|
3716
|
+
*
|
3717
|
+
* @internal
|
3718
|
+
* Limited to Microsoft-internal use
|
3719
|
+
*/
|
3720
|
+
declare function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
|
3721
|
+
/**
|
3722
|
+
* @hidden
|
3723
|
+
*
|
3724
|
+
* Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
|
3725
|
+
*
|
3726
|
+
* @internal
|
3727
|
+
* Limited to Microsoft-internal use
|
3728
|
+
*/
|
3729
|
+
declare function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
|
3730
|
+
|
3731
|
+
declare const url_d_getDialogInfoFromBotUrlDialogInfo: typeof getDialogInfoFromBotUrlDialogInfo;
|
3732
|
+
declare const url_d_getDialogInfoFromUrlDialogInfo: typeof getDialogInfoFromUrlDialogInfo;
|
3733
|
+
declare const url_d_submit: typeof submit;
|
3734
|
+
declare namespace url_d {
|
3735
|
+
export { bot_d as bot, url_d_getDialogInfoFromBotUrlDialogInfo as getDialogInfoFromBotUrlDialogInfo, url_d_getDialogInfoFromUrlDialogInfo as getDialogInfoFromUrlDialogInfo, isSupported$g as isSupported, open$1 as open, parentCommunication_d as parentCommunication, url_d_submit as submit };
|
3470
3736
|
}
|
3471
3737
|
|
3472
3738
|
/**
|
3473
3739
|
* 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.
|
3474
3740
|
* Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
|
3475
3741
|
* - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
|
3476
|
-
* - For URL dialogs, use the functions and interfaces in the {@link
|
3742
|
+
* - For URL dialogs, use the functions and interfaces in the {@link url} module.
|
3477
3743
|
* - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
|
3478
|
-
* - For Adaptive Card dialogs, use the functions and interfaces in the {@link
|
3744
|
+
* - For Adaptive Card dialogs, use the functions and interfaces in the {@link adaptiveCard} module.
|
3479
3745
|
*
|
3480
3746
|
* @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
|
3481
3747
|
* For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
|
3482
3748
|
*
|
3483
3749
|
* @beta
|
3484
3750
|
*/
|
3485
|
-
|
3751
|
+
/**
|
3752
|
+
* Data Structure to represent the SDK response when dialog closes
|
3753
|
+
*
|
3754
|
+
* @beta
|
3755
|
+
*/
|
3756
|
+
interface ISdkResponse {
|
3486
3757
|
/**
|
3487
|
-
*
|
3488
|
-
*
|
3489
|
-
* @beta
|
3758
|
+
* Error in case there is a failure before dialog submission
|
3490
3759
|
*/
|
3491
|
-
|
3492
|
-
/**
|
3493
|
-
* Error in case there is a failure before dialog submission
|
3494
|
-
*/
|
3495
|
-
err?: string;
|
3496
|
-
/**
|
3497
|
-
* Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
|
3498
|
-
* was called.
|
3499
|
-
* If the dialog was closed by the user without submitting (e.g., using a control in the corner
|
3500
|
-
* of the dialog), this value will be `undefined` here.
|
3501
|
-
*/
|
3502
|
-
result?: string | object;
|
3503
|
-
}
|
3504
|
-
/**
|
3505
|
-
* Handler used to receive and process messages sent between a dialog and the app that launched it
|
3506
|
-
* @beta
|
3507
|
-
*/
|
3508
|
-
type PostMessageChannel = (message: any) => void;
|
3509
|
-
/**
|
3510
|
-
* Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
|
3511
|
-
* or an error if the dialog was closed by the user.
|
3512
|
-
*
|
3513
|
-
* @see {@linkcode ISdkResponse}
|
3514
|
-
*
|
3515
|
-
* @beta
|
3516
|
-
*/
|
3517
|
-
type DialogSubmitHandler = (result: ISdkResponse) => void;
|
3518
|
-
/**
|
3519
|
-
* @hidden
|
3520
|
-
* Hide from docs because this function is only used during initialization
|
3521
|
-
*
|
3522
|
-
* Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
|
3523
|
-
* Function is called during app initialization
|
3524
|
-
* @internal
|
3525
|
-
* Limited to Microsoft-internal use
|
3526
|
-
*
|
3527
|
-
* @beta
|
3528
|
-
*/
|
3529
|
-
function initialize(): void;
|
3530
|
-
namespace url {
|
3531
|
-
/**
|
3532
|
-
* Allows app to open a url based dialog.
|
3533
|
-
*
|
3534
|
-
* @remarks
|
3535
|
-
* This function cannot be called from inside of a dialog
|
3536
|
-
*
|
3537
|
-
* @param urlDialogInfo - An object containing the parameters of the dialog module.
|
3538
|
-
* @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
|
3539
|
-
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
|
3540
|
-
*
|
3541
|
-
* @beta
|
3542
|
-
*/
|
3543
|
-
function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
|
3544
|
-
/**
|
3545
|
-
* Submit the dialog module and close the dialog
|
3546
|
-
*
|
3547
|
-
* @remarks
|
3548
|
-
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3549
|
-
*
|
3550
|
-
* @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
|
3551
|
-
* If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
|
3552
|
-
*
|
3553
|
-
* @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.
|
3554
|
-
*
|
3555
|
-
* @beta
|
3556
|
-
*/
|
3557
|
-
function submit(result?: string | object, appIds?: string | string[]): void;
|
3558
|
-
/**
|
3559
|
-
* Subcapability that allows communication between the dialog and the parent app.
|
3560
|
-
*
|
3561
|
-
* @remarks
|
3562
|
-
* Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
|
3563
|
-
*
|
3564
|
-
* @beta
|
3565
|
-
*/
|
3566
|
-
namespace parentCommunication {
|
3567
|
-
/**
|
3568
|
-
* Send message to the parent from dialog
|
3569
|
-
*
|
3570
|
-
* @remarks
|
3571
|
-
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3572
|
-
*
|
3573
|
-
* @param message - The message to send to the parent
|
3574
|
-
*
|
3575
|
-
* @beta
|
3576
|
-
*/
|
3577
|
-
function sendMessageToParentFromDialog(message: any): void;
|
3578
|
-
/**
|
3579
|
-
* Send message to the dialog from the parent
|
3580
|
-
*
|
3581
|
-
* @param message - The message to send
|
3582
|
-
*
|
3583
|
-
* @beta
|
3584
|
-
*/
|
3585
|
-
function sendMessageToDialog(message: any): void;
|
3586
|
-
/**
|
3587
|
-
* Register a listener that will be triggered when a message is received from the app that opened the dialog.
|
3588
|
-
*
|
3589
|
-
* @remarks
|
3590
|
-
* This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
|
3591
|
-
*
|
3592
|
-
* @param listener - The listener that will be triggered.
|
3593
|
-
*
|
3594
|
-
* @beta
|
3595
|
-
*/
|
3596
|
-
function registerOnMessageFromParent(listener: PostMessageChannel): void;
|
3597
|
-
/**
|
3598
|
-
* Checks if dialog.url.parentCommunication capability is supported by the host
|
3599
|
-
*
|
3600
|
-
* @returns boolean to represent whether dialog.url.parentCommunication capability is supported
|
3601
|
-
*
|
3602
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3603
|
-
*
|
3604
|
-
* @beta
|
3605
|
-
*/
|
3606
|
-
function isSupported(): boolean;
|
3607
|
-
}
|
3608
|
-
/**
|
3609
|
-
* Checks if dialog.url module is supported by the host
|
3610
|
-
*
|
3611
|
-
* @returns boolean to represent whether dialog.url module is supported
|
3612
|
-
*
|
3613
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3614
|
-
*
|
3615
|
-
* @beta
|
3616
|
-
*/
|
3617
|
-
function isSupported(): boolean;
|
3618
|
-
/**
|
3619
|
-
* Namespace to open a dialog that sends results to the bot framework
|
3620
|
-
*
|
3621
|
-
* @beta
|
3622
|
-
*/
|
3623
|
-
namespace bot {
|
3624
|
-
/**
|
3625
|
-
* Allows an app to open a dialog that sends submitted data to a bot.
|
3626
|
-
*
|
3627
|
-
* @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
|
3628
|
-
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
|
3629
|
-
* @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
|
3630
|
-
*
|
3631
|
-
* @returns a function that can be used to send messages to the dialog.
|
3632
|
-
*
|
3633
|
-
* @beta
|
3634
|
-
*/
|
3635
|
-
function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
|
3636
|
-
/**
|
3637
|
-
* Checks if dialog.url.bot capability is supported by the host
|
3638
|
-
*
|
3639
|
-
* @returns boolean to represent whether dialog.url.bot is supported
|
3640
|
-
*
|
3641
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3642
|
-
*
|
3643
|
-
* @beta
|
3644
|
-
*/
|
3645
|
-
function isSupported(): boolean;
|
3646
|
-
}
|
3647
|
-
/**
|
3648
|
-
* @hidden
|
3649
|
-
*
|
3650
|
-
* Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
|
3651
|
-
*
|
3652
|
-
* @internal
|
3653
|
-
* Limited to Microsoft-internal use
|
3654
|
-
*/
|
3655
|
-
function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
|
3656
|
-
/**
|
3657
|
-
* @hidden
|
3658
|
-
*
|
3659
|
-
* Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
|
3660
|
-
*
|
3661
|
-
* @internal
|
3662
|
-
* Limited to Microsoft-internal use
|
3663
|
-
*/
|
3664
|
-
function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
|
3665
|
-
}
|
3760
|
+
err?: string;
|
3666
3761
|
/**
|
3667
|
-
*
|
3668
|
-
*
|
3669
|
-
*
|
3670
|
-
*
|
3671
|
-
* @hidden
|
3762
|
+
* Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
|
3763
|
+
* was called.
|
3764
|
+
* If the dialog was closed by the user without submitting (e.g., using a control in the corner
|
3765
|
+
* of the dialog), this value will be `undefined` here.
|
3672
3766
|
*/
|
3673
|
-
|
3674
|
-
|
3675
|
-
|
3676
|
-
|
3677
|
-
|
3678
|
-
|
3679
|
-
|
3680
|
-
|
3681
|
-
|
3682
|
-
|
3683
|
-
|
3684
|
-
|
3685
|
-
|
3686
|
-
|
3687
|
-
|
3688
|
-
|
3689
|
-
|
3690
|
-
|
3691
|
-
|
3692
|
-
|
3693
|
-
|
3694
|
-
|
3695
|
-
|
3696
|
-
|
3697
|
-
|
3698
|
-
|
3699
|
-
|
3700
|
-
|
3701
|
-
|
3702
|
-
|
3703
|
-
|
3704
|
-
|
3705
|
-
|
3706
|
-
|
3707
|
-
|
3708
|
-
|
3709
|
-
|
3710
|
-
|
3711
|
-
|
3712
|
-
|
3713
|
-
|
3714
|
-
|
3715
|
-
/**
|
3716
|
-
* Checks if dialog.adaptiveCard module is supported by the host
|
3717
|
-
*
|
3718
|
-
* @returns boolean to represent whether dialog.adaptiveCard module is supported
|
3719
|
-
*
|
3720
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3721
|
-
*
|
3722
|
-
* @beta
|
3723
|
-
*/
|
3724
|
-
function isSupported(): boolean;
|
3725
|
-
/**
|
3726
|
-
* Namespace for interaction with adaptive card dialogs that need to communicate with the bot framework
|
3727
|
-
*
|
3728
|
-
* @beta
|
3729
|
-
*/
|
3730
|
-
namespace bot {
|
3731
|
-
/**
|
3732
|
-
* Allows an app to open an adaptive card-based dialog module using bot.
|
3733
|
-
*
|
3734
|
-
* @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
|
3735
|
-
* @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
|
3736
|
-
*
|
3737
|
-
* @beta
|
3738
|
-
*/
|
3739
|
-
function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
|
3740
|
-
/**
|
3741
|
-
* Checks if dialog.adaptiveCard.bot capability is supported by the host
|
3742
|
-
*
|
3743
|
-
* @returns boolean to represent whether dialog.adaptiveCard.bot is supported
|
3744
|
-
*
|
3745
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3746
|
-
*
|
3747
|
-
* @beta
|
3748
|
-
*/
|
3749
|
-
function isSupported(): boolean;
|
3750
|
-
}
|
3751
|
-
}
|
3767
|
+
result?: string | object;
|
3768
|
+
}
|
3769
|
+
/**
|
3770
|
+
* Handler used to receive and process messages sent between a dialog and the app that launched it
|
3771
|
+
* @beta
|
3772
|
+
*/
|
3773
|
+
type PostMessageChannel = (message: any) => void;
|
3774
|
+
/**
|
3775
|
+
* Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
|
3776
|
+
* or an error if the dialog was closed by the user.
|
3777
|
+
*
|
3778
|
+
* @see {@linkcode ISdkResponse}
|
3779
|
+
*
|
3780
|
+
* @beta
|
3781
|
+
*/
|
3782
|
+
type DialogSubmitHandler = (result: ISdkResponse) => void;
|
3783
|
+
/**
|
3784
|
+
* @hidden
|
3785
|
+
* Hide from docs because this function is only used during initialization
|
3786
|
+
*
|
3787
|
+
* Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
|
3788
|
+
* Function is called during app initialization
|
3789
|
+
* @internal
|
3790
|
+
* Limited to Microsoft-internal use
|
3791
|
+
*
|
3792
|
+
* @beta
|
3793
|
+
*/
|
3794
|
+
declare function initialize$2(): void;
|
3795
|
+
/**
|
3796
|
+
* This function currently serves no purpose and should not be used. All functionality that used
|
3797
|
+
* to be covered by this method is now in subcapabilities and those isSupported methods should be
|
3798
|
+
* used directly.
|
3799
|
+
*
|
3800
|
+
* @hidden
|
3801
|
+
*/
|
3802
|
+
declare function isSupported$f(): boolean;
|
3803
|
+
|
3804
|
+
type dialog_d_DialogSubmitHandler = DialogSubmitHandler;
|
3805
|
+
type dialog_d_ISdkResponse = ISdkResponse;
|
3806
|
+
type dialog_d_PostMessageChannel = PostMessageChannel;
|
3807
|
+
declare namespace dialog_d {
|
3808
|
+
export { type dialog_d_DialogSubmitHandler as DialogSubmitHandler, type dialog_d_ISdkResponse as ISdkResponse, type dialog_d_PostMessageChannel as PostMessageChannel, adaptiveCard_d as adaptiveCard, initialize$2 as initialize, isSupported$f as isSupported, update_d as update, url_d as url };
|
3752
3809
|
}
|
3753
3810
|
|
3754
3811
|
/**
|
3755
3812
|
* @beta
|
3756
3813
|
* Nested app auth capabilities
|
3757
3814
|
*/
|
3758
|
-
|
3759
|
-
|
3760
|
-
|
3761
|
-
|
3762
|
-
|
3763
|
-
|
3764
|
-
|
3765
|
-
|
3766
|
-
|
3767
|
-
|
3815
|
+
/**
|
3816
|
+
* Checks if MSAL-NAA channel recommended by the host
|
3817
|
+
* @returns true if host is recommending NAA channel and false otherwise
|
3818
|
+
*
|
3819
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3820
|
+
*
|
3821
|
+
* @beta
|
3822
|
+
*/
|
3823
|
+
declare function isNAAChannelRecommended(): boolean;
|
3824
|
+
|
3825
|
+
declare const nestedAppAuth_d_isNAAChannelRecommended: typeof isNAAChannelRecommended;
|
3826
|
+
declare namespace nestedAppAuth_d {
|
3827
|
+
export { nestedAppAuth_d_isNAAChannelRecommended as isNAAChannelRecommended };
|
3828
|
+
}
|
3829
|
+
|
3830
|
+
/**
|
3831
|
+
* Allows user to choose location on map
|
3832
|
+
*
|
3833
|
+
* @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
|
3834
|
+
*
|
3835
|
+
* @beta
|
3836
|
+
*/
|
3837
|
+
declare function chooseLocation(): Promise<Location$1>;
|
3838
|
+
/**
|
3839
|
+
* Shows the location on map corresponding to the given coordinates
|
3840
|
+
*
|
3841
|
+
* @param location - Location to be shown on the map
|
3842
|
+
* @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
|
3843
|
+
*
|
3844
|
+
* @beta
|
3845
|
+
*/
|
3846
|
+
declare function showLocation$1(location: Location$1): Promise<void>;
|
3847
|
+
/**
|
3848
|
+
* Checks if geoLocation.map capability is supported by the host
|
3849
|
+
* @returns boolean to represent whether geoLocation.map is supported
|
3850
|
+
*
|
3851
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3852
|
+
*
|
3853
|
+
* @beta
|
3854
|
+
*/
|
3855
|
+
declare function isSupported$e(): boolean;
|
3856
|
+
|
3857
|
+
declare const map_d_chooseLocation: typeof chooseLocation;
|
3858
|
+
declare namespace map_d {
|
3859
|
+
export { map_d_chooseLocation as chooseLocation, isSupported$e as isSupported, showLocation$1 as showLocation };
|
3768
3860
|
}
|
3769
3861
|
|
3770
3862
|
/**
|
@@ -3772,100 +3864,70 @@ declare namespace nestedAppAuth {
|
|
3772
3864
|
*
|
3773
3865
|
* @beta
|
3774
3866
|
*/
|
3775
|
-
|
3776
|
-
|
3777
|
-
|
3778
|
-
|
3779
|
-
|
3780
|
-
|
3781
|
-
interface Location {
|
3782
|
-
/**
|
3783
|
-
Latitude of the location
|
3784
|
-
*/
|
3785
|
-
latitude: number;
|
3786
|
-
/**
|
3787
|
-
Longitude of the location
|
3788
|
-
*/
|
3789
|
-
longitude: number;
|
3790
|
-
/**
|
3791
|
-
Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
|
3792
|
-
@remarks
|
3793
|
-
This property is only in scope for mobile
|
3794
|
-
*/
|
3795
|
-
accuracy?: number;
|
3796
|
-
/**
|
3797
|
-
Time stamp when the location was captured
|
3798
|
-
*/
|
3799
|
-
timestamp?: number;
|
3800
|
-
}
|
3801
|
-
/**
|
3802
|
-
* Fetches current user coordinates
|
3803
|
-
* @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
|
3804
|
-
*
|
3805
|
-
* @beta
|
3806
|
-
*/
|
3807
|
-
function getCurrentLocation(): Promise<Location>;
|
3867
|
+
/**
|
3868
|
+
* Data struture to represent the location information
|
3869
|
+
*
|
3870
|
+
* @beta
|
3871
|
+
*/
|
3872
|
+
interface Location$1 {
|
3808
3873
|
/**
|
3809
|
-
|
3810
|
-
|
3811
|
-
|
3812
|
-
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
3813
|
-
*
|
3814
|
-
* @beta
|
3815
|
-
*/
|
3816
|
-
function hasPermission(): Promise<boolean>;
|
3874
|
+
Latitude of the location
|
3875
|
+
*/
|
3876
|
+
latitude: number;
|
3817
3877
|
/**
|
3818
|
-
|
3819
|
-
|
3820
|
-
|
3821
|
-
* @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
|
3822
|
-
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
3823
|
-
*
|
3824
|
-
* @beta
|
3825
|
-
*/
|
3826
|
-
function requestPermission(): Promise<boolean>;
|
3878
|
+
Longitude of the location
|
3879
|
+
*/
|
3880
|
+
longitude: number;
|
3827
3881
|
/**
|
3828
|
-
|
3829
|
-
|
3830
|
-
|
3831
|
-
|
3832
|
-
|
3833
|
-
* @beta
|
3834
|
-
*/
|
3835
|
-
function isSupported(): boolean;
|
3882
|
+
Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
|
3883
|
+
@remarks
|
3884
|
+
This property is only in scope for mobile
|
3885
|
+
*/
|
3886
|
+
accuracy?: number;
|
3836
3887
|
/**
|
3837
|
-
|
3838
|
-
|
3839
|
-
|
3840
|
-
|
3841
|
-
|
3842
|
-
|
3843
|
-
|
3844
|
-
|
3845
|
-
|
3846
|
-
|
3847
|
-
|
3848
|
-
|
3849
|
-
|
3850
|
-
|
3851
|
-
|
3852
|
-
|
3853
|
-
|
3854
|
-
|
3855
|
-
|
3856
|
-
|
3857
|
-
|
3858
|
-
|
3859
|
-
|
3860
|
-
|
3861
|
-
|
3862
|
-
|
3863
|
-
|
3864
|
-
|
3865
|
-
|
3866
|
-
|
3867
|
-
|
3868
|
-
|
3888
|
+
Time stamp when the location was captured
|
3889
|
+
*/
|
3890
|
+
timestamp?: number;
|
3891
|
+
}
|
3892
|
+
/**
|
3893
|
+
* Fetches current user coordinates
|
3894
|
+
* @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
|
3895
|
+
*
|
3896
|
+
* @beta
|
3897
|
+
*/
|
3898
|
+
declare function getCurrentLocation(): Promise<Location$1>;
|
3899
|
+
/**
|
3900
|
+
* Checks whether or not location has user permission
|
3901
|
+
*
|
3902
|
+
* @returns Promise that will resolve with true if the user had granted the app permission to location information, or with false otherwise,
|
3903
|
+
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
3904
|
+
*
|
3905
|
+
* @beta
|
3906
|
+
*/
|
3907
|
+
declare function hasPermission$1(): Promise<boolean>;
|
3908
|
+
/**
|
3909
|
+
* Requests user permission for location
|
3910
|
+
*
|
3911
|
+
* @returns true if the user consented permission for location, false otherwise
|
3912
|
+
* @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
|
3913
|
+
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
3914
|
+
*
|
3915
|
+
* @beta
|
3916
|
+
*/
|
3917
|
+
declare function requestPermission$1(): Promise<boolean>;
|
3918
|
+
/**
|
3919
|
+
* Checks if geoLocation capability is supported by the host
|
3920
|
+
* @returns boolean to represent whether geoLocation is supported
|
3921
|
+
*
|
3922
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
3923
|
+
*
|
3924
|
+
* @beta
|
3925
|
+
*/
|
3926
|
+
declare function isSupported$d(): boolean;
|
3927
|
+
|
3928
|
+
declare const geoLocation_d_getCurrentLocation: typeof getCurrentLocation;
|
3929
|
+
declare namespace geoLocation_d {
|
3930
|
+
export { type Location$1 as Location, geoLocation_d_getCurrentLocation as getCurrentLocation, hasPermission$1 as hasPermission, isSupported$d as isSupported, map_d as map, requestPermission$1 as requestPermission };
|
3869
3931
|
}
|
3870
3932
|
|
3871
3933
|
/**
|
@@ -4498,751 +4560,818 @@ declare class ParentAppWindow implements IAppWindow {
|
|
4498
4560
|
}
|
4499
4561
|
|
4500
4562
|
/**
|
4501
|
-
*
|
4563
|
+
* Module to interact with the menu-specific part of the SDK.
|
4502
4564
|
* This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
|
4503
4565
|
*/
|
4504
|
-
|
4566
|
+
/**
|
4567
|
+
* @hidden
|
4568
|
+
* Represents information about item in View Configuration.
|
4569
|
+
*
|
4570
|
+
* @internal
|
4571
|
+
* Limited to Microsoft-internal use
|
4572
|
+
*/
|
4573
|
+
interface ViewConfiguration {
|
4505
4574
|
/**
|
4506
4575
|
* @hidden
|
4507
|
-
*
|
4576
|
+
* Unique identifier of view.
|
4508
4577
|
*
|
4509
4578
|
* @internal
|
4510
4579
|
* Limited to Microsoft-internal use
|
4511
4580
|
*/
|
4512
|
-
|
4513
|
-
/**
|
4514
|
-
* @hidden
|
4515
|
-
* Unique identifier of view.
|
4516
|
-
*
|
4517
|
-
* @internal
|
4518
|
-
* Limited to Microsoft-internal use
|
4519
|
-
*/
|
4520
|
-
id: string;
|
4521
|
-
/**
|
4522
|
-
* @hidden
|
4523
|
-
* Display title of the view.
|
4524
|
-
*
|
4525
|
-
* @internal
|
4526
|
-
* Limited to Microsoft-internal use
|
4527
|
-
*/
|
4528
|
-
title: string;
|
4529
|
-
/**
|
4530
|
-
* @hidden
|
4531
|
-
* Additional information for accessibility.
|
4532
|
-
*
|
4533
|
-
* @internal
|
4534
|
-
* Limited to Microsoft-internal use
|
4535
|
-
*/
|
4536
|
-
contentDescription?: string;
|
4537
|
-
}
|
4581
|
+
id: string;
|
4538
4582
|
/**
|
4539
|
-
*
|
4583
|
+
* @hidden
|
4584
|
+
* Display title of the view.
|
4585
|
+
*
|
4586
|
+
* @internal
|
4587
|
+
* Limited to Microsoft-internal use
|
4540
4588
|
*/
|
4541
|
-
|
4542
|
-
/**
|
4543
|
-
* Only place this item in the NavBar if there's room for it.
|
4544
|
-
* If there's no room, item is shown in the overflow menu.
|
4545
|
-
*/
|
4546
|
-
ifRoom = 0,
|
4547
|
-
/**
|
4548
|
-
* Never place this item in the NavBar.
|
4549
|
-
* The item would always be shown in NavBar's overflow menu.
|
4550
|
-
*/
|
4551
|
-
overflowOnly = 1
|
4552
|
-
}
|
4589
|
+
title: string;
|
4553
4590
|
/**
|
4554
4591
|
* @hidden
|
4555
|
-
*
|
4592
|
+
* Additional information for accessibility.
|
4593
|
+
*
|
4594
|
+
* @internal
|
4595
|
+
* Limited to Microsoft-internal use
|
4556
4596
|
*/
|
4557
|
-
|
4558
|
-
|
4559
|
-
|
4560
|
-
|
4561
|
-
|
4562
|
-
|
4563
|
-
|
4564
|
-
|
4565
|
-
|
4566
|
-
|
4567
|
-
|
4568
|
-
|
4569
|
-
|
4570
|
-
|
4571
|
-
|
4572
|
-
|
4573
|
-
|
4574
|
-
|
4575
|
-
|
4576
|
-
|
4577
|
-
|
4578
|
-
|
4579
|
-
* @hidden
|
4580
|
-
* Additional information for accessibility.
|
4581
|
-
*/
|
4582
|
-
contentDescription?: string;
|
4583
|
-
/**
|
4584
|
-
* @hidden
|
4585
|
-
* State of the menu item
|
4586
|
-
*/
|
4587
|
-
enabled: boolean;
|
4588
|
-
/**
|
4589
|
-
* @hidden
|
4590
|
-
* Interface to show list of items on selection of menu item.
|
4591
|
-
*/
|
4592
|
-
viewData?: ViewData;
|
4593
|
-
/**
|
4594
|
-
* @hidden
|
4595
|
-
* Whether the menu item is selected or not
|
4596
|
-
*/
|
4597
|
-
selected: boolean;
|
4598
|
-
/**
|
4599
|
-
* The Display Mode of the menu item.
|
4600
|
-
* Default Behaviour would be DisplayMode.ifRoom if null.
|
4601
|
-
* Refer {@link DisplayMode}
|
4602
|
-
*/
|
4603
|
-
displayMode?: DisplayMode;
|
4604
|
-
}
|
4597
|
+
contentDescription?: string;
|
4598
|
+
}
|
4599
|
+
/**
|
4600
|
+
* Defines how a menu item should appear in the NavBar.
|
4601
|
+
*/
|
4602
|
+
declare enum DisplayMode {
|
4603
|
+
/**
|
4604
|
+
* Only place this item in the NavBar if there's room for it.
|
4605
|
+
* If there's no room, item is shown in the overflow menu.
|
4606
|
+
*/
|
4607
|
+
ifRoom = 0,
|
4608
|
+
/**
|
4609
|
+
* Never place this item in the NavBar.
|
4610
|
+
* The item would always be shown in NavBar's overflow menu.
|
4611
|
+
*/
|
4612
|
+
overflowOnly = 1
|
4613
|
+
}
|
4614
|
+
/**
|
4615
|
+
* @hidden
|
4616
|
+
* Represents information about menu item for Action Menu and Navigation Bar Menu.
|
4617
|
+
*/
|
4618
|
+
declare class MenuItem {
|
4605
4619
|
/**
|
4606
4620
|
* @hidden
|
4607
|
-
*
|
4621
|
+
* Unique identifier for the menu item.
|
4608
4622
|
*/
|
4609
|
-
|
4610
|
-
/**
|
4611
|
-
* @hidden
|
4612
|
-
* Display header title of the item list.
|
4613
|
-
*/
|
4614
|
-
listTitle?: string;
|
4615
|
-
/**
|
4616
|
-
* @hidden
|
4617
|
-
* Type of the menu item.
|
4618
|
-
*/
|
4619
|
-
listType: MenuListType;
|
4620
|
-
/**
|
4621
|
-
* @hidden
|
4622
|
-
* Array of MenuItem. Icon value will be required for all items in the list.
|
4623
|
-
*/
|
4624
|
-
listItems: MenuItem[];
|
4625
|
-
}
|
4623
|
+
id: string;
|
4626
4624
|
/**
|
4627
4625
|
* @hidden
|
4628
|
-
*
|
4626
|
+
* Display title of the menu item.
|
4629
4627
|
*/
|
4630
|
-
|
4631
|
-
dropDown = "dropDown",
|
4632
|
-
popOver = "popOver"
|
4633
|
-
}
|
4628
|
+
title: string;
|
4634
4629
|
/**
|
4635
4630
|
* @hidden
|
4636
|
-
*
|
4637
|
-
*
|
4638
|
-
* @internal
|
4639
|
-
* Limited to Microsoft-internal use.
|
4631
|
+
* Display icon of the menu item. The icon value must be a string having SVG icon content.
|
4640
4632
|
*/
|
4641
|
-
|
4633
|
+
icon: string;
|
4642
4634
|
/**
|
4643
4635
|
* @hidden
|
4644
|
-
*
|
4645
|
-
* Handler is responsible for listening selection of View Configuration.
|
4646
|
-
*
|
4647
|
-
* @param viewConfig - List of view configurations. Minimum 1 value is required.
|
4648
|
-
* @param handler - The handler to invoke when the user selects view configuration.
|
4636
|
+
* Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
|
4649
4637
|
*/
|
4650
|
-
|
4638
|
+
iconSelected?: string;
|
4651
4639
|
/**
|
4652
4640
|
* @hidden
|
4653
|
-
*
|
4654
|
-
*
|
4655
|
-
* @param items List of MenuItems for Navigation Bar Menu.
|
4656
|
-
* @param handler The handler to invoke when the user selects menu item.
|
4641
|
+
* Additional information for accessibility.
|
4657
4642
|
*/
|
4658
|
-
|
4659
|
-
/**
|
4660
|
-
|
4661
|
-
|
4662
|
-
|
4663
|
-
|
4664
|
-
|
4665
|
-
|
4666
|
-
|
4667
|
-
|
4668
|
-
|
4669
|
-
|
4670
|
-
|
4671
|
-
|
4643
|
+
contentDescription?: string;
|
4644
|
+
/**
|
4645
|
+
* @hidden
|
4646
|
+
* State of the menu item
|
4647
|
+
*/
|
4648
|
+
enabled: boolean;
|
4649
|
+
/**
|
4650
|
+
* @hidden
|
4651
|
+
* Interface to show list of items on selection of menu item.
|
4652
|
+
*/
|
4653
|
+
viewData?: ViewData;
|
4654
|
+
/**
|
4655
|
+
* @hidden
|
4656
|
+
* Whether the menu item is selected or not
|
4657
|
+
*/
|
4658
|
+
selected: boolean;
|
4659
|
+
/**
|
4660
|
+
* The Display Mode of the menu item.
|
4661
|
+
* Default Behaviour would be DisplayMode.ifRoom if null.
|
4662
|
+
* Refer {@link DisplayMode}
|
4663
|
+
*/
|
4664
|
+
displayMode?: DisplayMode;
|
4665
|
+
}
|
4666
|
+
/**
|
4667
|
+
* @hidden
|
4668
|
+
* Represents information about view to show on Navigation Bar Menu item selection
|
4669
|
+
*/
|
4670
|
+
interface ViewData {
|
4671
|
+
/**
|
4672
|
+
* @hidden
|
4673
|
+
* Display header title of the item list.
|
4674
|
+
*/
|
4675
|
+
listTitle?: string;
|
4676
|
+
/**
|
4677
|
+
* @hidden
|
4678
|
+
* Type of the menu item.
|
4679
|
+
*/
|
4680
|
+
listType: MenuListType;
|
4681
|
+
/**
|
4682
|
+
* @hidden
|
4683
|
+
* Array of MenuItem. Icon value will be required for all items in the list.
|
4684
|
+
*/
|
4685
|
+
listItems: MenuItem[];
|
4686
|
+
}
|
4687
|
+
/**
|
4688
|
+
* @hidden
|
4689
|
+
* Represents information about type of list to display in Navigation Bar Menu.
|
4690
|
+
*/
|
4691
|
+
declare enum MenuListType {
|
4692
|
+
dropDown = "dropDown",
|
4693
|
+
popOver = "popOver"
|
4694
|
+
}
|
4695
|
+
/**
|
4696
|
+
* @hidden
|
4697
|
+
* Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
|
4698
|
+
*
|
4699
|
+
* @internal
|
4700
|
+
* Limited to Microsoft-internal use.
|
4701
|
+
*/
|
4702
|
+
declare function initialize$1(): void;
|
4703
|
+
/**
|
4704
|
+
* @hidden
|
4705
|
+
* Registers list of view configurations and it's handler.
|
4706
|
+
* Handler is responsible for listening selection of View Configuration.
|
4707
|
+
*
|
4708
|
+
* @param viewConfig - List of view configurations. Minimum 1 value is required.
|
4709
|
+
* @param handler - The handler to invoke when the user selects view configuration.
|
4710
|
+
*/
|
4711
|
+
declare function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
|
4712
|
+
/**
|
4713
|
+
* @hidden
|
4714
|
+
* Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
|
4715
|
+
*
|
4716
|
+
* @param items List of MenuItems for Navigation Bar Menu.
|
4717
|
+
* @param handler The handler to invoke when the user selects menu item.
|
4718
|
+
*/
|
4719
|
+
declare function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
|
4720
|
+
/** Parameters used to create an action menu within an app */
|
4721
|
+
interface ActionMenuParameters {
|
4672
4722
|
/**
|
4673
4723
|
* @hidden
|
4674
|
-
*
|
4675
|
-
*
|
4676
|
-
* @param params - Parameters for Menu Parameters
|
4677
|
-
* @param handler - The handler to invoke when the user selects menu item.
|
4724
|
+
* Display title for Action Menu
|
4678
4725
|
*/
|
4679
|
-
|
4726
|
+
title: string;
|
4680
4727
|
/**
|
4681
|
-
*
|
4682
|
-
*
|
4683
|
-
*
|
4684
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
4728
|
+
* @hidden
|
4729
|
+
* List of MenuItems for Action Menu
|
4685
4730
|
*/
|
4686
|
-
|
4731
|
+
items: MenuItem[];
|
4732
|
+
}
|
4733
|
+
/**
|
4734
|
+
* @hidden
|
4735
|
+
* Used to show Action Menu.
|
4736
|
+
*
|
4737
|
+
* @param params - Parameters for Menu Parameters
|
4738
|
+
* @param handler - The handler to invoke when the user selects menu item.
|
4739
|
+
*/
|
4740
|
+
declare function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
|
4741
|
+
/**
|
4742
|
+
* Checks if the menus capability is supported by the host
|
4743
|
+
* @returns boolean to represent whether the menus capability is supported
|
4744
|
+
*
|
4745
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
4746
|
+
*/
|
4747
|
+
declare function isSupported$c(): boolean;
|
4748
|
+
|
4749
|
+
type menus_d_ActionMenuParameters = ActionMenuParameters;
|
4750
|
+
type menus_d_DisplayMode = DisplayMode;
|
4751
|
+
declare const menus_d_DisplayMode: typeof DisplayMode;
|
4752
|
+
type menus_d_MenuItem = MenuItem;
|
4753
|
+
declare const menus_d_MenuItem: typeof MenuItem;
|
4754
|
+
type menus_d_MenuListType = MenuListType;
|
4755
|
+
declare const menus_d_MenuListType: typeof MenuListType;
|
4756
|
+
type menus_d_ViewConfiguration = ViewConfiguration;
|
4757
|
+
type menus_d_ViewData = ViewData;
|
4758
|
+
declare const menus_d_setNavBarMenu: typeof setNavBarMenu;
|
4759
|
+
declare const menus_d_setUpViews: typeof setUpViews;
|
4760
|
+
declare const menus_d_showActionMenu: typeof showActionMenu;
|
4761
|
+
declare namespace menus_d {
|
4762
|
+
export { type menus_d_ActionMenuParameters as ActionMenuParameters, menus_d_DisplayMode as DisplayMode, menus_d_MenuItem as MenuItem, menus_d_MenuListType as MenuListType, type menus_d_ViewConfiguration as ViewConfiguration, type menus_d_ViewData as ViewData, initialize$1 as initialize, isSupported$c as isSupported, menus_d_setNavBarMenu as setNavBarMenu, menus_d_setUpViews as setUpViews, menus_d_showActionMenu as showActionMenu };
|
4687
4763
|
}
|
4688
4764
|
|
4689
4765
|
/**
|
4690
4766
|
* Interact with media, including capturing and viewing images.
|
4691
4767
|
*/
|
4692
|
-
|
4693
|
-
|
4694
|
-
|
4695
|
-
|
4696
|
-
|
4697
|
-
|
4698
|
-
|
4699
|
-
|
4768
|
+
/**
|
4769
|
+
* Function callback type used when calling {@link media.captureImage}.
|
4770
|
+
*
|
4771
|
+
* @param error - Error encountered during the API call, if any, {@link SdkError}
|
4772
|
+
* @param files - Collection of File objects (images) captured by the user. Will be an empty array in the case of an error.
|
4773
|
+
* */
|
4774
|
+
type captureImageCallbackFunctionType = (error: SdkError, files: File[]) => void;
|
4775
|
+
/**
|
4776
|
+
* Function callback type used when calling {@link media.selectMedia}.
|
4777
|
+
*
|
4778
|
+
* @param error - Error encountered during the API call, if any, {@link SdkError}
|
4779
|
+
* @param attachments - Collection of {@link Media} objects selected by the user. Will be an empty array in the case of an error.
|
4780
|
+
* */
|
4781
|
+
type selectMediaCallbackFunctionType = (error: SdkError, attachments: Media[]) => void;
|
4782
|
+
/** Error callback function type. */
|
4783
|
+
type errorCallbackFunctionType = (error?: SdkError) => void;
|
4784
|
+
/**
|
4785
|
+
* Function callback type used when calling {@link media.scanBarCode}.
|
4786
|
+
*
|
4787
|
+
* @param error - Error encountered during the API call, if any, {@link SdkError}
|
4788
|
+
* @param decodedText - Decoded text from the barcode, if any. In the case of an error, this will be the empty string.
|
4789
|
+
* */
|
4790
|
+
type scanBarCodeCallbackFunctionType = (error: SdkError, decodedText: string) => void;
|
4791
|
+
/**
|
4792
|
+
* Function callback type used when calling {@link media.Media.getMedia}
|
4793
|
+
*
|
4794
|
+
* @param error - Error encountered during the API call, if any, {@link SdkError}
|
4795
|
+
* @param blob - Blob of media returned. Will be a blob with no BlobParts, in the case of an error.
|
4796
|
+
* */
|
4797
|
+
type getMediaCallbackFunctionType = (error: SdkError, blob: Blob) => void;
|
4798
|
+
/**
|
4799
|
+
* Enum for file formats supported
|
4800
|
+
*/
|
4801
|
+
declare enum FileFormat {
|
4802
|
+
/** Base64 encoding */
|
4803
|
+
Base64 = "base64",
|
4804
|
+
/** File id */
|
4805
|
+
ID = "id"
|
4806
|
+
}
|
4807
|
+
/**
|
4808
|
+
* File object that can be used to represent image or video or audio
|
4809
|
+
*/
|
4810
|
+
declare class File {
|
4700
4811
|
/**
|
4701
|
-
*
|
4702
|
-
*
|
4703
|
-
*
|
4704
|
-
|
4705
|
-
|
4706
|
-
export type selectMediaCallbackFunctionType = (error: SdkError, attachments: Media[]) => void;
|
4707
|
-
/** Error callback function type. */
|
4708
|
-
export type errorCallbackFunctionType = (error?: SdkError) => void;
|
4812
|
+
* Content of the file. When format is Base64, this is the base64 content
|
4813
|
+
* When format is ID, this is id mapping to the URI
|
4814
|
+
* When format is base64 and app needs to use this directly in HTML tags, it should convert this to dataUrl.
|
4815
|
+
*/
|
4816
|
+
content: string;
|
4709
4817
|
/**
|
4710
|
-
*
|
4711
|
-
|
4712
|
-
|
4713
|
-
* @param decodedText - Decoded text from the barcode, if any. In the case of an error, this will be the empty string.
|
4714
|
-
* */
|
4715
|
-
export type scanBarCodeCallbackFunctionType = (error: SdkError, decodedText: string) => void;
|
4818
|
+
* Format of the content
|
4819
|
+
*/
|
4820
|
+
format: FileFormat;
|
4716
4821
|
/**
|
4717
|
-
*
|
4718
|
-
|
4719
|
-
|
4720
|
-
* @param blob - Blob of media returned. Will be a blob with no BlobParts, in the case of an error.
|
4721
|
-
* */
|
4722
|
-
export type getMediaCallbackFunctionType = (error: SdkError, blob: Blob) => void;
|
4822
|
+
* Size of the file in KB
|
4823
|
+
*/
|
4824
|
+
size: number;
|
4723
4825
|
/**
|
4724
|
-
*
|
4826
|
+
* MIME type. This can be used for constructing a dataUrl, if needed.
|
4725
4827
|
*/
|
4726
|
-
|
4727
|
-
/** Base64 encoding */
|
4728
|
-
Base64 = "base64",
|
4729
|
-
/** File id */
|
4730
|
-
ID = "id"
|
4731
|
-
}
|
4828
|
+
mimeType: string;
|
4732
4829
|
/**
|
4733
|
-
*
|
4830
|
+
* Optional: Name of the file
|
4734
4831
|
*/
|
4735
|
-
|
4736
|
-
|
4737
|
-
|
4738
|
-
|
4739
|
-
|
4740
|
-
|
4741
|
-
|
4742
|
-
|
4743
|
-
|
4744
|
-
|
4745
|
-
|
4746
|
-
|
4747
|
-
|
4748
|
-
|
4749
|
-
|
4750
|
-
|
4751
|
-
|
4752
|
-
|
4753
|
-
|
4754
|
-
|
4755
|
-
|
4756
|
-
|
4757
|
-
|
4758
|
-
|
4832
|
+
name?: string;
|
4833
|
+
}
|
4834
|
+
/**
|
4835
|
+
* Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
|
4836
|
+
*
|
4837
|
+
* @params callback - Callback will be called with an @see SdkError if there are any.
|
4838
|
+
* If error is null or undefined, the callback will be called with a collection of @see File objects
|
4839
|
+
* @remarks
|
4840
|
+
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
4841
|
+
* Note: For desktop, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
4842
|
+
*
|
4843
|
+
*/
|
4844
|
+
declare function captureImage(callback: captureImageCallbackFunctionType): void;
|
4845
|
+
/**
|
4846
|
+
* Checks whether or not media has user permission
|
4847
|
+
*
|
4848
|
+
* @returns Promise that will resolve with true if the user had granted the app permission to media information, or with false otherwise,
|
4849
|
+
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
4850
|
+
*
|
4851
|
+
* @beta
|
4852
|
+
*/
|
4853
|
+
declare function hasPermission(): Promise<boolean>;
|
4854
|
+
/**
|
4855
|
+
* Requests user permission for media
|
4856
|
+
*
|
4857
|
+
* @returns Promise that will resolve with true if the user consented permission for media, or with false otherwise,
|
4858
|
+
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
4859
|
+
*
|
4860
|
+
* @beta
|
4861
|
+
*/
|
4862
|
+
declare function requestPermission(): Promise<boolean>;
|
4863
|
+
/**
|
4864
|
+
* Media object returned by the select Media API
|
4865
|
+
*/
|
4866
|
+
declare class Media extends File {
|
4867
|
+
constructor(that?: Media);
|
4759
4868
|
/**
|
4760
|
-
*
|
4761
|
-
*
|
4762
|
-
* @params callback - Callback will be called with an @see SdkError if there are any.
|
4763
|
-
* If error is null or undefined, the callback will be called with a collection of @see File objects
|
4764
|
-
* @remarks
|
4765
|
-
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
4766
|
-
* Note: For desktop, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
4767
|
-
*
|
4869
|
+
* A preview of the file which is a lightweight representation.
|
4870
|
+
* In case of images this will be a thumbnail/compressed image in base64 encoding.
|
4768
4871
|
*/
|
4769
|
-
|
4872
|
+
preview: string;
|
4770
4873
|
/**
|
4771
|
-
*
|
4772
|
-
*
|
4773
|
-
*
|
4774
|
-
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
4775
|
-
*
|
4776
|
-
* @beta
|
4874
|
+
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
4875
|
+
* @param callback - callback is called with the @see SdkError if there is an error
|
4876
|
+
* If error is null or undefined, the callback will be called with @see Blob.
|
4777
4877
|
*/
|
4778
|
-
|
4878
|
+
getMedia(callback: getMediaCallbackFunctionType): void;
|
4879
|
+
/** Function to retrieve media content, such as images or videos, via callback. */
|
4880
|
+
private getMediaViaCallback;
|
4881
|
+
/** Function to retrieve media content, such as images or videos, via handler. */
|
4882
|
+
private getMediaViaHandler;
|
4883
|
+
}
|
4884
|
+
/**
|
4885
|
+
* Input parameter supplied to the select Media API
|
4886
|
+
*/
|
4887
|
+
interface MediaInputs {
|
4779
4888
|
/**
|
4780
|
-
*
|
4781
|
-
*
|
4782
|
-
* @returns Promise that will resolve with true if the user consented permission for media, or with false otherwise,
|
4783
|
-
* In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
|
4784
|
-
*
|
4785
|
-
* @beta
|
4889
|
+
* Only one media type can be selected at a time
|
4786
4890
|
*/
|
4787
|
-
|
4891
|
+
mediaType: MediaType;
|
4788
4892
|
/**
|
4789
|
-
*
|
4893
|
+
* max limit of media allowed to be selected in one go, current max limit is 10 set by office lens.
|
4790
4894
|
*/
|
4791
|
-
|
4792
|
-
constructor(that?: Media);
|
4793
|
-
/**
|
4794
|
-
* A preview of the file which is a lightweight representation.
|
4795
|
-
* In case of images this will be a thumbnail/compressed image in base64 encoding.
|
4796
|
-
*/
|
4797
|
-
preview: string;
|
4798
|
-
/**
|
4799
|
-
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
4800
|
-
* @param callback - callback is called with the @see SdkError if there is an error
|
4801
|
-
* If error is null or undefined, the callback will be called with @see Blob.
|
4802
|
-
*/
|
4803
|
-
getMedia(callback: getMediaCallbackFunctionType): void;
|
4804
|
-
/** Function to retrieve media content, such as images or videos, via callback. */
|
4805
|
-
private getMediaViaCallback;
|
4806
|
-
/** Function to retrieve media content, such as images or videos, via handler. */
|
4807
|
-
private getMediaViaHandler;
|
4808
|
-
}
|
4895
|
+
maxMediaCount: number;
|
4809
4896
|
/**
|
4810
|
-
*
|
4897
|
+
* Additional properties for customization of select media - Image in mobile devices
|
4811
4898
|
*/
|
4812
|
-
|
4813
|
-
/**
|
4814
|
-
* Only one media type can be selected at a time
|
4815
|
-
*/
|
4816
|
-
mediaType: MediaType;
|
4817
|
-
/**
|
4818
|
-
* max limit of media allowed to be selected in one go, current max limit is 10 set by office lens.
|
4819
|
-
*/
|
4820
|
-
maxMediaCount: number;
|
4821
|
-
/**
|
4822
|
-
* Additional properties for customization of select media - Image in mobile devices
|
4823
|
-
*/
|
4824
|
-
imageProps?: ImageProps;
|
4825
|
-
/**
|
4826
|
-
* Additional properties for customization of select media - Video in mobile devices
|
4827
|
-
*/
|
4828
|
-
videoProps?: VideoProps;
|
4829
|
-
/**
|
4830
|
-
* Additional properties for customization of select media - VideoAndImage in mobile devices
|
4831
|
-
*/
|
4832
|
-
videoAndImageProps?: VideoAndImageProps;
|
4833
|
-
/**
|
4834
|
-
* Additional properties for audio capture flows.
|
4835
|
-
*/
|
4836
|
-
audioProps?: AudioProps;
|
4837
|
-
}
|
4899
|
+
imageProps?: ImageProps;
|
4838
4900
|
/**
|
4839
|
-
*
|
4840
|
-
* Hide from docs
|
4841
|
-
* --------
|
4842
|
-
* All properties common to Image and Video Props
|
4901
|
+
* Additional properties for customization of select media - Video in mobile devices
|
4843
4902
|
*/
|
4844
|
-
|
4845
|
-
/**
|
4846
|
-
* @hidden
|
4847
|
-
* Optional; Lets the developer specify the media source, more than one can be specified.
|
4848
|
-
* Default value is both camera and gallery
|
4849
|
-
*/
|
4850
|
-
sources?: Source[];
|
4851
|
-
/**
|
4852
|
-
* @hidden
|
4853
|
-
* Optional; Specify in which mode the camera will be opened.
|
4854
|
-
* Default value is Photo
|
4855
|
-
*/
|
4856
|
-
startMode?: CameraStartMode;
|
4857
|
-
/**
|
4858
|
-
* @hidden
|
4859
|
-
* Optional; indicate if user is allowed to move between front and back camera
|
4860
|
-
* Default value is true
|
4861
|
-
*/
|
4862
|
-
cameraSwitcher?: boolean;
|
4863
|
-
}
|
4903
|
+
videoProps?: VideoProps;
|
4864
4904
|
/**
|
4865
|
-
*
|
4905
|
+
* Additional properties for customization of select media - VideoAndImage in mobile devices
|
4866
4906
|
*/
|
4867
|
-
|
4868
|
-
/**
|
4869
|
-
* Optional; indicate if inking on the selected Image is allowed or not
|
4870
|
-
* Default value is true
|
4871
|
-
*/
|
4872
|
-
ink?: boolean;
|
4873
|
-
/**
|
4874
|
-
* Optional; indicate if putting text stickers on the selected Image is allowed or not
|
4875
|
-
* Default value is true
|
4876
|
-
*/
|
4877
|
-
textSticker?: boolean;
|
4878
|
-
/**
|
4879
|
-
* Optional; indicate if image filtering mode is enabled on the selected image
|
4880
|
-
* Default value is false
|
4881
|
-
*/
|
4882
|
-
enableFilter?: boolean;
|
4883
|
-
/**
|
4884
|
-
* Optional; Lets the developer specify the image output formats, more than one can be specified.
|
4885
|
-
* Default value is Image.
|
4886
|
-
*/
|
4887
|
-
imageOutputFormats?: ImageOutputFormats[];
|
4888
|
-
}
|
4907
|
+
videoAndImageProps?: VideoAndImageProps;
|
4889
4908
|
/**
|
4890
|
-
*
|
4909
|
+
* Additional properties for audio capture flows.
|
4891
4910
|
*/
|
4892
|
-
|
4893
|
-
|
4894
|
-
|
4895
|
-
|
4896
|
-
|
4897
|
-
|
4898
|
-
|
4899
|
-
|
4900
|
-
|
4901
|
-
* Default value is true, indicating video will always launch in Full Screen Mode via lens.
|
4902
|
-
*/
|
4903
|
-
isFullScreenMode?: boolean;
|
4904
|
-
/**
|
4905
|
-
* Optional; controls the visibility of stop button in PictureInPicture Mode.
|
4906
|
-
* Default value is true, indicating the user will be able to stop the video.
|
4907
|
-
*/
|
4908
|
-
isStopButtonVisible?: boolean;
|
4909
|
-
/**
|
4910
|
-
* Optional; setting VideoController will register your app to listen to the lifecycle events during the video capture flow.
|
4911
|
-
* Your app can also dynamically control the experience while capturing the video by notifying the host client.
|
4912
|
-
*/
|
4913
|
-
videoController?: VideoController;
|
4914
|
-
}
|
4911
|
+
audioProps?: AudioProps;
|
4912
|
+
}
|
4913
|
+
/**
|
4914
|
+
* @hidden
|
4915
|
+
* Hide from docs
|
4916
|
+
* --------
|
4917
|
+
* All properties common to Image and Video Props
|
4918
|
+
*/
|
4919
|
+
interface MediaProps {
|
4915
4920
|
/**
|
4916
|
-
*
|
4921
|
+
* @hidden
|
4922
|
+
* Optional; Lets the developer specify the media source, more than one can be specified.
|
4923
|
+
* Default value is both camera and gallery
|
4917
4924
|
*/
|
4918
|
-
|
4919
|
-
}
|
4925
|
+
sources?: Source[];
|
4920
4926
|
/**
|
4921
|
-
*
|
4927
|
+
* @hidden
|
4928
|
+
* Optional; Specify in which mode the camera will be opened.
|
4929
|
+
* Default value is Photo
|
4922
4930
|
*/
|
4923
|
-
|
4924
|
-
/**
|
4925
|
-
* Optional; the maximum duration in minutes after which the recording should terminate automatically
|
4926
|
-
* Default value is defined by the platform serving the API.
|
4927
|
-
*/
|
4928
|
-
maxDuration?: number;
|
4929
|
-
}
|
4931
|
+
startMode?: CameraStartMode;
|
4930
4932
|
/**
|
4931
4933
|
* @hidden
|
4932
|
-
*
|
4933
|
-
*
|
4934
|
-
* Base class which holds the callback and notifies events to the host client
|
4934
|
+
* Optional; indicate if user is allowed to move between front and back camera
|
4935
|
+
* Default value is true
|
4935
4936
|
*/
|
4936
|
-
|
4937
|
-
|
4938
|
-
|
4939
|
-
|
4940
|
-
|
4941
|
-
|
4942
|
-
* @hidden
|
4943
|
-
* Hide from docs
|
4944
|
-
* --------
|
4945
|
-
* This function will be implemented by the respective media class which holds the logic
|
4946
|
-
* of specific events that needs to be notified to the app.
|
4947
|
-
* @param mediaEvent indicates the event signed by the host client to the app
|
4948
|
-
*/
|
4949
|
-
protected abstract notifyEventToApp(mediaEvent: MediaControllerEvent): void;
|
4950
|
-
/**
|
4951
|
-
* @hidden
|
4952
|
-
* Hide from docs
|
4953
|
-
* --------
|
4954
|
-
* Function to notify the host client to programatically control the experience
|
4955
|
-
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
4956
|
-
* Optional; @param callback is used to send app if host client has successfully handled the notification event or not
|
4957
|
-
*/
|
4958
|
-
protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: errorCallbackFunctionType): void;
|
4959
|
-
/**
|
4960
|
-
* Function to programatically stop the ongoing media event
|
4961
|
-
* Optional; @param callback is used to send app if host client has successfully stopped the event or not
|
4962
|
-
*/
|
4963
|
-
stop(callback?: errorCallbackFunctionType): void;
|
4964
|
-
}
|
4937
|
+
cameraSwitcher?: boolean;
|
4938
|
+
}
|
4939
|
+
/**
|
4940
|
+
* All properties in ImageProps are optional and have default values in the platform
|
4941
|
+
*/
|
4942
|
+
interface ImageProps extends MediaProps {
|
4965
4943
|
/**
|
4966
|
-
*
|
4944
|
+
* Optional; indicate if inking on the selected Image is allowed or not
|
4945
|
+
* Default value is true
|
4967
4946
|
*/
|
4968
|
-
|
4969
|
-
/** The event is a type of callback that can be enlisted to handle various events linked to `onRecordingStarted`, which helps with playback of video content. */
|
4970
|
-
onRecordingStarted?(): void;
|
4971
|
-
}
|
4947
|
+
ink?: boolean;
|
4972
4948
|
/**
|
4973
|
-
*
|
4949
|
+
* Optional; indicate if putting text stickers on the selected Image is allowed or not
|
4950
|
+
* Default value is true
|
4974
4951
|
*/
|
4975
|
-
|
4976
|
-
/** Gets media type video. */
|
4977
|
-
protected getMediaType(): MediaType;
|
4978
|
-
/** Notify or send an event related to the playback and control of video content to a registered application. */
|
4979
|
-
notifyEventToApp(mediaEvent: MediaControllerEvent): void;
|
4980
|
-
}
|
4952
|
+
textSticker?: boolean;
|
4981
4953
|
/**
|
4982
|
-
*
|
4983
|
-
*
|
4954
|
+
* Optional; indicate if image filtering mode is enabled on the selected image
|
4955
|
+
* Default value is false
|
4984
4956
|
*/
|
4985
|
-
|
4986
|
-
/** Start recording. */
|
4987
|
-
StartRecording = 1,
|
4988
|
-
/** Stop recording. */
|
4989
|
-
StopRecording = 2
|
4990
|
-
}
|
4957
|
+
enableFilter?: boolean;
|
4991
4958
|
/**
|
4992
|
-
*
|
4993
|
-
|
4994
|
-
|
4995
|
-
|
4996
|
-
|
4997
|
-
|
4998
|
-
|
4999
|
-
|
5000
|
-
|
5001
|
-
/** Business card mode. */
|
5002
|
-
BusinessCard = 4
|
5003
|
-
}
|
4959
|
+
* Optional; Lets the developer specify the image output formats, more than one can be specified.
|
4960
|
+
* Default value is Image.
|
4961
|
+
*/
|
4962
|
+
imageOutputFormats?: ImageOutputFormats[];
|
4963
|
+
}
|
4964
|
+
/**
|
4965
|
+
* All properties in VideoProps are optional and have default values in the platform
|
4966
|
+
*/
|
4967
|
+
interface VideoProps extends MediaProps {
|
5004
4968
|
/**
|
5005
|
-
*
|
4969
|
+
* Optional; the maximum duration in seconds after which the recording should terminate automatically.
|
4970
|
+
* Default value is defined by the platform serving the API.
|
5006
4971
|
*/
|
5007
|
-
|
5008
|
-
/** Image source is camera. */
|
5009
|
-
Camera = 1,
|
5010
|
-
/** Image source is gallery. */
|
5011
|
-
Gallery = 2
|
5012
|
-
}
|
4972
|
+
maxDuration?: number;
|
5013
4973
|
/**
|
5014
|
-
*
|
5015
|
-
|
5016
|
-
|
5017
|
-
|
5018
|
-
|
5019
|
-
/** Media type video. */
|
5020
|
-
Video = 2,
|
5021
|
-
/** Media type video and image. */
|
5022
|
-
VideoAndImage = 3,
|
5023
|
-
/** Media type audio. */
|
5024
|
-
Audio = 4
|
5025
|
-
}
|
4974
|
+
* Optional; to determine if the video capturing flow needs to be launched
|
4975
|
+
* in Full Screen Mode (Lens implementation) or PictureInPicture Mode (Native implementation).
|
4976
|
+
* Default value is true, indicating video will always launch in Full Screen Mode via lens.
|
4977
|
+
*/
|
4978
|
+
isFullScreenMode?: boolean;
|
5026
4979
|
/**
|
5027
|
-
*
|
4980
|
+
* Optional; controls the visibility of stop button in PictureInPicture Mode.
|
4981
|
+
* Default value is true, indicating the user will be able to stop the video.
|
5028
4982
|
*/
|
5029
|
-
|
5030
|
-
/** Image location */
|
5031
|
-
value: string;
|
5032
|
-
/** Image Uri type */
|
5033
|
-
type: ImageUriType;
|
5034
|
-
}
|
4983
|
+
isStopButtonVisible?: boolean;
|
5035
4984
|
/**
|
5036
|
-
*
|
4985
|
+
* Optional; setting VideoController will register your app to listen to the lifecycle events during the video capture flow.
|
4986
|
+
* Your app can also dynamically control the experience while capturing the video by notifying the host client.
|
5037
4987
|
*/
|
5038
|
-
|
5039
|
-
|
5040
|
-
|
5041
|
-
|
5042
|
-
|
5043
|
-
|
4988
|
+
videoController?: VideoController;
|
4989
|
+
}
|
4990
|
+
/**
|
4991
|
+
* All properties in VideoAndImageProps are optional and have default values in the platform
|
4992
|
+
*/
|
4993
|
+
interface VideoAndImageProps extends ImageProps, VideoProps {
|
4994
|
+
}
|
4995
|
+
/**
|
4996
|
+
* All properties in AudioProps are optional and have default values in the platform
|
4997
|
+
*/
|
4998
|
+
interface AudioProps {
|
5044
4999
|
/**
|
5045
|
-
*
|
5000
|
+
* Optional; the maximum duration in minutes after which the recording should terminate automatically
|
5001
|
+
* Default value is defined by the platform serving the API.
|
5046
5002
|
*/
|
5047
|
-
|
5048
|
-
|
5049
|
-
|
5050
|
-
|
5051
|
-
|
5052
|
-
|
5003
|
+
maxDuration?: number;
|
5004
|
+
}
|
5005
|
+
/**
|
5006
|
+
* @hidden
|
5007
|
+
* Hide from docs
|
5008
|
+
* --------
|
5009
|
+
* Base class which holds the callback and notifies events to the host client
|
5010
|
+
*/
|
5011
|
+
declare abstract class MediaController<T> {
|
5012
|
+
/** Callback that can be registered to handle events related to the playback and control of video content. */
|
5013
|
+
protected controllerCallback?: T;
|
5014
|
+
constructor(controllerCallback?: T);
|
5015
|
+
protected abstract getMediaType(): MediaType;
|
5053
5016
|
/**
|
5054
|
-
*
|
5017
|
+
* @hidden
|
5018
|
+
* Hide from docs
|
5019
|
+
* --------
|
5020
|
+
* This function will be implemented by the respective media class which holds the logic
|
5021
|
+
* of specific events that needs to be notified to the app.
|
5022
|
+
* @param mediaEvent indicates the event signed by the host client to the app
|
5055
5023
|
*/
|
5056
|
-
|
5057
|
-
/**
|
5058
|
-
* Base 64 data for the requested uri
|
5059
|
-
*/
|
5060
|
-
chunk: string;
|
5061
|
-
/**
|
5062
|
-
* chunk sequence number
|
5063
|
-
*/
|
5064
|
-
chunkSequence: number;
|
5065
|
-
}
|
5024
|
+
protected abstract notifyEventToApp(mediaEvent: MediaControllerEvent): void;
|
5066
5025
|
/**
|
5067
|
-
*
|
5026
|
+
* @hidden
|
5027
|
+
* Hide from docs
|
5028
|
+
* --------
|
5029
|
+
* Function to notify the host client to programatically control the experience
|
5030
|
+
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
5031
|
+
* Optional; @param callback is used to send app if host client has successfully handled the notification event or not
|
5068
5032
|
*/
|
5069
|
-
|
5070
|
-
/**
|
5071
|
-
* error encountered in getMedia API
|
5072
|
-
*/
|
5073
|
-
error: SdkError;
|
5074
|
-
/**
|
5075
|
-
* Media chunk which will be assemebled and converted into a blob
|
5076
|
-
*/
|
5077
|
-
mediaChunk: MediaChunk;
|
5078
|
-
}
|
5033
|
+
protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: errorCallbackFunctionType): void;
|
5079
5034
|
/**
|
5080
|
-
*
|
5035
|
+
* Function to programatically stop the ongoing media event
|
5036
|
+
* Optional; @param callback is used to send app if host client has successfully stopped the event or not
|
5081
5037
|
*/
|
5082
|
-
|
5083
|
-
|
5084
|
-
|
5085
|
-
|
5086
|
-
|
5087
|
-
|
5038
|
+
stop(callback?: errorCallbackFunctionType): void;
|
5039
|
+
}
|
5040
|
+
/**
|
5041
|
+
* Callback which will register your app to listen to lifecycle events during the video capture flow
|
5042
|
+
*/
|
5043
|
+
interface VideoControllerCallback {
|
5044
|
+
/** The event is a type of callback that can be enlisted to handle various events linked to `onRecordingStarted`, which helps with playback of video content. */
|
5045
|
+
onRecordingStarted?(): void;
|
5046
|
+
}
|
5047
|
+
/**
|
5048
|
+
* VideoController class is used to communicate between the app and the host client during the video capture flow
|
5049
|
+
*/
|
5050
|
+
declare class VideoController extends MediaController<VideoControllerCallback> {
|
5051
|
+
/** Gets media type video. */
|
5052
|
+
protected getMediaType(): MediaType;
|
5053
|
+
/** Notify or send an event related to the playback and control of video content to a registered application. */
|
5054
|
+
notifyEventToApp(mediaEvent: MediaControllerEvent): void;
|
5055
|
+
}
|
5056
|
+
/**
|
5057
|
+
* @beta
|
5058
|
+
* Events which are used to communicate between the app and the host client during the media recording flow
|
5059
|
+
*/
|
5060
|
+
declare enum MediaControllerEvent {
|
5061
|
+
/** Start recording. */
|
5062
|
+
StartRecording = 1,
|
5063
|
+
/** Stop recording. */
|
5064
|
+
StopRecording = 2
|
5065
|
+
}
|
5066
|
+
/**
|
5067
|
+
* The modes in which camera can be launched in select Media API
|
5068
|
+
*/
|
5069
|
+
declare enum CameraStartMode {
|
5070
|
+
/** Photo mode. */
|
5071
|
+
Photo = 1,
|
5072
|
+
/** Document mode. */
|
5073
|
+
Document = 2,
|
5074
|
+
/** Whiteboard mode. */
|
5075
|
+
Whiteboard = 3,
|
5076
|
+
/** Business card mode. */
|
5077
|
+
BusinessCard = 4
|
5078
|
+
}
|
5079
|
+
/**
|
5080
|
+
* Specifies the image source
|
5081
|
+
*/
|
5082
|
+
declare enum Source {
|
5083
|
+
/** Image source is camera. */
|
5084
|
+
Camera = 1,
|
5085
|
+
/** Image source is gallery. */
|
5086
|
+
Gallery = 2
|
5087
|
+
}
|
5088
|
+
/**
|
5089
|
+
* Specifies the type of Media
|
5090
|
+
*/
|
5091
|
+
declare enum MediaType {
|
5092
|
+
/** Media type photo or image */
|
5093
|
+
Image = 1,
|
5094
|
+
/** Media type video. */
|
5095
|
+
Video = 2,
|
5096
|
+
/** Media type video and image. */
|
5097
|
+
VideoAndImage = 3,
|
5098
|
+
/** Media type audio. */
|
5099
|
+
Audio = 4
|
5100
|
+
}
|
5101
|
+
/**
|
5102
|
+
* Input for view images API
|
5103
|
+
*/
|
5104
|
+
interface ImageUri {
|
5105
|
+
/** Image location */
|
5106
|
+
value: string;
|
5107
|
+
/** Image Uri type */
|
5108
|
+
type: ImageUriType;
|
5109
|
+
}
|
5110
|
+
/**
|
5111
|
+
* ID contains a mapping for content uri on platform's side, URL is generic
|
5112
|
+
*/
|
5113
|
+
declare enum ImageUriType {
|
5114
|
+
/** Image Id. */
|
5115
|
+
ID = 1,
|
5116
|
+
/** Image URL. */
|
5117
|
+
URL = 2
|
5118
|
+
}
|
5119
|
+
/**
|
5120
|
+
* Specifies the image output formats.
|
5121
|
+
*/
|
5122
|
+
declare enum ImageOutputFormats {
|
5123
|
+
/** Outputs image. */
|
5124
|
+
IMAGE = 1,
|
5125
|
+
/** Outputs pdf. */
|
5126
|
+
PDF = 2
|
5127
|
+
}
|
5128
|
+
/**
|
5129
|
+
* Media chunks an output of getMedia API from platform
|
5130
|
+
*/
|
5131
|
+
interface MediaChunk {
|
5088
5132
|
/**
|
5089
|
-
*
|
5090
|
-
*
|
5091
|
-
* @param mediaInputs - The input params to customize the media to be selected
|
5092
|
-
* @param callback - The callback to invoke after fetching the media
|
5133
|
+
* Base 64 data for the requested uri
|
5093
5134
|
*/
|
5094
|
-
|
5135
|
+
chunk: string;
|
5095
5136
|
/**
|
5096
|
-
*
|
5097
|
-
|
5098
|
-
|
5099
|
-
|
5137
|
+
* chunk sequence number
|
5138
|
+
*/
|
5139
|
+
chunkSequence: number;
|
5140
|
+
}
|
5141
|
+
/**
|
5142
|
+
* Output of getMedia API from platform
|
5143
|
+
*/
|
5144
|
+
interface MediaResult {
|
5145
|
+
/**
|
5146
|
+
* error encountered in getMedia API
|
5100
5147
|
*/
|
5101
|
-
|
5148
|
+
error: SdkError;
|
5102
5149
|
/**
|
5103
|
-
*
|
5104
|
-
* All properties in BarCodeConfig are optional and have default values in the platform
|
5150
|
+
* Media chunk which will be assemebled and converted into a blob
|
5105
5151
|
*/
|
5106
|
-
|
5107
|
-
|
5108
|
-
|
5109
|
-
|
5110
|
-
|
5111
|
-
|
5112
|
-
|
5152
|
+
mediaChunk: MediaChunk;
|
5153
|
+
}
|
5154
|
+
/**
|
5155
|
+
* Helper object to assembled media chunks
|
5156
|
+
*/
|
5157
|
+
interface AssembleAttachment$1 {
|
5158
|
+
/** A number representing the sequence of the attachment in the media chunks. */
|
5159
|
+
sequence: number;
|
5160
|
+
/** A Blob object representing the data of the media chunks. */
|
5161
|
+
file: Blob;
|
5162
|
+
}
|
5163
|
+
/**
|
5164
|
+
* Select an attachment using camera/gallery
|
5165
|
+
*
|
5166
|
+
* @param mediaInputs - The input params to customize the media to be selected
|
5167
|
+
* @param callback - The callback to invoke after fetching the media
|
5168
|
+
*/
|
5169
|
+
declare function selectMedia(mediaInputs: MediaInputs, callback: selectMediaCallbackFunctionType): void;
|
5170
|
+
/**
|
5171
|
+
* View images using native image viewer
|
5172
|
+
*
|
5173
|
+
* @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
|
5174
|
+
* @param callback - returns back error if encountered, returns null in case of success
|
5175
|
+
*/
|
5176
|
+
declare function viewImages(uriList: ImageUri[], callback: errorCallbackFunctionType): void;
|
5177
|
+
/**
|
5178
|
+
* Barcode configuration supplied to scanBarCode API to customize barcode scanning experience in mobile
|
5179
|
+
* All properties in BarCodeConfig are optional and have default values in the platform
|
5180
|
+
*/
|
5181
|
+
interface BarCodeConfig {
|
5113
5182
|
/**
|
5114
|
-
*
|
5115
|
-
*
|
5116
|
-
|
5117
|
-
* Scan Barcode/QRcode using camera
|
5118
|
-
*
|
5119
|
-
* @remarks
|
5120
|
-
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
5121
|
-
*
|
5122
|
-
* @param callback - callback to invoke after scanning the barcode
|
5123
|
-
* @param config - optional input configuration to customize the barcode scanning experience
|
5183
|
+
* Optional; Lets the developer specify the scan timeout interval in seconds
|
5184
|
+
* Default value is 30 seconds and max allowed value is 60 seconds
|
5124
5185
|
*/
|
5125
|
-
|
5126
|
-
|
5186
|
+
timeOutIntervalInSec?: number;
|
5187
|
+
}
|
5188
|
+
/**
|
5189
|
+
* @deprecated
|
5190
|
+
* As of 2.1.0, please use {@link barCode.scanBarCode barCode.scanBarCode(config?: BarCodeConfig): Promise\<string\>} instead.
|
5191
|
+
|
5192
|
+
* Scan Barcode/QRcode using camera
|
5193
|
+
*
|
5194
|
+
* @remarks
|
5195
|
+
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
5196
|
+
*
|
5197
|
+
* @param callback - callback to invoke after scanning the barcode
|
5198
|
+
* @param config - optional input configuration to customize the barcode scanning experience
|
5199
|
+
*/
|
5200
|
+
declare function scanBarCode(callback: scanBarCodeCallbackFunctionType, config?: BarCodeConfig): void;
|
5201
|
+
|
5202
|
+
type media_d_AudioProps = AudioProps;
|
5203
|
+
type media_d_BarCodeConfig = BarCodeConfig;
|
5204
|
+
type media_d_CameraStartMode = CameraStartMode;
|
5205
|
+
declare const media_d_CameraStartMode: typeof CameraStartMode;
|
5206
|
+
type media_d_File = File;
|
5207
|
+
declare const media_d_File: typeof File;
|
5208
|
+
type media_d_FileFormat = FileFormat;
|
5209
|
+
declare const media_d_FileFormat: typeof FileFormat;
|
5210
|
+
type media_d_ImageOutputFormats = ImageOutputFormats;
|
5211
|
+
declare const media_d_ImageOutputFormats: typeof ImageOutputFormats;
|
5212
|
+
type media_d_ImageProps = ImageProps;
|
5213
|
+
type media_d_ImageUri = ImageUri;
|
5214
|
+
type media_d_ImageUriType = ImageUriType;
|
5215
|
+
declare const media_d_ImageUriType: typeof ImageUriType;
|
5216
|
+
type media_d_Media = Media;
|
5217
|
+
declare const media_d_Media: typeof Media;
|
5218
|
+
type media_d_MediaChunk = MediaChunk;
|
5219
|
+
type media_d_MediaControllerEvent = MediaControllerEvent;
|
5220
|
+
declare const media_d_MediaControllerEvent: typeof MediaControllerEvent;
|
5221
|
+
type media_d_MediaInputs = MediaInputs;
|
5222
|
+
type media_d_MediaResult = MediaResult;
|
5223
|
+
type media_d_MediaType = MediaType;
|
5224
|
+
declare const media_d_MediaType: typeof MediaType;
|
5225
|
+
type media_d_Source = Source;
|
5226
|
+
declare const media_d_Source: typeof Source;
|
5227
|
+
type media_d_VideoAndImageProps = VideoAndImageProps;
|
5228
|
+
type media_d_VideoController = VideoController;
|
5229
|
+
declare const media_d_VideoController: typeof VideoController;
|
5230
|
+
type media_d_VideoControllerCallback = VideoControllerCallback;
|
5231
|
+
type media_d_VideoProps = VideoProps;
|
5232
|
+
declare const media_d_captureImage: typeof captureImage;
|
5233
|
+
type media_d_captureImageCallbackFunctionType = captureImageCallbackFunctionType;
|
5234
|
+
type media_d_errorCallbackFunctionType = errorCallbackFunctionType;
|
5235
|
+
type media_d_getMediaCallbackFunctionType = getMediaCallbackFunctionType;
|
5236
|
+
declare const media_d_hasPermission: typeof hasPermission;
|
5237
|
+
declare const media_d_requestPermission: typeof requestPermission;
|
5238
|
+
declare const media_d_scanBarCode: typeof scanBarCode;
|
5239
|
+
type media_d_scanBarCodeCallbackFunctionType = scanBarCodeCallbackFunctionType;
|
5240
|
+
declare const media_d_selectMedia: typeof selectMedia;
|
5241
|
+
type media_d_selectMediaCallbackFunctionType = selectMediaCallbackFunctionType;
|
5242
|
+
declare const media_d_viewImages: typeof viewImages;
|
5243
|
+
declare namespace media_d {
|
5244
|
+
export { type AssembleAttachment$1 as AssembleAttachment, type media_d_AudioProps as AudioProps, type media_d_BarCodeConfig as BarCodeConfig, media_d_CameraStartMode as CameraStartMode, media_d_File as File, media_d_FileFormat as FileFormat, media_d_ImageOutputFormats as ImageOutputFormats, type media_d_ImageProps as ImageProps, type media_d_ImageUri as ImageUri, media_d_ImageUriType as ImageUriType, media_d_Media as Media, type media_d_MediaChunk as MediaChunk, media_d_MediaControllerEvent as MediaControllerEvent, type media_d_MediaInputs as MediaInputs, type media_d_MediaResult as MediaResult, media_d_MediaType as MediaType, media_d_Source as Source, type media_d_VideoAndImageProps as VideoAndImageProps, media_d_VideoController as VideoController, type media_d_VideoControllerCallback as VideoControllerCallback, type media_d_VideoProps as VideoProps, media_d_captureImage as captureImage, type media_d_captureImageCallbackFunctionType as captureImageCallbackFunctionType, type media_d_errorCallbackFunctionType as errorCallbackFunctionType, type media_d_getMediaCallbackFunctionType as getMediaCallbackFunctionType, media_d_hasPermission as hasPermission, media_d_requestPermission as requestPermission, media_d_scanBarCode as scanBarCode, type media_d_scanBarCodeCallbackFunctionType as scanBarCodeCallbackFunctionType, media_d_selectMedia as selectMedia, type media_d_selectMediaCallbackFunctionType as selectMediaCallbackFunctionType, media_d_viewImages as viewImages };
|
5127
5245
|
}
|
5128
5246
|
|
5129
5247
|
/**
|
5130
|
-
*
|
5248
|
+
* Module to power up the in-app browser experiences in the host app.
|
5131
5249
|
* For e.g., opening a URL in the host app inside a browser
|
5132
5250
|
*
|
5133
5251
|
* @beta
|
5134
5252
|
*/
|
5135
|
-
|
5136
|
-
|
5137
|
-
|
5138
|
-
|
5139
|
-
|
5140
|
-
|
5141
|
-
|
5142
|
-
|
5143
|
-
|
5144
|
-
|
5145
|
-
|
5146
|
-
|
5147
|
-
|
5148
|
-
|
5149
|
-
|
5150
|
-
|
5151
|
-
|
5152
|
-
|
5153
|
-
|
5154
|
-
|
5155
|
-
|
5156
|
-
|
5157
|
-
|
5158
|
-
|
5159
|
-
|
5253
|
+
/**
|
5254
|
+
* Open a URL in the secondary browser.
|
5255
|
+
*
|
5256
|
+
* On mobile, this is the in-app browser.
|
5257
|
+
*
|
5258
|
+
* On web and desktop, please use the `window.open()` method or other native external browser methods.
|
5259
|
+
*
|
5260
|
+
* @param url Url to open in the browser
|
5261
|
+
* @returns Promise that successfully resolves if the URL opens in the secondaryBrowser
|
5262
|
+
* or throws an error {@link SdkError} incase of failure before starting navigation
|
5263
|
+
*
|
5264
|
+
* @remarks Any error that happens after navigation begins is handled by the platform browser component and not returned from this function.
|
5265
|
+
* @beta
|
5266
|
+
*/
|
5267
|
+
declare function open(url: URL): Promise<void>;
|
5268
|
+
/**
|
5269
|
+
* Checks if secondaryBrowser capability is supported by the host
|
5270
|
+
* @returns boolean to represent whether secondaryBrowser is supported
|
5271
|
+
*
|
5272
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
5273
|
+
*
|
5274
|
+
* @beta
|
5275
|
+
*/
|
5276
|
+
declare function isSupported$b(): boolean;
|
5277
|
+
|
5278
|
+
declare const secondaryBrowser_d_open: typeof open;
|
5279
|
+
declare namespace secondaryBrowser_d {
|
5280
|
+
export { isSupported$b as isSupported, secondaryBrowser_d_open as open };
|
5160
5281
|
}
|
5161
5282
|
|
5162
5283
|
/**
|
5163
5284
|
* @deprecated
|
5164
5285
|
* As of 2.1.0, please use geoLocation namespace.
|
5165
5286
|
*
|
5166
|
-
*
|
5287
|
+
* Module to interact with the location module-specific part of the SDK.
|
5167
5288
|
*/
|
5168
|
-
|
5169
|
-
|
5170
|
-
|
5171
|
-
|
5172
|
-
|
5173
|
-
|
5174
|
-
|
5175
|
-
|
5176
|
-
|
5177
|
-
|
5178
|
-
|
5179
|
-
|
5180
|
-
|
5181
|
-
|
5182
|
-
|
5183
|
-
|
5184
|
-
|
5185
|
-
|
5186
|
-
|
5187
|
-
|
5188
|
-
|
5189
|
-
|
5190
|
-
|
5191
|
-
|
5289
|
+
/** Get location callback function type */
|
5290
|
+
type getLocationCallbackFunctionType = (error: SdkError, location: Location) => void;
|
5291
|
+
/** Show location callback function type */
|
5292
|
+
type showLocationCallbackFunctionType = (error: SdkError, status: boolean) => void;
|
5293
|
+
/**
|
5294
|
+
* @deprecated
|
5295
|
+
* Data Structure to set the location properties in getLocation call.
|
5296
|
+
*/
|
5297
|
+
interface LocationProps {
|
5298
|
+
/**
|
5299
|
+
whether user can alter location or not
|
5300
|
+
if false, user will be shown current location
|
5301
|
+
and wouldn't be allowed to alter it
|
5302
|
+
*/
|
5303
|
+
allowChooseLocation: boolean;
|
5304
|
+
/**
|
5305
|
+
whether selected location should be shown to user on map or not.
|
5306
|
+
If allowChooseLocation is true, this parameter will be ignored by platform.
|
5307
|
+
If allowChooseLocation is false, and this parameter is not provided, default
|
5308
|
+
value will be false.
|
5309
|
+
*/
|
5310
|
+
showMap?: boolean;
|
5311
|
+
}
|
5312
|
+
/**
|
5313
|
+
* @deprecated
|
5314
|
+
* Data struture to represent the location information
|
5315
|
+
*/
|
5316
|
+
interface Location {
|
5192
5317
|
/**
|
5193
|
-
|
5194
|
-
|
5195
|
-
|
5196
|
-
interface Location {
|
5197
|
-
/**
|
5198
|
-
Latitude of the location
|
5199
|
-
*/
|
5200
|
-
latitude: number;
|
5201
|
-
/**
|
5202
|
-
Longitude of the location
|
5203
|
-
*/
|
5204
|
-
longitude: number;
|
5205
|
-
/**
|
5206
|
-
Accuracy of the coordinates captured
|
5207
|
-
*/
|
5208
|
-
accuracy?: number;
|
5209
|
-
/**
|
5210
|
-
Time stamp when the location was captured
|
5211
|
-
*/
|
5212
|
-
timestamp?: number;
|
5213
|
-
}
|
5318
|
+
Latitude of the location
|
5319
|
+
*/
|
5320
|
+
latitude: number;
|
5214
5321
|
/**
|
5215
|
-
|
5216
|
-
|
5217
|
-
|
5218
|
-
* - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
|
5219
|
-
*
|
5220
|
-
* Fetches user location
|
5221
|
-
* @param props {@link LocationProps} - Specifying how the location request is handled
|
5222
|
-
* @param callback - Callback to invoke when current user location is fetched
|
5223
|
-
*/
|
5224
|
-
function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
|
5322
|
+
Longitude of the location
|
5323
|
+
*/
|
5324
|
+
longitude: number;
|
5225
5325
|
/**
|
5226
|
-
|
5227
|
-
|
5228
|
-
|
5229
|
-
* Shows the location on map corresponding to the given coordinates
|
5230
|
-
*
|
5231
|
-
* @param location - Location to be shown on the map
|
5232
|
-
* @param callback - Callback to invoke when the location is opened on map
|
5233
|
-
*/
|
5234
|
-
function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
|
5326
|
+
Accuracy of the coordinates captured
|
5327
|
+
*/
|
5328
|
+
accuracy?: number;
|
5235
5329
|
/**
|
5236
|
-
|
5237
|
-
|
5238
|
-
|
5239
|
-
|
5240
|
-
|
5241
|
-
|
5242
|
-
|
5243
|
-
|
5244
|
-
|
5245
|
-
|
5330
|
+
Time stamp when the location was captured
|
5331
|
+
*/
|
5332
|
+
timestamp?: number;
|
5333
|
+
}
|
5334
|
+
/**
|
5335
|
+
* @deprecated
|
5336
|
+
* As of 2.1.0, please use one of the following functions:
|
5337
|
+
* - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
|
5338
|
+
* - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
|
5339
|
+
*
|
5340
|
+
* Fetches user location
|
5341
|
+
* @param props {@link LocationProps} - Specifying how the location request is handled
|
5342
|
+
* @param callback - Callback to invoke when current user location is fetched
|
5343
|
+
*/
|
5344
|
+
declare function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
|
5345
|
+
/**
|
5346
|
+
* @deprecated
|
5347
|
+
* As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
|
5348
|
+
*
|
5349
|
+
* Shows the location on map corresponding to the given coordinates
|
5350
|
+
*
|
5351
|
+
* @param location - Location to be shown on the map
|
5352
|
+
* @param callback - Callback to invoke when the location is opened on map
|
5353
|
+
*/
|
5354
|
+
declare function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
|
5355
|
+
/**
|
5356
|
+
* @deprecated
|
5357
|
+
* As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
|
5358
|
+
*
|
5359
|
+
* Checks if Location capability is supported by the host
|
5360
|
+
*
|
5361
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
5362
|
+
*
|
5363
|
+
* @returns boolean to represent whether Location is supported
|
5364
|
+
*/
|
5365
|
+
declare function isSupported$a(): boolean;
|
5366
|
+
|
5367
|
+
type location_d_Location = Location;
|
5368
|
+
type location_d_LocationProps = LocationProps;
|
5369
|
+
declare const location_d_getLocation: typeof getLocation;
|
5370
|
+
type location_d_getLocationCallbackFunctionType = getLocationCallbackFunctionType;
|
5371
|
+
declare const location_d_showLocation: typeof showLocation;
|
5372
|
+
type location_d_showLocationCallbackFunctionType = showLocationCallbackFunctionType;
|
5373
|
+
declare namespace location_d {
|
5374
|
+
export { type location_d_Location as Location, type location_d_LocationProps as LocationProps, location_d_getLocation as getLocation, type location_d_getLocationCallbackFunctionType as getLocationCallbackFunctionType, isSupported$a as isSupported, location_d_showLocation as showLocation, type location_d_showLocationCallbackFunctionType as showLocationCallbackFunctionType };
|
5246
5375
|
}
|
5247
5376
|
|
5248
5377
|
/**
|
@@ -6150,62 +6279,66 @@ declare namespace meeting {
|
|
6150
6279
|
export { };
|
6151
6280
|
}
|
6152
6281
|
|
6153
|
-
|
6154
|
-
|
6155
|
-
|
6156
|
-
|
6157
|
-
|
6158
|
-
|
6159
|
-
|
6160
|
-
|
6161
|
-
interface PlanInfo {
|
6162
|
-
/**
|
6163
|
-
* @hidden
|
6164
|
-
* plan id
|
6165
|
-
*/
|
6166
|
-
planId: string;
|
6167
|
-
/**
|
6168
|
-
* @hidden
|
6169
|
-
* term of the plan
|
6170
|
-
*/
|
6171
|
-
term: string;
|
6172
|
-
}
|
6173
|
-
/**
|
6174
|
-
* @hidden
|
6175
|
-
* Open dialog to start user's purchase experience
|
6176
|
-
*
|
6177
|
-
* @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
|
6178
|
-
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
6179
|
-
* @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
|
6180
|
-
*
|
6181
|
-
* @internal
|
6182
|
-
* Limited to Microsoft-internal use
|
6183
|
-
*/
|
6184
|
-
function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
|
6282
|
+
/**
|
6283
|
+
* @hidden
|
6284
|
+
* Data structure to represent a subscription plan.
|
6285
|
+
*
|
6286
|
+
* @internal
|
6287
|
+
* Limited to Microsoft-internal use
|
6288
|
+
*/
|
6289
|
+
interface PlanInfo {
|
6185
6290
|
/**
|
6186
|
-
* @deprecated
|
6187
|
-
* As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
|
6188
|
-
*
|
6189
6291
|
* @hidden
|
6190
|
-
*
|
6191
|
-
*
|
6192
|
-
* @param callback Callback contains 1 parameters, error.
|
6193
|
-
* @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
|
6194
|
-
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
6195
|
-
*
|
6196
|
-
* @internal
|
6197
|
-
* Limited to Microsoft-internal use
|
6292
|
+
* plan id
|
6198
6293
|
*/
|
6199
|
-
|
6294
|
+
planId: string;
|
6200
6295
|
/**
|
6201
6296
|
* @hidden
|
6202
|
-
*
|
6203
|
-
* Checks if the monetization capability is supported by the host
|
6204
|
-
* @returns boolean to represent whether the monetization capability is supported
|
6205
|
-
*
|
6206
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6297
|
+
* term of the plan
|
6207
6298
|
*/
|
6208
|
-
|
6299
|
+
term: string;
|
6300
|
+
}
|
6301
|
+
/**
|
6302
|
+
* @hidden
|
6303
|
+
* Open dialog to start user's purchase experience
|
6304
|
+
*
|
6305
|
+
* @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
|
6306
|
+
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
6307
|
+
* @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
|
6308
|
+
*
|
6309
|
+
* @internal
|
6310
|
+
* Limited to Microsoft-internal use
|
6311
|
+
*/
|
6312
|
+
declare function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
|
6313
|
+
/**
|
6314
|
+
* @deprecated
|
6315
|
+
* As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
|
6316
|
+
*
|
6317
|
+
* @hidden
|
6318
|
+
* Open dialog to start user's purchase experience
|
6319
|
+
*
|
6320
|
+
* @param callback Callback contains 1 parameters, error.
|
6321
|
+
* @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
|
6322
|
+
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
6323
|
+
*
|
6324
|
+
* @internal
|
6325
|
+
* Limited to Microsoft-internal use
|
6326
|
+
*/
|
6327
|
+
declare function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
|
6328
|
+
/**
|
6329
|
+
* @hidden
|
6330
|
+
*
|
6331
|
+
* Checks if the monetization capability is supported by the host
|
6332
|
+
* @returns boolean to represent whether the monetization capability is supported
|
6333
|
+
*
|
6334
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6335
|
+
*/
|
6336
|
+
declare function isSupported$9(): boolean;
|
6337
|
+
|
6338
|
+
type monetization_d_PlanInfo = PlanInfo;
|
6339
|
+
declare const monetization_d_openPurchaseExperience: typeof openPurchaseExperience;
|
6340
|
+
declare namespace monetization_d {
|
6341
|
+
export { type monetization_d_PlanInfo as PlanInfo, isSupported$9 as isSupported, monetization_d_openPurchaseExperience as openPurchaseExperience };
|
6209
6342
|
}
|
6210
6343
|
|
6211
6344
|
/**
|
@@ -6229,7 +6362,7 @@ declare function composeMeeting(composeMeetingParams: ComposeMeetingParams): Pro
|
|
6229
6362
|
*
|
6230
6363
|
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6231
6364
|
*/
|
6232
|
-
declare function isSupported$
|
6365
|
+
declare function isSupported$8(): boolean;
|
6233
6366
|
/** Open calendar item parameters. */
|
6234
6367
|
interface OpenCalendarItemParams {
|
6235
6368
|
/** An unique base64-encoded string id that represents the event's unique identifier of the calendar item to be opened. */
|
@@ -6254,255 +6387,277 @@ type calendar_d_OpenCalendarItemParams = OpenCalendarItemParams;
|
|
6254
6387
|
declare const calendar_d_composeMeeting: typeof composeMeeting;
|
6255
6388
|
declare const calendar_d_openCalendarItem: typeof openCalendarItem;
|
6256
6389
|
declare namespace calendar_d {
|
6257
|
-
export { type calendar_d_ComposeMeetingParams as ComposeMeetingParams, type calendar_d_OpenCalendarItemParams as OpenCalendarItemParams, calendar_d_composeMeeting as composeMeeting, isSupported$
|
6390
|
+
export { type calendar_d_ComposeMeetingParams as ComposeMeetingParams, type calendar_d_OpenCalendarItemParams as OpenCalendarItemParams, calendar_d_composeMeeting as composeMeeting, isSupported$8 as isSupported, calendar_d_openCalendarItem as openCalendarItem };
|
6258
6391
|
}
|
6259
6392
|
|
6260
6393
|
/**
|
6261
6394
|
* Used to interact with mail capability, including opening and composing mail.
|
6262
6395
|
*/
|
6263
|
-
|
6264
|
-
|
6265
|
-
|
6266
|
-
|
6267
|
-
|
6268
|
-
|
6269
|
-
|
6270
|
-
|
6271
|
-
|
6272
|
-
|
6273
|
-
|
6274
|
-
|
6275
|
-
|
6276
|
-
|
6396
|
+
/**
|
6397
|
+
* Opens a mail message in the host.
|
6398
|
+
*
|
6399
|
+
* @param openMailItemParams - Object that specifies the ID of the mail message.
|
6400
|
+
*/
|
6401
|
+
declare function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
|
6402
|
+
/**
|
6403
|
+
* Compose a new email in the user's mailbox.
|
6404
|
+
*
|
6405
|
+
* @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
|
6406
|
+
*
|
6407
|
+
*/
|
6408
|
+
declare function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
|
6409
|
+
/**
|
6410
|
+
* Checks if the mail capability is supported by the host
|
6411
|
+
* @returns boolean to represent whether the mail capability is supported
|
6412
|
+
*
|
6413
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6414
|
+
*/
|
6415
|
+
declare function isSupported$7(): boolean;
|
6416
|
+
/** Defines the parameters used to open a mail item in the user's mailbox */
|
6417
|
+
interface OpenMailItemParams {
|
6418
|
+
/** An unique base64-encoded string id that represents the itemId or messageId. */
|
6419
|
+
itemId: string;
|
6420
|
+
}
|
6421
|
+
/** Defines compose mail types. */
|
6422
|
+
declare enum ComposeMailType {
|
6423
|
+
/** Compose a new mail message. */
|
6424
|
+
New = "new",
|
6425
|
+
/** Compose a reply to the sender of an existing mail message. */
|
6426
|
+
Reply = "reply",
|
6427
|
+
/** Compose a reply to all recipients of an existing mail message. */
|
6428
|
+
ReplyAll = "replyAll",
|
6429
|
+
/** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
|
6430
|
+
Forward = "forward"
|
6431
|
+
}
|
6432
|
+
/**
|
6433
|
+
* Foundational interface for all other mail compose interfaces
|
6434
|
+
* Used for holding the type of mail item being composed
|
6435
|
+
*
|
6436
|
+
* @typeParam T - the identity type.
|
6437
|
+
* @see {@link mail.ComposeMailType}
|
6438
|
+
*/
|
6439
|
+
interface ComposeMailBase<T extends ComposeMailType> {
|
6440
|
+
/** Type of the mail item being composed. */
|
6441
|
+
type: T;
|
6442
|
+
}
|
6443
|
+
/**
|
6444
|
+
* Parameters supplied when composing a new mail item
|
6445
|
+
*/
|
6446
|
+
interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
|
6277
6447
|
/**
|
6278
|
-
*
|
6279
|
-
* @returns boolean to represent whether the mail capability is supported
|
6280
|
-
*
|
6281
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6448
|
+
* The To: recipients for the message
|
6282
6449
|
*/
|
6283
|
-
|
6284
|
-
/** Defines the parameters used to open a mail item in the user's mailbox */
|
6285
|
-
export interface OpenMailItemParams {
|
6286
|
-
/** An unique base64-encoded string id that represents the itemId or messageId. */
|
6287
|
-
itemId: string;
|
6288
|
-
}
|
6289
|
-
/** Defines compose mail types. */
|
6290
|
-
export enum ComposeMailType {
|
6291
|
-
/** Compose a new mail message. */
|
6292
|
-
New = "new",
|
6293
|
-
/** Compose a reply to the sender of an existing mail message. */
|
6294
|
-
Reply = "reply",
|
6295
|
-
/** Compose a reply to all recipients of an existing mail message. */
|
6296
|
-
ReplyAll = "replyAll",
|
6297
|
-
/** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
|
6298
|
-
Forward = "forward"
|
6299
|
-
}
|
6450
|
+
toRecipients?: string[];
|
6300
6451
|
/**
|
6301
|
-
*
|
6302
|
-
* Used for holding the type of mail item being composed
|
6303
|
-
*
|
6304
|
-
* @typeParam T - the identity type.
|
6305
|
-
* @see {@link mail.ComposeMailType}
|
6452
|
+
* The Cc: recipients for the message
|
6306
6453
|
*/
|
6307
|
-
|
6308
|
-
/** Type of the mail item being composed. */
|
6309
|
-
type: T;
|
6310
|
-
}
|
6454
|
+
ccRecipients?: string[];
|
6311
6455
|
/**
|
6312
|
-
*
|
6456
|
+
* The Bcc: recipients for the message
|
6313
6457
|
*/
|
6314
|
-
|
6315
|
-
/**
|
6316
|
-
* The To: recipients for the message
|
6317
|
-
*/
|
6318
|
-
toRecipients?: string[];
|
6319
|
-
/**
|
6320
|
-
* The Cc: recipients for the message
|
6321
|
-
*/
|
6322
|
-
ccRecipients?: string[];
|
6323
|
-
/**
|
6324
|
-
* The Bcc: recipients for the message
|
6325
|
-
*/
|
6326
|
-
bccRecipients?: string[];
|
6327
|
-
/**
|
6328
|
-
* The subject of the message
|
6329
|
-
*/
|
6330
|
-
subject?: string;
|
6331
|
-
/**
|
6332
|
-
* The body of the message
|
6333
|
-
*/
|
6334
|
-
message?: string;
|
6335
|
-
}
|
6458
|
+
bccRecipients?: string[];
|
6336
6459
|
/**
|
6337
|
-
*
|
6338
|
-
*
|
6339
|
-
* @see {@link ComposeMailType}
|
6460
|
+
* The subject of the message
|
6340
6461
|
*/
|
6341
|
-
|
6342
|
-
/** An unique base64-encoded string id that represents the mail message. */
|
6343
|
-
itemid: string;
|
6344
|
-
}
|
6462
|
+
subject?: string;
|
6345
6463
|
/**
|
6346
|
-
*
|
6347
|
-
*
|
6348
|
-
* @see {@link ComposeNewParams}
|
6349
|
-
* @see {@link ComposeReplyOrForwardParams}
|
6350
|
-
* @see {@link ComposeMailType}
|
6464
|
+
* The body of the message
|
6351
6465
|
*/
|
6352
|
-
|
6353
|
-
|
6466
|
+
message?: string;
|
6467
|
+
}
|
6468
|
+
/**
|
6469
|
+
* Parameters supplied when composing a reply to or forward of a message
|
6470
|
+
*
|
6471
|
+
* @see {@link ComposeMailType}
|
6472
|
+
*/
|
6473
|
+
interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
|
6474
|
+
/** An unique base64-encoded string id that represents the mail message. */
|
6475
|
+
itemid: string;
|
6476
|
+
}
|
6477
|
+
/**
|
6478
|
+
* Parameters supplied to {@link composeMail} when composing a new mail item
|
6479
|
+
*
|
6480
|
+
* @see {@link ComposeNewParams}
|
6481
|
+
* @see {@link ComposeReplyOrForwardParams}
|
6482
|
+
* @see {@link ComposeMailType}
|
6483
|
+
*/
|
6484
|
+
type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
|
6485
|
+
|
6486
|
+
type mail_d_ComposeMailParams = ComposeMailParams;
|
6487
|
+
type mail_d_ComposeMailType = ComposeMailType;
|
6488
|
+
declare const mail_d_ComposeMailType: typeof ComposeMailType;
|
6489
|
+
type mail_d_ComposeNewParams = ComposeNewParams;
|
6490
|
+
type mail_d_ComposeReplyOrForwardParams<T extends ComposeMailType> = ComposeReplyOrForwardParams<T>;
|
6491
|
+
type mail_d_OpenMailItemParams = OpenMailItemParams;
|
6492
|
+
declare const mail_d_composeMail: typeof composeMail;
|
6493
|
+
declare const mail_d_openMailItem: typeof openMailItem;
|
6494
|
+
declare namespace mail_d {
|
6495
|
+
export { type mail_d_ComposeMailParams as ComposeMailParams, mail_d_ComposeMailType as ComposeMailType, type mail_d_ComposeNewParams as ComposeNewParams, type mail_d_ComposeReplyOrForwardParams as ComposeReplyOrForwardParams, type mail_d_OpenMailItemParams as OpenMailItemParams, mail_d_composeMail as composeMail, isSupported$7 as isSupported, mail_d_openMailItem as openMailItem };
|
6496
|
+
}
|
6497
|
+
|
6498
|
+
/** Ready to unload function type */
|
6499
|
+
type readyToUnloadFunctionType = () => void;
|
6500
|
+
/** Register on load handler function type */
|
6501
|
+
type registerOnLoadHandlerFunctionType = (context: LoadContext) => void;
|
6502
|
+
/** Register before unload handler function type */
|
6503
|
+
type registerBeforeUnloadHandlerFunctionType = (readyToUnload: readyToUnloadFunctionType) => boolean;
|
6504
|
+
/**
|
6505
|
+
* Enable print capability to support printing page using Ctrl+P and cmd+P
|
6506
|
+
*/
|
6507
|
+
declare function enablePrintCapability$1(): void;
|
6508
|
+
/**
|
6509
|
+
* default print handler
|
6510
|
+
*/
|
6511
|
+
declare function print$1(): void;
|
6512
|
+
/**
|
6513
|
+
* Registers a handler to be called when the page has been requested to load.
|
6514
|
+
*
|
6515
|
+
* @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
|
6516
|
+
* for a more detailed explanation about using this API.
|
6517
|
+
*
|
6518
|
+
* @param handler - The handler to invoke when the page is loaded.
|
6519
|
+
*
|
6520
|
+
* @beta
|
6521
|
+
*/
|
6522
|
+
declare function registerOnLoadHandler$1(handler: registerOnLoadHandlerFunctionType): void;
|
6523
|
+
/**
|
6524
|
+
* @hidden
|
6525
|
+
* Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
|
6526
|
+
*
|
6527
|
+
* @internal
|
6528
|
+
* Limited to Microsoft-internal use
|
6529
|
+
*
|
6530
|
+
* @param apiVersionTag - The tag indicating API version number with name
|
6531
|
+
* @param handler - The handler to invoke when the page is loaded.
|
6532
|
+
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
6533
|
+
*
|
6534
|
+
* @deprecated
|
6535
|
+
*/
|
6536
|
+
declare function registerOnLoadHandlerHelper(apiVersionTag: string, handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
|
6537
|
+
/**
|
6538
|
+
* Registers a handler to be called before the page is unloaded.
|
6539
|
+
*
|
6540
|
+
* @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
|
6541
|
+
* for a more detailed explanation about using this API.
|
6542
|
+
*
|
6543
|
+
* @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
|
6544
|
+
* invoke the readyToUnload function provided to it once it's ready to be unloaded.
|
6545
|
+
*
|
6546
|
+
* @beta
|
6547
|
+
*/
|
6548
|
+
declare function registerBeforeUnloadHandler$1(handler: registerBeforeUnloadHandlerFunctionType): void;
|
6549
|
+
/**
|
6550
|
+
* @hidden
|
6551
|
+
* Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
|
6552
|
+
*
|
6553
|
+
* @internal
|
6554
|
+
* Limited to Microsoft-internal use
|
6555
|
+
*
|
6556
|
+
* @param handler - - The handler to invoke before the page is unloaded. If this handler returns true the page should
|
6557
|
+
* invoke the readyToUnload function provided to it once it's ready to be unloaded.
|
6558
|
+
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
6559
|
+
*
|
6560
|
+
* @deprecated
|
6561
|
+
*/
|
6562
|
+
declare function registerBeforeUnloadHandlerHelper(apiVersionTag: string, handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
|
6563
|
+
/**
|
6564
|
+
* Checks if teamsCore capability is supported by the host
|
6565
|
+
*
|
6566
|
+
* @returns boolean to represent whether the teamsCore capability is supported
|
6567
|
+
*
|
6568
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6569
|
+
*
|
6570
|
+
*/
|
6571
|
+
declare function isSupported$6(): boolean;
|
6572
|
+
|
6573
|
+
type teamsAPIs_d_readyToUnloadFunctionType = readyToUnloadFunctionType;
|
6574
|
+
type teamsAPIs_d_registerBeforeUnloadHandlerFunctionType = registerBeforeUnloadHandlerFunctionType;
|
6575
|
+
declare const teamsAPIs_d_registerBeforeUnloadHandlerHelper: typeof registerBeforeUnloadHandlerHelper;
|
6576
|
+
type teamsAPIs_d_registerOnLoadHandlerFunctionType = registerOnLoadHandlerFunctionType;
|
6577
|
+
declare const teamsAPIs_d_registerOnLoadHandlerHelper: typeof registerOnLoadHandlerHelper;
|
6578
|
+
declare namespace teamsAPIs_d {
|
6579
|
+
export { enablePrintCapability$1 as enablePrintCapability, isSupported$6 as isSupported, print$1 as print, type teamsAPIs_d_readyToUnloadFunctionType as readyToUnloadFunctionType, registerBeforeUnloadHandler$1 as registerBeforeUnloadHandler, type teamsAPIs_d_registerBeforeUnloadHandlerFunctionType as registerBeforeUnloadHandlerFunctionType, teamsAPIs_d_registerBeforeUnloadHandlerHelper as registerBeforeUnloadHandlerHelper, registerOnLoadHandler$1 as registerOnLoadHandler, type teamsAPIs_d_registerOnLoadHandlerFunctionType as registerOnLoadHandlerFunctionType, teamsAPIs_d_registerOnLoadHandlerHelper as registerOnLoadHandlerHelper };
|
6354
6580
|
}
|
6355
6581
|
|
6356
|
-
|
6357
|
-
|
6358
|
-
|
6359
|
-
|
6360
|
-
|
6361
|
-
|
6362
|
-
|
6582
|
+
/** Select people callback function type */
|
6583
|
+
type selectPeopleCallbackFunctionType = (error: SdkError, people: PeoplePickerResult[]) => void;
|
6584
|
+
/**
|
6585
|
+
* Launches a people picker and allows the user to select one or more people from the list
|
6586
|
+
* If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
|
6587
|
+
|
6588
|
+
* @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
|
6589
|
+
* @param peoplePickerInputs - Input parameters to launch customized people picker
|
6590
|
+
* @returns Promise that will be fulfilled when the operation has completed
|
6591
|
+
*/
|
6592
|
+
declare function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
|
6593
|
+
/**
|
6594
|
+
* @deprecated
|
6595
|
+
* As of TeamsJS v2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
|
6596
|
+
*
|
6597
|
+
* Launches a people picker and allows the user to select one or more people from the list
|
6598
|
+
* If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
|
6599
|
+
|
6600
|
+
* @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
|
6601
|
+
* @param peoplePickerInputs - Input parameters to launch customized people picker
|
6602
|
+
*/
|
6603
|
+
declare function selectPeople(callback: selectPeopleCallbackFunctionType, peoplePickerInputs?: PeoplePickerInputs): void;
|
6604
|
+
/**
|
6605
|
+
* Input parameter supplied to the People Picker API
|
6606
|
+
*/
|
6607
|
+
interface PeoplePickerInputs {
|
6363
6608
|
/**
|
6364
|
-
*
|
6609
|
+
* Optional; Set title for the people picker
|
6610
|
+
* Default value is "Select people" for multiselect and "Select a person" for single select
|
6365
6611
|
*/
|
6366
|
-
|
6612
|
+
title?: string;
|
6367
6613
|
/**
|
6368
|
-
*
|
6614
|
+
* Optional; Microsoft Entra IDs of the users to be pre-populated in the search box of people picker control
|
6615
|
+
* If single select is enabled this value, only the first user in the list will be pre-populated
|
6616
|
+
* Default value is null
|
6369
6617
|
*/
|
6370
|
-
|
6618
|
+
setSelected?: string[];
|
6371
6619
|
/**
|
6372
|
-
*
|
6373
|
-
*
|
6374
|
-
* @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
|
6375
|
-
* for a more detailed explanation about using this API.
|
6376
|
-
*
|
6377
|
-
* @param handler - The handler to invoke when the page is loaded.
|
6378
|
-
*
|
6379
|
-
* @beta
|
6620
|
+
* Optional; launches the people picker in org wide scope even if the app is added to a chat or channel
|
6621
|
+
* Default value is false
|
6380
6622
|
*/
|
6381
|
-
|
6623
|
+
openOrgWideSearchInChatOrChannel?: boolean;
|
6382
6624
|
/**
|
6383
|
-
*
|
6384
|
-
*
|
6385
|
-
*
|
6386
|
-
* @internal
|
6387
|
-
* Limited to Microsoft-internal use
|
6388
|
-
*
|
6389
|
-
* @param apiVersionTag - The tag indicating API version number with name
|
6390
|
-
* @param handler - The handler to invoke when the page is loaded.
|
6391
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
6392
|
-
*
|
6393
|
-
* @deprecated
|
6625
|
+
* Optional; launches the people picker for which only 1 person can be selected
|
6626
|
+
* Default value is false
|
6394
6627
|
*/
|
6395
|
-
|
6628
|
+
singleSelect?: boolean;
|
6629
|
+
}
|
6630
|
+
/**
|
6631
|
+
* Output user object of people picker API
|
6632
|
+
*/
|
6633
|
+
interface PeoplePickerResult {
|
6396
6634
|
/**
|
6397
|
-
*
|
6398
|
-
*
|
6399
|
-
* @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
|
6400
|
-
* for a more detailed explanation about using this API.
|
6401
|
-
*
|
6402
|
-
* @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
|
6403
|
-
* invoke the readyToUnload function provided to it once it's ready to be unloaded.
|
6404
|
-
*
|
6405
|
-
* @beta
|
6635
|
+
* user object ID (also known as Microsoft Entra ID) of the selected user
|
6406
6636
|
*/
|
6407
|
-
|
6637
|
+
objectId: string;
|
6408
6638
|
/**
|
6409
|
-
*
|
6410
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
|
6411
|
-
*
|
6412
|
-
* @internal
|
6413
|
-
* Limited to Microsoft-internal use
|
6414
|
-
*
|
6415
|
-
* @param handler - - The handler to invoke before the page is unloaded. If this handler returns true the page should
|
6416
|
-
* invoke the readyToUnload function provided to it once it's ready to be unloaded.
|
6417
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
6418
|
-
*
|
6419
|
-
* @deprecated
|
6639
|
+
* Optional; display name of the selected user
|
6420
6640
|
*/
|
6421
|
-
|
6641
|
+
displayName?: string;
|
6422
6642
|
/**
|
6423
|
-
*
|
6424
|
-
*
|
6425
|
-
* @returns boolean to represent whether the teamsCore capability is supported
|
6426
|
-
*
|
6427
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6428
|
-
*
|
6643
|
+
* Optional; email of the selected user
|
6429
6644
|
*/
|
6430
|
-
|
6431
|
-
}
|
6645
|
+
email?: string;
|
6646
|
+
}
|
6647
|
+
/**
|
6648
|
+
* Checks if the people capability is supported by the host
|
6649
|
+
* @returns boolean to represent whether the people capability is supported
|
6650
|
+
*
|
6651
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6652
|
+
*/
|
6653
|
+
declare function isSupported$5(): boolean;
|
6432
6654
|
|
6433
|
-
|
6434
|
-
|
6435
|
-
|
6436
|
-
|
6437
|
-
|
6438
|
-
|
6439
|
-
|
6440
|
-
* @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
|
6441
|
-
* @param peoplePickerInputs - Input parameters to launch customized people picker
|
6442
|
-
* @returns Promise that will be fulfilled when the operation has completed
|
6443
|
-
*/
|
6444
|
-
function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
|
6445
|
-
/**
|
6446
|
-
* @deprecated
|
6447
|
-
* As of TeamsJS v2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
|
6448
|
-
*
|
6449
|
-
* Launches a people picker and allows the user to select one or more people from the list
|
6450
|
-
* If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
|
6451
|
-
|
6452
|
-
* @param callback - Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users
|
6453
|
-
* @param peoplePickerInputs - Input parameters to launch customized people picker
|
6454
|
-
*/
|
6455
|
-
function selectPeople(callback: selectPeopleCallbackFunctionType, peoplePickerInputs?: PeoplePickerInputs): void;
|
6456
|
-
/**
|
6457
|
-
* Input parameter supplied to the People Picker API
|
6458
|
-
*/
|
6459
|
-
interface PeoplePickerInputs {
|
6460
|
-
/**
|
6461
|
-
* Optional; Set title for the people picker
|
6462
|
-
* Default value is "Select people" for multiselect and "Select a person" for single select
|
6463
|
-
*/
|
6464
|
-
title?: string;
|
6465
|
-
/**
|
6466
|
-
* Optional; Microsoft Entra IDs of the users to be pre-populated in the search box of people picker control
|
6467
|
-
* If single select is enabled this value, only the first user in the list will be pre-populated
|
6468
|
-
* Default value is null
|
6469
|
-
*/
|
6470
|
-
setSelected?: string[];
|
6471
|
-
/**
|
6472
|
-
* Optional; launches the people picker in org wide scope even if the app is added to a chat or channel
|
6473
|
-
* Default value is false
|
6474
|
-
*/
|
6475
|
-
openOrgWideSearchInChatOrChannel?: boolean;
|
6476
|
-
/**
|
6477
|
-
* Optional; launches the people picker for which only 1 person can be selected
|
6478
|
-
* Default value is false
|
6479
|
-
*/
|
6480
|
-
singleSelect?: boolean;
|
6481
|
-
}
|
6482
|
-
/**
|
6483
|
-
* Output user object of people picker API
|
6484
|
-
*/
|
6485
|
-
interface PeoplePickerResult {
|
6486
|
-
/**
|
6487
|
-
* user object ID (also known as Microsoft Entra ID) of the selected user
|
6488
|
-
*/
|
6489
|
-
objectId: string;
|
6490
|
-
/**
|
6491
|
-
* Optional; display name of the selected user
|
6492
|
-
*/
|
6493
|
-
displayName?: string;
|
6494
|
-
/**
|
6495
|
-
* Optional; email of the selected user
|
6496
|
-
*/
|
6497
|
-
email?: string;
|
6498
|
-
}
|
6499
|
-
/**
|
6500
|
-
* Checks if the people capability is supported by the host
|
6501
|
-
* @returns boolean to represent whether the people capability is supported
|
6502
|
-
*
|
6503
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
6504
|
-
*/
|
6505
|
-
function isSupported(): boolean;
|
6655
|
+
type people_d_PeoplePickerInputs = PeoplePickerInputs;
|
6656
|
+
type people_d_PeoplePickerResult = PeoplePickerResult;
|
6657
|
+
declare const people_d_selectPeople: typeof selectPeople;
|
6658
|
+
type people_d_selectPeopleCallbackFunctionType = selectPeopleCallbackFunctionType;
|
6659
|
+
declare namespace people_d {
|
6660
|
+
export { type people_d_PeoplePickerInputs as PeoplePickerInputs, type people_d_PeoplePickerResult as PeoplePickerResult, isSupported$5 as isSupported, people_d_selectPeople as selectPeople, type people_d_selectPeopleCallbackFunctionType as selectPeopleCallbackFunctionType };
|
6506
6661
|
}
|
6507
6662
|
|
6508
6663
|
/**
|
@@ -6827,95 +6982,94 @@ declare namespace videoEffects {
|
|
6827
6982
|
}
|
6828
6983
|
|
6829
6984
|
/**
|
6830
|
-
*
|
6831
|
-
* By integrating your application with the host's search box, users can search
|
6832
|
-
* your app using the same search box they use elsewhere in Teams, Outlook, or Office.
|
6985
|
+
* This interface contains information pertaining to the contents of the host M365 application's search box
|
6833
6986
|
*
|
6834
|
-
* This functionality is in Beta.
|
6835
6987
|
* @beta
|
6836
6988
|
*/
|
6837
|
-
|
6838
|
-
/**
|
6839
|
-
|
6840
|
-
|
6841
|
-
|
6842
|
-
|
6843
|
-
|
6844
|
-
|
6845
|
-
|
6846
|
-
|
6847
|
-
|
6848
|
-
|
6849
|
-
|
6850
|
-
|
6851
|
-
|
6852
|
-
|
6853
|
-
|
6854
|
-
|
6855
|
-
|
6856
|
-
|
6857
|
-
|
6858
|
-
|
6859
|
-
|
6860
|
-
|
6861
|
-
|
6862
|
-
|
6863
|
-
|
6864
|
-
|
6865
|
-
|
6866
|
-
|
6867
|
-
|
6868
|
-
|
6869
|
-
|
6870
|
-
|
6871
|
-
|
6872
|
-
|
6873
|
-
|
6874
|
-
|
6875
|
-
|
6876
|
-
|
6877
|
-
|
6878
|
-
|
6879
|
-
|
6880
|
-
|
6881
|
-
|
6882
|
-
|
6883
|
-
|
6884
|
-
|
6885
|
-
|
6886
|
-
|
6887
|
-
|
6888
|
-
|
6889
|
-
|
6890
|
-
|
6891
|
-
|
6892
|
-
|
6893
|
-
|
6894
|
-
|
6895
|
-
|
6896
|
-
|
6897
|
-
|
6898
|
-
|
6899
|
-
|
6900
|
-
|
6901
|
-
|
6902
|
-
|
6903
|
-
|
6904
|
-
|
6905
|
-
|
6906
|
-
|
6907
|
-
|
6908
|
-
|
6909
|
-
|
6910
|
-
|
6911
|
-
|
6912
|
-
|
6913
|
-
|
6914
|
-
|
6915
|
-
|
6916
|
-
|
6917
|
-
|
6918
|
-
|
6989
|
+
interface SearchQuery {
|
6990
|
+
/** The current search term in the host search experience */
|
6991
|
+
searchTerm: string;
|
6992
|
+
/** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
|
6993
|
+
timestamp: number;
|
6994
|
+
}
|
6995
|
+
/**
|
6996
|
+
* This type will store the SearchQuery and allow other logic to be made inside the handler.
|
6997
|
+
*
|
6998
|
+
* @beta
|
6999
|
+
*/
|
7000
|
+
type SearchQueryHandler = (query: SearchQuery) => void;
|
7001
|
+
/**
|
7002
|
+
* Allows the caller to register for various events fired by the host search experience.
|
7003
|
+
* Calling this function indicates that your application intends to plug into the host's search box and handle search events,
|
7004
|
+
* when the user is actively using your page/tab.
|
7005
|
+
*
|
7006
|
+
* The host may visually update its search box, e.g. with the name or icon of your application.
|
7007
|
+
*
|
7008
|
+
* Your application should *not* re-render inside of these callbacks, there may be a large number
|
7009
|
+
* of onChangeHandler calls if the user is typing rapidly in the search box.
|
7010
|
+
*
|
7011
|
+
* @param onClosedHandler - This handler will be called when the user exits or cancels their search.
|
7012
|
+
* Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
|
7013
|
+
* will be whatever the last query was before ending search.
|
7014
|
+
*
|
7015
|
+
* @param onExecuteHandler - The handler will be called when the user executes their
|
7016
|
+
* search (by pressing Enter for example). Should be used to display the full list of search results.
|
7017
|
+
* The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
|
7018
|
+
*
|
7019
|
+
* @param onChangeHandler - This optional handler will be called when the user first starts using the
|
7020
|
+
* host's search box and as the user types their query. Can be used to put your application into a
|
7021
|
+
* word-wheeling state or to display suggestions as the user is typing.
|
7022
|
+
*
|
7023
|
+
* This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
|
7024
|
+
* with the current contents of the search box.
|
7025
|
+
* @example
|
7026
|
+
* ``` ts
|
7027
|
+
* search.registerHandlers(
|
7028
|
+
query => {
|
7029
|
+
console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
|
7030
|
+
},
|
7031
|
+
query => {
|
7032
|
+
console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
|
7033
|
+
},
|
7034
|
+
query => {
|
7035
|
+
console.log(`Update your application with the changed search query: ${query.searchTerm}`);
|
7036
|
+
},
|
7037
|
+
);
|
7038
|
+
* ```
|
7039
|
+
*
|
7040
|
+
* @beta
|
7041
|
+
*/
|
7042
|
+
declare function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
|
7043
|
+
/**
|
7044
|
+
* Allows the caller to unregister for all events fired by the host search experience. Calling
|
7045
|
+
* this function will cause your app to stop appearing in the set of search scopes in the hosts
|
7046
|
+
*
|
7047
|
+
* @beta
|
7048
|
+
*/
|
7049
|
+
declare function unregisterHandlers(): void;
|
7050
|
+
/**
|
7051
|
+
* Checks if search capability is supported by the host
|
7052
|
+
* @returns boolean to represent whether the search capability is supported
|
7053
|
+
*
|
7054
|
+
* @throws Error if {@link app.initialize} has not successfully completed
|
7055
|
+
*
|
7056
|
+
* @beta
|
7057
|
+
*/
|
7058
|
+
declare function isSupported$4(): boolean;
|
7059
|
+
/**
|
7060
|
+
* Clear the host M365 application's search box
|
7061
|
+
*
|
7062
|
+
* @beta
|
7063
|
+
*/
|
7064
|
+
declare function closeSearch(): Promise<void>;
|
7065
|
+
|
7066
|
+
type search_d_SearchQuery = SearchQuery;
|
7067
|
+
type search_d_SearchQueryHandler = SearchQueryHandler;
|
7068
|
+
declare const search_d_closeSearch: typeof closeSearch;
|
7069
|
+
declare const search_d_registerHandlers: typeof registerHandlers;
|
7070
|
+
declare const search_d_unregisterHandlers: typeof unregisterHandlers;
|
7071
|
+
declare namespace search_d {
|
7072
|
+
export { type search_d_SearchQuery as SearchQuery, type search_d_SearchQueryHandler as SearchQueryHandler, search_d_closeSearch as closeSearch, isSupported$4 as isSupported, search_d_registerHandlers as registerHandlers, search_d_unregisterHandlers as unregisterHandlers };
|
6919
7073
|
}
|
6920
7074
|
|
6921
7075
|
/**
|
@@ -7425,15 +7579,14 @@ declare function startCall(startCallParams: StartCallParams): Promise<boolean>;
|
|
7425
7579
|
*
|
7426
7580
|
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
7427
7581
|
*/
|
7428
|
-
declare function isSupported(): boolean;
|
7582
|
+
declare function isSupported$3(): boolean;
|
7429
7583
|
|
7430
7584
|
type call_d_CallModalities = CallModalities;
|
7431
7585
|
declare const call_d_CallModalities: typeof CallModalities;
|
7432
7586
|
type call_d_StartCallParams = StartCallParams;
|
7433
|
-
declare const call_d_isSupported: typeof isSupported;
|
7434
7587
|
declare const call_d_startCall: typeof startCall;
|
7435
7588
|
declare namespace call_d {
|
7436
|
-
export { call_d_CallModalities as CallModalities, type call_d_StartCallParams as StartCallParams,
|
7589
|
+
export { call_d_CallModalities as CallModalities, type call_d_StartCallParams as StartCallParams, isSupported$3 as isSupported, call_d_startCall as startCall };
|
7437
7590
|
}
|
7438
7591
|
|
7439
7592
|
/**
|
@@ -7488,118 +7641,126 @@ declare namespace appInitialization_d {
|
|
7488
7641
|
* actions like drag and drop to compose
|
7489
7642
|
* @beta
|
7490
7643
|
*/
|
7491
|
-
|
7644
|
+
/**
|
7645
|
+
* Interface to assemble file chunks
|
7646
|
+
* @beta
|
7647
|
+
*/
|
7648
|
+
interface AssembleAttachment {
|
7649
|
+
/** A number representing the sequence of the attachment in the file chunks. */
|
7650
|
+
sequence: number;
|
7651
|
+
/** A Blob object representing the data of the file chunks. */
|
7652
|
+
file: Blob;
|
7653
|
+
}
|
7654
|
+
/**
|
7655
|
+
* Object used to represent a file
|
7656
|
+
* @beta
|
7657
|
+
*
|
7658
|
+
*/
|
7659
|
+
interface FilesFor3PStorage extends Blob {
|
7492
7660
|
/**
|
7493
|
-
*
|
7494
|
-
* @beta
|
7661
|
+
* A number that represents the number of milliseconds since the Unix epoch
|
7495
7662
|
*/
|
7496
|
-
|
7497
|
-
/** A number representing the sequence of the attachment in the file chunks. */
|
7498
|
-
sequence: number;
|
7499
|
-
/** A Blob object representing the data of the file chunks. */
|
7500
|
-
file: Blob;
|
7501
|
-
}
|
7663
|
+
lastModified: number;
|
7502
7664
|
/**
|
7503
|
-
*
|
7504
|
-
* @beta
|
7505
|
-
*
|
7665
|
+
* Name of the file
|
7506
7666
|
*/
|
7507
|
-
|
7508
|
-
/**
|
7509
|
-
* A number that represents the number of milliseconds since the Unix epoch
|
7510
|
-
*/
|
7511
|
-
lastModified: number;
|
7512
|
-
/**
|
7513
|
-
* Name of the file
|
7514
|
-
*/
|
7515
|
-
name: string;
|
7516
|
-
/**
|
7517
|
-
* file type
|
7518
|
-
*/
|
7519
|
-
type: string;
|
7520
|
-
/**
|
7521
|
-
* A string containing the path of the file relative to the ancestor directory the user selected
|
7522
|
-
*/
|
7523
|
-
webkitRelativePath?: string;
|
7524
|
-
}
|
7667
|
+
name: string;
|
7525
7668
|
/**
|
7526
|
-
*
|
7527
|
-
* @beta
|
7669
|
+
* file type
|
7528
7670
|
*/
|
7529
|
-
|
7530
|
-
/**
|
7531
|
-
* Base 64 data for the requested uri
|
7532
|
-
*/
|
7533
|
-
chunk: string;
|
7534
|
-
/**
|
7535
|
-
* chunk sequence number
|
7536
|
-
*/
|
7537
|
-
chunkSequence: number;
|
7538
|
-
/**
|
7539
|
-
* Indicates whether this chunk is the final segment of a file
|
7540
|
-
*/
|
7541
|
-
endOfFile: boolean;
|
7542
|
-
}
|
7671
|
+
type: string;
|
7543
7672
|
/**
|
7544
|
-
*
|
7545
|
-
* @beta
|
7673
|
+
* A string containing the path of the file relative to the ancestor directory the user selected
|
7546
7674
|
*/
|
7547
|
-
|
7548
|
-
|
7549
|
-
|
7550
|
-
|
7551
|
-
|
7552
|
-
|
7553
|
-
|
7554
|
-
*/
|
7555
|
-
fileChunk: FileChunk;
|
7556
|
-
/**
|
7557
|
-
* File index of the file for which chunk data is getting recieved
|
7558
|
-
*/
|
7559
|
-
fileIndex: number;
|
7560
|
-
/**
|
7561
|
-
* File type/MIME type which is getting recieved
|
7562
|
-
*/
|
7563
|
-
fileType: string;
|
7564
|
-
/**
|
7565
|
-
* Indicates whether this file is the last one in a sequence.
|
7566
|
-
*/
|
7567
|
-
isLastFile: boolean;
|
7568
|
-
/**
|
7569
|
-
* The name of the file.
|
7570
|
-
*/
|
7571
|
-
fileName: string;
|
7572
|
-
}
|
7675
|
+
webkitRelativePath?: string;
|
7676
|
+
}
|
7677
|
+
/**
|
7678
|
+
* File chunks an output of getDragAndDropFiles API from platform
|
7679
|
+
* @beta
|
7680
|
+
*/
|
7681
|
+
interface FileChunk {
|
7573
7682
|
/**
|
7574
|
-
*
|
7575
|
-
* @beta
|
7683
|
+
* Base 64 data for the requested uri
|
7576
7684
|
*/
|
7577
|
-
|
7578
|
-
|
7579
|
-
|
7580
|
-
|
7581
|
-
|
7582
|
-
|
7583
|
-
|
7584
|
-
|
7685
|
+
chunk: string;
|
7686
|
+
/**
|
7687
|
+
* chunk sequence number
|
7688
|
+
*/
|
7689
|
+
chunkSequence: number;
|
7690
|
+
/**
|
7691
|
+
* Indicates whether this chunk is the final segment of a file
|
7692
|
+
*/
|
7693
|
+
endOfFile: boolean;
|
7694
|
+
}
|
7695
|
+
/**
|
7696
|
+
* Output of getDragAndDropFiles API from platform
|
7697
|
+
* @beta
|
7698
|
+
*/
|
7699
|
+
interface FileResult {
|
7700
|
+
/**
|
7701
|
+
* Error encountered in getDragAndDropFiles API
|
7702
|
+
*/
|
7703
|
+
error?: SdkError;
|
7704
|
+
/**
|
7705
|
+
* File chunk which will be assemebled and converted into a blob
|
7706
|
+
*/
|
7707
|
+
fileChunk: FileChunk;
|
7708
|
+
/**
|
7709
|
+
* File index of the file for which chunk data is getting recieved
|
7710
|
+
*/
|
7711
|
+
fileIndex: number;
|
7712
|
+
/**
|
7713
|
+
* File type/MIME type which is getting recieved
|
7714
|
+
*/
|
7715
|
+
fileType: string;
|
7585
7716
|
/**
|
7586
|
-
*
|
7587
|
-
*
|
7588
|
-
* @param {string} dragAndDropInput - unique id which is a combination of replyToId + threadId of teams chat and channel.
|
7589
|
-
* Both replyToId and threadId can be fetched from application context.
|
7590
|
-
* @param {DragAndDropFileCallback} dragAndDropFileCallback - callback
|
7591
|
-
* A callback function to handle the result of the operation
|
7592
|
-
* @beta
|
7717
|
+
* Indicates whether this file is the last one in a sequence.
|
7593
7718
|
*/
|
7594
|
-
|
7719
|
+
isLastFile: boolean;
|
7595
7720
|
/**
|
7596
|
-
*
|
7597
|
-
* @returns boolean to represent whether the thirdPartyCloudStorage capability is supported
|
7598
|
-
*
|
7599
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
7600
|
-
* @beta
|
7721
|
+
* The name of the file.
|
7601
7722
|
*/
|
7602
|
-
|
7723
|
+
fileName: string;
|
7724
|
+
}
|
7725
|
+
/**
|
7726
|
+
* Defines the callback function received from Third Party App
|
7727
|
+
* @beta
|
7728
|
+
*/
|
7729
|
+
interface DragAndDropFileCallback {
|
7730
|
+
/**
|
7731
|
+
* Definition of the callback which is received from third party app when calling {@link thirdPartyCloudStorage.getDragAndDropFiles}
|
7732
|
+
* An array of drag and dropped files {@link thirdPartyCloudStorage.FilesFor3PStorage}
|
7733
|
+
* Error encountered during the API call {@link SdkError}
|
7734
|
+
*/
|
7735
|
+
(files: FilesFor3PStorage[], error?: SdkError): void;
|
7736
|
+
}
|
7737
|
+
/**
|
7738
|
+
* Get drag-and-drop files using a callback.
|
7739
|
+
*
|
7740
|
+
* @param {string} dragAndDropInput - unique id which is a combination of replyToId + threadId of teams chat and channel.
|
7741
|
+
* Both replyToId and threadId can be fetched from application context.
|
7742
|
+
* @param {DragAndDropFileCallback} dragAndDropFileCallback - callback
|
7743
|
+
* A callback function to handle the result of the operation
|
7744
|
+
* @beta
|
7745
|
+
*/
|
7746
|
+
declare function getDragAndDropFiles(dragAndDropInput: string, dragAndDropFileCallback: DragAndDropFileCallback): void;
|
7747
|
+
/**
|
7748
|
+
* Checks if the thirdPartyCloudStorage capability is supported by the host
|
7749
|
+
* @returns boolean to represent whether the thirdPartyCloudStorage capability is supported
|
7750
|
+
*
|
7751
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
7752
|
+
* @beta
|
7753
|
+
*/
|
7754
|
+
declare function isSupported$2(): boolean;
|
7755
|
+
|
7756
|
+
type thirdPartyCloudStorage_d_AssembleAttachment = AssembleAttachment;
|
7757
|
+
type thirdPartyCloudStorage_d_DragAndDropFileCallback = DragAndDropFileCallback;
|
7758
|
+
type thirdPartyCloudStorage_d_FileChunk = FileChunk;
|
7759
|
+
type thirdPartyCloudStorage_d_FileResult = FileResult;
|
7760
|
+
type thirdPartyCloudStorage_d_FilesFor3PStorage = FilesFor3PStorage;
|
7761
|
+
declare const thirdPartyCloudStorage_d_getDragAndDropFiles: typeof getDragAndDropFiles;
|
7762
|
+
declare namespace thirdPartyCloudStorage_d {
|
7763
|
+
export { type thirdPartyCloudStorage_d_AssembleAttachment as AssembleAttachment, type thirdPartyCloudStorage_d_DragAndDropFileCallback as DragAndDropFileCallback, type thirdPartyCloudStorage_d_FileChunk as FileChunk, type thirdPartyCloudStorage_d_FileResult as FileResult, type thirdPartyCloudStorage_d_FilesFor3PStorage as FilesFor3PStorage, thirdPartyCloudStorage_d_getDragAndDropFiles as getDragAndDropFiles, isSupported$2 as isSupported };
|
7603
7764
|
}
|
7604
7765
|
|
7605
7766
|
/** Type of callback used to indicate when {@link executeDeepLink} completes */
|
@@ -7987,605 +8148,641 @@ declare namespace settings_d {
|
|
7987
8148
|
* @deprecated
|
7988
8149
|
* As of TeamsJS v2.0.0, please use {@link dialog} namespace instead.
|
7989
8150
|
*
|
7990
|
-
*
|
8151
|
+
* Module to interact with the task module-specific part of the SDK.
|
7991
8152
|
* This object is usable only on the content frame.
|
7992
|
-
* The tasks
|
8153
|
+
* The tasks module will be deprecated. Please use dialog for future developments.
|
8154
|
+
*/
|
8155
|
+
/**
|
8156
|
+
* Function type that is used to receive the result when a task module is submitted by
|
8157
|
+
* calling {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}
|
8158
|
+
*
|
8159
|
+
* @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
|
8160
|
+
* @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
|
8161
|
+
*/
|
8162
|
+
type startTaskSubmitHandlerFunctionType = (err: string, result: string | object) => void;
|
8163
|
+
/**
|
8164
|
+
* @deprecated
|
8165
|
+
* As of 2.8.0:
|
8166
|
+
* - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
|
8167
|
+
* - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
|
8168
|
+
* - For Adaptive Card-based dialogs:
|
8169
|
+
* - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
|
8170
|
+
* the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
|
8171
|
+
* - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
|
8172
|
+
*
|
8173
|
+
* Allows an app to open the task module.
|
8174
|
+
*
|
8175
|
+
* @param taskInfo - An object containing the parameters of the task module
|
8176
|
+
* @param submitHandler - Handler to call when the task module is completed
|
7993
8177
|
*/
|
7994
|
-
declare
|
8178
|
+
declare function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
|
8179
|
+
/**
|
8180
|
+
* @deprecated
|
8181
|
+
* As of TeamsJS v2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
|
8182
|
+
*
|
8183
|
+
* Update height/width task info properties.
|
8184
|
+
*
|
8185
|
+
* @param taskInfo - An object containing width and height properties
|
8186
|
+
*/
|
8187
|
+
declare function updateTask(taskInfo: TaskInfo): void;
|
8188
|
+
/**
|
8189
|
+
* @deprecated
|
8190
|
+
* As of 2.8.0, please use {@link dialog.url.submit} instead.
|
8191
|
+
*
|
8192
|
+
* Submit the task module.
|
8193
|
+
*
|
8194
|
+
* @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
|
8195
|
+
* @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.
|
8196
|
+
*/
|
8197
|
+
declare function submitTask(result?: string | object, appIds?: string | string[]): void;
|
8198
|
+
/**
|
8199
|
+
* Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
|
8200
|
+
* otherwise uses the height and width values corresponding to {@link DialogDimension | TaskModuleDimension.Small}
|
8201
|
+
* @param taskInfo TaskInfo object from which to extract size info, if specified
|
8202
|
+
* @returns TaskInfo with height and width specified
|
8203
|
+
*/
|
8204
|
+
declare function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
|
8205
|
+
|
8206
|
+
declare const tasks_d_getDefaultSizeIfNotProvided: typeof getDefaultSizeIfNotProvided;
|
8207
|
+
declare const tasks_d_startTask: typeof startTask;
|
8208
|
+
type tasks_d_startTaskSubmitHandlerFunctionType = startTaskSubmitHandlerFunctionType;
|
8209
|
+
declare const tasks_d_submitTask: typeof submitTask;
|
8210
|
+
declare const tasks_d_updateTask: typeof updateTask;
|
8211
|
+
declare namespace tasks_d {
|
8212
|
+
export { tasks_d_getDefaultSizeIfNotProvided as getDefaultSizeIfNotProvided, tasks_d_startTask as startTask, type tasks_d_startTaskSubmitHandlerFunctionType as startTaskSubmitHandlerFunctionType, tasks_d_submitTask as submitTask, tasks_d_updateTask as updateTask };
|
8213
|
+
}
|
8214
|
+
|
8215
|
+
/**
|
8216
|
+
* APIs involving Live Share, a framework for building real-time collaborative apps.
|
8217
|
+
* For more information, visit https://aka.ms/teamsliveshare
|
8218
|
+
*
|
8219
|
+
* @see LiveShareHost
|
8220
|
+
*/
|
8221
|
+
/**
|
8222
|
+
* @hidden
|
8223
|
+
* The meeting roles of a user.
|
8224
|
+
* Used in Live Share for its role verification feature.
|
8225
|
+
* For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
|
8226
|
+
*/
|
8227
|
+
declare enum UserMeetingRole {
|
7995
8228
|
/**
|
7996
|
-
*
|
7997
|
-
* calling {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}
|
7998
|
-
*
|
7999
|
-
* @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
|
8000
|
-
* @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
|
8229
|
+
* Guest role.
|
8001
8230
|
*/
|
8002
|
-
|
8231
|
+
guest = "Guest",
|
8003
8232
|
/**
|
8004
|
-
*
|
8005
|
-
|
8006
|
-
|
8007
|
-
|
8008
|
-
*
|
8009
|
-
|
8010
|
-
|
8011
|
-
|
8012
|
-
*
|
8013
|
-
|
8233
|
+
* Attendee role.
|
8234
|
+
*/
|
8235
|
+
attendee = "Attendee",
|
8236
|
+
/**
|
8237
|
+
* Presenter role.
|
8238
|
+
*/
|
8239
|
+
presenter = "Presenter",
|
8240
|
+
/**
|
8241
|
+
* Organizer role.
|
8242
|
+
*/
|
8243
|
+
organizer = "Organizer"
|
8244
|
+
}
|
8245
|
+
/**
|
8246
|
+
* @hidden
|
8247
|
+
* State of the current Live Share session's Fluid container.
|
8248
|
+
* This is used internally by the `LiveShareClient` when joining a Live Share session.
|
8249
|
+
*/
|
8250
|
+
declare enum ContainerState {
|
8251
|
+
/**
|
8252
|
+
* The call to `LiveShareHost.setContainerId()` successfully created the container mapping
|
8253
|
+
* for the current Live Share session.
|
8254
|
+
*/
|
8255
|
+
added = "Added",
|
8256
|
+
/**
|
8257
|
+
* A container mapping for the current Live Share session already exists.
|
8258
|
+
* This indicates to Live Share that a new container does not need be created.
|
8259
|
+
*/
|
8260
|
+
alreadyExists = "AlreadyExists",
|
8261
|
+
/**
|
8262
|
+
* The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
|
8263
|
+
* This happens when another client has already set the container ID for the session.
|
8264
|
+
*/
|
8265
|
+
conflict = "Conflict",
|
8266
|
+
/**
|
8267
|
+
* A container mapping for the current Live Share session does not yet exist.
|
8268
|
+
* This indicates to Live Share that a new container should be created.
|
8269
|
+
*/
|
8270
|
+
notFound = "NotFound"
|
8271
|
+
}
|
8272
|
+
/**
|
8273
|
+
* @hidden
|
8274
|
+
* Returned from `LiveShareHost.getFluidContainerId()` and `LiveShareHost.setFluidContainerId`.
|
8275
|
+
* This response specifies the container mapping information for the current Live Share session.
|
8276
|
+
*/
|
8277
|
+
interface IFluidContainerInfo {
|
8278
|
+
/**
|
8279
|
+
* State of the containerId mapping.
|
8280
|
+
*/
|
8281
|
+
containerState: ContainerState;
|
8282
|
+
/**
|
8283
|
+
* ID of the container to join for the meeting. Undefined if the container hasn't been
|
8284
|
+
* created yet.
|
8285
|
+
*/
|
8286
|
+
containerId: string | undefined;
|
8287
|
+
/**
|
8288
|
+
* If true, the local client should create the container and then save the created containers
|
8289
|
+
* ID to the mapping service.
|
8290
|
+
*/
|
8291
|
+
shouldCreate: boolean;
|
8292
|
+
/**
|
8293
|
+
* If `containerId` is undefined and `shouldCreate` is false, the container isn't ready
|
8294
|
+
* but another client is creating it. In this case, the local client should wait the specified
|
8295
|
+
* amount of time before calling `LiveShareHost.getFluidContainerId()` again.
|
8296
|
+
*/
|
8297
|
+
retryAfter: number;
|
8298
|
+
}
|
8299
|
+
/**
|
8300
|
+
* @hidden
|
8301
|
+
* Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
|
8302
|
+
* Live Share session.
|
8303
|
+
*/
|
8304
|
+
interface INtpTimeInfo {
|
8305
|
+
/**
|
8306
|
+
* ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
|
8307
|
+
*/
|
8308
|
+
ntpTime: string;
|
8309
|
+
/**
|
8310
|
+
* Server time expressed as the number of milliseconds since the ECMAScript epoch.
|
8311
|
+
*/
|
8312
|
+
ntpTimeInUTC: number;
|
8313
|
+
}
|
8314
|
+
/**
|
8315
|
+
* @hidden
|
8316
|
+
* Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
|
8317
|
+
* current Live Share session.
|
8318
|
+
*/
|
8319
|
+
interface IFluidTenantInfo {
|
8320
|
+
/**
|
8321
|
+
* The Fluid Tenant ID Live Share should use.
|
8322
|
+
*/
|
8323
|
+
tenantId: string;
|
8324
|
+
/**
|
8325
|
+
* The Fluid service endpoint Live Share should use.
|
8326
|
+
*/
|
8327
|
+
serviceEndpoint: string;
|
8328
|
+
}
|
8329
|
+
/**
|
8330
|
+
* @hidden
|
8331
|
+
* Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
|
8332
|
+
* particular client in a Live Share session.
|
8333
|
+
*/
|
8334
|
+
interface IClientInfo {
|
8335
|
+
/**
|
8336
|
+
* The host user's `userId` associated with a given `clientId`
|
8337
|
+
*/
|
8338
|
+
userId: string;
|
8339
|
+
/**
|
8340
|
+
* User's meeting roles associated with a given `clientId`
|
8341
|
+
*/
|
8342
|
+
roles: UserMeetingRole[];
|
8343
|
+
/**
|
8344
|
+
* The user's display name associated with a given `clientId`.
|
8345
|
+
* If this returns as `undefined`, the user may need to update their host client.
|
8346
|
+
*/
|
8347
|
+
displayName?: string;
|
8348
|
+
}
|
8349
|
+
/**
|
8350
|
+
* Checks if the interactive capability is supported by the host
|
8351
|
+
* @returns boolean to represent whether the interactive capability is supported
|
8352
|
+
*
|
8353
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
8354
|
+
*/
|
8355
|
+
declare function isSupported$1(): boolean;
|
8356
|
+
/**
|
8357
|
+
* Live Share host implementation for connecting to real-time collaborative sessions.
|
8358
|
+
* Designed for use with the `LiveShareClient` class in the `@microsoft/live-share` package.
|
8359
|
+
* Learn more at https://aka.ms/teamsliveshare
|
8360
|
+
*
|
8361
|
+
* @remarks
|
8362
|
+
* The `LiveShareClient` class from Live Share uses the hidden API's to join/manage the session.
|
8363
|
+
* To create a new `LiveShareHost` instance use the static `LiveShareHost.create()` function.
|
8364
|
+
*/
|
8365
|
+
declare class LiveShareHost {
|
8366
|
+
/**
|
8367
|
+
* @hidden
|
8368
|
+
* Returns the Fluid Tenant connection info for user's current context.
|
8369
|
+
*/
|
8370
|
+
getFluidTenantInfo(): Promise<IFluidTenantInfo>;
|
8371
|
+
/**
|
8372
|
+
* @hidden
|
8373
|
+
* Returns the fluid access token for mapped container Id.
|
8014
8374
|
*
|
8015
|
-
* @param
|
8016
|
-
* @
|
8375
|
+
* @param containerId Fluid's container Id for the request. Undefined for new containers.
|
8376
|
+
* @returns token for connecting to Fluid's session.
|
8017
8377
|
*/
|
8018
|
-
|
8378
|
+
getFluidToken(containerId?: string): Promise<string>;
|
8019
8379
|
/**
|
8020
|
-
* @
|
8021
|
-
*
|
8380
|
+
* @hidden
|
8381
|
+
* Returns the ID of the fluid container associated with the user's current context.
|
8382
|
+
*/
|
8383
|
+
getFluidContainerId(): Promise<IFluidContainerInfo>;
|
8384
|
+
/**
|
8385
|
+
* @hidden
|
8386
|
+
* Sets the ID of the fluid container associated with the current context.
|
8022
8387
|
*
|
8023
|
-
*
|
8388
|
+
* @remarks
|
8389
|
+
* If this returns false, the client should delete the container they created and then call
|
8390
|
+
* `getFluidContainerId()` to get the ID of the container being used.
|
8391
|
+
* @param containerId ID of the fluid container the client created.
|
8392
|
+
* @returns A data structure with a `containerState` indicating the success or failure of the request.
|
8393
|
+
*/
|
8394
|
+
setFluidContainerId(containerId: string): Promise<IFluidContainerInfo>;
|
8395
|
+
/**
|
8396
|
+
* @hidden
|
8397
|
+
* Returns the shared clock server's current time.
|
8398
|
+
*/
|
8399
|
+
getNtpTime(): Promise<INtpTimeInfo>;
|
8400
|
+
/**
|
8401
|
+
* @hidden
|
8402
|
+
* Associates the fluid client ID with a set of user roles.
|
8024
8403
|
*
|
8025
|
-
* @param
|
8404
|
+
* @param clientId The ID for the current user's Fluid client. Changes on reconnects.
|
8405
|
+
* @returns The roles for the current user.
|
8026
8406
|
*/
|
8027
|
-
|
8407
|
+
registerClientId(clientId: string): Promise<UserMeetingRole[]>;
|
8028
8408
|
/**
|
8029
|
-
* @
|
8030
|
-
*
|
8409
|
+
* @hidden
|
8410
|
+
* Returns the roles associated with a client ID.
|
8031
8411
|
*
|
8032
|
-
*
|
8412
|
+
* @param clientId The Client ID the message was received from.
|
8413
|
+
* @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
|
8414
|
+
*/
|
8415
|
+
getClientRoles(clientId: string): Promise<UserMeetingRole[] | undefined>;
|
8416
|
+
/**
|
8417
|
+
* @hidden
|
8418
|
+
* Returns the `IClientInfo` associated with a client ID.
|
8033
8419
|
*
|
8034
|
-
* @param
|
8035
|
-
* @
|
8420
|
+
* @param clientId The Client ID the message was received from.
|
8421
|
+
* @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
|
8036
8422
|
*/
|
8037
|
-
|
8423
|
+
getClientInfo(clientId: string): Promise<IClientInfo | undefined>;
|
8038
8424
|
/**
|
8039
|
-
*
|
8040
|
-
*
|
8041
|
-
*
|
8042
|
-
* @
|
8425
|
+
* Factories a new `LiveShareHost` instance for use with the `LiveShareClient` class
|
8426
|
+
* in the `@microsoft/live-share` package.
|
8427
|
+
*
|
8428
|
+
* @remarks
|
8429
|
+
* `app.initialize()` must first be called before using this API.
|
8430
|
+
* This API can only be called from `meetingStage` or `sidePanel` contexts.
|
8043
8431
|
*/
|
8044
|
-
|
8432
|
+
static create(): LiveShareHost;
|
8433
|
+
}
|
8434
|
+
|
8435
|
+
type liveShareHost_d_ContainerState = ContainerState;
|
8436
|
+
declare const liveShareHost_d_ContainerState: typeof ContainerState;
|
8437
|
+
type liveShareHost_d_IClientInfo = IClientInfo;
|
8438
|
+
type liveShareHost_d_IFluidContainerInfo = IFluidContainerInfo;
|
8439
|
+
type liveShareHost_d_IFluidTenantInfo = IFluidTenantInfo;
|
8440
|
+
type liveShareHost_d_INtpTimeInfo = INtpTimeInfo;
|
8441
|
+
type liveShareHost_d_LiveShareHost = LiveShareHost;
|
8442
|
+
declare const liveShareHost_d_LiveShareHost: typeof LiveShareHost;
|
8443
|
+
type liveShareHost_d_UserMeetingRole = UserMeetingRole;
|
8444
|
+
declare const liveShareHost_d_UserMeetingRole: typeof UserMeetingRole;
|
8445
|
+
declare namespace liveShareHost_d {
|
8446
|
+
export { liveShareHost_d_ContainerState as ContainerState, type liveShareHost_d_IClientInfo as IClientInfo, type liveShareHost_d_IFluidContainerInfo as IFluidContainerInfo, type liveShareHost_d_IFluidTenantInfo as IFluidTenantInfo, type liveShareHost_d_INtpTimeInfo as INtpTimeInfo, liveShareHost_d_LiveShareHost as LiveShareHost, liveShareHost_d_UserMeetingRole as UserMeetingRole, isSupported$1 as isSupported };
|
8045
8447
|
}
|
8046
8448
|
|
8047
8449
|
/**
|
8048
|
-
*
|
8049
|
-
*
|
8050
|
-
*
|
8051
|
-
* @see LiveShareHost
|
8450
|
+
* @hidden
|
8451
|
+
* Module for an app to support a checkout flow by interacting with the marketplace cart in the host.
|
8452
|
+
* @beta
|
8052
8453
|
*/
|
8053
|
-
|
8054
|
-
|
8055
|
-
|
8056
|
-
|
8057
|
-
|
8058
|
-
|
8059
|
-
|
8060
|
-
|
8061
|
-
|
8062
|
-
|
8063
|
-
|
8064
|
-
|
8065
|
-
|
8066
|
-
|
8067
|
-
|
8068
|
-
attendee = "Attendee",
|
8069
|
-
/**
|
8070
|
-
* Presenter role.
|
8071
|
-
*/
|
8072
|
-
presenter = "Presenter",
|
8073
|
-
/**
|
8074
|
-
* Organizer role.
|
8075
|
-
*/
|
8076
|
-
organizer = "Organizer"
|
8077
|
-
}
|
8454
|
+
/**
|
8455
|
+
* @hidden
|
8456
|
+
* the version of the current cart interface
|
8457
|
+
* which is forced to send to the host in the calls.
|
8458
|
+
* @internal
|
8459
|
+
* Limited to Microsoft-internal use
|
8460
|
+
* @beta
|
8461
|
+
*/
|
8462
|
+
declare const cartVersion: CartVersion;
|
8463
|
+
/**
|
8464
|
+
* @hidden
|
8465
|
+
* Represents the cart object for the app checkout flow.
|
8466
|
+
* @beta
|
8467
|
+
*/
|
8468
|
+
interface Cart {
|
8078
8469
|
/**
|
8079
8470
|
* @hidden
|
8080
|
-
*
|
8081
|
-
* This is used internally by the `LiveShareClient` when joining a Live Share session.
|
8471
|
+
* Version of the cart.
|
8082
8472
|
*/
|
8083
|
-
|
8084
|
-
/**
|
8085
|
-
* The call to `LiveShareHost.setContainerId()` successfully created the container mapping
|
8086
|
-
* for the current Live Share session.
|
8087
|
-
*/
|
8088
|
-
added = "Added",
|
8089
|
-
/**
|
8090
|
-
* A container mapping for the current Live Share session already exists.
|
8091
|
-
* This indicates to Live Share that a new container does not need be created.
|
8092
|
-
*/
|
8093
|
-
alreadyExists = "AlreadyExists",
|
8094
|
-
/**
|
8095
|
-
* The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
|
8096
|
-
* This happens when another client has already set the container ID for the session.
|
8097
|
-
*/
|
8098
|
-
conflict = "Conflict",
|
8099
|
-
/**
|
8100
|
-
* A container mapping for the current Live Share session does not yet exist.
|
8101
|
-
* This indicates to Live Share that a new container should be created.
|
8102
|
-
*/
|
8103
|
-
notFound = "NotFound"
|
8104
|
-
}
|
8473
|
+
readonly version: CartVersion;
|
8105
8474
|
/**
|
8106
8475
|
* @hidden
|
8107
|
-
*
|
8108
|
-
* This response specifies the container mapping information for the current Live Share session.
|
8476
|
+
* The uuid of the cart.
|
8109
8477
|
*/
|
8110
|
-
|
8111
|
-
/**
|
8112
|
-
* State of the containerId mapping.
|
8113
|
-
*/
|
8114
|
-
containerState: ContainerState;
|
8115
|
-
/**
|
8116
|
-
* ID of the container to join for the meeting. Undefined if the container hasn't been
|
8117
|
-
* created yet.
|
8118
|
-
*/
|
8119
|
-
containerId: string | undefined;
|
8120
|
-
/**
|
8121
|
-
* If true, the local client should create the container and then save the created containers
|
8122
|
-
* ID to the mapping service.
|
8123
|
-
*/
|
8124
|
-
shouldCreate: boolean;
|
8125
|
-
/**
|
8126
|
-
* If `containerId` is undefined and `shouldCreate` is false, the container isn't ready
|
8127
|
-
* but another client is creating it. In this case, the local client should wait the specified
|
8128
|
-
* amount of time before calling `LiveShareHost.getFluidContainerId()` again.
|
8129
|
-
*/
|
8130
|
-
retryAfter: number;
|
8131
|
-
}
|
8478
|
+
readonly id: string;
|
8132
8479
|
/**
|
8133
8480
|
* @hidden
|
8134
|
-
*
|
8135
|
-
* Live Share session.
|
8481
|
+
* The cart info.
|
8136
8482
|
*/
|
8137
|
-
|
8138
|
-
/**
|
8139
|
-
* ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
|
8140
|
-
*/
|
8141
|
-
ntpTime: string;
|
8142
|
-
/**
|
8143
|
-
* Server time expressed as the number of milliseconds since the ECMAScript epoch.
|
8144
|
-
*/
|
8145
|
-
ntpTimeInUTC: number;
|
8146
|
-
}
|
8483
|
+
readonly cartInfo: CartInfo;
|
8147
8484
|
/**
|
8148
8485
|
* @hidden
|
8149
|
-
*
|
8150
|
-
* current Live Share session.
|
8486
|
+
* The cart items.
|
8151
8487
|
*/
|
8152
|
-
|
8153
|
-
|
8154
|
-
|
8155
|
-
|
8156
|
-
|
8157
|
-
|
8158
|
-
|
8159
|
-
|
8160
|
-
|
8161
|
-
|
8488
|
+
readonly cartItems: CartItem[];
|
8489
|
+
}
|
8490
|
+
/**
|
8491
|
+
* @hidden
|
8492
|
+
* Version of the cart that is used by the app.
|
8493
|
+
* @internal
|
8494
|
+
* Limited to Microsoft-internal use
|
8495
|
+
* @beta
|
8496
|
+
*/
|
8497
|
+
interface CartVersion {
|
8162
8498
|
/**
|
8163
|
-
* @hidden
|
8164
|
-
*
|
8165
|
-
*
|
8166
|
-
*/
|
8167
|
-
|
8168
|
-
/**
|
8169
|
-
* The host user's `userId` associated with a given `clientId`
|
8170
|
-
*/
|
8171
|
-
userId: string;
|
8172
|
-
/**
|
8173
|
-
* User's meeting roles associated with a given `clientId`
|
8174
|
-
*/
|
8175
|
-
roles: UserMeetingRole[];
|
8176
|
-
/**
|
8177
|
-
* The user's display name associated with a given `clientId`.
|
8178
|
-
* If this returns as `undefined`, the user may need to update their host client.
|
8179
|
-
*/
|
8180
|
-
displayName?: string;
|
8181
|
-
}
|
8499
|
+
* @hidden
|
8500
|
+
* Represents the major version of a cart, it
|
8501
|
+
* not compatible with the previous major version.
|
8502
|
+
*/
|
8503
|
+
readonly majorVersion: number;
|
8182
8504
|
/**
|
8183
|
-
*
|
8184
|
-
*
|
8185
|
-
*
|
8186
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
8505
|
+
* @hidden
|
8506
|
+
* The minor version of a cart, which is compatible
|
8507
|
+
* with the previous minor version in the same major version.
|
8187
8508
|
*/
|
8188
|
-
|
8509
|
+
readonly minorVersion: number;
|
8189
8510
|
}
|
8190
8511
|
/**
|
8191
|
-
*
|
8192
|
-
*
|
8193
|
-
*
|
8194
|
-
*
|
8195
|
-
* @remarks
|
8196
|
-
* The `LiveShareClient` class from Live Share uses the hidden API's to join/manage the session.
|
8197
|
-
* To create a new `LiveShareHost` instance use the static `LiveShareHost.create()` function.
|
8512
|
+
* @hidden
|
8513
|
+
* Represents the cart information
|
8514
|
+
* @beta
|
8198
8515
|
*/
|
8199
|
-
|
8516
|
+
interface CartInfo {
|
8200
8517
|
/**
|
8201
8518
|
* @hidden
|
8202
|
-
*
|
8519
|
+
* The country market where the products are selling.
|
8520
|
+
* Should be country code in ISO 3166-1 alpha-2 format, e.g. CA for Canada.
|
8521
|
+
* https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
8203
8522
|
*/
|
8204
|
-
|
8523
|
+
readonly market: string;
|
8205
8524
|
/**
|
8206
8525
|
* @hidden
|
8207
|
-
*
|
8208
|
-
*
|
8209
|
-
* @param containerId Fluid's container Id for the request. Undefined for new containers.
|
8210
|
-
* @returns token for connecting to Fluid's session.
|
8526
|
+
* The identifier to tell the cart is checked out by admin or end user.
|
8211
8527
|
*/
|
8212
|
-
|
8528
|
+
readonly intent: Intent;
|
8213
8529
|
/**
|
8214
8530
|
* @hidden
|
8215
|
-
*
|
8531
|
+
* Locale the app should render for the user
|
8532
|
+
* Should be a BCP 47 language tag, e.g. en-US ([primary tag]-[ISO 3166-1 alpha-2 code]).
|
8533
|
+
* https://en.wikipedia.org/wiki/IETF_language_tag
|
8216
8534
|
*/
|
8217
|
-
|
8535
|
+
readonly locale: string;
|
8218
8536
|
/**
|
8219
8537
|
* @hidden
|
8220
|
-
*
|
8221
|
-
*
|
8222
|
-
* @remarks
|
8223
|
-
* If this returns false, the client should delete the container they created and then call
|
8224
|
-
* `getFluidContainerId()` to get the ID of the container being used.
|
8225
|
-
* @param containerId ID of the fluid container the client created.
|
8226
|
-
* @returns A data structure with a `containerState` indicating the success or failure of the request.
|
8538
|
+
* The status of the cart.
|
8227
8539
|
*/
|
8228
|
-
|
8540
|
+
readonly status: CartStatus;
|
8229
8541
|
/**
|
8230
8542
|
* @hidden
|
8231
|
-
*
|
8543
|
+
* ISO 4217 currency code for the cart item price, e.g. USD for US Dollar.
|
8544
|
+
* https://en.wikipedia.org/wiki/ISO_4217
|
8232
8545
|
*/
|
8233
|
-
|
8546
|
+
readonly currency: string;
|
8234
8547
|
/**
|
8235
8548
|
* @hidden
|
8236
|
-
*
|
8237
|
-
*
|
8238
|
-
*
|
8239
|
-
* @returns The roles for the current user.
|
8549
|
+
* ISO 8601 timestamp string in UTC, indicates when the cart is created.
|
8550
|
+
* e.g. 2023-06-19T22:06:59Z
|
8551
|
+
* https://en.wikipedia.org/wiki/ISO_8601
|
8240
8552
|
*/
|
8241
|
-
|
8553
|
+
readonly createdAt: string;
|
8242
8554
|
/**
|
8243
8555
|
* @hidden
|
8244
|
-
*
|
8245
|
-
*
|
8246
|
-
*
|
8247
|
-
* @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
|
8556
|
+
* ISO 8601 timestamp string in UTC, indicates when the cart is updated.
|
8557
|
+
* e.g. 2023-06-19T22:06:59Z
|
8558
|
+
* https://en.wikipedia.org/wiki/ISO_8601
|
8248
8559
|
*/
|
8249
|
-
|
8560
|
+
readonly updatedAt: string;
|
8561
|
+
}
|
8562
|
+
/**
|
8563
|
+
* @hidden
|
8564
|
+
* Represents the basic cart item information.
|
8565
|
+
* @beta
|
8566
|
+
*/
|
8567
|
+
interface Item {
|
8250
8568
|
/**
|
8251
8569
|
* @hidden
|
8252
|
-
*
|
8253
|
-
*
|
8254
|
-
* @param clientId The Client ID the message was received from.
|
8255
|
-
* @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
|
8570
|
+
* The id of the cart item.
|
8256
8571
|
*/
|
8257
|
-
|
8572
|
+
readonly id: string;
|
8258
8573
|
/**
|
8259
|
-
*
|
8260
|
-
*
|
8261
|
-
*
|
8262
|
-
* @remarks
|
8263
|
-
* `app.initialize()` must first be called before using this API.
|
8264
|
-
* This API can only be called from `meetingStage` or `sidePanel` contexts.
|
8574
|
+
* @hidden
|
8575
|
+
* The display name of the cart item.
|
8265
8576
|
*/
|
8266
|
-
|
8267
|
-
|
8268
|
-
|
8577
|
+
readonly name: string;
|
8578
|
+
/**
|
8579
|
+
* @hidden
|
8580
|
+
* The quantity of the cart item.
|
8581
|
+
*/
|
8582
|
+
readonly quantity: number;
|
8583
|
+
/**
|
8584
|
+
* @hidden
|
8585
|
+
* The price of the single cart item.
|
8586
|
+
*/
|
8587
|
+
readonly price: number;
|
8588
|
+
/**
|
8589
|
+
* @hidden
|
8590
|
+
* The thumbnail imageURL of the cart item.
|
8591
|
+
*/
|
8592
|
+
readonly imageURL?: URL;
|
8593
|
+
}
|
8269
8594
|
/**
|
8270
8595
|
* @hidden
|
8271
|
-
*
|
8596
|
+
* Represents the cart item that could have accessories
|
8272
8597
|
* @beta
|
8273
8598
|
*/
|
8274
|
-
|
8599
|
+
interface CartItem extends Item {
|
8275
8600
|
/**
|
8276
8601
|
* @hidden
|
8277
|
-
*
|
8278
|
-
* which is forced to send to the host in the calls.
|
8279
|
-
* @internal
|
8280
|
-
* Limited to Microsoft-internal use
|
8281
|
-
* @beta
|
8602
|
+
* Accessories to the item if existing.
|
8282
8603
|
*/
|
8283
|
-
|
8604
|
+
readonly accessories?: Item[];
|
8284
8605
|
/**
|
8285
8606
|
* @hidden
|
8286
|
-
*
|
8287
|
-
* @beta
|
8607
|
+
* The thumbnail imageURL of the cart item.
|
8288
8608
|
*/
|
8289
|
-
|
8290
|
-
|
8291
|
-
|
8292
|
-
|
8293
|
-
|
8294
|
-
|
8295
|
-
|
8296
|
-
|
8297
|
-
* The uuid of the cart.
|
8298
|
-
*/
|
8299
|
-
readonly id: string;
|
8300
|
-
/**
|
8301
|
-
* @hidden
|
8302
|
-
* The cart info.
|
8303
|
-
*/
|
8304
|
-
readonly cartInfo: CartInfo;
|
8305
|
-
/**
|
8306
|
-
* @hidden
|
8307
|
-
* The cart items.
|
8308
|
-
*/
|
8309
|
-
readonly cartItems: CartItem[];
|
8310
|
-
}
|
8609
|
+
readonly imageURL?: URL;
|
8610
|
+
}
|
8611
|
+
/**
|
8612
|
+
* @hidden
|
8613
|
+
* Represents the persona creating the cart.
|
8614
|
+
* @beta
|
8615
|
+
*/
|
8616
|
+
declare enum Intent {
|
8311
8617
|
/**
|
8312
8618
|
* @hidden
|
8313
|
-
*
|
8314
|
-
* @internal
|
8315
|
-
* Limited to Microsoft-internal use
|
8316
|
-
* @beta
|
8619
|
+
* The cart is created by admin of an organization in Teams Admin Center.
|
8317
8620
|
*/
|
8318
|
-
|
8319
|
-
/**
|
8320
|
-
* @hidden
|
8321
|
-
* Represents the major version of a cart, it
|
8322
|
-
* not compatible with the previous major version.
|
8323
|
-
*/
|
8324
|
-
readonly majorVersion: number;
|
8325
|
-
/**
|
8326
|
-
* @hidden
|
8327
|
-
* The minor version of a cart, which is compatible
|
8328
|
-
* with the previous minor version in the same major version.
|
8329
|
-
*/
|
8330
|
-
readonly minorVersion: number;
|
8331
|
-
}
|
8621
|
+
TACAdminUser = "TACAdminUser",
|
8332
8622
|
/**
|
8333
8623
|
* @hidden
|
8334
|
-
*
|
8335
|
-
* @beta
|
8624
|
+
* The cart is created by admin of an organization in Teams.
|
8336
8625
|
*/
|
8337
|
-
|
8338
|
-
/**
|
8339
|
-
* @hidden
|
8340
|
-
* The country market where the products are selling.
|
8341
|
-
* Should be country code in ISO 3166-1 alpha-2 format, e.g. CA for Canada.
|
8342
|
-
* https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
8343
|
-
*/
|
8344
|
-
readonly market: string;
|
8345
|
-
/**
|
8346
|
-
* @hidden
|
8347
|
-
* The identifier to tell the cart is checked out by admin or end user.
|
8348
|
-
*/
|
8349
|
-
readonly intent: Intent;
|
8350
|
-
/**
|
8351
|
-
* @hidden
|
8352
|
-
* Locale the app should render for the user
|
8353
|
-
* Should be a BCP 47 language tag, e.g. en-US ([primary tag]-[ISO 3166-1 alpha-2 code]).
|
8354
|
-
* https://en.wikipedia.org/wiki/IETF_language_tag
|
8355
|
-
*/
|
8356
|
-
readonly locale: string;
|
8357
|
-
/**
|
8358
|
-
* @hidden
|
8359
|
-
* The status of the cart.
|
8360
|
-
*/
|
8361
|
-
readonly status: CartStatus;
|
8362
|
-
/**
|
8363
|
-
* @hidden
|
8364
|
-
* ISO 4217 currency code for the cart item price, e.g. USD for US Dollar.
|
8365
|
-
* https://en.wikipedia.org/wiki/ISO_4217
|
8366
|
-
*/
|
8367
|
-
readonly currency: string;
|
8368
|
-
/**
|
8369
|
-
* @hidden
|
8370
|
-
* ISO 8601 timestamp string in UTC, indicates when the cart is created.
|
8371
|
-
* e.g. 2023-06-19T22:06:59Z
|
8372
|
-
* https://en.wikipedia.org/wiki/ISO_8601
|
8373
|
-
*/
|
8374
|
-
readonly createdAt: string;
|
8375
|
-
/**
|
8376
|
-
* @hidden
|
8377
|
-
* ISO 8601 timestamp string in UTC, indicates when the cart is updated.
|
8378
|
-
* e.g. 2023-06-19T22:06:59Z
|
8379
|
-
* https://en.wikipedia.org/wiki/ISO_8601
|
8380
|
-
*/
|
8381
|
-
readonly updatedAt: string;
|
8382
|
-
}
|
8626
|
+
TeamsAdminUser = "TeamsAdminUser",
|
8383
8627
|
/**
|
8384
8628
|
* @hidden
|
8385
|
-
*
|
8386
|
-
* @beta
|
8629
|
+
* The cart is created by end user of an organization in Teams.
|
8387
8630
|
*/
|
8388
|
-
|
8389
|
-
|
8390
|
-
|
8391
|
-
|
8392
|
-
|
8393
|
-
|
8394
|
-
|
8395
|
-
|
8396
|
-
* The display name of the cart item.
|
8397
|
-
*/
|
8398
|
-
readonly name: string;
|
8399
|
-
/**
|
8400
|
-
* @hidden
|
8401
|
-
* The quantity of the cart item.
|
8402
|
-
*/
|
8403
|
-
readonly quantity: number;
|
8404
|
-
/**
|
8405
|
-
* @hidden
|
8406
|
-
* The price of the single cart item.
|
8407
|
-
*/
|
8408
|
-
readonly price: number;
|
8409
|
-
/**
|
8410
|
-
* @hidden
|
8411
|
-
* The thumbnail imageURL of the cart item.
|
8412
|
-
*/
|
8413
|
-
readonly imageURL?: URL;
|
8414
|
-
}
|
8631
|
+
TeamsEndUser = "TeamsEndUser"
|
8632
|
+
}
|
8633
|
+
/**
|
8634
|
+
* @hidden
|
8635
|
+
* Represents the status of the cart.
|
8636
|
+
* @beta
|
8637
|
+
*/
|
8638
|
+
declare enum CartStatus {
|
8415
8639
|
/**
|
8416
8640
|
* @hidden
|
8417
|
-
*
|
8418
|
-
* @beta
|
8641
|
+
* Cart is created but not checked out yet.
|
8419
8642
|
*/
|
8420
|
-
|
8421
|
-
/**
|
8422
|
-
* @hidden
|
8423
|
-
* Accessories to the item if existing.
|
8424
|
-
*/
|
8425
|
-
readonly accessories?: Item[];
|
8426
|
-
/**
|
8427
|
-
* @hidden
|
8428
|
-
* The thumbnail imageURL of the cart item.
|
8429
|
-
*/
|
8430
|
-
readonly imageURL?: URL;
|
8431
|
-
}
|
8643
|
+
Open = "Open",
|
8432
8644
|
/**
|
8433
8645
|
* @hidden
|
8434
|
-
*
|
8435
|
-
* @beta
|
8646
|
+
* Cart is checked out but not completed yet.
|
8436
8647
|
*/
|
8437
|
-
|
8438
|
-
/**
|
8439
|
-
* @hidden
|
8440
|
-
* The cart is created by admin of an organization in Teams Admin Center.
|
8441
|
-
*/
|
8442
|
-
TACAdminUser = "TACAdminUser",
|
8443
|
-
/**
|
8444
|
-
* @hidden
|
8445
|
-
* The cart is created by admin of an organization in Teams.
|
8446
|
-
*/
|
8447
|
-
TeamsAdminUser = "TeamsAdminUser",
|
8448
|
-
/**
|
8449
|
-
* @hidden
|
8450
|
-
* The cart is created by end user of an organization in Teams.
|
8451
|
-
*/
|
8452
|
-
TeamsEndUser = "TeamsEndUser"
|
8453
|
-
}
|
8648
|
+
Processing = "Processing",
|
8454
8649
|
/**
|
8455
8650
|
* @hidden
|
8456
|
-
*
|
8457
|
-
*
|
8651
|
+
* Indicate checking out is completed and the host should
|
8652
|
+
* return a new cart in the next getCart call.
|
8458
8653
|
*/
|
8459
|
-
|
8460
|
-
/**
|
8461
|
-
* @hidden
|
8462
|
-
* Cart is created but not checked out yet.
|
8463
|
-
*/
|
8464
|
-
Open = "Open",
|
8465
|
-
/**
|
8466
|
-
* @hidden
|
8467
|
-
* Cart is checked out but not completed yet.
|
8468
|
-
*/
|
8469
|
-
Processing = "Processing",
|
8470
|
-
/**
|
8471
|
-
* @hidden
|
8472
|
-
* Indicate checking out is completed and the host should
|
8473
|
-
* return a new cart in the next getCart call.
|
8474
|
-
*/
|
8475
|
-
Processed = "Processed",
|
8476
|
-
/**
|
8477
|
-
* @hidden
|
8478
|
-
* Indicate checking out process is manually cancelled by the user
|
8479
|
-
*/
|
8480
|
-
Closed = "Closed",
|
8481
|
-
/**
|
8482
|
-
* @hidden
|
8483
|
-
* Indicate checking out is failed and the host should
|
8484
|
-
* return a new cart in the next getCart call.
|
8485
|
-
*/
|
8486
|
-
Error = "Error"
|
8487
|
-
}
|
8654
|
+
Processed = "Processed",
|
8488
8655
|
/**
|
8489
8656
|
* @hidden
|
8490
|
-
*
|
8491
|
-
* @beta
|
8657
|
+
* Indicate checking out process is manually cancelled by the user
|
8492
8658
|
*/
|
8493
|
-
|
8494
|
-
/**
|
8495
|
-
* @hidden
|
8496
|
-
* The uuid of the cart to be updated, target on the cart
|
8497
|
-
* being checked out if cartId is not provided.
|
8498
|
-
*/
|
8499
|
-
cartId?: string;
|
8500
|
-
/**
|
8501
|
-
* @hidden
|
8502
|
-
* A list of cart items object, for each item,
|
8503
|
-
* if item id exists in the cart, overwrite the item price and quantity,
|
8504
|
-
* otherwise add new items to cart.
|
8505
|
-
*/
|
8506
|
-
cartItems: CartItem[];
|
8507
|
-
}
|
8659
|
+
Closed = "Closed",
|
8508
8660
|
/**
|
8509
8661
|
* @hidden
|
8510
|
-
*
|
8511
|
-
*
|
8662
|
+
* Indicate checking out is failed and the host should
|
8663
|
+
* return a new cart in the next getCart call.
|
8512
8664
|
*/
|
8513
|
-
|
8514
|
-
|
8515
|
-
|
8516
|
-
|
8517
|
-
|
8518
|
-
|
8519
|
-
|
8520
|
-
|
8521
|
-
* @hidden
|
8522
|
-
* A list of cart id, delete the cart item accordingly.
|
8523
|
-
*/
|
8524
|
-
cartItemIds: string[];
|
8525
|
-
}
|
8665
|
+
Error = "Error"
|
8666
|
+
}
|
8667
|
+
/**
|
8668
|
+
* @hidden
|
8669
|
+
* Represents the parameters to update the cart items.
|
8670
|
+
* @beta
|
8671
|
+
*/
|
8672
|
+
interface AddOrUpdateCartItemsParams {
|
8526
8673
|
/**
|
8527
8674
|
* @hidden
|
8528
|
-
*
|
8529
|
-
*
|
8675
|
+
* The uuid of the cart to be updated, target on the cart
|
8676
|
+
* being checked out if cartId is not provided.
|
8530
8677
|
*/
|
8531
|
-
|
8532
|
-
/**
|
8533
|
-
* @hidden
|
8534
|
-
* The uuid of the cart to be updated, target on the cart
|
8535
|
-
* being checked out if cartId is not provided.
|
8536
|
-
*/
|
8537
|
-
cartId?: string;
|
8538
|
-
/**
|
8539
|
-
* @hidden
|
8540
|
-
* Status of the cart.
|
8541
|
-
*/
|
8542
|
-
cartStatus: CartStatus;
|
8543
|
-
/**
|
8544
|
-
* @hidden
|
8545
|
-
* Extra info to the status.
|
8546
|
-
*/
|
8547
|
-
statusInfo?: string;
|
8548
|
-
}
|
8678
|
+
cartId?: string;
|
8549
8679
|
/**
|
8550
8680
|
* @hidden
|
8551
|
-
*
|
8552
|
-
*
|
8553
|
-
*
|
8681
|
+
* A list of cart items object, for each item,
|
8682
|
+
* if item id exists in the cart, overwrite the item price and quantity,
|
8683
|
+
* otherwise add new items to cart.
|
8554
8684
|
*/
|
8555
|
-
|
8685
|
+
cartItems: CartItem[];
|
8686
|
+
}
|
8687
|
+
/**
|
8688
|
+
* @hidden
|
8689
|
+
* Represents the parameters to remove the cart items.
|
8690
|
+
* @beta
|
8691
|
+
*/
|
8692
|
+
interface RemoveCartItemsParams {
|
8556
8693
|
/**
|
8557
8694
|
* @hidden
|
8558
|
-
*
|
8559
|
-
*
|
8560
|
-
* @returns A promise of the updated cart object in the cartVersion.
|
8561
|
-
* @beta
|
8695
|
+
* The uuid of the cart to be updated, target on the cart
|
8696
|
+
* being checked out if cartId is not provided.
|
8562
8697
|
*/
|
8563
|
-
|
8698
|
+
cartId?: string;
|
8564
8699
|
/**
|
8565
8700
|
* @hidden
|
8566
|
-
*
|
8567
|
-
|
8568
|
-
|
8569
|
-
|
8701
|
+
* A list of cart id, delete the cart item accordingly.
|
8702
|
+
*/
|
8703
|
+
cartItemIds: string[];
|
8704
|
+
}
|
8705
|
+
/**
|
8706
|
+
* @hidden
|
8707
|
+
* Represents the parameters to update the cart status.
|
8708
|
+
* @beta
|
8709
|
+
*/
|
8710
|
+
interface UpdateCartStatusParams {
|
8711
|
+
/**
|
8712
|
+
* @hidden
|
8713
|
+
* The uuid of the cart to be updated, target on the cart
|
8714
|
+
* being checked out if cartId is not provided.
|
8570
8715
|
*/
|
8571
|
-
|
8716
|
+
cartId?: string;
|
8572
8717
|
/**
|
8573
8718
|
* @hidden
|
8574
|
-
*
|
8575
|
-
* @param updateCartStatusParams The parameters to update the cart status.
|
8576
|
-
* @returns A promise of the updated cart object in the cartVersion.
|
8577
|
-
* @beta
|
8719
|
+
* Status of the cart.
|
8578
8720
|
*/
|
8579
|
-
|
8721
|
+
cartStatus: CartStatus;
|
8580
8722
|
/**
|
8581
8723
|
* @hidden
|
8582
|
-
*
|
8583
|
-
* @returns Boolean to represent whether the marketplace capability is supported.
|
8584
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed.
|
8585
|
-
* @beta
|
8724
|
+
* Extra info to the status.
|
8586
8725
|
*/
|
8587
|
-
|
8588
|
-
|
8726
|
+
statusInfo?: string;
|
8727
|
+
}
|
8728
|
+
/**
|
8729
|
+
* @hidden
|
8730
|
+
* Get the cart object owned by the host to checkout.
|
8731
|
+
* @returns A promise of the cart object in the cartVersion.
|
8732
|
+
* @beta
|
8733
|
+
*/
|
8734
|
+
declare function getCart(): Promise<Cart>;
|
8735
|
+
/**
|
8736
|
+
* @hidden
|
8737
|
+
* Add or update cart items in the cart owned by the host.
|
8738
|
+
* @param addOrUpdateCartItemsParams Represents the parameters to update the cart items.
|
8739
|
+
* @returns A promise of the updated cart object in the cartVersion.
|
8740
|
+
* @beta
|
8741
|
+
*/
|
8742
|
+
declare function addOrUpdateCartItems(addOrUpdateCartItemsParams: AddOrUpdateCartItemsParams): Promise<Cart>;
|
8743
|
+
/**
|
8744
|
+
* @hidden
|
8745
|
+
* Remove cart items from the cart owned by the host.
|
8746
|
+
* @param removeCartItemsParams The parameters to remove the cart items.
|
8747
|
+
* @returns A promise of the updated cart object in the cartVersion.
|
8748
|
+
* @beta
|
8749
|
+
*/
|
8750
|
+
declare function removeCartItems(removeCartItemsParams: RemoveCartItemsParams): Promise<Cart>;
|
8751
|
+
/**
|
8752
|
+
* @hidden
|
8753
|
+
* Update cart status in the cart owned by the host.
|
8754
|
+
* @param updateCartStatusParams The parameters to update the cart status.
|
8755
|
+
* @returns A promise of the updated cart object in the cartVersion.
|
8756
|
+
* @beta
|
8757
|
+
*/
|
8758
|
+
declare function updateCartStatus(updateCartStatusParams: UpdateCartStatusParams): Promise<Cart>;
|
8759
|
+
/**
|
8760
|
+
* @hidden
|
8761
|
+
* Checks if the marketplace capability is supported by the host.
|
8762
|
+
* @returns Boolean to represent whether the marketplace capability is supported.
|
8763
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed.
|
8764
|
+
* @beta
|
8765
|
+
*/
|
8766
|
+
declare function isSupported(): boolean;
|
8767
|
+
|
8768
|
+
type marketplace_d_AddOrUpdateCartItemsParams = AddOrUpdateCartItemsParams;
|
8769
|
+
type marketplace_d_Cart = Cart;
|
8770
|
+
type marketplace_d_CartItem = CartItem;
|
8771
|
+
type marketplace_d_CartStatus = CartStatus;
|
8772
|
+
declare const marketplace_d_CartStatus: typeof CartStatus;
|
8773
|
+
type marketplace_d_Intent = Intent;
|
8774
|
+
declare const marketplace_d_Intent: typeof Intent;
|
8775
|
+
type marketplace_d_Item = Item;
|
8776
|
+
type marketplace_d_RemoveCartItemsParams = RemoveCartItemsParams;
|
8777
|
+
type marketplace_d_UpdateCartStatusParams = UpdateCartStatusParams;
|
8778
|
+
declare const marketplace_d_addOrUpdateCartItems: typeof addOrUpdateCartItems;
|
8779
|
+
declare const marketplace_d_cartVersion: typeof cartVersion;
|
8780
|
+
declare const marketplace_d_getCart: typeof getCart;
|
8781
|
+
declare const marketplace_d_isSupported: typeof isSupported;
|
8782
|
+
declare const marketplace_d_removeCartItems: typeof removeCartItems;
|
8783
|
+
declare const marketplace_d_updateCartStatus: typeof updateCartStatus;
|
8784
|
+
declare namespace marketplace_d {
|
8785
|
+
export { type marketplace_d_AddOrUpdateCartItemsParams as AddOrUpdateCartItemsParams, type marketplace_d_Cart as Cart, type marketplace_d_CartItem as CartItem, marketplace_d_CartStatus as CartStatus, marketplace_d_Intent as Intent, type marketplace_d_Item as Item, type marketplace_d_RemoveCartItemsParams as RemoveCartItemsParams, type marketplace_d_UpdateCartStatusParams as UpdateCartStatusParams, marketplace_d_addOrUpdateCartItems as addOrUpdateCartItems, marketplace_d_cartVersion as cartVersion, marketplace_d_getCart as getCart, marketplace_d_isSupported as isSupported, marketplace_d_removeCartItems as removeCartItems, marketplace_d_updateCartStatus as updateCartStatus };
|
8589
8786
|
}
|
8590
8787
|
|
8591
8788
|
/**
|
@@ -11063,4 +11260,4 @@ declare namespace hostEntity {
|
|
11063
11260
|
export { };
|
11064
11261
|
}
|
11065
11262
|
|
11066
|
-
export { type ActionInfo, ActionObjectType, type AdaptiveCardDialogInfo, type AdaptiveCardVersion, AppId, type BaseActionObject, type BotAdaptiveCardDialogInfo, type BotUrlDialogInfo, ChannelType, type ChatMembersInformation, ChildAppWindow, type Context$1 as Context, type DeepLinkParameters, DialogDimension, type DialogInfo, type DialogSize, EmailAddress, ErrorCode, FileOpenPreference, type FilePreviewParameters, type FrameContext, FrameContexts, type FrameInfo, HostClientType, HostName, type IAppWindow, type ISerializable, LiveShareHost, type LoadContext, type LocaleInfo, type M365ContentAction, NotificationTypes, type OpenConversationRequest, type OpenGroupChatRequest, type OpenSingleChatRequest, ParentAppWindow, type ResumeContext, type SdkError, type SecondaryId, SecondaryM365ContentIdName, type ShareDeepLinkParameters, type ShowNotificationParameters, type TabInformation, type TabInstance, type TabInstanceParameters, type TaskInfo, DialogDimension as TaskModuleDimension, type TeamInformation, type TeamInstanceParameters, TeamType, type ThreadMember, type UrlDialogInfo, type UserJoinedTeamsInformation, UserSettingTypes, UserTeamRole, ViewerActionTypes, type addEventListnerFunctionType, app_d as app, appEntity, appInitialization_d as appInitialization, appInstallDialog_d as appInstallDialog, authentication_d as authentication, barCode_d as barCode, calendar_d as calendar, call_d as call, type callbackFunctionType, chat, clipboard_d as clipboard, conversations, copilot, dialog, enablePrintCapability, executeDeepLink, type executeDeepLinkOnCompleteFunctionType, externalAppAuthentication, externalAppAuthenticationForCEA, externalAppCardActions, externalAppCardActionsForCEA, externalAppCommands, files, geoLocation, getAdaptiveCardSchemaVersion, getContext, type getContextCallbackFunctionType, getMruTabInstances, getTabInstances, type getTabInstancesCallbackFunctionType, hostEntity, initialize, initializeWithFrameContext, liveShare, location, logs, mail, marketplace, media, meeting, meetingRoom, menus, messageChannels, monetization, navigateBack, navigateCrossDomain, navigateToTab, nestedAppAuth, notifications, type onCompleteFunctionType, type onCompleteHandlerFunctionType, openFilePreview, otherAppStateChange, pages, people, print, profile, registerAppButtonClickHandler, registerAppButtonHoverEnterHandler, registerAppButtonHoverLeaveHandler, registerBackButtonHandler, type registerBackButtonHandlerFunctionType, registerBeforeUnloadHandler, registerChangeSettingsHandler, registerCustomHandler, registerFocusEnterHandler, registerFullScreenHandler, type registerFullScreenHandlerFunctionType, registerOnLoadHandler, registerOnThemeChangeHandler, type registerOnThemeChangeHandlerFunctionType, registerUserSettingsChangeHandler, remoteCamera, returnFocus, search, secondaryBrowser, sendCustomEvent, sendCustomMessage, setFrameContext, settings_d as settings, shareDeepLink, sharing, stageView, tasks, teams, teamsCore, thirdPartyCloudStorage, uploadCustomApp, version, videoEffects, videoEffectsEx, visualMedia, webStorage };
|
11263
|
+
export { type ActionInfo, ActionObjectType, type AdaptiveCardDialogInfo, type AdaptiveCardVersion, AppId, type BaseActionObject, type BotAdaptiveCardDialogInfo, type BotUrlDialogInfo, ChannelType, type ChatMembersInformation, ChildAppWindow, type Context$1 as Context, type DeepLinkParameters, DialogDimension, type DialogInfo, type DialogSize, EmailAddress, ErrorCode, FileOpenPreference, type FilePreviewParameters, type FrameContext, FrameContexts, type FrameInfo, HostClientType, HostName, type IAppWindow, type ISerializable, LiveShareHost, type LoadContext, type LocaleInfo, type M365ContentAction, NotificationTypes, type OpenConversationRequest, type OpenGroupChatRequest, type OpenSingleChatRequest, ParentAppWindow, type ResumeContext, type SdkError, type SecondaryId, SecondaryM365ContentIdName, type ShareDeepLinkParameters, type ShowNotificationParameters, type TabInformation, type TabInstance, type TabInstanceParameters, type TaskInfo, DialogDimension as TaskModuleDimension, type TeamInformation, type TeamInstanceParameters, TeamType, type ThreadMember, type UrlDialogInfo, type UserJoinedTeamsInformation, UserSettingTypes, UserTeamRole, ViewerActionTypes, type addEventListnerFunctionType, app_d as app, appEntity, appInitialization_d as appInitialization, appInstallDialog_d as appInstallDialog, authentication_d as authentication, barCode_d as barCode, calendar_d as calendar, call_d as call, type callbackFunctionType, chat_d as chat, clipboard_d as clipboard, conversations, copilot, dialog_d as dialog, enablePrintCapability, executeDeepLink, type executeDeepLinkOnCompleteFunctionType, externalAppAuthentication, externalAppAuthenticationForCEA, externalAppCardActions, externalAppCardActionsForCEA, externalAppCommands, files, geoLocation_d as geoLocation, getAdaptiveCardSchemaVersion, getContext, type getContextCallbackFunctionType, getMruTabInstances, getTabInstances, type getTabInstancesCallbackFunctionType, hostEntity, initialize, initializeWithFrameContext, liveShareHost_d as liveShare, location_d as location, logs, mail_d as mail, marketplace_d as marketplace, media_d as media, meeting, meetingRoom, menus_d as menus, messageChannels, monetization_d as monetization, navigateBack, navigateCrossDomain, navigateToTab, nestedAppAuth_d as nestedAppAuth, notifications, type onCompleteFunctionType, type onCompleteHandlerFunctionType, openFilePreview, otherAppStateChange, pages, people_d as people, print, profile, registerAppButtonClickHandler, registerAppButtonHoverEnterHandler, registerAppButtonHoverLeaveHandler, registerBackButtonHandler, type registerBackButtonHandlerFunctionType, registerBeforeUnloadHandler, registerChangeSettingsHandler, registerCustomHandler, registerFocusEnterHandler, registerFullScreenHandler, type registerFullScreenHandlerFunctionType, registerOnLoadHandler, registerOnThemeChangeHandler, type registerOnThemeChangeHandlerFunctionType, registerUserSettingsChangeHandler, remoteCamera, returnFocus, search_d as search, secondaryBrowser_d as secondaryBrowser, sendCustomEvent, sendCustomMessage, setFrameContext, settings_d as settings, shareDeepLink, sharing, stageView, tasks_d as tasks, teams, teamsAPIs_d as teamsCore, thirdPartyCloudStorage_d as thirdPartyCloudStorage, uploadCustomApp, version, videoEffects, videoEffectsEx, visualMedia, webStorage };
|