@types/office-js 1.0.464 → 1.0.466

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: Fri, 07 Feb 2025 19:32:28 GMT
11
+ * Last updated: Thu, 13 Feb 2025 18:37:23 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -10843,13 +10843,6 @@ declare namespace Office {
10843
10843
  /**
10844
10844
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10845
10845
  *
10846
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10847
- * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10848
- * In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
10849
- * the attachment identifier is valid only within the same session.
10850
- * 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
10851
- * continue in a separate window.
10852
- *
10853
10846
  * @remarks
10854
10847
  * [Api set: Mailbox 1.8]
10855
10848
  *
@@ -10857,6 +10850,18 @@ declare namespace Office {
10857
10850
  *
10858
10851
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10859
10852
  *
10853
+ * **Important**:
10854
+ *
10855
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10856
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10857
+ *
10858
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
10859
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
10860
+ *
10861
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
10862
+ * 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
10863
+ * continue in a separate window.
10864
+ *
10860
10865
  * **Errors**:
10861
10866
  *
10862
10867
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -10875,13 +10880,6 @@ declare namespace Office {
10875
10880
  /**
10876
10881
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
10877
10882
  *
10878
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10879
- * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10880
- * In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
10881
- * the attachment identifier is valid only within the same session.
10882
- * 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
10883
- * continue in a separate window.
10884
- *
10885
10883
  * @remarks
10886
10884
  * [Api set: Mailbox 1.8]
10887
10885
  *
@@ -10889,6 +10887,18 @@ declare namespace Office {
10889
10887
  *
10890
10888
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10891
10889
  *
10890
+ * **Important**:
10891
+ *
10892
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
10893
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
10894
+ *
10895
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
10896
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
10897
+ *
10898
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
10899
+ * 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
10900
+ * continue in a separate window.
10901
+ *
10892
10902
  * **Errors**:
10893
10903
  *
10894
10904
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -10912,6 +10922,9 @@ declare namespace Office {
10912
10922
  *
10913
10923
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10914
10924
  *
10925
+ * **Important**: In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
10926
+ * include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
10927
+ *
10915
10928
  * @param options - An object literal that contains one or more of the following properties:-
10916
10929
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10917
10930
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -10929,6 +10942,9 @@ declare namespace Office {
10929
10942
  *
10930
10943
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10931
10944
  *
10945
+ * **Important**: In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
10946
+ * include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
10947
+ *
10932
10948
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10933
10949
  * type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
10934
10950
  * the failure.
@@ -11638,9 +11654,12 @@ declare namespace Office {
11638
11654
  *
11639
11655
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11640
11656
  *
11641
- * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
11657
+ * **Important**:
11658
+ *
11659
+ * - Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
11642
11660
  * {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
11643
11661
  *
11662
+ * - Attachments added using the **Upload and share** option aren't returned.
11644
11663
  */
11645
11664
  attachments: AttachmentDetails[];
11646
11665
  /**
@@ -12143,12 +12162,6 @@ declare namespace Office {
12143
12162
  /**
12144
12163
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
12145
12164
  *
12146
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
12147
- * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
12148
- * to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12149
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
12150
- * inline form then subsequently pops out the form to continue in a separate window.
12151
- *
12152
12165
  * @remarks
12153
12166
  * [Api set: Mailbox 1.8]
12154
12167
  *
@@ -12156,6 +12169,19 @@ declare namespace Office {
12156
12169
  *
12157
12170
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12158
12171
  *
12172
+ * **Important**:
12173
+ *
12174
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
12175
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
12176
+ * to retrieve the attachment.
12177
+ *
12178
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12179
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
12180
+ *
12181
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
12182
+ * 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
12183
+ * continue in a separate window.
12184
+ *
12159
12185
  * **Errors**:
12160
12186
  *
12161
12187
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -12174,12 +12200,6 @@ declare namespace Office {
12174
12200
  /**
12175
12201
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
12176
12202
  *
12177
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
12178
- * the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
12179
- * to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12180
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
12181
- * inline form then subsequently pops out the form to continue in a separate window.
12182
- *
12183
12203
  * @remarks
12184
12204
  * [Api set: Mailbox 1.8]
12185
12205
  *
@@ -12187,6 +12207,19 @@ declare namespace Office {
12187
12207
  *
12188
12208
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12189
12209
  *
12210
+ * **Important**:
12211
+ *
12212
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
12213
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
12214
+ * to retrieve the attachment.
12215
+ *
12216
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12217
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
12218
+ *
12219
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
12220
+ * 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
12221
+ * continue in a separate window.
12222
+ *
12190
12223
  * **Errors**:
12191
12224
  *
12192
12225
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -16910,12 +16943,6 @@ declare namespace Office {
16910
16943
  /**
16911
16944
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16912
16945
  *
16913
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16914
- * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
16915
- * In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
16916
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
16917
- * then subsequently pops out the form to continue in a separate window.
16918
- *
16919
16946
  * @remarks
16920
16947
  * [Api set: Mailbox 1.8]
16921
16948
  *
@@ -16923,6 +16950,18 @@ declare namespace Office {
16923
16950
  *
16924
16951
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
16925
16952
  *
16953
+ * **Important**:
16954
+ *
16955
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16956
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
16957
+ *
16958
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
16959
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
16960
+ *
16961
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
16962
+ * 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
16963
+ * continue in a separate window.
16964
+ *
16926
16965
  * **Errors**:
16927
16966
  *
16928
16967
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -16941,12 +16980,6 @@ declare namespace Office {
16941
16980
  /**
16942
16981
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
16943
16982
  *
16944
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16945
- * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
16946
- * In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
16947
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
16948
- * then subsequently pops out the form to continue in a separate window.
16949
- *
16950
16983
  * @remarks
16951
16984
  * [Api set: Mailbox 1.8]
16952
16985
  *
@@ -16954,6 +16987,18 @@ declare namespace Office {
16954
16987
  *
16955
16988
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
16956
16989
  *
16990
+ * **Important**:
16991
+ *
16992
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
16993
+ * the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
16994
+ *
16995
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
16996
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
16997
+ *
16998
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
16999
+ * 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
17000
+ * continue in a separate window.
17001
+ *
16957
17002
  * **Errors**:
16958
17003
  *
16959
17004
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -16977,6 +17022,9 @@ declare namespace Office {
16977
17022
  *
16978
17023
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
16979
17024
  *
17025
+ * **Important**: In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
17026
+ * include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
17027
+ *
16980
17028
  * @param options - An object literal that contains one or more of the following properties:-
16981
17029
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16982
17030
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -16994,6 +17042,9 @@ declare namespace Office {
16994
17042
  *
16995
17043
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
16996
17044
  *
17045
+ * **Important**: In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
17046
+ * include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
17047
+ *
16997
17048
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
16998
17049
  * type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
16999
17050
  * the failure.
@@ -17779,10 +17830,13 @@ declare namespace Office {
17779
17830
  *
17780
17831
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17781
17832
  *
17782
- * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
17833
+ * **Important**:
17834
+ *
17835
+ * - Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
17783
17836
  * For more information, see
17784
17837
  * {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
17785
17838
  *
17839
+ * - Attachments added using the **Upload and share** option aren't returned.
17786
17840
  */
17787
17841
  attachments: AttachmentDetails[];
17788
17842
  /**
@@ -18445,12 +18499,6 @@ declare namespace Office {
18445
18499
  /**
18446
18500
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
18447
18501
  *
18448
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
18449
- * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
18450
- * to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
18451
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
18452
- * inline form then subsequently pops out the form to continue in a separate window.
18453
- *
18454
18502
  * @remarks
18455
18503
  * [Api set: Mailbox 1.8]
18456
18504
  *
@@ -18458,6 +18506,19 @@ declare namespace Office {
18458
18506
  *
18459
18507
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
18460
18508
  *
18509
+ * **Important**:
18510
+ *
18511
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
18512
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
18513
+ * to retrieve the attachment.
18514
+ *
18515
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
18516
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
18517
+ *
18518
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
18519
+ * 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
18520
+ * continue in a separate window.
18521
+ *
18461
18522
  * **Errors**:
18462
18523
  *
18463
18524
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -18476,12 +18537,6 @@ declare namespace Office {
18476
18537
  /**
18477
18538
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
18478
18539
  *
18479
- * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
18480
- * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
18481
- * to retrieve the attachment. In Outlook on the web, on mobile devices, and in {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
18482
- * the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an
18483
- * inline form then subsequently pops out the form to continue in a separate window.
18484
- *
18485
18540
  * @remarks
18486
18541
  * [Api set: Mailbox 1.8]
18487
18542
  *
@@ -18489,6 +18544,19 @@ declare namespace Office {
18489
18544
  *
18490
18545
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
18491
18546
  *
18547
+ * **Important**:
18548
+ *
18549
+ * - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
18550
+ * the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
18551
+ * to retrieve the attachment.
18552
+ *
18553
+ * - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
18554
+ * `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
18555
+ *
18556
+ * - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
18557
+ * 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
18558
+ * continue in a separate window.
18559
+ *
18492
18560
  * **Errors**:
18493
18561
  *
18494
18562
  * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
@@ -87914,7 +87982,7 @@ declare namespace Word {
87914
87982
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
87915
87983
  }
87916
87984
  /**
87917
- * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.
87985
+ * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
87918
87986
  *
87919
87987
  * @remarks
87920
87988
  * [Api set: WordApi 1.1]
@@ -88470,7 +88538,7 @@ declare namespace Word {
88470
88538
  toJSON(): Word.Interfaces.ContentControlData;
88471
88539
  }
88472
88540
  /**
88473
- * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported.
88541
+ * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
88474
88542
  *
88475
88543
  * @remarks
88476
88544
  * [Api set: WordApi 1.1]
@@ -88667,11 +88735,11 @@ declare namespace Word {
88667
88735
  */
88668
88736
  track(): Word.ContentControlListItem;
88669
88737
  /**
88670
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
88738
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
88671
88739
  */
88672
88740
  untrack(): Word.ContentControlListItem;
88673
88741
  /**
88674
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88742
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88675
88743
  * Whereas the original `Word.ContentControlListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemData`) that contains shallow copies of any loaded child properties from the original object.
88676
88744
  */
88677
88745
  toJSON(): Word.Interfaces.ContentControlListItemData;
@@ -88726,11 +88794,11 @@ declare namespace Word {
88726
88794
  */
88727
88795
  track(): Word.ContentControlListItemCollection;
88728
88796
  /**
88729
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
88797
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
88730
88798
  */
88731
88799
  untrack(): Word.ContentControlListItemCollection;
88732
88800
  /**
88733
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88801
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88734
88802
  * Whereas the original `Word.ContentControlListItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlListItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88735
88803
  */
88736
88804
  toJSON(): Word.Interfaces.ContentControlListItemCollectionData;
@@ -90214,11 +90282,11 @@ declare namespace Word {
90214
90282
  */
90215
90283
  track(): Word.DropDownListContentControl;
90216
90284
  /**
90217
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
90285
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90218
90286
  */
90219
90287
  untrack(): Word.DropDownListContentControl;
90220
90288
  /**
90221
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90289
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90222
90290
  * Whereas the original `Word.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object.
90223
90291
  */
90224
90292
  toJSON(): Word.Interfaces.DropDownListContentControlData;
@@ -90277,11 +90345,11 @@ declare namespace Word {
90277
90345
  */
90278
90346
  track(): Word.ComboBoxContentControl;
90279
90347
  /**
90280
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
90348
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90281
90349
  */
90282
90350
  untrack(): Word.ComboBoxContentControl;
90283
90351
  /**
90284
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90352
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90285
90353
  * Whereas the original `Word.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
90286
90354
  */
90287
90355
  toJSON(): Word.Interfaces.ComboBoxContentControlData;
@@ -96760,51 +96828,62 @@ declare namespace Word {
96760
96828
  evenPages = "EvenPages",
96761
96829
  }
96762
96830
  /**
96831
+ * Represents the types of body objects.
96832
+ *
96763
96833
  * @remarks
96764
96834
  * [Api set: WordApi 1.3]
96765
96835
  */
96766
96836
  enum BodyType {
96767
96837
  /**
96838
+ * Unknown body type.
96768
96839
  * @remarks
96769
96840
  * [Api set: WordApi 1.3]
96770
96841
  */
96771
96842
  unknown = "Unknown",
96772
96843
  /**
96844
+ * Main document body.
96773
96845
  * @remarks
96774
96846
  * [Api set: WordApi 1.3]
96775
96847
  */
96776
96848
  mainDoc = "MainDoc",
96777
96849
  /**
96850
+ * Section body.
96778
96851
  * @remarks
96779
96852
  * [Api set: WordApi 1.3]
96780
96853
  */
96781
96854
  section = "Section",
96782
96855
  /**
96856
+ * Header body.
96783
96857
  * @remarks
96784
96858
  * [Api set: WordApi 1.3]
96785
96859
  */
96786
96860
  header = "Header",
96787
96861
  /**
96862
+ * Footer body.
96788
96863
  * @remarks
96789
96864
  * [Api set: WordApi 1.3]
96790
96865
  */
96791
96866
  footer = "Footer",
96792
96867
  /**
96868
+ * Table cell body.
96793
96869
  * @remarks
96794
96870
  * [Api set: WordApi 1.3]
96795
96871
  */
96796
96872
  tableCell = "TableCell",
96797
96873
  /**
96874
+ * Footnote body.
96798
96875
  * @remarks
96799
96876
  * [Api set: WordApi 1.5]
96800
96877
  */
96801
96878
  footnote = "Footnote",
96802
96879
  /**
96880
+ * Endnote body.
96803
96881
  * @remarks
96804
96882
  * [Api set: WordApi 1.5]
96805
96883
  */
96806
96884
  endnote = "Endnote",
96807
96885
  /**
96886
+ * Note body e.g., endnote, footnote.
96808
96887
  * @remarks
96809
96888
  * [Api set: WordApi 1.5]
96810
96889
  */
@@ -96913,6 +96992,8 @@ declare namespace Word {
96913
96992
  svg = "Svg",
96914
96993
  }
96915
96994
  /**
96995
+ * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}.
96996
+ *
96916
96997
  * @remarks
96917
96998
  * [Api set: WordApi 1.3]
96918
96999
  */
@@ -96924,25 +97005,25 @@ declare namespace Word {
96924
97005
  */
96925
97006
  whole = "Whole",
96926
97007
  /**
96927
- * The starting point of the object. For content control, it is the point after the opening tag.
97008
+ * The starting point of the object. For content control, it's the point after the opening tag.
96928
97009
  * @remarks
96929
97010
  * [Api set: WordApi 1.3]
96930
97011
  */
96931
97012
  start = "Start",
96932
97013
  /**
96933
- * The ending point of the object. For paragraph, it is the point before the EOP. For content control, it is the point before the closing tag.
97014
+ * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag.
96934
97015
  * @remarks
96935
97016
  * [Api set: WordApi 1.3]
96936
97017
  */
96937
97018
  end = "End",
96938
97019
  /**
96939
- * For content control only. It is the point before the opening tag.
97020
+ * For content control only. It's the point before the opening tag.
96940
97021
  * @remarks
96941
97022
  * [Api set: WordApi 1.3]
96942
97023
  */
96943
97024
  before = "Before",
96944
97025
  /**
96945
- * The point after the object. If the object is a paragraph content control or table content control, it is the point after the EOP or Table characters.
97026
+ * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters.
96946
97027
  * @remarks
96947
97028
  * [Api set: WordApi 1.3]
96948
97029
  */
@@ -103934,7 +104015,7 @@ declare namespace Word {
103934
104015
  id?: boolean;
103935
104016
  }
103936
104017
  /**
103937
- * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, and checkbox content controls are supported.
104018
+ * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
103938
104019
  *
103939
104020
  * @remarks
103940
104021
  * [Api set: WordApi 1.1]
@@ -104107,7 +104188,7 @@ declare namespace Word {
104107
104188
  type?: boolean;
104108
104189
  }
104109
104190
  /**
104110
- * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text and plain text content controls are supported.
104191
+ * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
104111
104192
  *
104112
104193
  * @remarks
104113
104194
  * [Api set: WordApi 1.1]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.464",
3
+ "version": "1.0.466",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "d3543dcb2e7aa5f497e2bdc719c71dbccd014b5e7e45de0a0833ea4eca7efd4c",
49
+ "typesPublisherContentHash": "fe4d11cccf60a0e56151850255261c745f85712a2d82bec0958e92cafddce38f",
50
50
  "typeScriptVersion": "5.0"
51
51
  }