@types/office-js 1.0.272 → 1.0.275

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, 22 Aug 2022 23:33:32 GMT
11
+ * Last updated: Thu, 01 Sep 2022 23:02:41 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
@@ -11803,14 +11803,17 @@ declare namespace Office {
11803
11803
  /**
11804
11804
  * Appends on send the specified content to the end of the item body, after any signature.
11805
11805
  *
11806
- * If the user is running add-ins that implement the
11807
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature using `ItemSend` in the manifest},
11808
- * append-on-send runs before on-send functionality.
11809
- *
11810
- * **Important**: If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
11811
- * the `appendOnSendAsync` call returns an error as this scenario is not supported.
11806
+ * To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission. To learn more
11807
+ * about append-on-send and its configuration, see
11808
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
11809
+ *
11810
+ * **Important**: If the {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
11811
+ * is implemented with append-on-send, the following apply.
11812
+ *
11813
+ * - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
11812
11814
  *
11813
- * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
11815
+ * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
11816
+ * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
11814
11817
  *
11815
11818
  * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
11816
11819
  *
@@ -11840,14 +11843,17 @@ declare namespace Office {
11840
11843
  /**
11841
11844
  * Appends on send the specified content to the end of the item body, after any signature.
11842
11845
  *
11843
- * If the user is running add-ins that implement the
11844
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature using `ItemSend` in the manifest},
11845
- * append-on-send runs before on-send functionality.
11846
- *
11847
- * **Important**: If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
11848
- * the `appendOnSendAsync` call returns an error as this scenario is not supported.
11846
+ * To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission. To learn more
11847
+ * about append-on-send and its configuration, see
11848
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
11849
+ *
11850
+ * **Important**: If the {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
11851
+ * is implemented with append-on-send, the following apply.
11852
+ *
11853
+ * - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
11849
11854
  *
11850
- * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
11855
+ * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
11856
+ * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
11851
11857
  *
11852
11858
  * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
11853
11859
  *
@@ -12979,7 +12985,11 @@ declare namespace Office {
12979
12985
  *
12980
12986
  * Apply the following guidelines when you create internet headers in your add-in.
12981
12987
  *
12982
- * - Create the minimum number of headers required.
12988
+ * - Create the minimum number of headers required. The header quota is based on the total size of headers applied to a message. In Exchange Online,
12989
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
12990
+ * For further information on header limits, see
12991
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
12992
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
12983
12993
  *
12984
12994
  * - Name headers so that you can reuse and update their values later. As such, avoid naming headers in a variable manner
12985
12995
  * (for example, based on user input, timestamp, etc.).
@@ -13070,6 +13080,12 @@ declare namespace Office {
13070
13080
  * the new value.
13071
13081
  *
13072
13082
  * **Note**: This method is intended to set the values of your custom headers.
13083
+ *
13084
+ * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13085
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13086
+ * For further information on header limits, see
13087
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13088
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13073
13089
  *
13074
13090
  * @remarks
13075
13091
  * [Api set: Mailbox 1.8]
@@ -13093,6 +13109,12 @@ declare namespace Office {
13093
13109
  * the new value.
13094
13110
  *
13095
13111
  * **Note**: This method is intended to set the values of your custom headers.
13112
+ *
13113
+ * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13114
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13115
+ * For further information on header limits, see
13116
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13117
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13096
13118
  *
13097
13119
  * @remarks
13098
13120
  * [Api set: Mailbox 1.8]
@@ -16581,6 +16603,13 @@ declare namespace Office {
16581
16603
  *
16582
16604
  * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
16583
16605
  *
16606
+ * **Important**:
16607
+ *
16608
+ * - Only one notification of type {@link https://docs.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
16609
+ * is allowed per add-in. Attempting to add more will throw an error.
16610
+ *
16611
+ * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
16612
+ *
16584
16613
  * @remarks
16585
16614
  * [Api set: Mailbox 1.3]
16586
16615
  *
@@ -16603,6 +16632,13 @@ declare namespace Office {
16603
16632
  *
16604
16633
  * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
16605
16634
  *
16635
+ * **Important**:
16636
+ *
16637
+ * - Only one notification of type {@link https://docs.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
16638
+ * is allowed per add-in. Attempting to add more will throw an error.
16639
+ *
16640
+ * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
16641
+ *
16606
16642
  * @remarks
16607
16643
  * [Api set: Mailbox 1.3]
16608
16644
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.272",
3
+ "version": "1.0.275",
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": "f96142c84b8e9890c8c9eaaf80839a994bc12d0da6ce020297f253d70210f51b",
49
- "typeScriptVersion": "4.0"
48
+ "typesPublisherContentHash": "a23e9d16a54ef7b06a0e1f4d77fcc1b51a39a9318a8094012588ca84b2d7027a",
49
+ "typeScriptVersion": "4.1"
50
50
  }