@types/office-js 1.0.336 → 1.0.337
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 +1 -1
- office-js/index.d.ts +332 -231
- office-js/package.json +2 -2
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:
|
|
11
|
+
* Last updated: Thu, 13 Jul 2023 21:02:43 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
|
@@ -11014,13 +11014,15 @@ declare namespace Office {
|
|
|
11014
11014
|
/**
|
|
11015
11015
|
* Gets the date and time that an item was last modified.
|
|
11016
11016
|
*
|
|
11017
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
11018
|
-
*
|
|
11019
11017
|
* @remarks
|
|
11018
|
+
* [Api set: Mailbox 1.1]
|
|
11020
11019
|
*
|
|
11021
11020
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11022
11021
|
*
|
|
11023
11022
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11023
|
+
*
|
|
11024
|
+
* **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11025
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11024
11026
|
*/
|
|
11025
11027
|
dateTimeModified: Date;
|
|
11026
11028
|
/**
|
|
@@ -11318,20 +11320,24 @@ declare namespace Office {
|
|
|
11318
11320
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
11319
11321
|
* selected appointment.
|
|
11320
11322
|
*
|
|
11321
|
-
*
|
|
11323
|
+
* @remarks
|
|
11324
|
+
* [Api set: Mailbox 1.1]
|
|
11322
11325
|
*
|
|
11323
|
-
*
|
|
11326
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11324
11327
|
*
|
|
11325
|
-
*
|
|
11326
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11328
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11327
11329
|
*
|
|
11328
|
-
* **
|
|
11330
|
+
* **Important**:
|
|
11329
11331
|
*
|
|
11330
|
-
*
|
|
11332
|
+
* - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11331
11333
|
*
|
|
11332
|
-
*
|
|
11334
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
11333
11335
|
*
|
|
11334
|
-
*
|
|
11336
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11337
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11338
|
+
*
|
|
11339
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11340
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11335
11341
|
*
|
|
11336
11342
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11337
11343
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -11394,20 +11400,24 @@ declare namespace Office {
|
|
|
11394
11400
|
/**
|
|
11395
11401
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
11396
11402
|
*
|
|
11397
|
-
*
|
|
11403
|
+
* @remarks
|
|
11404
|
+
* [Api set: Mailbox 1.1]
|
|
11398
11405
|
*
|
|
11399
|
-
*
|
|
11406
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11400
11407
|
*
|
|
11401
|
-
*
|
|
11402
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11408
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11403
11409
|
*
|
|
11404
|
-
* **
|
|
11410
|
+
* **Important**:
|
|
11405
11411
|
*
|
|
11406
|
-
*
|
|
11412
|
+
* - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
11407
11413
|
*
|
|
11408
|
-
*
|
|
11414
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
11409
11415
|
*
|
|
11410
|
-
*
|
|
11416
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11417
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11418
|
+
*
|
|
11419
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11420
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11411
11421
|
*
|
|
11412
11422
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11413
11423
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -11528,31 +11538,35 @@ declare namespace Office {
|
|
|
11528
11538
|
/**
|
|
11529
11539
|
* Gets the entities found in the selected item's body.
|
|
11530
11540
|
*
|
|
11531
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11532
|
-
*
|
|
11533
11541
|
* @remarks
|
|
11542
|
+
* [Api set: Mailbox 1.1]
|
|
11534
11543
|
*
|
|
11535
11544
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11536
11545
|
*
|
|
11537
11546
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11547
|
+
*
|
|
11548
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11549
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11538
11550
|
*/
|
|
11539
11551
|
getEntities(): Entities;
|
|
11540
11552
|
/**
|
|
11541
11553
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
11542
11554
|
*
|
|
11543
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11544
|
-
*
|
|
11545
11555
|
* @returns
|
|
11546
11556
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null.
|
|
11547
11557
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
11548
11558
|
* Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter.
|
|
11549
11559
|
*
|
|
11550
11560
|
* @remarks
|
|
11561
|
+
* [Api set: Mailbox 1.1]
|
|
11551
11562
|
*
|
|
11552
11563
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
11553
11564
|
*
|
|
11554
11565
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11555
11566
|
*
|
|
11567
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11568
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11569
|
+
*
|
|
11556
11570
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
11557
11571
|
*
|
|
11558
11572
|
* While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the following table.
|
|
@@ -11603,25 +11617,28 @@ declare namespace Office {
|
|
|
11603
11617
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
11604
11618
|
/**
|
|
11605
11619
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
11606
|
-
*
|
|
11607
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11608
|
-
*
|
|
11609
|
-
* The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
|
|
11610
|
-
* in the manifest XML file with the specified `FilterName` element value.
|
|
11611
11620
|
*
|
|
11612
|
-
*
|
|
11613
|
-
*
|
|
11614
|
-
*
|
|
11615
|
-
* the method returns `null`.
|
|
11616
|
-
*
|
|
11617
|
-
* the method return an empty array.
|
|
11621
|
+
* @returns
|
|
11622
|
+
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
11623
|
+
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
11624
|
+
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
11625
|
+
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
11618
11626
|
*
|
|
11619
11627
|
* @remarks
|
|
11628
|
+
* [Api set: Mailbox 1.1]
|
|
11620
11629
|
*
|
|
11621
11630
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11622
11631
|
*
|
|
11623
11632
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11624
11633
|
*
|
|
11634
|
+
* **Important**:
|
|
11635
|
+
*
|
|
11636
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11637
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11638
|
+
*
|
|
11639
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11640
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11641
|
+
*
|
|
11625
11642
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
11626
11643
|
*/
|
|
11627
11644
|
getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
@@ -11661,56 +11678,59 @@ declare namespace Office {
|
|
|
11661
11678
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
11662
11679
|
/**
|
|
11663
11680
|
* Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
|
|
11664
|
-
*
|
|
11665
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11666
|
-
*
|
|
11667
|
-
* The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
|
|
11668
|
-
* `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
11669
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
11670
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
11671
|
-
*
|
|
11672
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11673
|
-
* and should not attempt to return the entire body of the item.
|
|
11674
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
11675
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11676
|
-
*
|
|
11677
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11678
11681
|
*
|
|
11679
11682
|
* @returns
|
|
11680
11683
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
11681
11684
|
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
11682
|
-
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
|
|
11685
|
+
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
11686
|
+
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
11683
11687
|
*
|
|
11684
11688
|
* @remarks
|
|
11689
|
+
* [Api set: Mailbox 1.1]
|
|
11685
11690
|
*
|
|
11686
11691
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11687
11692
|
*
|
|
11688
11693
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11694
|
+
*
|
|
11695
|
+
* **Important**:
|
|
11696
|
+
*
|
|
11697
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11698
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11699
|
+
*
|
|
11700
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11701
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
11702
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11703
|
+
*
|
|
11704
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11705
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11689
11706
|
*/
|
|
11690
11707
|
getRegExMatches(): any;
|
|
11691
11708
|
/**
|
|
11692
11709
|
* Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
|
|
11693
|
-
*
|
|
11694
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11695
|
-
*
|
|
11696
|
-
* The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule
|
|
11697
|
-
* element in the manifest XML file with the specified `RegExName` element value.
|
|
11698
|
-
*
|
|
11699
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11700
|
-
* and should not attempt to return the entire body of the item.
|
|
11701
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
11702
|
-
*
|
|
11703
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11704
11710
|
*
|
|
11705
11711
|
* @returns
|
|
11706
|
-
* An array that contains the strings that match the regular expression defined in the manifest XML file
|
|
11712
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
|
|
11713
|
+
* with the specified `RegExName` element value.
|
|
11707
11714
|
*
|
|
11708
11715
|
* @remarks
|
|
11716
|
+
* [Api set: Mailbox 1.1]
|
|
11709
11717
|
*
|
|
11710
11718
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11711
11719
|
*
|
|
11712
11720
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11713
11721
|
*
|
|
11722
|
+
* **Important**:
|
|
11723
|
+
*
|
|
11724
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11725
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11726
|
+
*
|
|
11727
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11728
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
11729
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11730
|
+
*
|
|
11731
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11732
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11733
|
+
*
|
|
11714
11734
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
11715
11735
|
*/
|
|
11716
11736
|
getRegExMatchesByName(name: string): string[];
|
|
@@ -12195,6 +12215,10 @@ declare namespace Office {
|
|
|
12195
12215
|
*
|
|
12196
12216
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12197
12217
|
*
|
|
12218
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12219
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12220
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12221
|
+
*
|
|
12198
12222
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
12199
12223
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12200
12224
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -12212,6 +12236,10 @@ declare namespace Office {
|
|
|
12212
12236
|
*
|
|
12213
12237
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12214
12238
|
*
|
|
12239
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12240
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12241
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12242
|
+
*
|
|
12215
12243
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12216
12244
|
* of type `Office.AsyncResult`.
|
|
12217
12245
|
* The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property.
|
|
@@ -12241,6 +12269,10 @@ declare namespace Office {
|
|
|
12241
12269
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
12242
12270
|
* (see the **Examples** section for a sample).
|
|
12243
12271
|
*
|
|
12272
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12273
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12274
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12275
|
+
*
|
|
12244
12276
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12245
12277
|
*
|
|
12246
12278
|
* **Errors**:
|
|
@@ -12279,6 +12311,10 @@ declare namespace Office {
|
|
|
12279
12311
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
12280
12312
|
* (see the **Examples** section for a sample).
|
|
12281
12313
|
*
|
|
12314
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12315
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12316
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12317
|
+
*
|
|
12282
12318
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12283
12319
|
*
|
|
12284
12320
|
* **Errors**:
|
|
@@ -12395,6 +12431,10 @@ declare namespace Office {
|
|
|
12395
12431
|
*
|
|
12396
12432
|
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
12397
12433
|
*
|
|
12434
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12435
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12436
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12437
|
+
*
|
|
12398
12438
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12399
12439
|
*
|
|
12400
12440
|
* **Errors**:
|
|
@@ -12437,6 +12477,10 @@ declare namespace Office {
|
|
|
12437
12477
|
*
|
|
12438
12478
|
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
12439
12479
|
*
|
|
12480
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12481
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12482
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12483
|
+
*
|
|
12440
12484
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12441
12485
|
*
|
|
12442
12486
|
* **Errors**:
|
|
@@ -12526,10 +12570,12 @@ declare namespace Office {
|
|
|
12526
12570
|
* **Important**:
|
|
12527
12571
|
*
|
|
12528
12572
|
* - In Outlook on the web, `setSignatureAsync` only works on messages.
|
|
12529
|
-
*
|
|
12573
|
+
*
|
|
12530
12574
|
* - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
|
|
12531
12575
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
12532
|
-
*
|
|
12576
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
12577
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12578
|
+
*
|
|
12533
12579
|
* - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
|
|
12534
12580
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
|
|
12535
12581
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
@@ -12563,10 +12609,12 @@ declare namespace Office {
|
|
|
12563
12609
|
* **Important**:
|
|
12564
12610
|
*
|
|
12565
12611
|
* - In Outlook on the web, `setSignatureAsync` only works on messages.
|
|
12566
|
-
*
|
|
12612
|
+
*
|
|
12567
12613
|
* - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
|
|
12568
12614
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
12569
|
-
*
|
|
12615
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
12616
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12617
|
+
*
|
|
12570
12618
|
* - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
|
|
12571
12619
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
|
|
12572
12620
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
@@ -13378,7 +13426,9 @@ declare namespace Office {
|
|
|
13378
13426
|
*
|
|
13379
13427
|
* - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
|
|
13380
13428
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
13381
|
-
*
|
|
13429
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
13430
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13431
|
+
*
|
|
13382
13432
|
* - A `recipientType` property value isn't returned by the `getAsync` method.
|
|
13383
13433
|
* The email sender is always a user whose email address is on the Exchange server.
|
|
13384
13434
|
*
|
|
@@ -13407,7 +13457,9 @@ declare namespace Office {
|
|
|
13407
13457
|
*
|
|
13408
13458
|
* - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
|
|
13409
13459
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
13410
|
-
*
|
|
13460
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
13461
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13462
|
+
*
|
|
13411
13463
|
* - A `recipientType` property value isn't returned by the `getAsync` method.
|
|
13412
13464
|
* The email sender is always a user whose email address is on the Exchange server.
|
|
13413
13465
|
*
|
|
@@ -13918,22 +13970,26 @@ declare namespace Office {
|
|
|
13918
13970
|
*/
|
|
13919
13971
|
diagnostics: Diagnostics;
|
|
13920
13972
|
/**
|
|
13921
|
-
* Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.
|
|
13922
|
-
*
|
|
13923
|
-
* Your app must have the **read item** permission specified in its manifest to call the `ewsUrl` member in read mode.
|
|
13924
|
-
*
|
|
13925
|
-
* In compose mode you must call the `saveAsync` method before you can use the `ewsUrl` member.
|
|
13926
|
-
* Your app must have **read/write item** permissions to call the `saveAsync` method.
|
|
13927
|
-
*
|
|
13928
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
13973
|
+
* Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.
|
|
13929
13974
|
*
|
|
13930
13975
|
* @remarks
|
|
13976
|
+
* [Api set: Mailbox 1.1]
|
|
13931
13977
|
*
|
|
13932
13978
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13933
13979
|
*
|
|
13934
13980
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13935
13981
|
*
|
|
13936
|
-
*
|
|
13982
|
+
* **Important**:
|
|
13983
|
+
*
|
|
13984
|
+
* - Your app must have the **read item** permission specified in its manifest to call the `ewsUrl` member in read mode.
|
|
13985
|
+
*
|
|
13986
|
+
* - In compose mode, you must call the `saveAsync` method before you can use the `ewsUrl` member.
|
|
13987
|
+
* Your app must have **read/write item** permissions to call the `saveAsync` method.
|
|
13988
|
+
*
|
|
13989
|
+
* - This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
13990
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13991
|
+
*
|
|
13992
|
+
* - The `ewsUrl` value can be used by a remote service to make EWS calls to the user's mailbox.
|
|
13937
13993
|
* For example, you can create a remote service to {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
13938
13994
|
*/
|
|
13939
13995
|
ewsUrl: string;
|
|
@@ -14036,8 +14092,6 @@ declare namespace Office {
|
|
|
14036
14092
|
* Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by
|
|
14037
14093
|
* Exchange Web Services (EWS). The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS.
|
|
14038
14094
|
*
|
|
14039
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14040
|
-
*
|
|
14041
14095
|
* @remarks
|
|
14042
14096
|
* [Api set: Mailbox 1.3]
|
|
14043
14097
|
*
|
|
@@ -14045,6 +14099,9 @@ declare namespace Office {
|
|
|
14045
14099
|
*
|
|
14046
14100
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14047
14101
|
*
|
|
14102
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14103
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14104
|
+
*
|
|
14048
14105
|
* @param itemId - An item ID formatted for the Outlook REST APIs.
|
|
14049
14106
|
* @param restVersion - A value indicating the version of the Outlook REST API used to retrieve the item ID.
|
|
14050
14107
|
*/
|
|
@@ -14074,8 +14131,6 @@ declare namespace Office {
|
|
|
14074
14131
|
/**
|
|
14075
14132
|
* Converts an item ID formatted for EWS into REST format.
|
|
14076
14133
|
*
|
|
14077
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14078
|
-
*
|
|
14079
14134
|
* @remarks
|
|
14080
14135
|
* [Api set: Mailbox 1.3]
|
|
14081
14136
|
*
|
|
@@ -14083,7 +14138,12 @@ declare namespace Office {
|
|
|
14083
14138
|
*
|
|
14084
14139
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14085
14140
|
*
|
|
14086
|
-
*
|
|
14141
|
+
* **Important**:
|
|
14142
|
+
*
|
|
14143
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14144
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14145
|
+
*
|
|
14146
|
+
* - Item IDs retrieved via EWS or via the `itemId` property use a different format than the format used by REST APIs (such as the
|
|
14087
14147
|
* {@link https://learn.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API}
|
|
14088
14148
|
* or the {@link https://graph.microsoft.io/ | Microsoft Graph}.
|
|
14089
14149
|
* The `convertToRestId` method converts an EWS-formatted ID into the proper format for REST.
|
|
@@ -14112,10 +14172,9 @@ declare namespace Office {
|
|
|
14112
14172
|
/**
|
|
14113
14173
|
* Displays an existing calendar appointment.
|
|
14114
14174
|
*
|
|
14115
|
-
* The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop
|
|
14116
|
-
* mobile devices.
|
|
14175
|
+
* The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop.
|
|
14117
14176
|
*
|
|
14118
|
-
* In Outlook on Mac, you can use this method to display a single appointment that
|
|
14177
|
+
* In Outlook on Mac, you can use this method to display a single appointment that isn't part of a recurring series, or the master appointment
|
|
14119
14178
|
* of a recurring series. However, you can't display an instance of the series because you can't access the properties
|
|
14120
14179
|
* (including the item ID) of instances of a recurring series.
|
|
14121
14180
|
*
|
|
@@ -14124,14 +14183,16 @@ declare namespace Office {
|
|
|
14124
14183
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
14125
14184
|
* no error message is returned.
|
|
14126
14185
|
*
|
|
14127
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14128
|
-
*
|
|
14129
14186
|
* @remarks
|
|
14187
|
+
* [Api set: Mailbox 1.1]
|
|
14130
14188
|
*
|
|
14131
14189
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14132
14190
|
*
|
|
14133
14191
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14134
14192
|
*
|
|
14193
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14194
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14195
|
+
*
|
|
14135
14196
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment.
|
|
14136
14197
|
*/
|
|
14137
14198
|
displayAppointmentForm(itemId: string): void;
|
|
@@ -14198,24 +14259,28 @@ declare namespace Office {
|
|
|
14198
14259
|
/**
|
|
14199
14260
|
* Displays an existing message.
|
|
14200
14261
|
*
|
|
14201
|
-
* The `displayMessageForm` method opens an existing message in a new window on the desktop
|
|
14262
|
+
* The `displayMessageForm` method opens an existing message in a new window on the desktop.
|
|
14202
14263
|
*
|
|
14203
14264
|
* In Outlook on the web, this method opens the specified form only if the body of the form is less than or equal to 32K characters.
|
|
14204
14265
|
*
|
|
14205
|
-
* If the specified item identifier
|
|
14266
|
+
* If the specified item identifier doesn't identify an existing message, no message will be displayed on the client computer, and
|
|
14206
14267
|
* no error message is returned.
|
|
14207
14268
|
*
|
|
14208
|
-
* Do not use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display
|
|
14209
|
-
* an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment.
|
|
14210
|
-
*
|
|
14211
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14212
|
-
*
|
|
14213
14269
|
* @remarks
|
|
14270
|
+
* [Api set: Mailbox 1.1]
|
|
14214
14271
|
*
|
|
14215
14272
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14216
14273
|
*
|
|
14217
14274
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14218
14275
|
*
|
|
14276
|
+
* **Important**:
|
|
14277
|
+
*
|
|
14278
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14279
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14280
|
+
*
|
|
14281
|
+
* - Don't use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display
|
|
14282
|
+
* an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment.
|
|
14283
|
+
*
|
|
14219
14284
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing message.
|
|
14220
14285
|
*/
|
|
14221
14286
|
displayMessageForm(itemId: string): void;
|
|
@@ -14284,7 +14349,7 @@ declare namespace Office {
|
|
|
14284
14349
|
* If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.
|
|
14285
14350
|
*
|
|
14286
14351
|
* In Outlook on the web, this method always displays a form with an attendees field.
|
|
14287
|
-
* If you
|
|
14352
|
+
* If you don't specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
14288
14353
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
14289
14354
|
*
|
|
14290
14355
|
* In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
@@ -14293,14 +14358,16 @@ declare namespace Office {
|
|
|
14293
14358
|
*
|
|
14294
14359
|
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
|
|
14295
14360
|
*
|
|
14296
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14297
|
-
*
|
|
14298
14361
|
* @remarks
|
|
14362
|
+
* [Api set: Mailbox 1.1]
|
|
14299
14363
|
*
|
|
14300
14364
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14301
14365
|
*
|
|
14302
14366
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
14303
14367
|
*
|
|
14368
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14369
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14370
|
+
*
|
|
14304
14371
|
* @param parameters - An `AppointmentForm` describing the new appointment. All properties are optional.
|
|
14305
14372
|
*/
|
|
14306
14373
|
displayNewAppointmentForm(parameters: AppointmentForm): void;
|
|
@@ -14365,7 +14432,7 @@ declare namespace Office {
|
|
|
14365
14432
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14366
14433
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
14367
14434
|
*/
|
|
14368
|
-
|
|
14435
|
+
displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
14369
14436
|
/**
|
|
14370
14437
|
* Displays a form for creating a new message.
|
|
14371
14438
|
*
|
|
@@ -14521,17 +14588,16 @@ declare namespace Office {
|
|
|
14521
14588
|
*
|
|
14522
14589
|
* The token is returned as a string in the `asyncResult.value` property.
|
|
14523
14590
|
*
|
|
14524
|
-
*
|
|
14591
|
+
* @remarks
|
|
14592
|
+
* [Api set: Mailbox 1.5]
|
|
14525
14593
|
*
|
|
14526
|
-
*
|
|
14527
|
-
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14594
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14528
14595
|
*
|
|
14529
|
-
* **
|
|
14530
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
|
|
14596
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14531
14597
|
*
|
|
14532
14598
|
* *REST Tokens*
|
|
14533
14599
|
*
|
|
14534
|
-
* When a REST token is requested (`options.isRest` = `true`), the resulting token
|
|
14600
|
+
* When a REST token is requested (`options.isRest` = `true`), the resulting token won't work to authenticate EWS calls.
|
|
14535
14601
|
* The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the
|
|
14536
14602
|
* **read/write mailbox** permission in its manifest.
|
|
14537
14603
|
* If the **read/write mailbox** permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts,
|
|
@@ -14551,7 +14617,7 @@ declare namespace Office {
|
|
|
14551
14617
|
*
|
|
14552
14618
|
* *EWS Tokens*
|
|
14553
14619
|
*
|
|
14554
|
-
* When an EWS token is requested (`options.isRest` = `false`), the resulting token
|
|
14620
|
+
* When an EWS token is requested (`options.isRest` = `false`), the resulting token won't work to authenticate REST API calls.
|
|
14555
14621
|
* The token will be limited in scope to accessing the current item.
|
|
14556
14622
|
*
|
|
14557
14623
|
* The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls.
|
|
@@ -14563,17 +14629,21 @@ declare namespace Office {
|
|
|
14563
14629
|
* attachment or item. For example, you can create a remote service to
|
|
14564
14630
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
14565
14631
|
*
|
|
14566
|
-
* **Important**:
|
|
14632
|
+
* **Important**:
|
|
14633
|
+
*
|
|
14634
|
+
* - This method is only supported in read mode in Outlook on Android and on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14635
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14636
|
+
*
|
|
14637
|
+
* - EWS operations aren't supported in add-ins running in Outlook on iOS and on Android. A REST token is always returned in Outlook
|
|
14567
14638
|
* mobile clients even if `options.isRest` is set to `false`.
|
|
14568
14639
|
*
|
|
14569
|
-
|
|
14640
|
+
*- Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14570
14641
|
*
|
|
14571
|
-
*
|
|
14572
|
-
*
|
|
14573
|
-
*
|
|
14574
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14642
|
+
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14643
|
+
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14575
14644
|
*
|
|
14576
|
-
*
|
|
14645
|
+
* - For guidance on delegate or shared scenarios, see the
|
|
14646
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
14577
14647
|
*
|
|
14578
14648
|
* **Errors**:
|
|
14579
14649
|
*
|
|
@@ -14599,29 +14669,33 @@ declare namespace Office {
|
|
|
14599
14669
|
*
|
|
14600
14670
|
* The token is returned as a string in the `asyncResult.value` property.
|
|
14601
14671
|
*
|
|
14602
|
-
*
|
|
14672
|
+
* @remarks
|
|
14673
|
+
* [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
|
|
14674
|
+
*
|
|
14675
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14676
|
+
*
|
|
14677
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14678
|
+
*
|
|
14679
|
+
* **Important**:
|
|
14680
|
+
*
|
|
14681
|
+
* - You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
|
|
14603
14682
|
* the token as a bearer authorization token to call the Exchange Web Services (EWS)
|
|
14604
14683
|
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} or
|
|
14605
14684
|
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
|
|
14606
14685
|
* attachment or item. For example, you can create a remote service to
|
|
14607
14686
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
14608
14687
|
*
|
|
14609
|
-
* Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14688
|
+
* - Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14610
14689
|
*
|
|
14611
|
-
* Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14690
|
+
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14612
14691
|
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14613
14692
|
*
|
|
14614
|
-
*
|
|
14615
|
-
*
|
|
14616
|
-
*
|
|
14617
|
-
* **Note**: This method isn't supported in Outlook on iOS or Android. EWS operations aren't supported in add-ins running on Outlook mobile clients.
|
|
14618
|
-
*
|
|
14619
|
-
* @remarks
|
|
14620
|
-
* [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
|
|
14693
|
+
* - This method isn't supported in Outlook on Android or on iOS. EWS operations aren't supported in add-ins running on Outlook mobile clients.
|
|
14694
|
+
* For more information on supported APIs in Outlook mobile, see
|
|
14695
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14621
14696
|
*
|
|
14622
|
-
*
|
|
14623
|
-
*
|
|
14624
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14697
|
+
* - For guidance on delegate or shared scenarios, see the
|
|
14698
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
14625
14699
|
*
|
|
14626
14700
|
* **Errors**:
|
|
14627
14701
|
*
|
|
@@ -14713,52 +14787,41 @@ declare namespace Office {
|
|
|
14713
14787
|
/**
|
|
14714
14788
|
* Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.
|
|
14715
14789
|
*
|
|
14716
|
-
* In these cases, add-ins should use REST APIs to access the user's mailbox instead.
|
|
14717
|
-
*
|
|
14718
14790
|
* The `makeEwsRequestAsync` method sends an EWS request on behalf of the add-in to Exchange.
|
|
14719
14791
|
*
|
|
14720
|
-
*
|
|
14721
|
-
*
|
|
14722
|
-
* The XML request must specify UTF-8 encoding: `\<?xml version="1.0" encoding="utf-8"?\>`.
|
|
14723
|
-
*
|
|
14724
|
-
* Your add-in must have the **read/write mailbox** permission to use the `makeEwsRequestAsync` method.
|
|
14725
|
-
* For information about using the **read/write mailbox** permission and the EWS operations that you can call with the `makeEwsRequestAsync` method,
|
|
14726
|
-
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}.
|
|
14727
|
-
*
|
|
14728
|
-
* The XML result of the EWS call is provided as a string in the `asyncResult.value` property.
|
|
14729
|
-
* If the result exceeds 1 MB in size, an error message is returned instead.
|
|
14730
|
-
*
|
|
14731
|
-
* **Note**: This method is not supported in the following scenarios.
|
|
14732
|
-
*
|
|
14733
|
-
* - In Outlook on iOS or Android.
|
|
14792
|
+
* @remarks
|
|
14793
|
+
* [Api set: Mailbox 1.1]
|
|
14734
14794
|
*
|
|
14735
|
-
*
|
|
14795
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14736
14796
|
*
|
|
14737
|
-
* **
|
|
14738
|
-
* `makeEwsRequestAsync` method to make EWS requests.
|
|
14797
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14739
14798
|
*
|
|
14740
|
-
*
|
|
14799
|
+
* **Important**:
|
|
14741
14800
|
*
|
|
14742
|
-
*
|
|
14743
|
-
*
|
|
14801
|
+
* - To enable the `makeEwsRequestAsync` method to make EWS requests, the server administrator must set `OAuthAuthentication` to `true` on the
|
|
14802
|
+
* Client Access Server EWS directory .
|
|
14744
14803
|
*
|
|
14745
|
-
*
|
|
14804
|
+
* - Your add-in must have the **read/write mailbox** permission to use the `makeEwsRequestAsync` method.
|
|
14805
|
+
* For information about using the **read/write mailbox** permission and the EWS operations that you can call with the `makeEwsRequestAsync` method, see
|
|
14806
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}.
|
|
14746
14807
|
*
|
|
14747
|
-
*
|
|
14748
|
-
*
|
|
14749
|
-
* You can determine what version of Outlook is running by using the `mailbox.diagnostics.hostVersion` property.
|
|
14808
|
+
* - If your add-in needs to access Folder Associated Items or its XML request must specify UTF-8 encoding (`\<?xml version="1.0" encoding="utf-8"?\>`),
|
|
14809
|
+
* it must use Microsoft Graph or REST APIs to access the user's mailbox instead.
|
|
14750
14810
|
*
|
|
14751
|
-
*
|
|
14811
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14812
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14752
14813
|
*
|
|
14753
|
-
*
|
|
14814
|
+
* - This method isn't supported when the add-in is loaded in a Gmail mailbox.
|
|
14754
14815
|
*
|
|
14755
|
-
*
|
|
14816
|
+
* - When you use the `makeEwsRequestAsync` method in add-ins that run in Outlook versions earlier than Version 15.0.4535.1004, you must set
|
|
14817
|
+
* the encoding value to ISO-8859-1 (`<?xml version="1.0" encoding="iso-8859-1"?>`). To determine the version of an Outlook client, use the
|
|
14818
|
+
* `mailbox.diagnostics.hostVersion` property. You don't need to set the encoding value when your add-in is running in Outlook on the web.
|
|
14819
|
+
* To determine the Outlook client in which your add-in is running, use the `mailbox.diagnostics.hostName` property.
|
|
14756
14820
|
*
|
|
14757
14821
|
* @param data - The EWS request.
|
|
14758
14822
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter
|
|
14759
|
-
* of type `Office.AsyncResult`.
|
|
14760
|
-
*
|
|
14761
|
-
* If the result exceeds 1 MB in size, an error message is returned instead.
|
|
14823
|
+
* of type `Office.AsyncResult`. The `value` property of the result is the XML of the EWS request provided as a string.
|
|
14824
|
+
* If the result exceeds 1 MB in size, an error message is returned in the `error` property.
|
|
14762
14825
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
14763
14826
|
*/
|
|
14764
14827
|
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
@@ -15310,7 +15373,8 @@ declare namespace Office {
|
|
|
15310
15373
|
*
|
|
15311
15374
|
* **Important**:
|
|
15312
15375
|
*
|
|
15313
|
-
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
|
|
15376
|
+
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15377
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15314
15378
|
*
|
|
15315
15379
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
15316
15380
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
@@ -15355,7 +15419,8 @@ declare namespace Office {
|
|
|
15355
15419
|
*
|
|
15356
15420
|
* **Important**:
|
|
15357
15421
|
*
|
|
15358
|
-
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
|
|
15422
|
+
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15423
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15359
15424
|
*
|
|
15360
15425
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
15361
15426
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
@@ -15527,7 +15592,8 @@ declare namespace Office {
|
|
|
15527
15592
|
*
|
|
15528
15593
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15529
15594
|
*
|
|
15530
|
-
* **Important**: This method is supported in Message Compose in Outlook on Android and on iOS.
|
|
15595
|
+
* **Important**: This method is supported in Message Compose in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15596
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15531
15597
|
*
|
|
15532
15598
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15533
15599
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -15555,7 +15621,8 @@ declare namespace Office {
|
|
|
15555
15621
|
*
|
|
15556
15622
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15557
15623
|
*
|
|
15558
|
-
* **Important**: This method is supported in Message Compose on Outlook on Android and on iOS.
|
|
15624
|
+
* **Important**: This method is supported in Message Compose on Outlook on Android and on iOS. For more information on supported APIs in
|
|
15625
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15559
15626
|
*
|
|
15560
15627
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
15561
15628
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
@@ -15664,7 +15731,8 @@ declare namespace Office {
|
|
|
15664
15731
|
*
|
|
15665
15732
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15666
15733
|
*
|
|
15667
|
-
* **Important**: This method is supported in Outlook on Android and on iOS.
|
|
15734
|
+
* **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15735
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15668
15736
|
*
|
|
15669
15737
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15670
15738
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -15687,7 +15755,8 @@ declare namespace Office {
|
|
|
15687
15755
|
*
|
|
15688
15756
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15689
15757
|
*
|
|
15690
|
-
* **Important**: This method is supported in Outlook on Android and on iOS.
|
|
15758
|
+
* **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15759
|
+
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15691
15760
|
*
|
|
15692
15761
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15693
15762
|
* type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
|
|
@@ -16303,13 +16372,15 @@ declare namespace Office {
|
|
|
16303
16372
|
/**
|
|
16304
16373
|
* Gets the date and time that an item was last modified.
|
|
16305
16374
|
*
|
|
16306
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
16307
|
-
*
|
|
16308
16375
|
* @remarks
|
|
16376
|
+
* [Api set: Mailbox 1.1]
|
|
16309
16377
|
*
|
|
16310
16378
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16311
16379
|
*
|
|
16312
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
16380
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16381
|
+
*
|
|
16382
|
+
* **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16383
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16313
16384
|
*/
|
|
16314
16385
|
dateTimeModified: Date;
|
|
16315
16386
|
/**
|
|
@@ -16618,20 +16689,24 @@ declare namespace Office {
|
|
|
16618
16689
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
16619
16690
|
* selected appointment.
|
|
16620
16691
|
*
|
|
16621
|
-
*
|
|
16692
|
+
* @remarks
|
|
16693
|
+
* [Api set: Mailbox 1.1]
|
|
16622
16694
|
*
|
|
16623
|
-
*
|
|
16695
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16624
16696
|
*
|
|
16625
|
-
*
|
|
16626
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
16697
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16627
16698
|
*
|
|
16628
|
-
* **
|
|
16699
|
+
* **Important**:
|
|
16629
16700
|
*
|
|
16630
|
-
*
|
|
16701
|
+
* - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
16631
16702
|
*
|
|
16632
|
-
*
|
|
16703
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
16633
16704
|
*
|
|
16634
|
-
*
|
|
16705
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16706
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
16707
|
+
*
|
|
16708
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16709
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16635
16710
|
*
|
|
16636
16711
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
16637
16712
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -16694,20 +16769,24 @@ declare namespace Office {
|
|
|
16694
16769
|
/**
|
|
16695
16770
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
16696
16771
|
*
|
|
16697
|
-
*
|
|
16772
|
+
* @remarks
|
|
16773
|
+
* [Api set: Mailbox 1.1]
|
|
16698
16774
|
*
|
|
16699
|
-
*
|
|
16775
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16700
16776
|
*
|
|
16701
|
-
*
|
|
16702
|
-
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
16777
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16703
16778
|
*
|
|
16704
|
-
* **
|
|
16779
|
+
* **Important**:
|
|
16705
16780
|
*
|
|
16706
|
-
*
|
|
16781
|
+
* - In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2-column or 1-column view.
|
|
16707
16782
|
*
|
|
16708
|
-
*
|
|
16783
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
16709
16784
|
*
|
|
16710
|
-
*
|
|
16785
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16786
|
+
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
16787
|
+
*
|
|
16788
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16789
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16711
16790
|
*
|
|
16712
16791
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
16713
16792
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -16870,31 +16949,35 @@ declare namespace Office {
|
|
|
16870
16949
|
/**
|
|
16871
16950
|
* Gets the entities found in the selected item's body.
|
|
16872
16951
|
*
|
|
16873
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
16874
|
-
*
|
|
16875
16952
|
* @remarks
|
|
16953
|
+
* [Api set: Mailbox 1.1]
|
|
16876
16954
|
*
|
|
16877
16955
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16878
16956
|
*
|
|
16879
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
16957
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16958
|
+
*
|
|
16959
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16960
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16880
16961
|
*/
|
|
16881
16962
|
getEntities(): Entities;
|
|
16882
16963
|
/**
|
|
16883
16964
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
16884
16965
|
*
|
|
16885
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
16886
|
-
*
|
|
16887
16966
|
* @returns
|
|
16888
16967
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`.
|
|
16889
16968
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
16890
16969
|
* Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter.
|
|
16891
16970
|
*
|
|
16892
16971
|
* @remarks
|
|
16972
|
+
* [Api set: Mailbox 1.1]
|
|
16893
16973
|
*
|
|
16894
16974
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
16895
16975
|
*
|
|
16896
16976
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16897
16977
|
*
|
|
16978
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16979
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16980
|
+
*
|
|
16898
16981
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
16899
16982
|
*
|
|
16900
16983
|
* While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the
|
|
@@ -16946,24 +17029,27 @@ declare namespace Office {
|
|
|
16946
17029
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
16947
17030
|
/**
|
|
16948
17031
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
16949
|
-
*
|
|
16950
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
16951
|
-
*
|
|
16952
|
-
* The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
|
|
16953
|
-
* in the manifest XML file with the specified `FilterName` element value.
|
|
16954
|
-
*
|
|
16955
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
16956
17032
|
*
|
|
16957
|
-
* @returns
|
|
16958
|
-
* the
|
|
16959
|
-
*
|
|
16960
|
-
* the method
|
|
17033
|
+
* @returns
|
|
17034
|
+
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
17035
|
+
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
17036
|
+
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
17037
|
+
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
16961
17038
|
*
|
|
16962
17039
|
* @remarks
|
|
17040
|
+
* [Api set: Mailbox 1.1]
|
|
16963
17041
|
*
|
|
16964
17042
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16965
17043
|
*
|
|
16966
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17044
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17045
|
+
*
|
|
17046
|
+
* **Important**:
|
|
17047
|
+
*
|
|
17048
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
17049
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17050
|
+
*
|
|
17051
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17052
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16967
17053
|
*
|
|
16968
17054
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
16969
17055
|
*/
|
|
@@ -17004,55 +17090,58 @@ declare namespace Office {
|
|
|
17004
17090
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17005
17091
|
/**
|
|
17006
17092
|
* Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
|
|
17007
|
-
*
|
|
17008
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17009
|
-
*
|
|
17010
|
-
* The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
|
|
17011
|
-
* `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
17012
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
17013
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
17014
|
-
*
|
|
17015
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter
|
|
17016
|
-
* the body and should not attempt to return the entire body of the item.
|
|
17017
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
17018
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17019
|
-
*
|
|
17020
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17021
17093
|
*
|
|
17022
17094
|
* @returns
|
|
17023
17095
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
17024
|
-
* The name of each array is equal to the corresponding value of the
|
|
17025
|
-
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
|
|
17096
|
+
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
17097
|
+
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
17098
|
+
* of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
17026
17099
|
*
|
|
17027
17100
|
* @remarks
|
|
17101
|
+
* [Api set: Mailbox 1.1]
|
|
17028
17102
|
*
|
|
17029
17103
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17030
17104
|
*
|
|
17031
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17105
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17106
|
+
*
|
|
17107
|
+
* **Important**:
|
|
17108
|
+
*
|
|
17109
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
17110
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17111
|
+
*
|
|
17112
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17113
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
17114
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17115
|
+
*
|
|
17116
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17117
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17032
17118
|
*/
|
|
17033
17119
|
getRegExMatches(): any;
|
|
17034
17120
|
/**
|
|
17035
17121
|
* Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
|
|
17036
|
-
*
|
|
17037
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17038
|
-
*
|
|
17039
|
-
* The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the
|
|
17040
|
-
* `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value.
|
|
17041
|
-
*
|
|
17042
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter
|
|
17043
|
-
* the body and should not attempt to return the entire body of the item.
|
|
17044
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
17045
|
-
*
|
|
17046
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17047
17122
|
*
|
|
17048
17123
|
* @returns
|
|
17049
|
-
* An array that contains the strings that match the regular expression defined in the manifest XML file
|
|
17124
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
|
|
17125
|
+
* with the specified `RegExName` element value.
|
|
17050
17126
|
*
|
|
17051
17127
|
* @remarks
|
|
17128
|
+
* [Api set: Mailbox 1.1]
|
|
17052
17129
|
*
|
|
17053
17130
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17054
17131
|
*
|
|
17055
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17132
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17133
|
+
*
|
|
17134
|
+
* **Important**:
|
|
17135
|
+
*
|
|
17136
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
17137
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17138
|
+
*
|
|
17139
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17140
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
17141
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17142
|
+
*
|
|
17143
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17144
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17056
17145
|
*
|
|
17057
17146
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
17058
17147
|
*/
|
|
@@ -17586,7 +17675,8 @@ declare namespace Office {
|
|
|
17586
17675
|
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
17587
17676
|
*
|
|
17588
17677
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
17589
|
-
* supported.
|
|
17678
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
17679
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17590
17680
|
*
|
|
17591
17681
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
17592
17682
|
*
|
|
@@ -17619,7 +17709,8 @@ declare namespace Office {
|
|
|
17619
17709
|
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
17620
17710
|
*
|
|
17621
17711
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
17622
|
-
* supported.
|
|
17712
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
17713
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17623
17714
|
*
|
|
17624
17715
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
17625
17716
|
*
|
|
@@ -17740,7 +17831,8 @@ declare namespace Office {
|
|
|
17740
17831
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
17741
17832
|
*
|
|
17742
17833
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
17743
|
-
* supported.
|
|
17834
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
17835
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17744
17836
|
*
|
|
17745
17837
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
17746
17838
|
*
|
|
@@ -17776,7 +17868,8 @@ declare namespace Office {
|
|
|
17776
17868
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
17777
17869
|
*
|
|
17778
17870
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
17779
|
-
* supported.
|
|
17871
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
17872
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17780
17873
|
*
|
|
17781
17874
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
17782
17875
|
*
|
|
@@ -18998,6 +19091,10 @@ declare namespace Office {
|
|
|
18998
19091
|
*
|
|
18999
19092
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19000
19093
|
*
|
|
19094
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
19095
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
19096
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19097
|
+
*
|
|
19001
19098
|
* **Errors**:
|
|
19002
19099
|
*
|
|
19003
19100
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
|
@@ -19022,6 +19119,10 @@ declare namespace Office {
|
|
|
19022
19119
|
*
|
|
19023
19120
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19024
19121
|
*
|
|
19122
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
19123
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
19124
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19125
|
+
*
|
|
19025
19126
|
* **Errors**:
|
|
19026
19127
|
*
|
|
19027
19128
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.337",
|
|
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": "
|
|
48
|
+
"typesPublisherContentHash": "3d98be5c2f3516797ee8d673cc3a8a0e1f896bb578764f88c80c4bd41a0ec3ce",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|