@types/office-js-preview 1.0.313 → 1.0.316
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +47 -35
- office-js-preview/package.json +2 -2
office-js-preview/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-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 21 Jun 2022 21:01:37 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -1100,15 +1100,15 @@ declare namespace Office {
|
|
|
1100
1100
|
*/
|
|
1101
1101
|
interface EventCompletedOptions {
|
|
1102
1102
|
/**
|
|
1103
|
-
*
|
|
1103
|
+
* When the completed method is used to signal completion of an event handler,
|
|
1104
1104
|
* this value indicates if the handled event should continue execution or be canceled.
|
|
1105
1105
|
* For example, an add-in that handles the `ItemSend` event can set `allowEvent` to `false` to cancel sending of the message.
|
|
1106
1106
|
*/
|
|
1107
1107
|
allowEvent: boolean;
|
|
1108
1108
|
|
|
1109
1109
|
/**
|
|
1110
|
-
*
|
|
1111
|
-
* this value sets the error message that will be displayed to the user. For an example, refer to
|
|
1110
|
+
* When the completed method is used to signal completion of an event handler and if the `allowEvent` option is set to `false`,
|
|
1111
|
+
* this value sets the error message that will be displayed to the user. For an example, refer to the
|
|
1112
1112
|
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1113
1113
|
*
|
|
1114
1114
|
* [Api set: Mailbox preview]
|
|
@@ -1536,9 +1536,15 @@ declare namespace Office {
|
|
|
1536
1536
|
*
|
|
1537
1537
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1538
1538
|
*
|
|
1539
|
-
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1540
|
-
*
|
|
1541
1539
|
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1540
|
+
*
|
|
1541
|
+
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1542
|
+
*
|
|
1543
|
+
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from version 2111 (build 14701.20000).
|
|
1544
|
+
* To retrieve an access token in older builds, use
|
|
1545
|
+
* {@link https://docs.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
|
|
1546
|
+
* OfficeRuntime.auth.getAccessToken} instead. For more information, see
|
|
1547
|
+
* {@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}.
|
|
1542
1548
|
*
|
|
1543
1549
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
1544
1550
|
* @returns Promise to the access token.
|
|
@@ -10819,9 +10825,9 @@ declare namespace Office {
|
|
|
10819
10825
|
*
|
|
10820
10826
|
* - Windows: 500 members
|
|
10821
10827
|
*
|
|
10822
|
-
* - Mac: 100 members
|
|
10828
|
+
* - Classic Mac UI: 100 members
|
|
10823
10829
|
*
|
|
10824
|
-
* -
|
|
10830
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10825
10831
|
*
|
|
10826
10832
|
* *Compose mode*
|
|
10827
10833
|
*
|
|
@@ -10856,9 +10862,9 @@ declare namespace Office {
|
|
|
10856
10862
|
*
|
|
10857
10863
|
* - Windows: 500 members
|
|
10858
10864
|
*
|
|
10859
|
-
* - Mac: 100 members
|
|
10865
|
+
* - Classic Mac UI: 100 members
|
|
10860
10866
|
*
|
|
10861
|
-
* -
|
|
10867
|
+
* - New Mac UI, web browser, Android: No limit
|
|
10862
10868
|
*
|
|
10863
10869
|
* *Compose mode*
|
|
10864
10870
|
*
|
|
@@ -11141,11 +11147,11 @@ declare namespace Office {
|
|
|
11141
11147
|
* The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
11142
11148
|
* each optional attendee to the meeting. Collection size limits:
|
|
11143
11149
|
*
|
|
11144
|
-
|
|
11145
|
-
|
|
11146
|
-
|
|
11147
|
-
|
|
11148
|
-
|
|
11150
|
+
* - Windows: 500 members
|
|
11151
|
+
*
|
|
11152
|
+
* - Classic Mac UI: 100 members
|
|
11153
|
+
*
|
|
11154
|
+
* - New Mac UI, web browser, Android: No limit
|
|
11149
11155
|
*
|
|
11150
11156
|
* @remarks
|
|
11151
11157
|
*
|
|
@@ -11189,11 +11195,11 @@ declare namespace Office {
|
|
|
11189
11195
|
* The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
11190
11196
|
* each required attendee to the meeting. Collection size limits:
|
|
11191
11197
|
*
|
|
11192
|
-
|
|
11193
|
-
|
|
11194
|
-
|
|
11195
|
-
|
|
11196
|
-
|
|
11198
|
+
* - Windows: 500 members
|
|
11199
|
+
*
|
|
11200
|
+
* - Classic Mac UI: 100 members
|
|
11201
|
+
*
|
|
11202
|
+
* - New Mac UI, web browser, Android: No limit
|
|
11197
11203
|
*
|
|
11198
11204
|
* @remarks
|
|
11199
11205
|
*
|
|
@@ -15995,11 +16001,11 @@ declare namespace Office {
|
|
|
15995
16001
|
*
|
|
15996
16002
|
* - Windows: 500 members
|
|
15997
16003
|
*
|
|
15998
|
-
* - Mac: 100 members
|
|
16004
|
+
* - Classic Mac UI: 100 members
|
|
15999
16005
|
*
|
|
16000
16006
|
* - Web browser: 20 members
|
|
16001
16007
|
*
|
|
16002
|
-
* -
|
|
16008
|
+
* - New Mac UI, Android: No limit
|
|
16003
16009
|
*
|
|
16004
16010
|
* @remarks
|
|
16005
16011
|
*
|
|
@@ -16293,11 +16299,11 @@ declare namespace Office {
|
|
|
16293
16299
|
*
|
|
16294
16300
|
* - Windows: 500 members
|
|
16295
16301
|
*
|
|
16296
|
-
* - Mac: 100 members
|
|
16302
|
+
* - Classic Mac UI: 100 members
|
|
16297
16303
|
*
|
|
16298
16304
|
* - Web browser: 20 members
|
|
16299
16305
|
*
|
|
16300
|
-
* -
|
|
16306
|
+
* - New Mac UI, Android: No limit
|
|
16301
16307
|
*
|
|
16302
16308
|
* @remarks
|
|
16303
16309
|
*
|
|
@@ -17440,9 +17446,9 @@ declare namespace Office {
|
|
|
17440
17446
|
* - Windows: 100 recipients.
|
|
17441
17447
|
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
17442
17448
|
*
|
|
17443
|
-
* - Mac, web browser: 100 recipients
|
|
17449
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
17444
17450
|
*
|
|
17445
|
-
* -
|
|
17451
|
+
* - New Mac UI, Android: No limit
|
|
17446
17452
|
*
|
|
17447
17453
|
* @remarks
|
|
17448
17454
|
* [Api set: Mailbox 1.1]
|
|
@@ -17478,9 +17484,9 @@ declare namespace Office {
|
|
|
17478
17484
|
* - Windows: 100 recipients.
|
|
17479
17485
|
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
17480
17486
|
*
|
|
17481
|
-
* - Mac, web browser: 100 recipients
|
|
17487
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
17482
17488
|
*
|
|
17483
|
-
* -
|
|
17489
|
+
* - New Mac UI, Android: No limit
|
|
17484
17490
|
*
|
|
17485
17491
|
* @remarks
|
|
17486
17492
|
* [Api set: Mailbox 1.1]
|
|
@@ -17504,9 +17510,9 @@ declare namespace Office {
|
|
|
17504
17510
|
* When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
|
|
17505
17511
|
* objects. Collection size limits:
|
|
17506
17512
|
*
|
|
17507
|
-
* - Windows, Mac, web browser: 500 members
|
|
17513
|
+
* - Windows, classic Mac UI, web browser: 500 members
|
|
17508
17514
|
*
|
|
17509
|
-
* -
|
|
17515
|
+
* - New Mac UI, Android: No limit
|
|
17510
17516
|
*
|
|
17511
17517
|
* **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
|
|
17512
17518
|
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
@@ -17532,9 +17538,9 @@ declare namespace Office {
|
|
|
17532
17538
|
* When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
|
|
17533
17539
|
* objects. Collection size limits:
|
|
17534
17540
|
*
|
|
17535
|
-
* - Windows, Mac, web browser: 500 members
|
|
17541
|
+
* - Windows, classic Mac UI, web browser: 500 members
|
|
17536
17542
|
*
|
|
17537
|
-
* -
|
|
17543
|
+
* - New Mac UI, Android: No limit
|
|
17538
17544
|
*
|
|
17539
17545
|
* **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
|
|
17540
17546
|
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
@@ -17567,9 +17573,12 @@ declare namespace Office {
|
|
|
17567
17573
|
*
|
|
17568
17574
|
* Maximum number that can be set:
|
|
17569
17575
|
*
|
|
17570
|
-
* - Windows
|
|
17576
|
+
* - Windows: 100 recipients.
|
|
17577
|
+
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
17578
|
+
*
|
|
17579
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
17571
17580
|
*
|
|
17572
|
-
* -
|
|
17581
|
+
* - New Mac UI, Android: No limit
|
|
17573
17582
|
*
|
|
17574
17583
|
* @remarks
|
|
17575
17584
|
* [Api set: Mailbox 1.1]
|
|
@@ -17605,9 +17614,12 @@ declare namespace Office {
|
|
|
17605
17614
|
*
|
|
17606
17615
|
* Maximum number that can be set:
|
|
17607
17616
|
*
|
|
17608
|
-
* - Windows
|
|
17617
|
+
* - Windows: 100 recipients.
|
|
17618
|
+
* **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
|
|
17619
|
+
*
|
|
17620
|
+
* - Classic Mac UI, web browser: 100 recipients
|
|
17609
17621
|
*
|
|
17610
|
-
* -
|
|
17622
|
+
* - New Mac UI, Android: No limit
|
|
17611
17623
|
*
|
|
17612
17624
|
* @remarks
|
|
17613
17625
|
* [Api set: Mailbox 1.1]
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.316",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "97181eb5028cd9f7645c39c83042f1a4c6872436e0a1fdf72898b6731e3dc2a7",
|
|
49
49
|
"typeScriptVersion": "4.0"
|
|
50
50
|
}
|