@types/office-js 1.0.275 → 1.0.278

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: Thu, 01 Sep 2022 23:02:41 GMT
11
+ * Last updated: Mon, 12 Sep 2022 21:02:42 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
@@ -983,14 +983,14 @@ declare namespace Office {
983
983
  }
984
984
  namespace AddinCommands {
985
985
  /**
986
- * The `Event` object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify
986
+ * The `Event` object is passed as a parameter to add-in functions invoked by function command buttons. The object allows the add-in to identify
987
987
  * which button was clicked and to signal the host that it has completed its processing.
988
988
  *
989
989
  * @remarks
990
990
  *
991
991
  * See {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
992
992
  *
993
- * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
993
+ * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
994
994
  *
995
995
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
996
996
  */
@@ -1006,25 +1006,27 @@ declare namespace Office {
1006
1006
 
1007
1007
  /**
1008
1008
  * Indicates that the add-in has completed processing and will automatically be closed.
1009
- *
1010
- * This method must be called at the end of a function which was invoked by the following.
1011
- *
1012
- * - A UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`)
1009
+ *
1010
+ * This method must be called at the end of a function which was invoked by the following:
1011
+ *
1012
+ * - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
1013
+ *
1014
+ * - An event defined in the {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
1015
+ * For example, an `OnMessageSend` event.
1013
1016
  *
1014
1017
  * - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
1015
- * {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
1016
- * e.g., an `ItemSend` event
1017
- *
1018
- * [Api set: Mailbox 1.3]
1018
+ * {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
1019
1019
  *
1020
1020
  * @remarks
1021
+ *
1022
+ * [Api set: Mailbox 1.3]
1021
1023
  *
1022
1024
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted`
1023
- *
1025
+ *
1024
1026
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
1025
- *
1027
+ *
1026
1028
  * **Note**: The `options` parameter was introduced in Mailbox 1.8.
1027
- *
1029
+ *
1028
1030
  * @param options Optional. An object that specifies behavior options for when the event is completed.
1029
1031
  */
1030
1032
  completed(options?: EventCompletedOptions): void;
@@ -1035,11 +1037,37 @@ declare namespace Office {
1035
1037
  */
1036
1038
  interface EventCompletedOptions {
1037
1039
  /**
1038
- * When the completed method is used to signal completion of an event handler,
1039
- * this value indicates if the handled event should continue execution or be canceled.
1040
- * For example, an add-in that handles the `ItemSend` event can set `allowEvent` to `false` to cancel sending of the message.
1040
+ * When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1041
+ * is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
1042
+ * For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
1043
+ * sending of an item. For a complete sample, see the
1044
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
1045
+ *
1046
+ * @remarks
1047
+ *
1048
+ * [Api set: Mailbox 1.8]
1049
+ *
1050
+ * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
1051
+ *
1052
+ * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
1041
1053
  */
1042
1054
  allowEvent: boolean;
1055
+
1056
+ /**
1057
+ * When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1058
+ * is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
1059
+ * that will be displayed to the user. For an example, see the
1060
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
1061
+ *
1062
+ * @remarks
1063
+ *
1064
+ * [Api set: Mailbox 1.12]
1065
+ *
1066
+ * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
1067
+ *
1068
+ * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
1069
+ */
1070
+ errorMessage?: string;
1043
1071
  }
1044
1072
 
1045
1073
  /**
@@ -9468,7 +9496,7 @@ declare namespace Office {
9468
9496
  *
9469
9497
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
9470
9498
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
9471
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
9499
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
9472
9500
  *
9473
9501
  * Child interfaces:
9474
9502
  *
@@ -9483,7 +9511,7 @@ declare namespace Office {
9483
9511
  *
9484
9512
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
9485
9513
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
9486
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
9514
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
9487
9515
  *
9488
9516
  * Parent interfaces:
9489
9517
  *
@@ -9868,7 +9896,7 @@ declare namespace Office {
9868
9896
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
9869
9897
  *
9870
9898
  * For supported events, refer to the Item object model
9871
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
9899
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
9872
9900
  *
9873
9901
  * @remarks
9874
9902
  * [Api set: Mailbox 1.7]
@@ -9890,7 +9918,7 @@ declare namespace Office {
9890
9918
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
9891
9919
  *
9892
9920
  * For supported events, refer to the Item object model
9893
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
9921
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
9894
9922
  *
9895
9923
  * @remarks
9896
9924
  * [Api set: Mailbox 1.7]
@@ -10036,9 +10064,9 @@ declare namespace Office {
10036
10064
  /**
10037
10065
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10038
10066
  *
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.
10067
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10068
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10069
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10042
10070
  * 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
10071
  * continue in a separate window.
10044
10072
  *
@@ -10067,9 +10095,9 @@ declare namespace Office {
10067
10095
  /**
10068
10096
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10069
10097
  *
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.
10098
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10099
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10100
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
10073
10101
  * 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
10102
  * continue in a separate window.
10075
10103
  *
@@ -10392,7 +10420,7 @@ declare namespace Office {
10392
10420
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
10393
10421
  *
10394
10422
  * For supported events, refer to the Item object model
10395
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10423
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
10396
10424
  *
10397
10425
  * @remarks
10398
10426
  * [Api set: Mailbox 1.7]
@@ -10412,7 +10440,7 @@ declare namespace Office {
10412
10440
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
10413
10441
  *
10414
10442
  * For supported events, refer to the Item object model
10415
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10443
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
10416
10444
  *
10417
10445
  * @remarks
10418
10446
  * [Api set: Mailbox 1.7]
@@ -10737,7 +10765,7 @@ declare namespace Office {
10737
10765
  *
10738
10766
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10739
10767
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10740
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
10768
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
10741
10769
  *
10742
10770
  * Parent interfaces:
10743
10771
  *
@@ -11057,7 +11085,7 @@ declare namespace Office {
11057
11085
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11058
11086
  *
11059
11087
  * For supported events, refer to the Item object model
11060
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11088
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
11061
11089
  *
11062
11090
  * @remarks
11063
11091
  * [Api set: Mailbox 1.7]
@@ -11079,7 +11107,7 @@ declare namespace Office {
11079
11107
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
11080
11108
  *
11081
11109
  * For supported events, refer to the Item object model
11082
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11110
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
11083
11111
  *
11084
11112
  * @remarks
11085
11113
  * [Api set: Mailbox 1.7]
@@ -11249,9 +11277,9 @@ declare namespace Office {
11249
11277
  /**
11250
11278
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11251
11279
  *
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.
11280
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11281
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11282
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11255
11283
  * 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
11284
  * continue in a separate window.
11257
11285
  *
@@ -11280,9 +11308,9 @@ declare namespace Office {
11280
11308
  /**
11281
11309
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
11282
11310
  *
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.
11311
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
11312
+ * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
11313
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
11286
11314
  * 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
11315
  * continue in a separate window.
11288
11316
  *
@@ -11568,7 +11596,7 @@ declare namespace Office {
11568
11596
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11569
11597
  *
11570
11598
  * For supported events, refer to the Item object model
11571
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11599
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
11572
11600
  *
11573
11601
  * @remarks
11574
11602
  * [Api set: Mailbox 1.7]
@@ -11588,7 +11616,7 @@ declare namespace Office {
11588
11616
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11589
11617
  *
11590
11618
  * For supported events, refer to the Item object model
11591
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11619
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
11592
11620
  *
11593
11621
  * @remarks
11594
11622
  * [Api set: Mailbox 1.7]
@@ -13135,7 +13163,7 @@ declare namespace Office {
13135
13163
  * You can determine the type of the item by using the `itemType` property.
13136
13164
  *
13137
13165
  * To see the full member list, refer to the
13138
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13166
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
13139
13167
  *
13140
13168
  * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
13141
13169
  *
@@ -13160,7 +13188,7 @@ declare namespace Office {
13160
13188
  *
13161
13189
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
13162
13190
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
13163
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13191
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
13164
13192
  *
13165
13193
  * Child interfaces:
13166
13194
  *
@@ -13175,7 +13203,7 @@ declare namespace Office {
13175
13203
  *
13176
13204
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
13177
13205
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
13178
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13206
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
13179
13207
  *
13180
13208
  * Child interfaces:
13181
13209
  *
@@ -13496,7 +13524,7 @@ declare namespace Office {
13496
13524
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
13497
13525
  *
13498
13526
  * For supported events, refer to the Mailbox object model
13499
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
13527
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
13500
13528
  *
13501
13529
  * @remarks
13502
13530
  * [Api set: Mailbox 1.5]
@@ -13517,7 +13545,7 @@ declare namespace Office {
13517
13545
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
13518
13546
  *
13519
13547
  * For supported events, refer to the Mailbox object model
13520
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
13548
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
13521
13549
  *
13522
13550
  * @remarks
13523
13551
  * [Api set: Mailbox 1.5]
@@ -14220,7 +14248,7 @@ declare namespace Office {
14220
14248
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
14221
14249
  *
14222
14250
  * For supported events, refer to the Mailbox object model
14223
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
14251
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
14224
14252
  *
14225
14253
  * @remarks
14226
14254
  * [Api set: Mailbox 1.5]
@@ -14239,7 +14267,7 @@ declare namespace Office {
14239
14267
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
14240
14268
  *
14241
14269
  * For supported events, refer to the Mailbox object model
14242
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
14270
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
14243
14271
  *
14244
14272
  * @remarks
14245
14273
  * [Api set: Mailbox 1.5]
@@ -14431,7 +14459,7 @@ declare namespace Office {
14431
14459
  *
14432
14460
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
14433
14461
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
14434
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
14462
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
14435
14463
  *
14436
14464
  * Child interfaces:
14437
14465
  *
@@ -14446,7 +14474,7 @@ declare namespace Office {
14446
14474
  *
14447
14475
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
14448
14476
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
14449
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
14477
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
14450
14478
  *
14451
14479
  * Parent interfaces:
14452
14480
  *
@@ -14798,7 +14826,7 @@ declare namespace Office {
14798
14826
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
14799
14827
  *
14800
14828
  * For supported events, refer to the Item object model
14801
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
14829
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
14802
14830
  *
14803
14831
  * @remarks
14804
14832
  * [Api set: Mailbox 1.7]
@@ -14820,7 +14848,7 @@ declare namespace Office {
14820
14848
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
14821
14849
  *
14822
14850
  * For supported events, refer to the Item object model
14823
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
14851
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
14824
14852
  *
14825
14853
  * @remarks
14826
14854
  * [Api set: Mailbox 1.7]
@@ -14964,9 +14992,9 @@ declare namespace Office {
14964
14992
  /**
14965
14993
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14966
14994
  *
14967
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14968
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
14969
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14995
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
14996
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
14997
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
14970
14998
  * 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
14971
14999
  * continue in a separate window.
14972
15000
  *
@@ -14995,9 +15023,9 @@ declare namespace Office {
14995
15023
  /**
14996
15024
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
14997
15025
  *
14998
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
14999
- * the identifier to retrieve an attachment in the same session that the attachment IDs were retrieved with the `getAttachmentsAsync` or
15000
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15026
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
15027
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
15028
+ * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
15001
15029
  * 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
15002
15030
  * continue in a separate window.
15003
15031
  *
@@ -15380,7 +15408,7 @@ declare namespace Office {
15380
15408
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
15381
15409
  *
15382
15410
  * For supported events, refer to the Item object model
15383
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15411
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
15384
15412
  *
15385
15413
  * @remarks
15386
15414
  * [Api set: Mailbox 1.7]
@@ -15400,7 +15428,7 @@ declare namespace Office {
15400
15428
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
15401
15429
  *
15402
15430
  * For supported events, refer to the Item object model
15403
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15431
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
15404
15432
  *
15405
15433
  * @remarks
15406
15434
  * [Api set: Mailbox 1.7]
@@ -15544,7 +15572,7 @@ declare namespace Office {
15544
15572
  *
15545
15573
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15546
15574
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15547
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
15575
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
15548
15576
  *
15549
15577
  * Parent interfaces:
15550
15578
  *
@@ -15915,7 +15943,7 @@ declare namespace Office {
15915
15943
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
15916
15944
  *
15917
15945
  * For supported events, refer to the Item object model
15918
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15946
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
15919
15947
  *
15920
15948
  * @remarks
15921
15949
  * [Api set: Mailbox 1.7]
@@ -15937,7 +15965,7 @@ declare namespace Office {
15937
15965
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
15938
15966
  *
15939
15967
  * For supported events, refer to the Item object model
15940
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15968
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
15941
15969
  *
15942
15970
  * @remarks
15943
15971
  * [Api set: Mailbox 1.7]
@@ -16149,9 +16177,9 @@ declare namespace Office {
16149
16177
  /**
16150
16178
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16151
16179
  *
16152
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16153
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16154
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16180
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16181
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16182
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16155
16183
  * 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
16156
16184
  * continue in a separate window.
16157
16185
  *
@@ -16180,9 +16208,9 @@ declare namespace Office {
16180
16208
  /**
16181
16209
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16182
16210
  *
16183
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
16184
- * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
16185
- * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16211
+ * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16212
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
16213
+ * to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
16186
16214
  * 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
16187
16215
  * continue in a separate window.
16188
16216
  *
@@ -16466,7 +16494,7 @@ declare namespace Office {
16466
16494
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
16467
16495
  *
16468
16496
  * For supported events, refer to the Item object model
16469
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
16497
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
16470
16498
  *
16471
16499
  * @remarks
16472
16500
  * [Api set: Mailbox 1.7]
@@ -16486,7 +16514,7 @@ declare namespace Office {
16486
16514
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
16487
16515
  *
16488
16516
  * For supported events, refer to the Item object model
16489
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
16517
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
16490
16518
  *
16491
16519
  * @remarks
16492
16520
  * [Api set: Mailbox 1.7]
@@ -18173,7 +18201,7 @@ declare namespace Office {
18173
18201
  * </tr>
18174
18202
  * <tr>
18175
18203
  * <td>office365</td>
18176
- * <td>The mailbox is associated with an Office 365 work or school account.</td>
18204
+ * <td>The mailbox is associated with a Microsoft 365 work or school account.</td>
18177
18205
  * </tr>
18178
18206
  * <tr>
18179
18207
  * <td>outlookCom</td>
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.275",
3
+ "version": "1.0.278",
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": "a23e9d16a54ef7b06a0e1f4d77fcc1b51a39a9318a8094012588ca84b2d7027a",
48
+ "typesPublisherContentHash": "88bfe3f560a440576b09e3f5a5b1ec26c79f29fc6b73b8e77281dc5ed35ae7d9",
49
49
  "typeScriptVersion": "4.1"
50
50
  }