@types/office-js-preview 1.0.343 → 1.0.344

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.
@@ -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: Mon, 10 Oct 2022 23:33:18 GMT
11
+ * Last updated: Tue, 11 Oct 2022 17:33:25 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -2275,7 +2275,7 @@ declare namespace Office {
2275
2275
  ActiveViewChanged,
2276
2276
  /**
2277
2277
  * Occurs when any date or time of the selected appointment or series is changed in Outlook.
2278
- * **Important**: Only available with task pane implementation.
2278
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2279
2279
  *
2280
2280
  * To add an event handler for the `AppointmentTimeChanged` event, use the `addHandlerAsync` method of the `Item` object.
2281
2281
  * The event handler receives an argument of type
@@ -2285,7 +2285,7 @@ declare namespace Office {
2285
2285
  */
2286
2286
  AppointmentTimeChanged,
2287
2287
  /**
2288
- * Occurs when an attachment is added to or removed from an item. **Important**: Only available with task pane implementation.
2288
+ * Occurs when an attachment is added to or removed from an item. **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2289
2289
  *
2290
2290
  * To add an event handler for the `AttachmentsChanged` event, use the `addHandlerAsync` method of the `Item` object.
2291
2291
  * The event handler receives an argument of type
@@ -2334,7 +2334,7 @@ declare namespace Office {
2334
2334
  */
2335
2335
  DocumentSelectionChanged,
2336
2336
  /**
2337
- * Occurs when the appointment location is changed in Outlook. **Important**: Only available with task pane implementation.
2337
+ * Occurs when the appointment location is changed in Outlook. **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2338
2338
  *
2339
2339
  * To add an event handler for the `EnhancedLocationsChanged` event, use the `addHandlerAsync` method of the `Item` object.
2340
2340
  * The event handler receives an argument of type
@@ -2348,7 +2348,7 @@ declare namespace Office {
2348
2348
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.notificationmessagedetails#actions | custom action}.
2349
2349
  * Currently, "Dismiss" is the only supported action that fires this event.
2350
2350
  *
2351
- * **Important**: This event is only available with task pane implementation.
2351
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2352
2352
  *
2353
2353
  * To add an event handler for the `InfobarClicked` event, use the `addHandlerAsync` method of the `Item` object.
2354
2354
  * The event handler receives an argument of type
@@ -2359,7 +2359,7 @@ declare namespace Office {
2359
2359
  InfobarClicked,
2360
2360
  /**
2361
2361
  * Occurs when a different Outlook item is selected for viewing while the task pane is pinned.
2362
- * **Important**: Only available with task pane implementation.
2362
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2363
2363
  *
2364
2364
  * To add an event handler for the `ItemChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
2365
2365
  *
@@ -2379,7 +2379,7 @@ declare namespace Office {
2379
2379
  */
2380
2380
  NodeReplaced,
2381
2381
  /**
2382
- * Occurs when the OfficeTheme is changed in Outlook. **Important**: Only available with task pane implementation.
2382
+ * Occurs when the OfficeTheme is changed in Outlook. **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2383
2383
  *
2384
2384
  * To add an event handler for the `OfficeThemeChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
2385
2385
  * The event handler receives an argument of type
@@ -2392,7 +2392,7 @@ declare namespace Office {
2392
2392
  OfficeThemeChanged,
2393
2393
  /**
2394
2394
  * Occurs when the recipient list of the selected item or the appointment location is changed in Outlook.
2395
- * **Important**: Only available with task pane implementation.
2395
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2396
2396
  *
2397
2397
  * To add an event handler for the `RecipientsChanged` event, use the `addHandlerAsync` method of the `Item` object.
2398
2398
  * The event handler receives an argument of type
@@ -2403,7 +2403,7 @@ declare namespace Office {
2403
2403
  RecipientsChanged,
2404
2404
  /**
2405
2405
  * Occurs when the recurrence pattern of the selected series is changed in Outlook.
2406
- * **Important**: Only available with task pane implementation.
2406
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2407
2407
  *
2408
2408
  * To add an event handler for the `RecurrenceChanged` event, use the `addHandlerAsync` method of the `Item` object.
2409
2409
  * The event handler receives an argument of type
@@ -2416,6 +2416,15 @@ declare namespace Office {
2416
2416
  * Triggers when a Resource selection happens in Project.
2417
2417
  */
2418
2418
  ResourceSelectionChanged,
2419
+ /**
2420
+ * Occurs in Outlook when one or more messages are selected or deselected.
2421
+ * **Important**: This event can only be handled in a task pane. It isn't supported in function commands.
2422
+ *
2423
+ * To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
2424
+ *
2425
+ * [Api set: Mailbox preview]
2426
+ */
2427
+ SelectedItemsChanged,
2419
2428
  /**
2420
2429
  * A Settings.settingsChanged event was raised.
2421
2430
  *
@@ -14273,8 +14282,8 @@ declare namespace Office {
14273
14282
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14274
14283
  * `asyncResult`, which is an `Office.AsyncResult` object.
14275
14284
  */
14276
- displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
14277
- /**
14285
+ displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
14286
+ /**
14278
14287
  * Displays a form for creating a new message.
14279
14288
  *
14280
14289
  * The `displayNewMessageForm` method opens a form that enables the user to create a new message. If parameters are specified, the message form
@@ -14540,6 +14549,54 @@ declare namespace Office {
14540
14549
  * @param userContext - Optional. Any state data that is passed to the asynchronous method.
14541
14550
  */
14542
14551
  getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
14552
+ /**
14553
+ * 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.
14554
+ * To learn more about item multi-select, see
14555
+ * [Activate your Outlook add-in on multiple messages (preview)](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select).
14556
+ *
14557
+ * @remarks
14558
+ * [Api set: Mailbox preview]
14559
+ *
14560
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox`
14561
+ *
14562
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
14563
+ *
14564
+ * **Important**: This method only applies to messages.
14565
+ *
14566
+ * @param options - An object literal that contains one or more of the following properties:-
14567
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14568
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14569
+ * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
14570
+ * `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
14571
+ * (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
14572
+ *
14573
+ * @beta
14574
+ */
14575
+ getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
14576
+ /**
14577
+ * 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.
14578
+ * To learn more about item multi-select, see
14579
+ * [Activate your Outlook add-in on multiple messages (preview)](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select).
14580
+ *
14581
+ * @remarks
14582
+ * [Api set: Mailbox preview]
14583
+ *
14584
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox`
14585
+ *
14586
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
14587
+ *
14588
+ * **Important**: This method only applies to messages.
14589
+ *
14590
+ * @param options - An object literal that contains one or more of the following properties:-
14591
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14592
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14593
+ * `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
14594
+ * `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
14595
+ * (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
14596
+ *
14597
+ * @beta
14598
+ */
14599
+ getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
14543
14600
  /**
14544
14601
  * Gets a token identifying the user and the Office Add-in.
14545
14602
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.343",
3
+ "version": "1.0.344",
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": "29a063dd1df28c8e3504d112ca119d534499b9504eab5db9501aae7aed1adfd4",
48
+ "typesPublisherContentHash": "0f62d3659bfc798e0dd6fc089951a2c474e8941003d2e8736d154bf36d55db16",
49
49
  "typeScriptVersion": "4.1"
50
50
  }