@types/office-js 1.0.488 → 1.0.489

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, 07 Apr 2025 19:02:16 GMT
11
+ * Last updated: Mon, 14 Apr 2025 18:02:23 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -10368,6 +10368,9 @@ declare namespace Office {
10368
10368
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
10369
10369
  *
10370
10370
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10371
+ *
10372
+ * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
10373
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10371
10374
  */
10372
10375
  notificationMessages: NotificationMessages;
10373
10376
  /**
@@ -11933,6 +11936,9 @@ declare namespace Office {
11933
11936
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
11934
11937
  *
11935
11938
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11939
+ *
11940
+ * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11941
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11936
11942
  */
11937
11943
  notificationMessages: NotificationMessages;
11938
11944
  /**
@@ -21089,21 +21095,30 @@ declare namespace Office {
21089
21095
  /**
21090
21096
  * Specifies the `ItemNotificationMessageType` of message.
21091
21097
  *
21092
- * If type is `ProgressIndicator` or `ErrorMessage`, an icon is automatically supplied
21093
- * and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages.
21098
+ * @remarks
21099
+ *
21100
+ * **Important**:
21101
+ *
21102
+ * - For the `ProgressIndicator` or `ErrorMessage` types, an icon is automatically supplied
21103
+ * and the message isn't persistent. Therefore, the icon and persistent properties aren't valid for these types of messages.
21094
21104
  * Including them will result in an `ArgumentException`.
21095
21105
  *
21096
- * If type is `ProgressIndicator`, the developer should remove or replace the progress indicator when the action is complete.
21097
- *
21098
- * **Important**: Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21106
+ * - For the `ProgressIndicator` type, you should remove or replace the progress indicator when the action is complete.
21107
+ *
21108
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21109
+ *
21110
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21111
+ * all use the same style. The notification message is always prefixed with an informational icon.
21099
21112
  */
21100
21113
  type: MailboxEnums.ItemNotificationMessageType | string;
21101
21114
  /**
21102
- * A reference to an icon that is defined in the manifest. It appears in the infobar area.
21103
- * It is applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
21115
+ * A reference to an icon that's defined in the manifest. It appears in the infobar area.
21116
+ * It's applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
21104
21117
  * Specifying this parameter for an unsupported type results in an exception.
21105
21118
  *
21106
- * **Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g., Mac, web browser).
21119
+ * @remarks
21120
+ *
21121
+ * **Important**: Currently, the custom icon is only displayed in classic Outlook on Windows.
21107
21122
  */
21108
21123
  icon?: string;
21109
21124
  /**
@@ -21148,8 +21163,6 @@ declare namespace Office {
21148
21163
  /**
21149
21164
  * Adds a notification to an item.
21150
21165
  *
21151
- * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
21152
- *
21153
21166
  * @remarks
21154
21167
  * [Api set: Mailbox 1.3]
21155
21168
  *
@@ -21159,13 +21172,20 @@ declare namespace Office {
21159
21172
  *
21160
21173
  * **Important**:
21161
21174
  *
21175
+ * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
21176
+ * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
21177
+ * Setting an additional notification replaces the previous one.
21178
+ *
21162
21179
  * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
21163
21180
  * is allowed per add-in. Attempting to add more will throw an error.
21164
21181
  *
21165
21182
  * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
21166
21183
  * you can add an `InsightMessage` notification only in Compose mode.
21167
21184
  *
21168
- * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21185
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21186
+ *
21187
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21188
+ * all use the same style. The notification message is always prefixed with an informational icon.
21169
21189
  *
21170
21190
  * @param key - A developer-specified key used to reference this notification message.
21171
21191
  * Developers can use it to modify this message later. It can't be longer than 32 characters.
@@ -21180,8 +21200,6 @@ declare namespace Office {
21180
21200
  /**
21181
21201
  * Adds a notification to an item.
21182
21202
  *
21183
- * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
21184
- *
21185
21203
  * @remarks
21186
21204
  * [Api set: Mailbox 1.3]
21187
21205
  *
@@ -21191,13 +21209,20 @@ declare namespace Office {
21191
21209
  *
21192
21210
  * **Important**:
21193
21211
  *
21212
+ * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
21213
+ * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
21214
+ * Setting an additional notification replaces the previous one.
21215
+ *
21194
21216
  * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
21195
21217
  * is allowed per add-in. Attempting to add more will throw an error.
21196
21218
  *
21197
21219
  * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
21198
21220
  * you can add an `InsightMessage` notification only in Compose mode.
21199
21221
  *
21200
- * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21222
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21223
+ *
21224
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21225
+ * all use the same style. The notification message is always prefixed with an informational icon.
21201
21226
  *
21202
21227
  * @param key - A developer-specified key used to reference this notification message.
21203
21228
  * Developers can use it to modify this message later. It can't be longer than 32 characters.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.488",
3
+ "version": "1.0.489",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "1d24d351aa7b6886e9d7f10fbcb04bf1a82118294145d41110ee4c7a2c6a4c6e",
49
+ "typesPublisherContentHash": "baef25f87a885143e94e10938b818e7528f5520c6e1aff719d3b78361dd91333",
50
50
  "typeScriptVersion": "5.1"
51
51
  }