@types/office-js 1.0.273 → 1.0.276

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, 29 Aug 2022 23:32:43 GMT
11
+ * Last updated: Fri, 02 Sep 2022 20:32:40 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
@@ -10036,9 +10036,9 @@ declare namespace Office {
10036
10036
  /**
10037
10037
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10038
10038
  *
10039
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
10040
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
10041
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10039
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10040
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10041
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10042
10042
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
10043
10043
  * continue in a separate window.
10044
10044
  *
@@ -10067,9 +10067,9 @@ declare namespace Office {
10067
10067
  /**
10068
10068
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10069
10069
  *
10070
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
10071
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
10072
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10070
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10071
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10072
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10073
10073
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
10074
10074
  * continue in a separate window.
10075
10075
  *
@@ -11249,9 +11249,9 @@ declare namespace Office {
11249
11249
  /**
11250
11250
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11251
11251
  *
11252
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
11253
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
11254
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11252
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11253
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11254
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11255
11255
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
11256
11256
  * continue in a separate window.
11257
11257
  *
@@ -11280,9 +11280,9 @@ declare namespace Office {
11280
11280
  /**
11281
11281
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11282
11282
  *
11283
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
11284
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
11285
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11283
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11284
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11285
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11286
11286
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
11287
11287
  * continue in a separate window.
11288
11288
  *
@@ -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]
@@ -14942,9 +14964,9 @@ declare namespace Office {
14942
14964
  /**
14943
14965
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14944
14966
  *
14945
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14946
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
14947
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14967
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
14968
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
14969
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14948
14970
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
14949
14971
  * continue in a separate window.
14950
14972
  *
@@ -14973,9 +14995,9 @@ declare namespace Office {
14973
14995
  /**
14974
14996
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14975
14997
  *
14976
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14977
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
14978
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14998
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
14999
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
15000
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14979
15001
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
14980
15002
  * continue in a separate window.
14981
15003
  *
@@ -16127,9 +16149,9 @@ declare namespace Office {
16127
16149
  /**
16128
16150
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16129
16151
  *
16130
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16131
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16132
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16152
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16153
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16154
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16133
16155
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
16134
16156
  * continue in a separate window.
16135
16157
  *
@@ -16158,9 +16180,9 @@ declare namespace Office {
16158
16180
  /**
16159
16181
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16160
16182
  *
16161
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16162
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16163
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16183
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16184
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16185
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16164
16186
  * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
16165
16187
  * continue in a separate window.
16166
16188
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.273",
3
+ "version": "1.0.276",
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": "259cf2bcde08dabe6367345d9072f2ea044b6315871c61a5a1f63ab3b90bb229",
49
- "typeScriptVersion": "4.0"
48
+ "typesPublisherContentHash": "646499cf357690b9f489be2f72e9d9317f389ff728d06094fa517347ea384bd3",
49
+ "typeScriptVersion": "4.1"
50
50
  }