@types/office-js 1.0.385 → 1.0.386

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: Wed, 24 Apr 2024 21:35:36 GMT
11
+ * Last updated: Tue, 30 Apr 2024 19:36:04 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -13710,7 +13710,15 @@ declare namespace Office {
13710
13710
  * @remarks
13711
13711
  * [Api set: Mailbox 1.8]
13712
13712
  *
13713
- * **Recommended practices**
13713
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
13714
+ *
13715
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13716
+ *
13717
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13718
+ * To learn more about features supported in Outlook on mobile devices, see
13719
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13720
+ *
13721
+ * **Recommended practices**:
13714
13722
  *
13715
13723
  * Currently, internet headers are a finite resource on a user's mailbox. When the quota is exhausted, you can't create any more internet headers
13716
13724
  * on that mailbox, which can result in unexpected behavior from clients that rely on this to function.
@@ -13724,11 +13732,7 @@ declare namespace Office {
13724
13732
  * and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13725
13733
  *
13726
13734
  * - Name headers so that you can reuse and update their values later. As such, avoid naming headers in a variable manner
13727
- * (for example, based on user input, timestamp, etc.).
13728
- *
13729
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
13730
- *
13731
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13735
+ * (for example, based on user input or a timestamp).
13732
13736
  */
13733
13737
  interface InternetHeaders {
13734
13738
  /**
@@ -13744,6 +13748,10 @@ declare namespace Office {
13744
13748
  *
13745
13749
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13746
13750
  *
13751
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13752
+ * To learn more about features supported in Outlook on mobile devices, see
13753
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13754
+ *
13747
13755
  * @param names - The names of the internet headers to be returned.
13748
13756
  * @param options - An object literal that contains one or more of the following properties:-
13749
13757
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13765,6 +13773,10 @@ declare namespace Office {
13765
13773
  *
13766
13774
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13767
13775
  *
13776
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13777
+ * To learn more about features supported in Outlook on mobile devices, see
13778
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13779
+ *
13768
13780
  * @param names - The names of the internet headers to be returned.
13769
13781
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13770
13782
  * `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
@@ -13783,6 +13795,10 @@ declare namespace Office {
13783
13795
  *
13784
13796
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13785
13797
  *
13798
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13799
+ * To learn more about features supported in Outlook on mobile devices, see
13800
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13801
+ *
13786
13802
  * @param names - The names of the internet headers to be removed.
13787
13803
  * @param options - An object literal that contains one or more of the following properties:-
13788
13804
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13802,6 +13818,10 @@ declare namespace Office {
13802
13818
  *
13803
13819
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13804
13820
  *
13821
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13822
+ * To learn more about features supported in Outlook on mobile devices, see
13823
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13824
+ *
13805
13825
  * @param names - The names of the internet headers to be removed.
13806
13826
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13807
13827
  * `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
@@ -13814,12 +13834,6 @@ declare namespace Office {
13814
13834
  * the new value.
13815
13835
  *
13816
13836
  * **Note**: This method is intended to set the values of your custom headers.
13817
- *
13818
- * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13819
- * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13820
- * For further information on header limits, see
13821
- * {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13822
- * and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13823
13837
  *
13824
13838
  * @remarks
13825
13839
  * [Api set: Mailbox 1.8]
@@ -13828,6 +13842,18 @@ declare namespace Office {
13828
13842
  *
13829
13843
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13830
13844
  *
13845
+ * **Important**:
13846
+ *
13847
+ * - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13848
+ * To learn more about features supported in Outlook on mobile devices, see
13849
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13850
+ *
13851
+ * - The header quota is based on the total size of headers applied to a message. In Exchange Online,
13852
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13853
+ * For further information on header limits, see
13854
+ * {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13855
+ * and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13856
+ *
13831
13857
  * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
13832
13858
  * and values being the corresponding header value strings.
13833
13859
  * @param options - An object literal that contains one or more of the following properties:-
@@ -13843,12 +13869,6 @@ declare namespace Office {
13843
13869
  * the new value.
13844
13870
  *
13845
13871
  * **Note**: This method is intended to set the values of your custom headers.
13846
- *
13847
- * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13848
- * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13849
- * For further information on header limits, see
13850
- * {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13851
- * and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13852
13872
  *
13853
13873
  * @remarks
13854
13874
  * [Api set: Mailbox 1.8]
@@ -13857,6 +13877,18 @@ declare namespace Office {
13857
13877
  *
13858
13878
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13859
13879
  *
13880
+ * **Important**:
13881
+ *
13882
+ * - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
13883
+ * To learn more about features supported in Outlook on mobile devices, see
13884
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13885
+ *
13886
+ * - The header quota is based on the total size of headers applied to a message. In Exchange Online,
13887
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13888
+ * For further information on header limits, see
13889
+ * {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13890
+ * and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13891
+ *
13860
13892
  * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
13861
13893
  * and values being the corresponding header value strings.
13862
13894
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -15450,6 +15482,10 @@ declare namespace Office {
15450
15482
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15451
15483
  *
15452
15484
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15485
+ *
15486
+ * **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
15487
+ * To learn more about features supported in Outlook on mobile devices, see
15488
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15453
15489
  */
15454
15490
  internetHeaders: InternetHeaders;
15455
15491
  /**
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.385",
3
+ "version": "1.0.386",
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": "fe80b573392b4dd31910ffccbb83a36149246a638e7668bd14ad5f5652ea2ba9",
48
+ "typesPublisherContentHash": "ffc5507e2940641257d8665f289db32607bb694c6edb463fe923e594745705e9",
49
49
  "typeScriptVersion": "4.7"
50
50
  }