@microsoft/teams-js 2.3.0-beta.2 → 2.3.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/MicrosoftTeams.d.ts +12 -83
- package/dist/MicrosoftTeams.js +52 -138
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +1 -1
- package/dist/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
@@ -24,7 +24,7 @@ To install the stable [version](https://docs.microsoft.com/javascript/api/overvi
|
|
24
24
|
|
25
25
|
### Production
|
26
26
|
|
27
|
-
You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.
|
27
|
+
You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.3.0/js/MicrosoftTeams.min.js) or point your package manager at them.
|
28
28
|
|
29
29
|
## Usage
|
30
30
|
|
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
|
|
45
45
|
```html
|
46
46
|
<!-- Microsoft Teams JavaScript API (via CDN) -->
|
47
47
|
<script
|
48
|
-
src="https://res.cdn.office.net/teams-js/2.
|
49
|
-
integrity="sha384-
|
48
|
+
src="https://res.cdn.office.net/teams-js/2.3.0/js/MicrosoftTeams.min.js"
|
49
|
+
integrity="sha384-LI9E631Gz4tFN2IFwM29y0lSXUgqhkoTtdiH4ghd6eNOA1lAzX9F+D8w1NnFF9xM"
|
50
50
|
crossorigin="anonymous"
|
51
51
|
></script>
|
52
52
|
|
53
53
|
<!-- Microsoft Teams JavaScript API (via npm) -->
|
54
|
-
<script src="node_modules/@microsoft/teams-js@2.
|
54
|
+
<script src="node_modules/@microsoft/teams-js@2.3.0/dist/MicrosoftTeams.min.js"></script>
|
55
55
|
|
56
56
|
<!-- Microsoft Teams JavaScript API (via local) -->
|
57
57
|
<script src="MicrosoftTeams.min.js"></script>
|
package/dist/MicrosoftTeams.d.ts
CHANGED
@@ -911,7 +911,7 @@ export namespace files {
|
|
911
911
|
/**
|
912
912
|
* The file path to uniquely identify it within the file hierarchy
|
913
913
|
*/
|
914
|
-
|
914
|
+
webkitRelativePath?: string;
|
915
915
|
}
|
916
916
|
/**
|
917
917
|
* @hidden
|
@@ -1006,6 +1006,7 @@ export namespace files {
|
|
1006
1006
|
/**
|
1007
1007
|
* @hidden
|
1008
1008
|
* Hide from docs
|
1009
|
+
* @beta
|
1009
1010
|
*
|
1010
1011
|
* Interface representing 3P cloud storage provider upload existing file(s) action
|
1011
1012
|
*
|
@@ -1137,13 +1138,16 @@ export namespace files {
|
|
1137
1138
|
* Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
|
1138
1139
|
* 3P provider from the configured policy supported 3P provider list, following which user authentication
|
1139
1140
|
* for selected 3P provider is performed on success of which the selected 3P provider support is added for user
|
1141
|
+
* @beta
|
1140
1142
|
*
|
1141
|
-
* @param callback Callback that will be triggered post add 3P cloud storage provider action
|
1143
|
+
* @param callback Callback that will be triggered post add 3P cloud storage provider action.
|
1144
|
+
* If the error is encountered (and hence passed back), no provider value is sent back.
|
1145
|
+
* For success scenarios, error value will be passed as null and a valid provider value is sent.
|
1142
1146
|
*
|
1143
1147
|
* @internal
|
1144
1148
|
* Limited to Microsoft-internal use
|
1145
1149
|
*/
|
1146
|
-
export function addCloudStorageProvider(callback: (error?: SdkError) => void): void;
|
1150
|
+
export function addCloudStorageProvider(callback: (error?: SdkError, provider?: CloudStorageProvider) => void): void;
|
1147
1151
|
/**
|
1148
1152
|
* @hidden
|
1149
1153
|
* Hide from docs
|
@@ -1218,6 +1222,7 @@ export namespace files {
|
|
1218
1222
|
* Hide from docs
|
1219
1223
|
*
|
1220
1224
|
* Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
|
1225
|
+
* @beta
|
1221
1226
|
*
|
1222
1227
|
* @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
|
1223
1228
|
* @param callback Callback that will be triggered post uploading file(s) flow is finished
|
@@ -3503,7 +3508,7 @@ export namespace app {
|
|
3503
3508
|
*/
|
3504
3509
|
locale: string;
|
3505
3510
|
/**
|
3506
|
-
* The current UI theme.
|
3511
|
+
* The current UI theme of the host. Possible values: "default", "dark", or "contrast".
|
3507
3512
|
*/
|
3508
3513
|
theme: string;
|
3509
3514
|
/**
|
@@ -4197,7 +4202,9 @@ export namespace geoLocation {
|
|
4197
4202
|
*/
|
4198
4203
|
longitude: number;
|
4199
4204
|
/**
|
4200
|
-
Accuracy
|
4205
|
+
Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
|
4206
|
+
@remarks
|
4207
|
+
This property is only in scope for mobile
|
4201
4208
|
*/
|
4202
4209
|
accuracy?: number;
|
4203
4210
|
/**
|
@@ -4296,17 +4303,6 @@ export namespace pages {
|
|
4296
4303
|
* Limited to Microsoft-internal use
|
4297
4304
|
*/
|
4298
4305
|
function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
|
4299
|
-
/**
|
4300
|
-
* @hidden
|
4301
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerFocusEnterHandler API.
|
4302
|
-
*
|
4303
|
-
* @internal
|
4304
|
-
* Limited to Microsoft-internal use
|
4305
|
-
*
|
4306
|
-
* @param handler - The handler for placing focus within the application.
|
4307
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4308
|
-
*/
|
4309
|
-
function registerFocusEnterHandlerHelper(handler: (navigateForward: boolean) => void, versionSpecificHelper?: () => void): void;
|
4310
4306
|
/**
|
4311
4307
|
* Sets/Updates the current frame with new information
|
4312
4308
|
*
|
@@ -4387,17 +4383,6 @@ export namespace pages {
|
|
4387
4383
|
* @param handler - The handler to invoke when the user toggles full-screen view for a tab.
|
4388
4384
|
*/
|
4389
4385
|
function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
|
4390
|
-
/**
|
4391
|
-
* @hidden
|
4392
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerFullScreenHandler API.
|
4393
|
-
*
|
4394
|
-
* @internal
|
4395
|
-
* Limited to Microsoft-internal use
|
4396
|
-
*
|
4397
|
-
* @param handler - The handler to invoke when the user toggles full-screen view for a tab.
|
4398
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4399
|
-
*/
|
4400
|
-
function registerFullScreenHandlerHelper(handler: (isFullScreen: boolean) => void, versionSpecificHelper?: () => void): void;
|
4401
4386
|
/**
|
4402
4387
|
* Checks if the pages capability is supported by the host
|
4403
4388
|
* @returns true if the pages capability is enabled in runtime.supports.pages and
|
@@ -4531,17 +4516,6 @@ export namespace pages {
|
|
4531
4516
|
* @param handler - The handler to invoke when the user clicks on Settings.
|
4532
4517
|
*/
|
4533
4518
|
function registerChangeConfigHandler(handler: () => void): void;
|
4534
|
-
/**
|
4535
|
-
* @hidden
|
4536
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerConfigChangeHandler API.
|
4537
|
-
*
|
4538
|
-
* @internal
|
4539
|
-
* Limited to Microsoft-internal use
|
4540
|
-
*
|
4541
|
-
* @param handler - The handler to invoke when the user clicks on Settings.
|
4542
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4543
|
-
*/
|
4544
|
-
function registerChangeConfigHandlerHelper(handler: () => void, versionSpecificHelper?: () => void): void;
|
4545
4519
|
/**
|
4546
4520
|
* Describes the results of the settings.save event. Includes result, notifySuccess, and notifyFailure
|
4547
4521
|
* to indicate the return object (result) and the status of whether the settings.save call succeeded or not and why.
|
@@ -4669,51 +4643,18 @@ export namespace pages {
|
|
4669
4643
|
* @param handler - The handler to invoke when the personal app button is clicked in the app bar.
|
4670
4644
|
*/
|
4671
4645
|
function onClick(handler: () => void): void;
|
4672
|
-
/**
|
4673
|
-
* @hidden
|
4674
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onClick API.
|
4675
|
-
*
|
4676
|
-
* @internal
|
4677
|
-
* Limited to Microsoft-internal use
|
4678
|
-
*
|
4679
|
-
* @param handler - The handler to invoke when the personal app button is clicked in the app bar.
|
4680
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4681
|
-
*/
|
4682
|
-
function onClickHelper(handler: () => void, versionSpecificHelper?: () => void): void;
|
4683
4646
|
/**
|
4684
4647
|
* Registers a handler for entering hover of the app button.
|
4685
4648
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
4686
4649
|
* @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
|
4687
4650
|
*/
|
4688
4651
|
function onHoverEnter(handler: () => void): void;
|
4689
|
-
/**
|
4690
|
-
* @hidden
|
4691
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onHoverEnter API.
|
4692
|
-
*
|
4693
|
-
* @internal
|
4694
|
-
* Limited to Microsoft-internal use
|
4695
|
-
*
|
4696
|
-
* @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
|
4697
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4698
|
-
*/
|
4699
|
-
function onHoverEnterHelper(handler: () => void, versionSpecificHelper?: () => void): void;
|
4700
4652
|
/**
|
4701
4653
|
* Registers a handler for exiting hover of the app button.
|
4702
4654
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
4703
4655
|
* @param handler - The handler to invoke when exiting hover of the personal app button in the app bar.
|
4704
4656
|
*/
|
4705
4657
|
function onHoverLeave(handler: () => void): void;
|
4706
|
-
/**
|
4707
|
-
* @hidden
|
4708
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onHoverLeave API.
|
4709
|
-
*
|
4710
|
-
* @internal
|
4711
|
-
* Limited to Microsoft-internal use
|
4712
|
-
*
|
4713
|
-
* @param handler - The handler to invoke when existing hover of the personal app button in the app bar.
|
4714
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4715
|
-
*/
|
4716
|
-
function onHoverLeaveHelper(handler: () => void, versionSpecificHelper?: () => void): void;
|
4717
4658
|
/**
|
4718
4659
|
* Checks if pages.appButton capability is supported by the host
|
4719
4660
|
* @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
|
@@ -6880,18 +6821,6 @@ export namespace tasks {
|
|
6880
6821
|
* @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
|
6881
6822
|
*/
|
6882
6823
|
function submitTask(result?: string | object, appIds?: string | string[]): void;
|
6883
|
-
/**
|
6884
|
-
* Converts {@link TaskInfo} to {@link UrlDialogInfo}
|
6885
|
-
* @param taskInfo - TaskInfo object to convert
|
6886
|
-
* @returns - Converted UrlDialogInfo object
|
6887
|
-
*/
|
6888
|
-
function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
|
6889
|
-
/**
|
6890
|
-
* Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
|
6891
|
-
* @param taskInfo - TaskInfo object to convert
|
6892
|
-
* @returns - converted BotUrlDialogInfo object
|
6893
|
-
*/
|
6894
|
-
function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
|
6895
6824
|
/**
|
6896
6825
|
* Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
|
6897
6826
|
* otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}
|
package/dist/MicrosoftTeams.js
CHANGED
@@ -1129,7 +1129,7 @@ __webpack_require__.d(__webpack_exports__, {
|
|
1129
1129
|
});
|
1130
1130
|
|
1131
1131
|
;// CONCATENATED MODULE: ./src/internal/constants.ts
|
1132
|
-
var version = "2.3.
|
1132
|
+
var version = "2.3.1-beta.0";
|
1133
1133
|
/**
|
1134
1134
|
* @hidden
|
1135
1135
|
* The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
|
@@ -3468,31 +3468,13 @@ var pages;
|
|
3468
3468
|
* Limited to Microsoft-internal use
|
3469
3469
|
*/
|
3470
3470
|
function registerFocusEnterHandler(handler) {
|
3471
|
-
|
3472
|
-
|
3473
|
-
|
3474
|
-
|
3475
|
-
|
3471
|
+
registerHandlerHelper('focusEnter', handler, [], function () {
|
3472
|
+
if (!isSupported()) {
|
3473
|
+
throw errorNotSupportedOnPlatform;
|
3474
|
+
}
|
3475
|
+
});
|
3476
3476
|
}
|
3477
3477
|
pages.registerFocusEnterHandler = registerFocusEnterHandler;
|
3478
|
-
/**
|
3479
|
-
* @hidden
|
3480
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerFocusEnterHandler API.
|
3481
|
-
*
|
3482
|
-
* @internal
|
3483
|
-
* Limited to Microsoft-internal use
|
3484
|
-
*
|
3485
|
-
* @param handler - The handler for placing focus within the application.
|
3486
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
3487
|
-
*/
|
3488
|
-
function registerFocusEnterHandlerHelper(handler, versionSpecificHelper) {
|
3489
|
-
ensureInitialized();
|
3490
|
-
if (versionSpecificHelper) {
|
3491
|
-
versionSpecificHelper();
|
3492
|
-
}
|
3493
|
-
registerHandler('focusEnter', handler);
|
3494
|
-
}
|
3495
|
-
pages.registerFocusEnterHandlerHelper = registerFocusEnterHandlerHelper;
|
3496
3478
|
/**
|
3497
3479
|
* Sets/Updates the current frame with new information
|
3498
3480
|
*
|
@@ -3602,31 +3584,13 @@ var pages;
|
|
3602
3584
|
* @param handler - The handler to invoke when the user toggles full-screen view for a tab.
|
3603
3585
|
*/
|
3604
3586
|
function registerFullScreenHandler(handler) {
|
3605
|
-
|
3606
|
-
|
3607
|
-
|
3608
|
-
|
3609
|
-
|
3587
|
+
registerHandlerHelper('fullScreenChange', handler, [], function () {
|
3588
|
+
if (!isSupported()) {
|
3589
|
+
throw errorNotSupportedOnPlatform;
|
3590
|
+
}
|
3591
|
+
});
|
3610
3592
|
}
|
3611
3593
|
pages.registerFullScreenHandler = registerFullScreenHandler;
|
3612
|
-
/**
|
3613
|
-
* @hidden
|
3614
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerFullScreenHandler API.
|
3615
|
-
*
|
3616
|
-
* @internal
|
3617
|
-
* Limited to Microsoft-internal use
|
3618
|
-
*
|
3619
|
-
* @param handler - The handler to invoke when the user toggles full-screen view for a tab.
|
3620
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
3621
|
-
*/
|
3622
|
-
function registerFullScreenHandlerHelper(handler, versionSpecificHelper) {
|
3623
|
-
ensureInitialized();
|
3624
|
-
if (versionSpecificHelper) {
|
3625
|
-
versionSpecificHelper();
|
3626
|
-
}
|
3627
|
-
registerHandler('fullScreenChange', handler);
|
3628
|
-
}
|
3629
|
-
pages.registerFullScreenHandlerHelper = registerFullScreenHandlerHelper;
|
3630
3594
|
/**
|
3631
3595
|
* Checks if the pages capability is supported by the host
|
3632
3596
|
* @returns true if the pages capability is enabled in runtime.supports.pages and
|
@@ -3832,31 +3796,13 @@ var pages;
|
|
3832
3796
|
* @param handler - The handler to invoke when the user clicks on Settings.
|
3833
3797
|
*/
|
3834
3798
|
function registerChangeConfigHandler(handler) {
|
3835
|
-
|
3799
|
+
registerHandlerHelper('changeSettings', handler, [FrameContexts.content], function () {
|
3836
3800
|
if (!isSupported()) {
|
3837
3801
|
throw errorNotSupportedOnPlatform;
|
3838
3802
|
}
|
3839
3803
|
});
|
3840
3804
|
}
|
3841
3805
|
config.registerChangeConfigHandler = registerChangeConfigHandler;
|
3842
|
-
/**
|
3843
|
-
* @hidden
|
3844
|
-
* Undocumented helper function with shared code between deprecated version and current version of the registerConfigChangeHandler API.
|
3845
|
-
*
|
3846
|
-
* @internal
|
3847
|
-
* Limited to Microsoft-internal use
|
3848
|
-
*
|
3849
|
-
* @param handler - The handler to invoke when the user clicks on Settings.
|
3850
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
3851
|
-
*/
|
3852
|
-
function registerChangeConfigHandlerHelper(handler, versionSpecificHelper) {
|
3853
|
-
ensureInitialized(FrameContexts.content);
|
3854
|
-
if (versionSpecificHelper) {
|
3855
|
-
versionSpecificHelper();
|
3856
|
-
}
|
3857
|
-
registerHandler('changeSettings', handler);
|
3858
|
-
}
|
3859
|
-
config.registerChangeConfigHandlerHelper = registerChangeConfigHandlerHelper;
|
3860
3806
|
/**
|
3861
3807
|
* @hidden
|
3862
3808
|
* Hide from docs, since this class is not directly used.
|
@@ -4062,93 +4008,39 @@ var pages;
|
|
4062
4008
|
* @param handler - The handler to invoke when the personal app button is clicked in the app bar.
|
4063
4009
|
*/
|
4064
4010
|
function onClick(handler) {
|
4065
|
-
|
4011
|
+
registerHandlerHelper('appButtonClick', handler, [FrameContexts.content], function () {
|
4066
4012
|
if (!isSupported()) {
|
4067
4013
|
throw errorNotSupportedOnPlatform;
|
4068
4014
|
}
|
4069
4015
|
});
|
4070
4016
|
}
|
4071
4017
|
appButton.onClick = onClick;
|
4072
|
-
/**
|
4073
|
-
* @hidden
|
4074
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onClick API.
|
4075
|
-
*
|
4076
|
-
* @internal
|
4077
|
-
* Limited to Microsoft-internal use
|
4078
|
-
*
|
4079
|
-
* @param handler - The handler to invoke when the personal app button is clicked in the app bar.
|
4080
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4081
|
-
*/
|
4082
|
-
function onClickHelper(handler, versionSpecificHelper) {
|
4083
|
-
ensureInitialized(FrameContexts.content);
|
4084
|
-
if (versionSpecificHelper) {
|
4085
|
-
versionSpecificHelper();
|
4086
|
-
}
|
4087
|
-
registerHandler('appButtonClick', handler);
|
4088
|
-
}
|
4089
|
-
appButton.onClickHelper = onClickHelper;
|
4090
4018
|
/**
|
4091
4019
|
* Registers a handler for entering hover of the app button.
|
4092
4020
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
4093
4021
|
* @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
|
4094
4022
|
*/
|
4095
4023
|
function onHoverEnter(handler) {
|
4096
|
-
|
4024
|
+
registerHandlerHelper('appButtonHoverEnter', handler, [FrameContexts.content], function () {
|
4097
4025
|
if (!isSupported()) {
|
4098
4026
|
throw errorNotSupportedOnPlatform;
|
4099
4027
|
}
|
4100
4028
|
});
|
4101
4029
|
}
|
4102
4030
|
appButton.onHoverEnter = onHoverEnter;
|
4103
|
-
/**
|
4104
|
-
* @hidden
|
4105
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onHoverEnter API.
|
4106
|
-
*
|
4107
|
-
* @internal
|
4108
|
-
* Limited to Microsoft-internal use
|
4109
|
-
*
|
4110
|
-
* @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
|
4111
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4112
|
-
*/
|
4113
|
-
function onHoverEnterHelper(handler, versionSpecificHelper) {
|
4114
|
-
ensureInitialized(FrameContexts.content);
|
4115
|
-
if (versionSpecificHelper) {
|
4116
|
-
versionSpecificHelper();
|
4117
|
-
}
|
4118
|
-
registerHandler('appButtonHoverEnter', handler);
|
4119
|
-
}
|
4120
|
-
appButton.onHoverEnterHelper = onHoverEnterHelper;
|
4121
4031
|
/**
|
4122
4032
|
* Registers a handler for exiting hover of the app button.
|
4123
4033
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
4124
4034
|
* @param handler - The handler to invoke when exiting hover of the personal app button in the app bar.
|
4125
4035
|
*/
|
4126
4036
|
function onHoverLeave(handler) {
|
4127
|
-
|
4037
|
+
registerHandlerHelper('appButtonHoverLeave', handler, [FrameContexts.content], function () {
|
4128
4038
|
if (!isSupported()) {
|
4129
4039
|
throw errorNotSupportedOnPlatform;
|
4130
4040
|
}
|
4131
4041
|
});
|
4132
4042
|
}
|
4133
4043
|
appButton.onHoverLeave = onHoverLeave;
|
4134
|
-
/**
|
4135
|
-
* @hidden
|
4136
|
-
* Undocumented helper function with shared code between deprecated version and current version of the onHoverLeave API.
|
4137
|
-
*
|
4138
|
-
* @internal
|
4139
|
-
* Limited to Microsoft-internal use
|
4140
|
-
*
|
4141
|
-
* @param handler - The handler to invoke when existing hover of the personal app button in the app bar.
|
4142
|
-
* @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
|
4143
|
-
*/
|
4144
|
-
function onHoverLeaveHelper(handler, versionSpecificHelper) {
|
4145
|
-
ensureInitialized(FrameContexts.content);
|
4146
|
-
if (versionSpecificHelper) {
|
4147
|
-
versionSpecificHelper();
|
4148
|
-
}
|
4149
|
-
registerHandler('appButtonHoverLeave', handler);
|
4150
|
-
}
|
4151
|
-
appButton.onHoverLeaveHelper = onHoverLeaveHelper;
|
4152
4044
|
/**
|
4153
4045
|
* Checks if pages.appButton capability is supported by the host
|
4154
4046
|
* @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
|
@@ -4190,6 +4082,7 @@ var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from
|
|
4190
4082
|
|
4191
4083
|
|
4192
4084
|
|
4085
|
+
|
4193
4086
|
var handlersLogger = getLogger('handlers');
|
4194
4087
|
/**
|
4195
4088
|
* @internal
|
@@ -4251,10 +4144,32 @@ function registerHandler(name, handler, sendMessage, args) {
|
|
4251
4144
|
function removeHandler(name) {
|
4252
4145
|
delete HandlersPrivate.handlers[name];
|
4253
4146
|
}
|
4254
|
-
/**
|
4147
|
+
/**
|
4148
|
+
* @internal
|
4149
|
+
* Limited to Microsoft-internal use
|
4150
|
+
*/
|
4255
4151
|
function doesHandlerExist(name) {
|
4256
4152
|
return HandlersPrivate.handlers[name] != null;
|
4257
4153
|
}
|
4154
|
+
/**
|
4155
|
+
* @hidden
|
4156
|
+
* Undocumented helper function with shared code between deprecated version and current version of register*Handler APIs
|
4157
|
+
*
|
4158
|
+
* @internal
|
4159
|
+
* Limited to Microsoft-internal use
|
4160
|
+
*
|
4161
|
+
* @param name - The name of the handler to register.
|
4162
|
+
* @param handler - The handler to invoke.
|
4163
|
+
* @param contexts - The context within which it is valid to register this handler.
|
4164
|
+
* @param registrationHelper - The helper function containing logic pertaining to a specific version of the API.
|
4165
|
+
*/
|
4166
|
+
function registerHandlerHelper(name, handler, contexts, registrationHelper) {
|
4167
|
+
ensureInitialized.apply(void 0, contexts);
|
4168
|
+
if (registrationHelper) {
|
4169
|
+
registrationHelper();
|
4170
|
+
}
|
4171
|
+
registerHandler(name, handler);
|
4172
|
+
}
|
4258
4173
|
/**
|
4259
4174
|
* @internal
|
4260
4175
|
* Limited to Microsoft-internal use
|
@@ -7488,6 +7403,7 @@ var appInitialization;
|
|
7488
7403
|
|
7489
7404
|
|
7490
7405
|
|
7406
|
+
|
7491
7407
|
/**
|
7492
7408
|
* @deprecated
|
7493
7409
|
* As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
|
@@ -7588,7 +7504,7 @@ function registerOnThemeChangeHandler(handler) {
|
|
7588
7504
|
* @param handler - The handler to invoke when the user toggles full-screen view for a tab.
|
7589
7505
|
*/
|
7590
7506
|
function registerFullScreenHandler(handler) {
|
7591
|
-
|
7507
|
+
registerHandlerHelper('fullScreenChange', handler, []);
|
7592
7508
|
}
|
7593
7509
|
/**
|
7594
7510
|
* @deprecated
|
@@ -7600,7 +7516,7 @@ function registerFullScreenHandler(handler) {
|
|
7600
7516
|
* @param handler - The handler to invoke when the personal app button is clicked in the app bar.
|
7601
7517
|
*/
|
7602
7518
|
function registerAppButtonClickHandler(handler) {
|
7603
|
-
|
7519
|
+
registerHandlerHelper('appButtonClick', handler, [FrameContexts.content]);
|
7604
7520
|
}
|
7605
7521
|
/**
|
7606
7522
|
* @deprecated
|
@@ -7612,7 +7528,7 @@ function registerAppButtonClickHandler(handler) {
|
|
7612
7528
|
* @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
|
7613
7529
|
*/
|
7614
7530
|
function registerAppButtonHoverEnterHandler(handler) {
|
7615
|
-
|
7531
|
+
registerHandlerHelper('appButtonHoverEnter', handler, [FrameContexts.content]);
|
7616
7532
|
}
|
7617
7533
|
/**
|
7618
7534
|
* @deprecated
|
@@ -7624,7 +7540,7 @@ function registerAppButtonHoverEnterHandler(handler) {
|
|
7624
7540
|
*
|
7625
7541
|
*/
|
7626
7542
|
function registerAppButtonHoverLeaveHandler(handler) {
|
7627
|
-
|
7543
|
+
registerHandlerHelper('appButtonHoverLeave', handler, [FrameContexts.content]);
|
7628
7544
|
}
|
7629
7545
|
/**
|
7630
7546
|
* @deprecated
|
@@ -7675,7 +7591,7 @@ function registerBeforeUnloadHandler(handler) {
|
|
7675
7591
|
* @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
|
7676
7592
|
*/
|
7677
7593
|
function registerFocusEnterHandler(handler) {
|
7678
|
-
|
7594
|
+
registerHandlerHelper('focusEnter', handler, []);
|
7679
7595
|
}
|
7680
7596
|
/**
|
7681
7597
|
* @deprecated
|
@@ -7686,7 +7602,7 @@ function registerFocusEnterHandler(handler) {
|
|
7686
7602
|
* @param handler - The handler to invoke when the user click on Settings.
|
7687
7603
|
*/
|
7688
7604
|
function registerChangeSettingsHandler(handler) {
|
7689
|
-
|
7605
|
+
registerHandlerHelper('changeSettings', handler, [FrameContexts.content]);
|
7690
7606
|
}
|
7691
7607
|
/**
|
7692
7608
|
* @deprecated
|
@@ -8142,7 +8058,6 @@ var tasks;
|
|
8142
8058
|
};
|
8143
8059
|
return urldialogInfo;
|
8144
8060
|
}
|
8145
|
-
tasks.getUrlDialogInfoFromTaskInfo = getUrlDialogInfoFromTaskInfo;
|
8146
8061
|
/**
|
8147
8062
|
* Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
|
8148
8063
|
* @param taskInfo - TaskInfo object to convert
|
@@ -8161,7 +8076,6 @@ var tasks;
|
|
8161
8076
|
};
|
8162
8077
|
return botUrldialogInfo;
|
8163
8078
|
}
|
8164
|
-
tasks.getBotUrlDialogInfoFromTaskInfo = getBotUrlDialogInfoFromTaskInfo;
|
8165
8079
|
/**
|
8166
8080
|
* Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
|
8167
8081
|
* otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}
|
@@ -8536,8 +8450,11 @@ var files;
|
|
8536
8450
|
* Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
|
8537
8451
|
* 3P provider from the configured policy supported 3P provider list, following which user authentication
|
8538
8452
|
* for selected 3P provider is performed on success of which the selected 3P provider support is added for user
|
8453
|
+
* @beta
|
8539
8454
|
*
|
8540
|
-
* @param callback Callback that will be triggered post add 3P cloud storage provider action
|
8455
|
+
* @param callback Callback that will be triggered post add 3P cloud storage provider action.
|
8456
|
+
* If the error is encountered (and hence passed back), no provider value is sent back.
|
8457
|
+
* For success scenarios, error value will be passed as null and a valid provider value is sent.
|
8541
8458
|
*
|
8542
8459
|
* @internal
|
8543
8460
|
* Limited to Microsoft-internal use
|
@@ -8680,6 +8597,7 @@ var files;
|
|
8680
8597
|
* Hide from docs
|
8681
8598
|
*
|
8682
8599
|
* Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
|
8600
|
+
* @beta
|
8683
8601
|
*
|
8684
8602
|
* @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
|
8685
8603
|
* @param callback Callback that will be triggered post uploading file(s) flow is finished
|
@@ -8698,11 +8616,7 @@ var files;
|
|
8698
8616
|
uploadFileRequest.content.itemList.length > 0)) {
|
8699
8617
|
throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.uploadCloudStorageProviderFile] 3P cloud storage provider request content details are missing');
|
8700
8618
|
}
|
8701
|
-
if (!
|
8702
|
-
(uploadFileRequest.content.providerCode === CloudStorageProvider.SharePoint
|
8703
|
-
? uploadFileRequest.content.destinationFolder.isFolder
|
8704
|
-
: uploadFileRequest.content.destinationFolder.isSubdirectory) &&
|
8705
|
-
uploadFileRequest.content.destinationFolder.objectUrl)) {
|
8619
|
+
if (!uploadFileRequest.content.destinationFolder) {
|
8706
8620
|
throw getSdkError(ErrorCode.INVALID_ARGUMENTS, '[files.uploadCloudStorageProviderFile] Invalid destination folder details');
|
8707
8621
|
}
|
8708
8622
|
sendMessageToParent('files.uploadCloudStorageProviderFile', [uploadFileRequest], callback);
|