@types/office-js 1.0.331 → 1.0.332

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 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: Mon, 19 Jun 2023 15:02:35 GMT
11
+ * Last updated: Tue, 20 Jun 2023 17:32:40 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
@@ -14633,11 +14633,11 @@ declare namespace Office {
14633
14633
  * @param options - An object literal that contains one or more of the following properties:-
14634
14634
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14635
14635
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14636
- * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
14637
- * `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
14638
- * (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
14636
+ * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages, such as the item ID and subject, are returned as an array of
14637
+ * {@link Office.SelectedItemDetails | SelectedItemDetails} objects in the `asyncResult.value` property. The objects in the array follow the order in which
14638
+ * messages were selected.
14639
14639
  */
14640
- getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
14640
+ getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void): void;
14641
14641
  /**
14642
14642
  * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
14643
14643
  * To learn more about item multi-select, see
@@ -14655,11 +14655,11 @@ declare namespace Office {
14655
14655
  * @param options - An object literal that contains one or more of the following properties:-
14656
14656
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14657
14657
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14658
- * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
14659
- * `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
14660
- * (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
14658
+ * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages, such as the item ID and subject, are returned as an array of
14659
+ * {@link Office.SelectedItemDetails | SelectedItemDetails} objects in the `asyncResult.value` property. The objects in the array follow the order in which
14660
+ * messages were selected.
14661
14661
  */
14662
- getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
14662
+ getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void): void;
14663
14663
  /**
14664
14664
  * Gets a token identifying the user and the Office Add-in.
14665
14665
  *
@@ -18236,6 +18236,34 @@ declare namespace Office {
18236
18236
  */
18237
18237
  set(name: string, value: any): void;
18238
18238
  }
18239
+ /**
18240
+ * Represents the properties of a message that's currently selected in Outlook.
18241
+ *
18242
+ * @remarks
18243
+ * [Api set: Mailbox 1.13]
18244
+ *
18245
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
18246
+ *
18247
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
18248
+ */
18249
+ interface SelectedItemDetails {
18250
+ /**
18251
+ * The Exchange Web Services (EWS) item identifier of the message that's currently selected.
18252
+ */
18253
+ itemId: string;
18254
+ /**
18255
+ * The Outlook mode (`Read` or `Compose`) of the message that's currently selected.
18256
+ */
18257
+ itemMode: string;
18258
+ /**
18259
+ * The type of the item that's currently selected. `Message` is the only supported type at this time.
18260
+ */
18261
+ itemType: MailboxEnums.ItemType | string;
18262
+ /**
18263
+ * The description that appears in the subject field of the message that's currently selected.
18264
+ */
18265
+ subject: string;
18266
+ }
18239
18267
  /**
18240
18268
  * Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
18241
18269
  * {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.331",
3
+ "version": "1.0.332",
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": "5666ed95bccc0a1b1d122dc4303e86ab515d310ef55a6daba6d9362a2551d8cc",
48
+ "typesPublisherContentHash": "61674515026554e09af1050e92f1b97b947a10aa8f521972b005f82f364489cc",
49
49
  "typeScriptVersion": "4.3"
50
50
  }