@types/office-js-preview 1.0.451 → 1.0.453

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-preview (https://github.com
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: Thu, 08 Feb 2024 22:06:43 GMT
11
+ * Last updated: Tue, 13 Feb 2024 22:07:06 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -948,11 +948,11 @@ declare namespace Office {
948
948
  */
949
949
  officeTheme: OfficeTheme;
950
950
  /**
951
- * Gets a partition key for local storage. Add-ins should use this key as the location to securely store data.
951
+ * Gets a partition key for local storage. Add-ins should use this partition key as part of the storage key to securely store data. The partition key is `undefined` in environments without partitioning, such as the browser controls for Windows applications.
952
952
  *
953
953
  * @remarks
954
954
  *
955
- * The hashed value of the UserPrincipalName (UPN) for the add-in's current partition.
955
+ * See the article {@link https://learn.microsoft.com/office/dev/add-ins/develop/persisting-add-in-state-and-settings | Persist add-in state and settings} for more information.
956
956
  */
957
957
  partitionKey: string;
958
958
  /**
@@ -2376,18 +2376,10 @@ declare namespace Office {
2376
2376
  *
2377
2377
  * Only task pane add-ins for Outlook support Mailbox API set event types.
2378
2378
  *
2379
- * @remarks
2380
- *
2381
- * **`BindingDataChanged` and `BindingSelectionChanged` applications**: Excel, Word.
2382
- *
2383
2379
  */
2384
2380
  enum EventType {
2385
2381
  /**
2386
- * A Document.ActiveViewChanged event was raised in PowerPoint.
2387
- *
2388
- * @remarks
2389
- *
2390
- * **Applications**: PowerPoint
2382
+ * A `Document.ActiveViewChanged` event was raised in PowerPoint.
2391
2383
  */
2392
2384
  ActiveViewChanged,
2393
2385
  /**
@@ -2412,22 +2404,17 @@ declare namespace Office {
2412
2404
  */
2413
2405
  AttachmentsChanged,
2414
2406
  /**
2415
- * Occurs when data within the binding is changed.
2407
+ * Occurs when data within the binding is changed in Excel or Word.
2408
+ *
2416
2409
  * To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object.
2417
2410
  * The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}.
2418
- *
2419
- * @remarks
2420
- *
2421
- * **Applications**: Excel, Word
2422
2411
  */
2423
2412
  BindingDataChanged,
2424
2413
  /**
2425
- * Occurs when the selection is changed within the binding. To add an event handler for the BindingSelectionChanged event of a binding, use
2426
- * the addHandlerAsync method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
2427
- *
2428
- * @remarks
2429
- *
2430
- * **Applications**: Excel, Word
2414
+ * Occurs when the selection is changed within the binding in Excel or Word.
2415
+ *
2416
+ * To add an event handler for the `BindingSelectionChanged` event of a binding, use
2417
+ * the `addHandlerAsync` method of the `Binding` object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
2431
2418
  */
2432
2419
  BindingSelectionChanged,
2433
2420
  /**
@@ -2443,11 +2430,7 @@ declare namespace Office {
2443
2430
  */
2444
2431
  DialogParentMessageReceived,
2445
2432
  /**
2446
- * Triggers when a document-level selection happens.
2447
- *
2448
- * @remarks
2449
- *
2450
- * **Applications**: Excel, Word
2433
+ * Triggers when a document-level selection happens in Excel or Word.
2451
2434
  */
2452
2435
  DocumentSelectionChanged,
2453
2436
  /**
@@ -2484,15 +2467,15 @@ declare namespace Office {
2484
2467
  */
2485
2468
  ItemChanged,
2486
2469
  /**
2487
- * Triggers when a customXmlPart node is deleted.
2470
+ * Triggers when a `customXmlPart` node is deleted.
2488
2471
  */
2489
2472
  NodeDeleted,
2490
2473
  /**
2491
- * Triggers when a customXmlPart node is inserted.
2474
+ * Triggers when a `customXmlPart` node is inserted.
2492
2475
  */
2493
2476
  NodeInserted,
2494
2477
  /**
2495
- * Triggers when a customXmlPart node is replaced.
2478
+ * Triggers when a `customXmlPart` node is replaced.
2496
2479
  */
2497
2480
  NodeReplaced,
2498
2481
  /**
@@ -2509,7 +2492,7 @@ declare namespace Office {
2509
2492
  OfficeThemeChanged,
2510
2493
  /**
2511
2494
  * Occurs when the recipient list of the selected item or the appointment location is changed in Outlook.
2512
- * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
2495
+ * **Important**: Only available with task pane implementation.
2513
2496
  *
2514
2497
  * To add an event handler for the `RecipientsChanged` event, use the `addHandlerAsync` method of the `Item` object.
2515
2498
  * The event handler receives an argument of type
@@ -2520,7 +2503,7 @@ declare namespace Office {
2520
2503
  RecipientsChanged,
2521
2504
  /**
2522
2505
  * Occurs when the recurrence pattern of the selected series is changed in Outlook.
2523
- * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
2506
+ * **Important**: Only available with task pane implementation.
2524
2507
  *
2525
2508
  * To add an event handler for the `RecurrenceChanged` event, use the `addHandlerAsync` method of the `Item` object.
2526
2509
  * The event handler receives an argument of type
@@ -2554,11 +2537,7 @@ declare namespace Office {
2554
2537
  */
2555
2538
  SensitivityLabelChanged,
2556
2539
  /**
2557
- * A Settings.settingsChanged event was raised.
2558
- *
2559
- * @remarks
2560
- *
2561
- * **Applications**: Excel, PowerPoint, Word
2540
+ * A `Settings.settingsChanged` event was raised in Excel, PowerPoint, or Word.
2562
2541
  */
2563
2542
  SettingsChanged,
2564
2543
  /**
@@ -12479,29 +12458,33 @@ declare namespace Office {
12479
12458
  size: number;
12480
12459
  }
12481
12460
  /**
12482
- * Provides information about the attachments that raised the `Office.EventType.AttachmentsChanged` event.
12461
+ * Provides information about an attachment on a mail item that raised the
12462
+ * `Office.EventType.AttachmentsChanged` event.
12483
12463
  *
12484
12464
  * @remarks
12485
12465
  * [Api set: Mailbox 1.8]
12486
12466
  */
12487
12467
  export interface AttachmentsChangedEventArgs {
12488
12468
  /**
12489
- * Represents the set of attachments that were added or removed.
12490
- * For each such attachment, gets `id`, `name`, `size`, and `attachmentType` properties.
12469
+ * Gets the object that represents the attachment that was added or removed from
12470
+ * a mail item. The object contains the `id`, `name`, `size`, and `attachmentType` properties
12471
+ * of the attachment.
12491
12472
  *
12492
12473
  * @remarks
12493
12474
  * [Api set: Mailbox 1.8]
12494
12475
  */
12495
- attachmentDetails: object[];
12476
+ attachmentDetails: object;
12496
12477
  /**
12497
- * Gets whether the attachments were added or removed. For details, refer to {@link Office.MailboxEnums.AttachmentStatus | MailboxEnums.AttachmentStatus}.
12478
+ * Specifies whether the attachment was added or removed from a mail item. For details, see
12479
+ * {@link Office.MailboxEnums.AttachmentStatus | MailboxEnums.AttachmentStatus}.
12498
12480
  *
12499
12481
  * @remarks
12500
12482
  * [Api set: Mailbox 1.8]
12501
12483
  */
12502
12484
  attachmentStatus: MailboxEnums.AttachmentStatus | string;
12503
12485
  /**
12504
- * Gets the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
12486
+ * Gets the type of event that was raised. For details, see
12487
+ * {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
12505
12488
  *
12506
12489
  * @remarks
12507
12490
  * [Api set: Mailbox 1.8]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.451",
3
+ "version": "1.0.453",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "67fdd2c1d675174f079d74bef663aaab67ecd18f21046e00e7ce6bacc386c92f",
48
+ "typesPublisherContentHash": "9b7302439bb24f20818835b2ede4f9622b21be967348771f55e9e468ba54b326",
49
49
  "typeScriptVersion": "4.6",
50
50
  "nonNpm": true
51
51
  }