@types/office-js 1.0.274 → 1.0.277

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, 31 Aug 2022 17:32:44 GMT
11
+ * Last updated: Fri, 09 Sep 2022 21:02:44 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
  *
@@ -12985,7 +12985,11 @@ declare namespace Office {
12985
12985
  *
12986
12986
  * Apply the following guidelines when you create internet headers in your add-in.
12987
12987
  *
12988
- * - 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}.
12989
12993
  *
12990
12994
  * - Name headers so that you can reuse and update their values later. As such, avoid naming headers in a variable manner
12991
12995
  * (for example, based on user input, timestamp, etc.).
@@ -13076,6 +13080,12 @@ declare namespace Office {
13076
13080
  * the new value.
13077
13081
  *
13078
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}.
13079
13089
  *
13080
13090
  * @remarks
13081
13091
  * [Api set: Mailbox 1.8]
@@ -13099,6 +13109,12 @@ declare namespace Office {
13099
13109
  * the new value.
13100
13110
  *
13101
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}.
13102
13118
  *
13103
13119
  * @remarks
13104
13120
  * [Api set: Mailbox 1.8]
@@ -14948,9 +14964,9 @@ declare namespace Office {
14948
14964
  /**
14949
14965
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14950
14966
  *
14951
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14952
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
14953
- * `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.
14954
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
14955
14971
  * continue in a separate window.
14956
14972
  *
@@ -14979,9 +14995,9 @@ declare namespace Office {
14979
14995
  /**
14980
14996
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14981
14997
  *
14982
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14983
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
14984
- * `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.
14985
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
14986
15002
  * continue in a separate window.
14987
15003
  *
@@ -16133,9 +16149,9 @@ declare namespace Office {
16133
16149
  /**
16134
16150
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16135
16151
  *
16136
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16137
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16138
- * `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.
16139
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
16140
16156
  * continue in a separate window.
16141
16157
  *
@@ -16164,9 +16180,9 @@ declare namespace Office {
16164
16180
  /**
16165
16181
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16166
16182
  *
16167
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16168
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16169
- * `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.
16170
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
16171
16187
  * continue in a separate window.
16172
16188
  *
@@ -18157,7 +18173,7 @@ declare namespace Office {
18157
18173
  * </tr>
18158
18174
  * <tr>
18159
18175
  * <td>office365</td>
18160
- * <td>The mailbox is associated with an Office 365 work or school account.</td>
18176
+ * <td>The mailbox is associated with a Microsoft 365 work or school account.</td>
18161
18177
  * </tr>
18162
18178
  * <tr>
18163
18179
  * <td>outlookCom</td>
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.274",
3
+ "version": "1.0.277",
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": "916f52dc93ca4c42ea21844a3e60c9b40232999634e667cd470340f1f67b9416",
48
+ "typesPublisherContentHash": "260ca3c657efd4c18dd5d8ce31dae12da6a5d8593b0a810b7c2b6e706ef060af",
49
49
  "typeScriptVersion": "4.1"
50
50
  }