@types/office-js-preview 1.0.556 → 1.0.558
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +182 -77
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
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:
|
|
11
|
+
* Last updated: Fri, 14 Feb 2025 21:32:13 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -10907,13 +10907,6 @@ declare namespace Office {
|
|
|
10907
10907
|
/**
|
|
10908
10908
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
10909
10909
|
*
|
|
10910
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10911
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10912
|
-
* 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},
|
|
10913
|
-
* the attachment identifier is valid only within the same session.
|
|
10914
|
-
* 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
|
|
10915
|
-
* continue in a separate window.
|
|
10916
|
-
*
|
|
10917
10910
|
* @remarks
|
|
10918
10911
|
* [Api set: Mailbox 1.8]
|
|
10919
10912
|
*
|
|
@@ -10921,6 +10914,18 @@ declare namespace Office {
|
|
|
10921
10914
|
*
|
|
10922
10915
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10923
10916
|
*
|
|
10917
|
+
* **Important**:
|
|
10918
|
+
*
|
|
10919
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10920
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10921
|
+
*
|
|
10922
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10923
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
10924
|
+
*
|
|
10925
|
+
* - 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.
|
|
10926
|
+
* 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
|
|
10927
|
+
* continue in a separate window.
|
|
10928
|
+
*
|
|
10924
10929
|
* **Errors**:
|
|
10925
10930
|
*
|
|
10926
10931
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -10939,13 +10944,6 @@ declare namespace Office {
|
|
|
10939
10944
|
/**
|
|
10940
10945
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
10941
10946
|
*
|
|
10942
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10943
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10944
|
-
* 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},
|
|
10945
|
-
* the attachment identifier is valid only within the same session.
|
|
10946
|
-
* 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
|
|
10947
|
-
* continue in a separate window.
|
|
10948
|
-
*
|
|
10949
10947
|
* @remarks
|
|
10950
10948
|
* [Api set: Mailbox 1.8]
|
|
10951
10949
|
*
|
|
@@ -10953,6 +10951,18 @@ declare namespace Office {
|
|
|
10953
10951
|
*
|
|
10954
10952
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10955
10953
|
*
|
|
10954
|
+
* **Important**:
|
|
10955
|
+
*
|
|
10956
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10957
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10958
|
+
*
|
|
10959
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
10960
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
10961
|
+
*
|
|
10962
|
+
* - 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.
|
|
10963
|
+
* 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
|
|
10964
|
+
* continue in a separate window.
|
|
10965
|
+
*
|
|
10956
10966
|
* **Errors**:
|
|
10957
10967
|
*
|
|
10958
10968
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -10976,6 +10986,9 @@ declare namespace Office {
|
|
|
10976
10986
|
*
|
|
10977
10987
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10978
10988
|
*
|
|
10989
|
+
* **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
|
|
10990
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
10991
|
+
*
|
|
10979
10992
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10980
10993
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10981
10994
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -10993,6 +11006,9 @@ declare namespace Office {
|
|
|
10993
11006
|
*
|
|
10994
11007
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10995
11008
|
*
|
|
11009
|
+
* **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
|
|
11010
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
11011
|
+
*
|
|
10996
11012
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10997
11013
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
10998
11014
|
* the failure.
|
|
@@ -11698,9 +11714,12 @@ declare namespace Office {
|
|
|
11698
11714
|
*
|
|
11699
11715
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11700
11716
|
*
|
|
11701
|
-
* **
|
|
11717
|
+
* **Important**:
|
|
11718
|
+
*
|
|
11719
|
+
* - Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
|
|
11702
11720
|
* {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
|
|
11703
11721
|
*
|
|
11722
|
+
* - Attachments added using the **Upload and share** option aren't returned.
|
|
11704
11723
|
*/
|
|
11705
11724
|
attachments: AttachmentDetails[];
|
|
11706
11725
|
/**
|
|
@@ -12229,12 +12248,6 @@ declare namespace Office {
|
|
|
12229
12248
|
/**
|
|
12230
12249
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
12231
12250
|
*
|
|
12232
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12233
|
-
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12234
|
-
* 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},
|
|
12235
|
-
* 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
|
|
12236
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
12237
|
-
*
|
|
12238
12251
|
* @remarks
|
|
12239
12252
|
* [Api set: Mailbox 1.8]
|
|
12240
12253
|
*
|
|
@@ -12242,6 +12255,19 @@ declare namespace Office {
|
|
|
12242
12255
|
*
|
|
12243
12256
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12244
12257
|
*
|
|
12258
|
+
* **Important**:
|
|
12259
|
+
*
|
|
12260
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12261
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12262
|
+
* to retrieve the attachment.
|
|
12263
|
+
*
|
|
12264
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12265
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
12266
|
+
*
|
|
12267
|
+
* - 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.
|
|
12268
|
+
* 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
|
|
12269
|
+
* continue in a separate window.
|
|
12270
|
+
*
|
|
12245
12271
|
* **Errors**:
|
|
12246
12272
|
*
|
|
12247
12273
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -12260,12 +12286,6 @@ declare namespace Office {
|
|
|
12260
12286
|
/**
|
|
12261
12287
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
12262
12288
|
*
|
|
12263
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12264
|
-
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12265
|
-
* 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},
|
|
12266
|
-
* 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
|
|
12267
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
12268
|
-
*
|
|
12269
12289
|
* @remarks
|
|
12270
12290
|
* [Api set: Mailbox 1.8]
|
|
12271
12291
|
*
|
|
@@ -12273,6 +12293,19 @@ declare namespace Office {
|
|
|
12273
12293
|
*
|
|
12274
12294
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12275
12295
|
*
|
|
12296
|
+
* **Important**:
|
|
12297
|
+
*
|
|
12298
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
12299
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
12300
|
+
* to retrieve the attachment.
|
|
12301
|
+
*
|
|
12302
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
12303
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
12304
|
+
*
|
|
12305
|
+
* - 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.
|
|
12306
|
+
* 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
|
|
12307
|
+
* continue in a separate window.
|
|
12308
|
+
*
|
|
12276
12309
|
* **Errors**:
|
|
12277
12310
|
*
|
|
12278
12311
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -15238,12 +15271,6 @@ declare namespace Office {
|
|
|
15238
15271
|
/**
|
|
15239
15272
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
15240
15273
|
*
|
|
15241
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15242
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15243
|
-
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15244
|
-
* 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
|
|
15245
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
15246
|
-
*
|
|
15247
15274
|
* @remarks
|
|
15248
15275
|
* [Api set: Mailbox 1.8]
|
|
15249
15276
|
*
|
|
@@ -15251,6 +15278,18 @@ declare namespace Office {
|
|
|
15251
15278
|
*
|
|
15252
15279
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15253
15280
|
*
|
|
15281
|
+
* **Important**:
|
|
15282
|
+
*
|
|
15283
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15284
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15285
|
+
*
|
|
15286
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15287
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
15288
|
+
*
|
|
15289
|
+
* - 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.
|
|
15290
|
+
* 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
|
|
15291
|
+
* continue in a separate window.
|
|
15292
|
+
*
|
|
15254
15293
|
* **Errors**:
|
|
15255
15294
|
*
|
|
15256
15295
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -15269,12 +15308,6 @@ declare namespace Office {
|
|
|
15269
15308
|
/**
|
|
15270
15309
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
15271
15310
|
*
|
|
15272
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15273
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15274
|
-
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15275
|
-
* 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
|
|
15276
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
15277
|
-
*
|
|
15278
15311
|
* @remarks
|
|
15279
15312
|
* [Api set: Mailbox 1.8]
|
|
15280
15313
|
*
|
|
@@ -15282,6 +15315,18 @@ declare namespace Office {
|
|
|
15282
15315
|
*
|
|
15283
15316
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15284
15317
|
*
|
|
15318
|
+
* **Important**:
|
|
15319
|
+
*
|
|
15320
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15321
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15322
|
+
*
|
|
15323
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
15324
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
15325
|
+
*
|
|
15326
|
+
* - 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.
|
|
15327
|
+
* 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
|
|
15328
|
+
* continue in a separate window.
|
|
15329
|
+
*
|
|
15285
15330
|
* **Errors**:
|
|
15286
15331
|
*
|
|
15287
15332
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -15305,6 +15350,9 @@ declare namespace Office {
|
|
|
15305
15350
|
*
|
|
15306
15351
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15307
15352
|
*
|
|
15353
|
+
* **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
|
|
15354
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
15355
|
+
*
|
|
15308
15356
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15309
15357
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15310
15358
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -15322,6 +15370,9 @@ declare namespace Office {
|
|
|
15322
15370
|
*
|
|
15323
15371
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15324
15372
|
*
|
|
15373
|
+
* **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
|
|
15374
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
15375
|
+
*
|
|
15325
15376
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15326
15377
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
15327
15378
|
* the failure.
|
|
@@ -15927,10 +15978,13 @@ declare namespace Office {
|
|
|
15927
15978
|
*
|
|
15928
15979
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
15929
15980
|
*
|
|
15930
|
-
* **
|
|
15981
|
+
* **Important**:
|
|
15982
|
+
*
|
|
15983
|
+
* - Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
|
|
15931
15984
|
* For more information, see
|
|
15932
15985
|
* {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
|
|
15933
15986
|
*
|
|
15987
|
+
* - Attachments added using the **Upload and share** option aren't returned.
|
|
15934
15988
|
*/
|
|
15935
15989
|
attachments: AttachmentDetails[];
|
|
15936
15990
|
/**
|
|
@@ -16490,12 +16544,6 @@ declare namespace Office {
|
|
|
16490
16544
|
/**
|
|
16491
16545
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16492
16546
|
*
|
|
16493
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16494
|
-
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16495
|
-
* to retrieve the attachment. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16496
|
-
* 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
|
|
16497
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
16498
|
-
*
|
|
16499
16547
|
* @remarks
|
|
16500
16548
|
* [Api set: Mailbox 1.8]
|
|
16501
16549
|
*
|
|
@@ -16503,6 +16551,19 @@ declare namespace Office {
|
|
|
16503
16551
|
*
|
|
16504
16552
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16505
16553
|
*
|
|
16554
|
+
* **Important**:
|
|
16555
|
+
*
|
|
16556
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16557
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16558
|
+
* to retrieve the attachment.
|
|
16559
|
+
*
|
|
16560
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16561
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16562
|
+
*
|
|
16563
|
+
* - 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.
|
|
16564
|
+
* 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
|
|
16565
|
+
* continue in a separate window.
|
|
16566
|
+
*
|
|
16506
16567
|
* **Errors**:
|
|
16507
16568
|
*
|
|
16508
16569
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -16521,12 +16582,6 @@ declare namespace Office {
|
|
|
16521
16582
|
/**
|
|
16522
16583
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16523
16584
|
*
|
|
16524
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16525
|
-
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16526
|
-
* to retrieve the attachment. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16527
|
-
* 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
|
|
16528
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
16529
|
-
*
|
|
16530
16585
|
* @remarks
|
|
16531
16586
|
* [Api set: Mailbox 1.8]
|
|
16532
16587
|
*
|
|
@@ -16534,6 +16589,19 @@ declare namespace Office {
|
|
|
16534
16589
|
*
|
|
16535
16590
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16536
16591
|
*
|
|
16592
|
+
* **Important**:
|
|
16593
|
+
*
|
|
16594
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16595
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
16596
|
+
* to retrieve the attachment.
|
|
16597
|
+
*
|
|
16598
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16599
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16600
|
+
*
|
|
16601
|
+
* - 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.
|
|
16602
|
+
* 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
|
|
16603
|
+
* continue in a separate window.
|
|
16604
|
+
*
|
|
16537
16605
|
* **Errors**:
|
|
16538
16606
|
*
|
|
16539
16607
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -19119,12 +19187,6 @@ declare namespace Office {
|
|
|
19119
19187
|
/**
|
|
19120
19188
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
19121
19189
|
*
|
|
19122
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19123
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19124
|
-
* 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},
|
|
19125
|
-
* 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
|
|
19126
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
19127
|
-
*
|
|
19128
19190
|
* @remarks
|
|
19129
19191
|
* [Api set: Mailbox 1.8]
|
|
19130
19192
|
*
|
|
@@ -19132,6 +19194,18 @@ declare namespace Office {
|
|
|
19132
19194
|
*
|
|
19133
19195
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19134
19196
|
*
|
|
19197
|
+
* **Important**:
|
|
19198
|
+
*
|
|
19199
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19200
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19201
|
+
*
|
|
19202
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
19203
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
19204
|
+
*
|
|
19205
|
+
* - 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.
|
|
19206
|
+
* 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
|
|
19207
|
+
* continue in a separate window.
|
|
19208
|
+
*
|
|
19135
19209
|
* **Errors**:
|
|
19136
19210
|
*
|
|
19137
19211
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -19150,12 +19224,6 @@ declare namespace Office {
|
|
|
19150
19224
|
/**
|
|
19151
19225
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
19152
19226
|
*
|
|
19153
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19154
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19155
|
-
* 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},
|
|
19156
|
-
* 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
|
|
19157
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
19158
|
-
*
|
|
19159
19227
|
* @remarks
|
|
19160
19228
|
* [Api set: Mailbox 1.8]
|
|
19161
19229
|
*
|
|
@@ -19163,6 +19231,18 @@ declare namespace Office {
|
|
|
19163
19231
|
*
|
|
19164
19232
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19165
19233
|
*
|
|
19234
|
+
* **Important**:
|
|
19235
|
+
*
|
|
19236
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19237
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19238
|
+
*
|
|
19239
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
19240
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
19241
|
+
*
|
|
19242
|
+
* - 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.
|
|
19243
|
+
* 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
|
|
19244
|
+
* continue in a separate window.
|
|
19245
|
+
*
|
|
19166
19246
|
* **Errors**:
|
|
19167
19247
|
*
|
|
19168
19248
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -19186,6 +19266,9 @@ declare namespace Office {
|
|
|
19186
19266
|
*
|
|
19187
19267
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19188
19268
|
*
|
|
19269
|
+
* **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
|
|
19270
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
19271
|
+
*
|
|
19189
19272
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19190
19273
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19191
19274
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -19203,6 +19286,9 @@ declare namespace Office {
|
|
|
19203
19286
|
*
|
|
19204
19287
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19205
19288
|
*
|
|
19289
|
+
* **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
|
|
19290
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
19291
|
+
*
|
|
19206
19292
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19207
19293
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
19208
19294
|
* the failure.
|
|
@@ -19988,10 +20074,13 @@ declare namespace Office {
|
|
|
19988
20074
|
*
|
|
19989
20075
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19990
20076
|
*
|
|
19991
|
-
* **
|
|
20077
|
+
* **Important**:
|
|
20078
|
+
*
|
|
20079
|
+
* - Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
|
|
19992
20080
|
* For more information, see
|
|
19993
20081
|
* {@link https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519 | Blocked attachments in Outlook}.
|
|
19994
20082
|
*
|
|
20083
|
+
* - Attachments added using the **Upload and share** option aren't returned.
|
|
19995
20084
|
*/
|
|
19996
20085
|
attachments: AttachmentDetails[];
|
|
19997
20086
|
/**
|
|
@@ -20667,12 +20756,6 @@ declare namespace Office {
|
|
|
20667
20756
|
/**
|
|
20668
20757
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
20669
20758
|
*
|
|
20670
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20671
|
-
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
20672
|
-
* 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},
|
|
20673
|
-
* 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
|
|
20674
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
20675
|
-
*
|
|
20676
20759
|
* @remarks
|
|
20677
20760
|
* [Api set: Mailbox 1.8]
|
|
20678
20761
|
*
|
|
@@ -20680,6 +20763,19 @@ declare namespace Office {
|
|
|
20680
20763
|
*
|
|
20681
20764
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20682
20765
|
*
|
|
20766
|
+
* **Important**:
|
|
20767
|
+
*
|
|
20768
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20769
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
20770
|
+
* to retrieve the attachment.
|
|
20771
|
+
*
|
|
20772
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
20773
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
20774
|
+
*
|
|
20775
|
+
* - 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.
|
|
20776
|
+
* 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
|
|
20777
|
+
* continue in a separate window.
|
|
20778
|
+
*
|
|
20683
20779
|
* **Errors**:
|
|
20684
20780
|
*
|
|
20685
20781
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -20698,12 +20794,6 @@ declare namespace Office {
|
|
|
20698
20794
|
/**
|
|
20699
20795
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
20700
20796
|
*
|
|
20701
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20702
|
-
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
20703
|
-
* 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},
|
|
20704
|
-
* 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
|
|
20705
|
-
* inline form then subsequently pops out the form to continue in a separate window.
|
|
20706
|
-
*
|
|
20707
20797
|
* @remarks
|
|
20708
20798
|
* [Api set: Mailbox 1.8]
|
|
20709
20799
|
*
|
|
@@ -20711,6 +20801,19 @@ declare namespace Office {
|
|
|
20711
20801
|
*
|
|
20712
20802
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20713
20803
|
*
|
|
20804
|
+
* **Important**:
|
|
20805
|
+
*
|
|
20806
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20807
|
+
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
20808
|
+
* to retrieve the attachment.
|
|
20809
|
+
*
|
|
20810
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
20811
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
20812
|
+
*
|
|
20813
|
+
* - 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.
|
|
20814
|
+
* 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
|
|
20815
|
+
* continue in a separate window.
|
|
20816
|
+
*
|
|
20714
20817
|
* **Errors**:
|
|
20715
20818
|
*
|
|
20716
20819
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -23286,6 +23389,8 @@ declare namespace Office {
|
|
|
23286
23389
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
23287
23390
|
*
|
|
23288
23391
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23392
|
+
*
|
|
23393
|
+
* **Important**: The error message must be 500 characters or less.
|
|
23289
23394
|
*/
|
|
23290
23395
|
errorMessage?: string;
|
|
23291
23396
|
/**
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.558",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "c547ee29ebdc75b295f73edc510b372a698042bd6911e06af86d45a5cc16a0b1",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|