@types/office-js 1.0.263 → 1.0.266
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.
- office-js/README.md +1 -1
- office-js/index.d.ts +74 -36
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 28 Jun 2022 23:32:26 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js/index.d.ts
CHANGED
|
@@ -1459,9 +1459,15 @@ declare namespace Office {
|
|
|
1459
1459
|
*
|
|
1460
1460
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1461
1461
|
*
|
|
1462
|
-
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1463
|
-
*
|
|
1464
1462
|
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1463
|
+
*
|
|
1464
|
+
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1465
|
+
*
|
|
1466
|
+
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from version 2111 (build 14701.20000).
|
|
1467
|
+
* To retrieve an access token in older builds, use
|
|
1468
|
+
* {@link https://docs.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
|
|
1469
|
+
* OfficeRuntime.auth.getAccessToken} instead. For more information, see
|
|
1470
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
|
|
1465
1471
|
*
|
|
1466
1472
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
1467
1473
|
* @returns Promise to the access token.
|
|
@@ -10616,9 +10622,9 @@ declare namespace Office {
|
|
|
10616
10622
|
*
|
|
10617
10623
|
* - Windows: 500 members
|
|
10618
10624
|
*
|
|
10619
|
-
* - Mac: 100 members
|
|
10625
|
+
* - Classic Mac UI: 100 members
|
|
10620
10626
|
*
|
|
10621
|
-
* -
|
|
10627
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10622
10628
|
*
|
|
10623
10629
|
* *Compose mode*
|
|
10624
10630
|
*
|
|
@@ -10654,9 +10660,9 @@ declare namespace Office {
|
|
|
10654
10660
|
*
|
|
10655
10661
|
* - Windows: 500 members
|
|
10656
10662
|
*
|
|
10657
|
-
* - Mac: 100 members
|
|
10663
|
+
* - Classic Mac UI: 100 members
|
|
10658
10664
|
*
|
|
10659
|
-
* -
|
|
10665
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10660
10666
|
*
|
|
10661
10667
|
* *Compose mode*
|
|
10662
10668
|
*
|
|
@@ -10928,9 +10934,9 @@ declare namespace Office {
|
|
|
10928
10934
|
*
|
|
10929
10935
|
* - Windows: 500 members
|
|
10930
10936
|
*
|
|
10931
|
-
* - Mac: 100 members
|
|
10937
|
+
* - Classic Mac UI: 100 members
|
|
10932
10938
|
*
|
|
10933
|
-
* -
|
|
10939
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10934
10940
|
*
|
|
10935
10941
|
* @remarks
|
|
10936
10942
|
*
|
|
@@ -10976,9 +10982,9 @@ declare namespace Office {
|
|
|
10976
10982
|
*
|
|
10977
10983
|
* - Windows: 500 members
|
|
10978
10984
|
*
|
|
10979
|
-
* - Mac: 100 members
|
|
10985
|
+
* - Classic Mac UI: 100 members
|
|
10980
10986
|
*
|
|
10981
|
-
* -
|
|
10987
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10982
10988
|
*
|
|
10983
10989
|
* @remarks
|
|
10984
10990
|
*
|
|
@@ -15551,11 +15557,11 @@ declare namespace Office {
|
|
|
15551
15557
|
*
|
|
15552
15558
|
* - Windows: 500 members
|
|
15553
15559
|
*
|
|
15554
|
-
* - Mac: 100 members
|
|
15560
|
+
* - Classic Mac UI: 100 members
|
|
15555
15561
|
*
|
|
15556
15562
|
* - Web browser: 20 members
|
|
15557
15563
|
*
|
|
15558
|
-
* -
|
|
15564
|
+
* - New Mac UI, Android: No limit
|
|
15559
15565
|
*
|
|
15560
15566
|
* @remarks
|
|
15561
15567
|
*
|
|
@@ -15849,11 +15855,11 @@ declare namespace Office {
|
|
|
15849
15855
|
*
|
|
15850
15856
|
* - Windows: 500 members
|
|
15851
15857
|
*
|
|
15852
|
-
* - Mac: 100 members
|
|
15858
|
+
* - Classic Mac UI: 100 members
|
|
15853
15859
|
*
|
|
15854
15860
|
* - Web browser: 20 members
|
|
15855
15861
|
*
|
|
15856
|
-
* -
|
|
15862
|
+
* - New Mac UI, Android: No limit
|
|
15857
15863
|
*
|
|
15858
15864
|
* @remarks
|
|
15859
15865
|
*
|
|
@@ -16802,9 +16808,9 @@ declare namespace Office {
|
|
|
16802
16808
|
* - Windows: 100 recipients.
|
|
16803
16809
|
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
16804
16810
|
*
|
|
16805
|
-
* - Mac, web browser: 100 recipients
|
|
16811
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
16806
16812
|
*
|
|
16807
|
-
* -
|
|
16813
|
+
* - New Mac UI, Android: No limit
|
|
16808
16814
|
*
|
|
16809
16815
|
* @remarks
|
|
16810
16816
|
* [Api set: Mailbox 1.1]
|
|
@@ -16840,9 +16846,9 @@ declare namespace Office {
|
|
|
16840
16846
|
* - Windows: 100 recipients.
|
|
16841
16847
|
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
16842
16848
|
*
|
|
16843
|
-
* - Mac, web browser: 100 recipients
|
|
16849
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
16844
16850
|
*
|
|
16845
|
-
* -
|
|
16851
|
+
* - New Mac UI, Android: No limit
|
|
16846
16852
|
*
|
|
16847
16853
|
* @remarks
|
|
16848
16854
|
* [Api set: Mailbox 1.1]
|
|
@@ -16866,14 +16872,9 @@ declare namespace Office {
|
|
|
16866
16872
|
* When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
|
|
16867
16873
|
* objects. Collection size limits:
|
|
16868
16874
|
*
|
|
16869
|
-
* - Windows, Mac, web browser: 500 members
|
|
16870
|
-
*
|
|
16871
|
-
* - Other: No limit
|
|
16875
|
+
* - Windows, classic Mac UI, web browser: 500 members
|
|
16872
16876
|
*
|
|
16873
|
-
*
|
|
16874
|
-
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
16875
|
-
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
16876
|
-
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
16877
|
+
* - New Mac UI, Android: No limit
|
|
16877
16878
|
*
|
|
16878
16879
|
* @remarks
|
|
16879
16880
|
* [Api set: Mailbox 1.1]
|
|
@@ -16882,6 +16883,24 @@ declare namespace Office {
|
|
|
16882
16883
|
*
|
|
16883
16884
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
16884
16885
|
*
|
|
16886
|
+
* **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
|
|
16887
|
+
* or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
|
|
16888
|
+
* `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
|
|
16889
|
+
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
16890
|
+
*
|
|
16891
|
+
* **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
|
|
16892
|
+
*
|
|
16893
|
+
* - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
|
|
16894
|
+
*
|
|
16895
|
+
* - A Teams meeting status icon appears before the recipient's name or email address.
|
|
16896
|
+
*
|
|
16897
|
+
* - A semicolon appears after the recipient's name or email address.
|
|
16898
|
+
*
|
|
16899
|
+
* - The recipient's name or email address is underlined or enclosed in a box.
|
|
16900
|
+
*
|
|
16901
|
+
* To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
|
|
16902
|
+
* the auto-complete list.
|
|
16903
|
+
*
|
|
16885
16904
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16886
16905
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
16887
16906
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -16894,14 +16913,9 @@ declare namespace Office {
|
|
|
16894
16913
|
* When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
|
|
16895
16914
|
* objects. Collection size limits:
|
|
16896
16915
|
*
|
|
16897
|
-
* - Windows, Mac, web browser: 500 members
|
|
16898
|
-
*
|
|
16899
|
-
* - Other: No limit
|
|
16916
|
+
* - Windows, classic Mac UI, web browser: 500 members
|
|
16900
16917
|
*
|
|
16901
|
-
*
|
|
16902
|
-
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
16903
|
-
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
16904
|
-
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
16918
|
+
* - New Mac UI, Android: No limit
|
|
16905
16919
|
*
|
|
16906
16920
|
* @remarks
|
|
16907
16921
|
* [Api set: Mailbox 1.1]
|
|
@@ -16910,6 +16924,24 @@ declare namespace Office {
|
|
|
16910
16924
|
*
|
|
16911
16925
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
16912
16926
|
*
|
|
16927
|
+
* **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
|
|
16928
|
+
* or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
|
|
16929
|
+
* `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
|
|
16930
|
+
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
16931
|
+
*
|
|
16932
|
+
* **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
|
|
16933
|
+
*
|
|
16934
|
+
* - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
|
|
16935
|
+
*
|
|
16936
|
+
* - A Teams meeting status icon appears before the recipient's name or email address.
|
|
16937
|
+
*
|
|
16938
|
+
* - A semicolon appears after the recipient's name or email address.
|
|
16939
|
+
*
|
|
16940
|
+
* - The recipient's name or email address is underlined or enclosed in a box.
|
|
16941
|
+
*
|
|
16942
|
+
* To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
|
|
16943
|
+
* the auto-complete list.
|
|
16944
|
+
*
|
|
16913
16945
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16914
16946
|
* of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
|
|
16915
16947
|
*/
|
|
@@ -16929,9 +16961,12 @@ declare namespace Office {
|
|
|
16929
16961
|
*
|
|
16930
16962
|
* Maximum number that can be set:
|
|
16931
16963
|
*
|
|
16932
|
-
* - Windows
|
|
16964
|
+
* - Windows: 100 recipients.
|
|
16965
|
+
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
16966
|
+
*
|
|
16967
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
16933
16968
|
*
|
|
16934
|
-
* -
|
|
16969
|
+
* - New Mac UI, Android: No limit
|
|
16935
16970
|
*
|
|
16936
16971
|
* @remarks
|
|
16937
16972
|
* [Api set: Mailbox 1.1]
|
|
@@ -16967,9 +17002,12 @@ declare namespace Office {
|
|
|
16967
17002
|
*
|
|
16968
17003
|
* Maximum number that can be set:
|
|
16969
17004
|
*
|
|
16970
|
-
* - Windows
|
|
17005
|
+
* - Windows: 100 recipients.
|
|
17006
|
+
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
17007
|
+
*
|
|
17008
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
16971
17009
|
*
|
|
16972
|
-
* -
|
|
17010
|
+
* - New Mac UI, Android: No limit
|
|
16973
17011
|
*
|
|
16974
17012
|
* @remarks
|
|
16975
17013
|
* [Api set: Mailbox 1.1]
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.266",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "0ed2d9c97fc5f0d41dbb1a23226ff853bd56f0cae874222fb3ef74c97248d56f",
|
|
49
49
|
"typeScriptVersion": "4.0"
|
|
50
50
|
}
|