@types/office-js 1.0.212 → 1.0.216
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 +174 -2
- 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: Mon, 01 Nov 2021 17:01:30 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
|
@@ -9503,6 +9503,17 @@ declare namespace Office {
|
|
|
9503
9503
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
9504
9504
|
*/
|
|
9505
9505
|
requiredAttendees: Recipients;
|
|
9506
|
+
/**
|
|
9507
|
+
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
9508
|
+
*
|
|
9509
|
+
* @remarks
|
|
9510
|
+
* [Api set: Mailbox 1.11]
|
|
9511
|
+
*
|
|
9512
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
9513
|
+
*
|
|
9514
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
9515
|
+
*/
|
|
9516
|
+
sessionData: SessionData;
|
|
9506
9517
|
/**
|
|
9507
9518
|
* Gets the id of the series that an instance belongs to.
|
|
9508
9519
|
*
|
|
@@ -14343,6 +14354,17 @@ declare namespace Office {
|
|
|
14343
14354
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14344
14355
|
*/
|
|
14345
14356
|
notificationMessages: NotificationMessages;
|
|
14357
|
+
/**
|
|
14358
|
+
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
14359
|
+
*
|
|
14360
|
+
* @remarks
|
|
14361
|
+
* [Api set: Mailbox 1.11]
|
|
14362
|
+
*
|
|
14363
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
14364
|
+
*
|
|
14365
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14366
|
+
*/
|
|
14367
|
+
sessionData: SessionData;
|
|
14346
14368
|
/**
|
|
14347
14369
|
* Gets the ID of the series that an instance belongs to.
|
|
14348
14370
|
*
|
|
@@ -16648,6 +16670,11 @@ declare namespace Office {
|
|
|
16648
16670
|
*
|
|
16649
16671
|
* - Other: No limit
|
|
16650
16672
|
*
|
|
16673
|
+
* **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
|
|
16674
|
+
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
16675
|
+
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
16676
|
+
* {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
|
|
16677
|
+
*
|
|
16651
16678
|
* @remarks
|
|
16652
16679
|
* [Api set: Mailbox 1.1]
|
|
16653
16680
|
*
|
|
@@ -16670,7 +16697,12 @@ declare namespace Office {
|
|
|
16670
16697
|
* - Windows, Mac, web browser: 500 members
|
|
16671
16698
|
*
|
|
16672
16699
|
* - Other: No limit
|
|
16673
|
-
*
|
|
16700
|
+
*
|
|
16701
|
+
* **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
|
|
16702
|
+
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
16703
|
+
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
16704
|
+
* {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
|
|
16705
|
+
*
|
|
16674
16706
|
* @remarks
|
|
16675
16707
|
* [Api set: Mailbox 1.1]
|
|
16676
16708
|
*
|
|
@@ -17407,6 +17439,143 @@ declare namespace Office {
|
|
|
17407
17439
|
*/
|
|
17408
17440
|
setStartTime(time: string): void;
|
|
17409
17441
|
}
|
|
17442
|
+
/**
|
|
17443
|
+
* Provides methods to manage an item's session data.
|
|
17444
|
+
*
|
|
17445
|
+
* @remarks
|
|
17446
|
+
* [Api set: Mailbox 1.11]
|
|
17447
|
+
*
|
|
17448
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
17449
|
+
*
|
|
17450
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17451
|
+
*/
|
|
17452
|
+
interface SessionData {
|
|
17453
|
+
/**
|
|
17454
|
+
* Clears all session data key-value pairs.
|
|
17455
|
+
*
|
|
17456
|
+
* @remarks
|
|
17457
|
+
* [Api set: Mailbox 1.11]
|
|
17458
|
+
*
|
|
17459
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
17460
|
+
*
|
|
17461
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17462
|
+
*
|
|
17463
|
+
* @param options - An object literal that contains one or more of the following properties.
|
|
17464
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
17465
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17466
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17467
|
+
*/
|
|
17468
|
+
clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17469
|
+
/**
|
|
17470
|
+
* Clears all session data key-value pairs.
|
|
17471
|
+
*
|
|
17472
|
+
* @remarks
|
|
17473
|
+
* [Api set: Mailbox 1.11]
|
|
17474
|
+
*
|
|
17475
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
17476
|
+
*
|
|
17477
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17478
|
+
*
|
|
17479
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17480
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17481
|
+
*/
|
|
17482
|
+
clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17483
|
+
/**
|
|
17484
|
+
* Gets all session data key-value pairs.
|
|
17485
|
+
*
|
|
17486
|
+
* @remarks
|
|
17487
|
+
* [Api set: Mailbox 1.11]
|
|
17488
|
+
*
|
|
17489
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
17490
|
+
*
|
|
17491
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17492
|
+
*
|
|
17493
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17494
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17495
|
+
*/
|
|
17496
|
+
getAllAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17497
|
+
/**
|
|
17498
|
+
* Gets the session data value of the specified key.
|
|
17499
|
+
*
|
|
17500
|
+
* @remarks
|
|
17501
|
+
* [Api set: Mailbox 1.11]
|
|
17502
|
+
*
|
|
17503
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
17504
|
+
*
|
|
17505
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17506
|
+
*
|
|
17507
|
+
* @param name - The session data key.
|
|
17508
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
17509
|
+
* type `Office.AsyncResult`.
|
|
17510
|
+
*/
|
|
17511
|
+
getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17512
|
+
/**
|
|
17513
|
+
* Removes a session data key-value pair.
|
|
17514
|
+
*
|
|
17515
|
+
* @remarks
|
|
17516
|
+
* [Api set: Mailbox 1.11]
|
|
17517
|
+
*
|
|
17518
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
17519
|
+
*
|
|
17520
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17521
|
+
*
|
|
17522
|
+
* @param name - The session data key.
|
|
17523
|
+
* @param options - An object literal that contains one or more of the following properties.
|
|
17524
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
17525
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17526
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17527
|
+
*/
|
|
17528
|
+
removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17529
|
+
/**
|
|
17530
|
+
* Removes a session data key-value pair.
|
|
17531
|
+
*
|
|
17532
|
+
* @remarks
|
|
17533
|
+
* [Api set: Mailbox 1.11]
|
|
17534
|
+
*
|
|
17535
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
17536
|
+
*
|
|
17537
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17538
|
+
*
|
|
17539
|
+
* @param name - The session data key.
|
|
17540
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17541
|
+
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17542
|
+
*/
|
|
17543
|
+
removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17544
|
+
/**
|
|
17545
|
+
* Sets a session data key-value pair.
|
|
17546
|
+
*
|
|
17547
|
+
* @remarks
|
|
17548
|
+
* [Api set: Mailbox 1.11]
|
|
17549
|
+
*
|
|
17550
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
17551
|
+
*
|
|
17552
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17553
|
+
|
|
17554
|
+
* @param name - The session data key.
|
|
17555
|
+
* @param value - The session data value as a string.
|
|
17556
|
+
* @param options - An object literal that contains one or more of the following properties.
|
|
17557
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
17558
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
17559
|
+
* type `Office.AsyncResult`.
|
|
17560
|
+
*/
|
|
17561
|
+
setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17562
|
+
/**
|
|
17563
|
+
* Sets a session data key-value pair.
|
|
17564
|
+
*
|
|
17565
|
+
* @remarks
|
|
17566
|
+
* [Api set: Mailbox 1.11]
|
|
17567
|
+
*
|
|
17568
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
17569
|
+
*
|
|
17570
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17571
|
+
|
|
17572
|
+
* @param name - The session data key.
|
|
17573
|
+
* @param value - The session data value as a string.
|
|
17574
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
17575
|
+
* type `Office.AsyncResult`.
|
|
17576
|
+
*/
|
|
17577
|
+
setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
17578
|
+
}
|
|
17410
17579
|
/**
|
|
17411
17580
|
* Represents the properties of an appointment or message in a shared folder.
|
|
17412
17581
|
*
|
|
@@ -32823,7 +32992,7 @@ declare namespace Excel {
|
|
|
32823
32992
|
* Clears the column filter criteria of the AutoFilter.
|
|
32824
32993
|
*
|
|
32825
32994
|
* @remarks
|
|
32826
|
-
* [Api set:
|
|
32995
|
+
* [Api set: ExcelApi 1.14]
|
|
32827
32996
|
*
|
|
32828
32997
|
* @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
|
|
32829
32998
|
If the index value is not supported(for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
|
|
@@ -74341,6 +74510,9 @@ declare namespace Word {
|
|
|
74341
74510
|
/**
|
|
74342
74511
|
* Gets the collection of paragraph objects in the body. Read-only.
|
|
74343
74512
|
*
|
|
74513
|
+
* **Important**: Paragraphs in tables are not returned for requirement sets 1.1 and 1.2.
|
|
74514
|
+
* From requirement set 1.3, paragraphs in tables are also returned.
|
|
74515
|
+
*
|
|
74344
74516
|
* @remarks
|
|
74345
74517
|
* [Api set: WordApi 1.1]
|
|
74346
74518
|
*/
|
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.216",
|
|
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",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
43
|
+
"typesPublisherContentHash": "9e4c53a0a52ac360362c71060083acd4335d05f0725b64a5f34aca10fc317267",
|
|
44
44
|
"typeScriptVersion": "3.7"
|
|
45
45
|
}
|