@types/office-js-preview 1.0.598 → 1.0.600

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, 22 May 2025 18:02:31 GMT
11
+ * Last updated: Wed, 28 May 2025 19:32:15 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -10432,7 +10432,12 @@ declare namespace Office {
10432
10432
  *
10433
10433
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10434
10434
  *
10435
- * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
10435
+ * **Important**:
10436
+ *
10437
+ * - To learn about the different types of notification messages you can implement, see
10438
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
10439
+ *
10440
+ * - This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
10436
10441
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10437
10442
  */
10438
10443
  notificationMessages: NotificationMessages;
@@ -12009,7 +12014,12 @@ declare namespace Office {
12009
12014
  *
12010
12015
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12011
12016
  *
12012
- * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12017
+ * **Important**:
12018
+ *
12019
+ * - To learn about the different types of notification messages you can implement, see
12020
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
12021
+ *
12022
+ * - This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12013
12023
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12014
12024
  */
12015
12025
  notificationMessages: NotificationMessages;
@@ -15363,7 +15373,12 @@ declare namespace Office {
15363
15373
  *
15364
15374
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15365
15375
  *
15366
- * **Important**: Only the `getAllAsync` method of the NotificationMessages object is supported.
15376
+ * **Important**:
15377
+ *
15378
+ * - To learn about the different types of notification messages you can implement, see
15379
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
15380
+ *
15381
+ * - Only the `getAllAsync` method of the NotificationMessages object is supported.
15367
15382
  */
15368
15383
  notificationMessages: NotificationMessages;
15369
15384
  /**
@@ -16385,6 +16400,9 @@ declare namespace Office {
16385
16400
  *
16386
16401
  * **Important**:
16387
16402
  *
16403
+ * - To learn about the different types of notification messages you can implement, see
16404
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
16405
+ *
16388
16406
  * - Only the `getAllAsync` method of the NotificationMessages object is supported.
16389
16407
  */
16390
16408
  notificationMessages: NotificationMessages;
@@ -18815,6 +18833,9 @@ declare namespace Office {
18815
18833
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
18816
18834
  *
18817
18835
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
18836
+ *
18837
+ * **Important**: To learn about the different types of notification messages you can implement, see
18838
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
18818
18839
  */
18819
18840
  notificationMessages: NotificationMessages;
18820
18841
  /**
@@ -20553,6 +20574,9 @@ declare namespace Office {
20553
20574
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
20554
20575
  *
20555
20576
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
20577
+ *
20578
+ * **Important**: To learn about the different types of notification messages you can implement, see
20579
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
20556
20580
  */
20557
20581
  notificationMessages: NotificationMessages;
20558
20582
  /**
@@ -21506,6 +21530,9 @@ declare namespace Office {
21506
21530
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21507
21531
  *
21508
21532
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
21533
+ *
21534
+ * **Important**: To learn about the different types of notification messages you can implement, see
21535
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
21509
21536
  */
21510
21537
  interface NotificationMessageDetails {
21511
21538
  /**
@@ -21532,13 +21559,27 @@ declare namespace Office {
21532
21559
  */
21533
21560
  type: MailboxEnums.ItemNotificationMessageType | string;
21534
21561
  /**
21535
- * A reference to an icon that's defined in the manifest. It appears in the infobar area.
21536
- * It's applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
21537
- * Specifying this parameter for an unsupported type results in an exception.
21562
+ * A reference to a custom icon that's defined in the manifest. The icon appears before the notification message in the infobar area.
21563
+ * An icon must be specified for `InformationalMessage` and `InsightMessage` notifications.
21538
21564
  *
21539
21565
  * @remarks
21540
21566
  *
21541
- * **Important**: Currently, the custom icon is only displayed in classic Outlook on Windows.
21567
+ * **Important**:
21568
+ *
21569
+ * - Currently, the custom icon is only displayed in classic Outlook on Windows.
21570
+ *
21571
+ * - A custom icon is only supported in `InformationalMessage` and `InsightMessage` notifications. Specifying an icon for other notification
21572
+ * types results in an exception.
21573
+ *
21574
+ * - If your add-in uses the {@link https://learn.microsoft.com/office/dev/add-ins/develop/add-in-manifests | add-in only manifest}, the icon
21575
+ * must be specified in the {@link https://learn.microsoft.com/javascript/api/manifest/images | Images} element of the
21576
+ * {@link https://learn.microsoft.com/javascript/api/manifest/resources | Resources} section of the manifest.
21577
+ *
21578
+ * - If your add-in uses the {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | unified manifest for Microsoft 365},
21579
+ * you can't currently customize the icon of an `InformationalMessage` or `InsightMessage` notification. The notification uses the first image specified in the
21580
+ * {@link https://learn.microsoft.com/microsoft-365/extensibility/schema/extension-common-icon | "icons"} array of the first
21581
+ * {@link https://learn.microsoft.com/microsoft-365/extensibility/schema/extension-common-custom-group-controls-item | extensions.ribbons.tabs.groups.controls} object
21582
+ * of the manifest. Although this is the case, you must still specify a string in the `icon` property (for example, "icon-16").
21542
21583
  */
21543
21584
  icon?: string;
21544
21585
  /**
@@ -21578,6 +21619,9 @@ declare namespace Office {
21578
21619
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
21579
21620
  *
21580
21621
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
21622
+ *
21623
+ * **Important**: To learn about the different types of notification messages you can implement, see
21624
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/notifications | Create notifications for your Outlook add-in}.
21581
21625
  */
21582
21626
  interface NotificationMessages {
21583
21627
  /**
@@ -139431,7 +139475,7 @@ declare namespace PowerPoint {
139431
139475
  */
139432
139476
  readonly tags: PowerPoint.TagCollection;
139433
139477
  /**
139434
- * Returns the text frame object of this shape.
139478
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
139435
139479
  *
139436
139480
  * @remarks
139437
139481
  * [Api set: PowerPointApi 1.4]
@@ -143101,7 +143145,7 @@ declare namespace PowerPoint {
143101
143145
  */
143102
143146
  placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
143103
143147
  /**
143104
- * For EACH ITEM in the collection: Returns the text frame object of this shape.
143148
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
143105
143149
  *
143106
143150
  * @remarks
143107
143151
  * [Api set: PowerPointApi 1.4]
@@ -143412,7 +143456,7 @@ declare namespace PowerPoint {
143412
143456
  */
143413
143457
  placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
143414
143458
  /**
143415
- * For EACH ITEM in the collection: Returns the text frame object of this shape.
143459
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
143416
143460
  *
143417
143461
  * @remarks
143418
143462
  * [Api set: PowerPointApi 1.5]
@@ -143788,7 +143832,7 @@ declare namespace PowerPoint {
143788
143832
  */
143789
143833
  placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
143790
143834
  /**
143791
- * Returns the text frame object of this shape.
143835
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
143792
143836
  *
143793
143837
  * @remarks
143794
143838
  * [Api set: PowerPointApi 1.4]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.598",
3
+ "version": "1.0.600",
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",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "40dad4b49ba22e299374e6fec5de53d9dc37740f27015c536c5d65daa58fcde3",
49
+ "typesPublisherContentHash": "c98b8f81caaf434f097a1780aceaaaf156d3673ddad55c2124dcdc4cbe014b86",
50
50
  "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }