@types/office-js-preview 1.0.327 → 1.0.330

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.
@@ -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-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 29 Aug 2022 23:32:44 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
 
@@ -10189,9 +10189,9 @@ declare namespace Office {
10189
10189
  /**
10190
10190
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10191
10191
  *
10192
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
10193
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
10194
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10192
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10193
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10194
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10195
10195
  * 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
10196
10196
  * continue in a separate window.
10197
10197
  *
@@ -10220,9 +10220,9 @@ declare namespace Office {
10220
10220
  /**
10221
10221
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10222
10222
  *
10223
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
10224
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
10225
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10223
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10224
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10225
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10226
10226
  * 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
10227
10227
  * continue in a separate window.
10228
10228
  *
@@ -11477,9 +11477,9 @@ declare namespace Office {
11477
11477
  /**
11478
11478
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11479
11479
  *
11480
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
11481
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
11482
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11480
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11481
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11482
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11483
11483
  * 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
11484
11484
  * continue in a separate window.
11485
11485
  *
@@ -11508,9 +11508,9 @@ declare namespace Office {
11508
11508
  /**
11509
11509
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11510
11510
  *
11511
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
11512
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
11513
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11511
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11512
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11513
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11514
11514
  * 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
11515
11515
  * continue in a separate window.
11516
11516
  *
@@ -12078,14 +12078,17 @@ declare namespace Office {
12078
12078
  /**
12079
12079
  * Appends on send the specified content to the end of the item body, after any signature.
12080
12080
  *
12081
- * If the user is running add-ins that implement the
12082
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature using `ItemSend` in the manifest},
12083
- * append-on-send runs before on-send functionality.
12084
- *
12085
- * **Important**: If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
12086
- * the `appendOnSendAsync` call returns an error as this scenario is not supported.
12081
+ * To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission. To learn more
12082
+ * about append-on-send and its configuration, see
12083
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
12084
+ *
12085
+ * **Important**: If the {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
12086
+ * is implemented with append-on-send, the following apply.
12087
+ *
12088
+ * - 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.
12087
12089
  *
12088
- * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
12090
+ * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
12091
+ * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
12089
12092
  *
12090
12093
  * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
12091
12094
  *
@@ -12115,14 +12118,17 @@ declare namespace Office {
12115
12118
  /**
12116
12119
  * Appends on send the specified content to the end of the item body, after any signature.
12117
12120
  *
12118
- * If the user is running add-ins that implement the
12119
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature using `ItemSend` in the manifest},
12120
- * append-on-send runs before on-send functionality.
12121
- *
12122
- * **Important**: If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
12123
- * the `appendOnSendAsync` call returns an error as this scenario is not supported.
12121
+ * To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission. To learn more
12122
+ * about append-on-send and its configuration, see
12123
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
12124
+ *
12125
+ * **Important**: If the {@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
12126
+ * is implemented with append-on-send, the following apply.
12127
+ *
12128
+ * - 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.
12124
12129
  *
12125
- * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
12130
+ * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
12131
+ * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
12126
12132
  *
12127
12133
  * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
12128
12134
  *
@@ -13338,7 +13344,11 @@ declare namespace Office {
13338
13344
  *
13339
13345
  * Apply the following guidelines when you create internet headers in your add-in.
13340
13346
  *
13341
- * - Create the minimum number of headers required.
13347
+ * - 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,
13348
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13349
+ * For further information on header limits, see
13350
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13351
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13342
13352
  *
13343
13353
  * - Name headers so that you can reuse and update their values later. As such, avoid naming headers in a variable manner
13344
13354
  * (for example, based on user input, timestamp, etc.).
@@ -13429,6 +13439,12 @@ declare namespace Office {
13429
13439
  * the new value.
13430
13440
  *
13431
13441
  * **Note**: This method is intended to set the values of your custom headers.
13442
+ *
13443
+ * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13444
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13445
+ * For further information on header limits, see
13446
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13447
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13432
13448
  *
13433
13449
  * @remarks
13434
13450
  * [Api set: Mailbox 1.8]
@@ -13452,6 +13468,12 @@ declare namespace Office {
13452
13468
  * the new value.
13453
13469
  *
13454
13470
  * **Note**: This method is intended to set the values of your custom headers.
13471
+ *
13472
+ * **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
13473
+ * the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
13474
+ * For further information on header limits, see
13475
+ * {@link https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
13476
+ * and {@link https://docs.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
13455
13477
  *
13456
13478
  * @remarks
13457
13479
  * [Api set: Mailbox 1.8]
@@ -15316,9 +15338,9 @@ declare namespace Office {
15316
15338
  /**
15317
15339
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
15318
15340
  *
15319
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
15320
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
15321
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15341
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
15342
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
15343
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15322
15344
  * 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
15323
15345
  * continue in a separate window.
15324
15346
  *
@@ -15347,9 +15369,9 @@ declare namespace Office {
15347
15369
  /**
15348
15370
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
15349
15371
  *
15350
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
15351
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
15352
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15372
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
15373
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
15374
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15353
15375
  * 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
15354
15376
  * continue in a separate window.
15355
15377
  *
@@ -16571,9 +16593,9 @@ declare namespace Office {
16571
16593
  /**
16572
16594
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16573
16595
  *
16574
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16575
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16576
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16596
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16597
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16598
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16577
16599
  * 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
16578
16600
  * continue in a separate window.
16579
16601
  *
@@ -16602,9 +16624,9 @@ declare namespace Office {
16602
16624
  /**
16603
16625
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16604
16626
  *
16605
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16606
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16607
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16627
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16628
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16629
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16608
16630
  * 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
16609
16631
  * continue in a separate window.
16610
16632
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.327",
3
+ "version": "1.0.330",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "784558303982b3ca5b3b7fdb585eca48f6df6323af2cbcb0be92d43944aaaa7a",
49
- "typeScriptVersion": "4.0"
48
+ "typesPublisherContentHash": "02da0d528889632af2e050454a3b6404f621c2ed70d30777c9ec6dd1286e5a1d",
49
+ "typeScriptVersion": "4.1"
50
50
  }