@types/office-js-preview 1.0.399 → 1.0.401
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 +334 -233
- 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 (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
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-preview/index.d.ts
CHANGED
|
@@ -11117,13 +11117,15 @@ declare namespace Office {
|
|
|
11117
11117
|
/**
|
|
11118
11118
|
* Gets the date and time that an item was last modified.
|
|
11119
11119
|
*
|
|
11120
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
11121
|
-
*
|
|
11122
11120
|
* @remarks
|
|
11121
|
+
* [Api set: Mailbox 1.1]
|
|
11123
11122
|
*
|
|
11124
11123
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11125
11124
|
*
|
|
11126
11125
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11126
|
+
*
|
|
11127
|
+
* **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11128
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11127
11129
|
*/
|
|
11128
11130
|
dateTimeModified: Date;
|
|
11129
11131
|
/**
|
|
@@ -11447,20 +11449,24 @@ declare namespace Office {
|
|
|
11447
11449
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
11448
11450
|
* selected appointment.
|
|
11449
11451
|
*
|
|
11450
|
-
*
|
|
11452
|
+
* @remarks
|
|
11453
|
+
* [Api set: Mailbox 1.1]
|
|
11451
11454
|
*
|
|
11452
|
-
*
|
|
11455
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11453
11456
|
*
|
|
11454
|
-
*
|
|
11455
|
-
* 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.
|
|
11457
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11456
11458
|
*
|
|
11457
|
-
* **
|
|
11459
|
+
* **Important**:
|
|
11458
11460
|
*
|
|
11459
|
-
*
|
|
11461
|
+
* - 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.
|
|
11460
11462
|
*
|
|
11461
|
-
*
|
|
11463
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
11462
11464
|
*
|
|
11463
|
-
*
|
|
11465
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11466
|
+
* 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.
|
|
11467
|
+
*
|
|
11468
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11469
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11464
11470
|
*
|
|
11465
11471
|
* @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
|
|
11466
11472
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -11523,20 +11529,24 @@ declare namespace Office {
|
|
|
11523
11529
|
/**
|
|
11524
11530
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
11525
11531
|
*
|
|
11526
|
-
*
|
|
11532
|
+
* @remarks
|
|
11533
|
+
* [Api set: Mailbox 1.1]
|
|
11527
11534
|
*
|
|
11528
|
-
*
|
|
11535
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11529
11536
|
*
|
|
11530
|
-
*
|
|
11531
|
-
* 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.
|
|
11537
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11532
11538
|
*
|
|
11533
|
-
* **
|
|
11539
|
+
* **Important**:
|
|
11534
11540
|
*
|
|
11535
|
-
*
|
|
11541
|
+
* - 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.
|
|
11536
11542
|
*
|
|
11537
|
-
*
|
|
11543
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
11538
11544
|
*
|
|
11539
|
-
*
|
|
11545
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11546
|
+
* 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.
|
|
11547
|
+
*
|
|
11548
|
+
* - 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}.
|
|
11540
11550
|
*
|
|
11541
11551
|
* @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
|
|
11542
11552
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -11657,30 +11667,34 @@ declare namespace Office {
|
|
|
11657
11667
|
/**
|
|
11658
11668
|
* Gets the entities found in the selected item's body.
|
|
11659
11669
|
*
|
|
11660
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11661
|
-
*
|
|
11662
11670
|
* @remarks
|
|
11671
|
+
* [Api set: Mailbox 1.1]
|
|
11663
11672
|
*
|
|
11664
11673
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11665
11674
|
*
|
|
11666
11675
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11676
|
+
*
|
|
11677
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11678
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11667
11679
|
*/
|
|
11668
11680
|
getEntities(): Entities;
|
|
11669
11681
|
/**
|
|
11670
11682
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
11671
11683
|
*
|
|
11672
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11673
|
-
*
|
|
11674
11684
|
* @returns
|
|
11675
11685
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null.
|
|
11676
11686
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
11677
11687
|
* Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter.
|
|
11678
11688
|
*
|
|
11679
11689
|
* @remarks
|
|
11690
|
+
* [Api set: Mailbox 1.1]
|
|
11680
11691
|
*
|
|
11681
11692
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
11682
11693
|
*
|
|
11683
11694
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11695
|
+
*
|
|
11696
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11697
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11684
11698
|
*
|
|
11685
11699
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
11686
11700
|
*
|
|
@@ -11732,25 +11746,28 @@ declare namespace Office {
|
|
|
11732
11746
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
11733
11747
|
/**
|
|
11734
11748
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
11735
|
-
*
|
|
11736
|
-
* **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)}.
|
|
11737
|
-
*
|
|
11738
|
-
* The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
|
|
11739
|
-
* in the manifest XML file with the specified `FilterName` element value.
|
|
11740
11749
|
*
|
|
11741
|
-
*
|
|
11742
|
-
*
|
|
11743
|
-
*
|
|
11744
|
-
* the method returns `null`.
|
|
11745
|
-
*
|
|
11746
|
-
* the method return an empty array.
|
|
11750
|
+
* @returns
|
|
11751
|
+
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
11752
|
+
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
11753
|
+
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
11754
|
+
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
11747
11755
|
*
|
|
11748
11756
|
* @remarks
|
|
11757
|
+
* [Api set: Mailbox 1.1]
|
|
11749
11758
|
*
|
|
11750
11759
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11751
11760
|
*
|
|
11752
11761
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11753
11762
|
*
|
|
11763
|
+
* **Important**:
|
|
11764
|
+
*
|
|
11765
|
+
* - 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},
|
|
11766
|
+
* 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)}.
|
|
11767
|
+
*
|
|
11768
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11769
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11770
|
+
*
|
|
11754
11771
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
11755
11772
|
*/
|
|
11756
11773
|
getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
@@ -11790,56 +11807,59 @@ declare namespace Office {
|
|
|
11790
11807
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
11791
11808
|
/**
|
|
11792
11809
|
* Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
|
|
11793
|
-
*
|
|
11794
|
-
* **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)}.
|
|
11795
|
-
*
|
|
11796
|
-
* The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
|
|
11797
|
-
* `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
11798
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
11799
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
11800
|
-
*
|
|
11801
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11802
|
-
* and should not attempt to return the entire body of the item.
|
|
11803
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
11804
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11805
|
-
*
|
|
11806
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11807
11810
|
*
|
|
11808
11811
|
* @returns
|
|
11809
11812
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
11810
11813
|
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
11811
|
-
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
|
|
11814
|
+
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
11815
|
+
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
11812
11816
|
*
|
|
11813
11817
|
* @remarks
|
|
11818
|
+
* [Api set: Mailbox 1.1]
|
|
11814
11819
|
*
|
|
11815
11820
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11816
11821
|
*
|
|
11817
11822
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11823
|
+
*
|
|
11824
|
+
* **Important**:
|
|
11825
|
+
*
|
|
11826
|
+
* - 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},
|
|
11827
|
+
* 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)}.
|
|
11828
|
+
*
|
|
11829
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11830
|
+
* 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.
|
|
11831
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11832
|
+
*
|
|
11833
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11834
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11818
11835
|
*/
|
|
11819
11836
|
getRegExMatches(): any;
|
|
11820
11837
|
/**
|
|
11821
11838
|
* Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
|
|
11822
|
-
*
|
|
11823
|
-
* **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)}.
|
|
11824
|
-
*
|
|
11825
|
-
* The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule
|
|
11826
|
-
* element in the manifest XML file with the specified `RegExName` element value.
|
|
11827
|
-
*
|
|
11828
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11829
|
-
* and should not attempt to return the entire body of the item.
|
|
11830
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
11831
|
-
*
|
|
11832
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11833
11839
|
*
|
|
11834
11840
|
* @returns
|
|
11835
|
-
* An array that contains the strings that match the regular expression defined in the manifest XML file
|
|
11841
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
|
|
11842
|
+
* with the specified `RegExName` element value.
|
|
11836
11843
|
*
|
|
11837
11844
|
* @remarks
|
|
11845
|
+
* [Api set: Mailbox 1.1]
|
|
11838
11846
|
*
|
|
11839
11847
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11840
11848
|
*
|
|
11841
11849
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11842
11850
|
*
|
|
11851
|
+
* **Important**:
|
|
11852
|
+
*
|
|
11853
|
+
* - 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},
|
|
11854
|
+
* 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)}.
|
|
11855
|
+
*
|
|
11856
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11857
|
+
* 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.
|
|
11858
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
11859
|
+
*
|
|
11860
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11861
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11862
|
+
*
|
|
11843
11863
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
11844
11864
|
*/
|
|
11845
11865
|
getRegExMatchesByName(name: string): string[];
|
|
@@ -12324,6 +12344,10 @@ declare namespace Office {
|
|
|
12324
12344
|
*
|
|
12325
12345
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12326
12346
|
*
|
|
12347
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12348
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12349
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12350
|
+
*
|
|
12327
12351
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
12328
12352
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12329
12353
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -12341,6 +12365,10 @@ declare namespace Office {
|
|
|
12341
12365
|
*
|
|
12342
12366
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12343
12367
|
*
|
|
12368
|
+
* **Important**: In Outlook on Android and on iOS, this` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12369
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12370
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12371
|
+
*
|
|
12344
12372
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12345
12373
|
* of type `Office.AsyncResult`.
|
|
12346
12374
|
* The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property.
|
|
@@ -12370,6 +12398,10 @@ declare namespace Office {
|
|
|
12370
12398
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
12371
12399
|
* (see the **Examples** section for a sample).
|
|
12372
12400
|
*
|
|
12401
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12402
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12403
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12404
|
+
*
|
|
12373
12405
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12374
12406
|
*
|
|
12375
12407
|
* **Errors**:
|
|
@@ -12408,6 +12440,10 @@ declare namespace Office {
|
|
|
12408
12440
|
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
12409
12441
|
* (see the **Examples** section for a sample).
|
|
12410
12442
|
*
|
|
12443
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12444
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12445
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12446
|
+
*
|
|
12411
12447
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12412
12448
|
*
|
|
12413
12449
|
* **Errors**:
|
|
@@ -12524,6 +12560,10 @@ declare namespace Office {
|
|
|
12524
12560
|
*
|
|
12525
12561
|
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
12526
12562
|
*
|
|
12563
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12564
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12565
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12566
|
+
*
|
|
12527
12567
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12528
12568
|
*
|
|
12529
12569
|
* **Errors**:
|
|
@@ -12566,6 +12606,10 @@ declare namespace Office {
|
|
|
12566
12606
|
*
|
|
12567
12607
|
* - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo** command.
|
|
12568
12608
|
*
|
|
12609
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
12610
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12611
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12612
|
+
*
|
|
12569
12613
|
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12570
12614
|
*
|
|
12571
12615
|
* **Errors**:
|
|
@@ -12655,10 +12699,12 @@ declare namespace Office {
|
|
|
12655
12699
|
* **Important**:
|
|
12656
12700
|
*
|
|
12657
12701
|
* - In Outlook on the web, `setSignatureAsync` only works on messages.
|
|
12658
|
-
*
|
|
12702
|
+
*
|
|
12659
12703
|
* - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
|
|
12660
12704
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
12661
|
-
*
|
|
12705
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
12706
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12707
|
+
*
|
|
12662
12708
|
* - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
|
|
12663
12709
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
|
|
12664
12710
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
@@ -12692,10 +12738,12 @@ declare namespace Office {
|
|
|
12692
12738
|
* **Important**:
|
|
12693
12739
|
*
|
|
12694
12740
|
* - In Outlook on the web, `setSignatureAsync` only works on messages.
|
|
12695
|
-
*
|
|
12741
|
+
*
|
|
12696
12742
|
* - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
|
|
12697
12743
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
12698
|
-
*
|
|
12744
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
12745
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12746
|
+
*
|
|
12699
12747
|
* - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
|
|
12700
12748
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
|
|
12701
12749
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
@@ -13652,7 +13700,9 @@ declare namespace Office {
|
|
|
13652
13700
|
*
|
|
13653
13701
|
* - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
|
|
13654
13702
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
13655
|
-
*
|
|
13703
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
13704
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13705
|
+
*
|
|
13656
13706
|
* - A `recipientType` property value isn't returned by the `getAsync` method.
|
|
13657
13707
|
* The email sender is always a user whose email address is on the Exchange server.
|
|
13658
13708
|
*
|
|
@@ -13681,7 +13731,9 @@ declare namespace Office {
|
|
|
13681
13731
|
*
|
|
13682
13732
|
* - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
|
|
13683
13733
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
|
|
13684
|
-
*
|
|
13734
|
+
* To learn more about APIs supported in Outlook mobile, see
|
|
13735
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13736
|
+
*
|
|
13685
13737
|
* - A `recipientType` property value isn't returned by the `getAsync` method.
|
|
13686
13738
|
* The email sender is always a user whose email address is on the Exchange server.
|
|
13687
13739
|
*
|
|
@@ -13737,7 +13789,7 @@ declare namespace Office {
|
|
|
13737
13789
|
}
|
|
13738
13790
|
/**
|
|
13739
13791
|
* The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
|
|
13740
|
-
* and is converted to a MIME message.
|
|
13792
|
+
* and is converted to a MIME message.
|
|
13741
13793
|
*
|
|
13742
13794
|
* Internet headers are stored as string key-value pairs on a per-item basis.
|
|
13743
13795
|
*
|
|
@@ -13770,7 +13822,7 @@ declare namespace Office {
|
|
|
13770
13822
|
interface InternetHeaders {
|
|
13771
13823
|
/**
|
|
13772
13824
|
* Given an array of internet header names, this method returns a record containing those internet headers and their values.
|
|
13773
|
-
* If the add-in requests
|
|
13825
|
+
* If the add-in requests a header that isn't available, that header won't be returned in the results.
|
|
13774
13826
|
*
|
|
13775
13827
|
* **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
|
|
13776
13828
|
*
|
|
@@ -13791,7 +13843,7 @@ declare namespace Office {
|
|
|
13791
13843
|
getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
|
|
13792
13844
|
/**
|
|
13793
13845
|
* Given an array of internet header names, this method returns a record containing those internet headers and their values.
|
|
13794
|
-
* If the add-in requests
|
|
13846
|
+
* If the add-in requests a header that isn't available, that header won't be returned in the results.
|
|
13795
13847
|
*
|
|
13796
13848
|
* **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
|
|
13797
13849
|
*
|
|
@@ -14192,22 +14244,26 @@ declare namespace Office {
|
|
|
14192
14244
|
*/
|
|
14193
14245
|
diagnostics: Diagnostics;
|
|
14194
14246
|
/**
|
|
14195
|
-
* Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.
|
|
14196
|
-
*
|
|
14197
|
-
* Your app must have the **read item** permission specified in its manifest to call the `ewsUrl` member in read mode.
|
|
14198
|
-
*
|
|
14199
|
-
* In compose mode you must call the `saveAsync` method before you can use the `ewsUrl` member.
|
|
14200
|
-
* Your app must have **read/write item** permissions to call the `saveAsync` method.
|
|
14201
|
-
*
|
|
14202
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
14247
|
+
* Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.
|
|
14203
14248
|
*
|
|
14204
14249
|
* @remarks
|
|
14250
|
+
* [Api set: Mailbox 1.1]
|
|
14205
14251
|
*
|
|
14206
14252
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14207
14253
|
*
|
|
14208
14254
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14209
14255
|
*
|
|
14210
|
-
*
|
|
14256
|
+
* **Important**:
|
|
14257
|
+
*
|
|
14258
|
+
* - Your app must have the **read item** permission specified in its manifest to call the `ewsUrl` member in read mode.
|
|
14259
|
+
*
|
|
14260
|
+
* - In compose mode, you must call the `saveAsync` method before you can use the `ewsUrl` member.
|
|
14261
|
+
* Your app must have **read/write item** permissions to call the `saveAsync` method.
|
|
14262
|
+
*
|
|
14263
|
+
* - This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14264
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14265
|
+
*
|
|
14266
|
+
* - The `ewsUrl` value can be used by a remote service to make EWS calls to the user's mailbox.
|
|
14211
14267
|
* 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}.
|
|
14212
14268
|
*/
|
|
14213
14269
|
ewsUrl: string;
|
|
@@ -14309,8 +14365,6 @@ declare namespace Office {
|
|
|
14309
14365
|
* 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
|
|
14310
14366
|
* Exchange Web Services (EWS). The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS.
|
|
14311
14367
|
*
|
|
14312
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14313
|
-
*
|
|
14314
14368
|
* @remarks
|
|
14315
14369
|
* [Api set: Mailbox 1.3]
|
|
14316
14370
|
*
|
|
@@ -14318,6 +14372,9 @@ declare namespace Office {
|
|
|
14318
14372
|
*
|
|
14319
14373
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14320
14374
|
*
|
|
14375
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14376
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14377
|
+
*
|
|
14321
14378
|
* @param itemId - An item ID formatted for the Outlook REST APIs.
|
|
14322
14379
|
* @param restVersion - A value indicating the version of the Outlook REST API used to retrieve the item ID.
|
|
14323
14380
|
*/
|
|
@@ -14347,8 +14404,6 @@ declare namespace Office {
|
|
|
14347
14404
|
/**
|
|
14348
14405
|
* Converts an item ID formatted for EWS into REST format.
|
|
14349
14406
|
*
|
|
14350
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14351
|
-
*
|
|
14352
14407
|
* @remarks
|
|
14353
14408
|
* [Api set: Mailbox 1.3]
|
|
14354
14409
|
*
|
|
@@ -14356,7 +14411,12 @@ declare namespace Office {
|
|
|
14356
14411
|
*
|
|
14357
14412
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14358
14413
|
*
|
|
14359
|
-
*
|
|
14414
|
+
* **Important**:
|
|
14415
|
+
*
|
|
14416
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14417
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14418
|
+
*
|
|
14419
|
+
* - Item IDs retrieved via EWS or via the `itemId` property use a different format than the format used by REST APIs (such as the
|
|
14360
14420
|
* {@link https://learn.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API}
|
|
14361
14421
|
* or the {@link https://graph.microsoft.io/ | Microsoft Graph}.
|
|
14362
14422
|
* The `convertToRestId` method converts an EWS-formatted ID into the proper format for REST.
|
|
@@ -14385,10 +14445,9 @@ declare namespace Office {
|
|
|
14385
14445
|
/**
|
|
14386
14446
|
* Displays an existing calendar appointment.
|
|
14387
14447
|
*
|
|
14388
|
-
* The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop
|
|
14389
|
-
* mobile devices.
|
|
14448
|
+
* The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop.
|
|
14390
14449
|
*
|
|
14391
|
-
* In Outlook on Mac, you can use this method to display a single appointment that
|
|
14450
|
+
* 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
|
|
14392
14451
|
* of a recurring series. However, you can't display an instance of the series because you can't access the properties
|
|
14393
14452
|
* (including the item ID) of instances of a recurring series.
|
|
14394
14453
|
*
|
|
@@ -14397,14 +14456,16 @@ declare namespace Office {
|
|
|
14397
14456
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
14398
14457
|
* no error message is returned.
|
|
14399
14458
|
*
|
|
14400
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14401
|
-
*
|
|
14402
14459
|
* @remarks
|
|
14460
|
+
* [Api set: Mailbox 1.1]
|
|
14403
14461
|
*
|
|
14404
14462
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14405
14463
|
*
|
|
14406
14464
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14407
14465
|
*
|
|
14466
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14467
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14468
|
+
*
|
|
14408
14469
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment.
|
|
14409
14470
|
*/
|
|
14410
14471
|
displayAppointmentForm(itemId: string): void;
|
|
@@ -14471,24 +14532,28 @@ declare namespace Office {
|
|
|
14471
14532
|
/**
|
|
14472
14533
|
* Displays an existing message.
|
|
14473
14534
|
*
|
|
14474
|
-
* The `displayMessageForm` method opens an existing message in a new window on the desktop
|
|
14535
|
+
* The `displayMessageForm` method opens an existing message in a new window on the desktop.
|
|
14475
14536
|
*
|
|
14476
14537
|
* 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.
|
|
14477
14538
|
*
|
|
14478
|
-
* If the specified item identifier
|
|
14539
|
+
* If the specified item identifier doesn't identify an existing message, no message will be displayed on the client computer, and
|
|
14479
14540
|
* no error message is returned.
|
|
14480
14541
|
*
|
|
14481
|
-
* Do not use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display
|
|
14482
|
-
* an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment.
|
|
14483
|
-
*
|
|
14484
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14485
|
-
*
|
|
14486
14542
|
* @remarks
|
|
14543
|
+
* [Api set: Mailbox 1.1]
|
|
14487
14544
|
*
|
|
14488
14545
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14489
14546
|
*
|
|
14490
14547
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14491
14548
|
*
|
|
14549
|
+
* **Important**:
|
|
14550
|
+
*
|
|
14551
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14552
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14553
|
+
*
|
|
14554
|
+
* - Don't use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display
|
|
14555
|
+
* an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment.
|
|
14556
|
+
*
|
|
14492
14557
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing message.
|
|
14493
14558
|
*/
|
|
14494
14559
|
displayMessageForm(itemId: string): void;
|
|
@@ -14557,7 +14622,7 @@ declare namespace Office {
|
|
|
14557
14622
|
* If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters.
|
|
14558
14623
|
*
|
|
14559
14624
|
* In Outlook on the web, this method always displays a form with an attendees field.
|
|
14560
|
-
* If you
|
|
14625
|
+
* If you don't specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
14561
14626
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
14562
14627
|
*
|
|
14563
14628
|
* In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
@@ -14566,14 +14631,16 @@ declare namespace Office {
|
|
|
14566
14631
|
*
|
|
14567
14632
|
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
|
|
14568
14633
|
*
|
|
14569
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
14570
|
-
*
|
|
14571
14634
|
* @remarks
|
|
14635
|
+
* [Api set: Mailbox 1.1]
|
|
14572
14636
|
*
|
|
14573
14637
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14574
14638
|
*
|
|
14575
14639
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
14576
14640
|
*
|
|
14641
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
14642
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14643
|
+
*
|
|
14577
14644
|
* @param parameters - An `AppointmentForm` describing the new appointment. All properties are optional.
|
|
14578
14645
|
*/
|
|
14579
14646
|
displayNewAppointmentForm(parameters: AppointmentForm): void;
|
|
@@ -14794,17 +14861,16 @@ declare namespace Office {
|
|
|
14794
14861
|
*
|
|
14795
14862
|
* The token is returned as a string in the `asyncResult.value` property.
|
|
14796
14863
|
*
|
|
14797
|
-
*
|
|
14864
|
+
* @remarks
|
|
14865
|
+
* [Api set: Mailbox 1.5]
|
|
14798
14866
|
*
|
|
14799
|
-
*
|
|
14800
|
-
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14867
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14801
14868
|
*
|
|
14802
|
-
* **
|
|
14803
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
14869
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14804
14870
|
*
|
|
14805
14871
|
* *REST Tokens*
|
|
14806
14872
|
*
|
|
14807
|
-
* When a REST token is requested (`options.isRest` = `true`), the resulting token
|
|
14873
|
+
* When a REST token is requested (`options.isRest` = `true`), the resulting token won't work to authenticate EWS calls.
|
|
14808
14874
|
* 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
|
|
14809
14875
|
* **read/write mailbox** permission in its manifest.
|
|
14810
14876
|
* If the **read/write mailbox** permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts,
|
|
@@ -14824,7 +14890,7 @@ declare namespace Office {
|
|
|
14824
14890
|
*
|
|
14825
14891
|
* *EWS Tokens*
|
|
14826
14892
|
*
|
|
14827
|
-
* When an EWS token is requested (`options.isRest` = `false`), the resulting token
|
|
14893
|
+
* When an EWS token is requested (`options.isRest` = `false`), the resulting token won't work to authenticate REST API calls.
|
|
14828
14894
|
* The token will be limited in scope to accessing the current item.
|
|
14829
14895
|
*
|
|
14830
14896
|
* The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls.
|
|
@@ -14836,17 +14902,21 @@ declare namespace Office {
|
|
|
14836
14902
|
* attachment or item. For example, you can create a remote service to
|
|
14837
14903
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
14838
14904
|
*
|
|
14839
|
-
* **Important**:
|
|
14905
|
+
* **Important**:
|
|
14906
|
+
*
|
|
14907
|
+
* - 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
|
|
14908
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14909
|
+
*
|
|
14910
|
+
* - EWS operations aren't supported in add-ins running in Outlook on iOS and on Android. A REST token is always returned in Outlook
|
|
14840
14911
|
* mobile clients even if `options.isRest` is set to `false`.
|
|
14841
14912
|
*
|
|
14842
|
-
|
|
14913
|
+
*- Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14843
14914
|
*
|
|
14844
|
-
*
|
|
14845
|
-
*
|
|
14846
|
-
*
|
|
14847
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14915
|
+
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14916
|
+
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14848
14917
|
*
|
|
14849
|
-
*
|
|
14918
|
+
* - For guidance on delegate or shared scenarios, see the
|
|
14919
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
14850
14920
|
*
|
|
14851
14921
|
* **Errors**:
|
|
14852
14922
|
*
|
|
@@ -14872,29 +14942,33 @@ declare namespace Office {
|
|
|
14872
14942
|
*
|
|
14873
14943
|
* The token is returned as a string in the `asyncResult.value` property.
|
|
14874
14944
|
*
|
|
14875
|
-
*
|
|
14945
|
+
* @remarks
|
|
14946
|
+
* [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
|
|
14947
|
+
*
|
|
14948
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14949
|
+
*
|
|
14950
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14951
|
+
*
|
|
14952
|
+
* **Important**:
|
|
14953
|
+
*
|
|
14954
|
+
* - You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
|
|
14876
14955
|
* the token as a bearer authorization token to call the Exchange Web Services (EWS)
|
|
14877
14956
|
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} or
|
|
14878
14957
|
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
|
|
14879
14958
|
* attachment or item. For example, you can create a remote service to
|
|
14880
14959
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
14881
14960
|
*
|
|
14882
|
-
* Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14961
|
+
* - Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14883
14962
|
*
|
|
14884
|
-
* Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14963
|
+
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14885
14964
|
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14886
14965
|
*
|
|
14887
|
-
*
|
|
14888
|
-
*
|
|
14889
|
-
*
|
|
14890
|
-
* **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.
|
|
14891
|
-
*
|
|
14892
|
-
* @remarks
|
|
14893
|
-
* [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
|
|
14894
|
-
*
|
|
14895
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14966
|
+
* - 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.
|
|
14967
|
+
* For more information on supported APIs in Outlook mobile, see
|
|
14968
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14896
14969
|
*
|
|
14897
|
-
*
|
|
14970
|
+
* - For guidance on delegate or shared scenarios, see the
|
|
14971
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
14898
14972
|
*
|
|
14899
14973
|
* **Errors**:
|
|
14900
14974
|
*
|
|
@@ -14986,52 +15060,41 @@ declare namespace Office {
|
|
|
14986
15060
|
/**
|
|
14987
15061
|
* Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.
|
|
14988
15062
|
*
|
|
14989
|
-
* In these cases, add-ins should use REST APIs to access the user's mailbox instead.
|
|
14990
|
-
*
|
|
14991
15063
|
* The `makeEwsRequestAsync` method sends an EWS request on behalf of the add-in to Exchange.
|
|
14992
15064
|
*
|
|
14993
|
-
*
|
|
14994
|
-
*
|
|
14995
|
-
* The XML request must specify UTF-8 encoding: `\<?xml version="1.0" encoding="utf-8"?\>`.
|
|
14996
|
-
*
|
|
14997
|
-
* Your add-in must have the **read/write mailbox** permission to use the `makeEwsRequestAsync` method.
|
|
14998
|
-
* For information about using the **read/write mailbox** permission and the EWS operations that you can call with the `makeEwsRequestAsync` method,
|
|
14999
|
-
* 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}.
|
|
15000
|
-
*
|
|
15001
|
-
* The XML result of the EWS call is provided as a string in the `asyncResult.value` property.
|
|
15002
|
-
* If the result exceeds 1 MB in size, an error message is returned instead.
|
|
15003
|
-
*
|
|
15004
|
-
* **Note**: This method is not supported in the following scenarios.
|
|
15005
|
-
*
|
|
15006
|
-
* - In Outlook on iOS or Android.
|
|
15065
|
+
* @remarks
|
|
15066
|
+
* [Api set: Mailbox 1.1]
|
|
15007
15067
|
*
|
|
15008
|
-
*
|
|
15068
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
15009
15069
|
*
|
|
15010
|
-
* **
|
|
15011
|
-
* `makeEwsRequestAsync` method to make EWS requests.
|
|
15070
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15012
15071
|
*
|
|
15013
|
-
*
|
|
15072
|
+
* **Important**:
|
|
15014
15073
|
*
|
|
15015
|
-
*
|
|
15016
|
-
*
|
|
15074
|
+
* - To enable the `makeEwsRequestAsync` method to make EWS requests, the server administrator must set `OAuthAuthentication` to `true` on the
|
|
15075
|
+
* Client Access Server EWS directory .
|
|
15017
15076
|
*
|
|
15018
|
-
*
|
|
15077
|
+
* - Your add-in must have the **read/write mailbox** permission to use the `makeEwsRequestAsync` method.
|
|
15078
|
+
* For information about using the **read/write mailbox** permission and the EWS operations that you can call with the `makeEwsRequestAsync` method, see
|
|
15079
|
+
* {@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}.
|
|
15019
15080
|
*
|
|
15020
|
-
*
|
|
15021
|
-
*
|
|
15022
|
-
* You can determine what version of Outlook is running by using the `mailbox.diagnostics.hostVersion` property.
|
|
15081
|
+
* - 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"?\>`),
|
|
15082
|
+
* it must use Microsoft Graph or REST APIs to access the user's mailbox instead.
|
|
15023
15083
|
*
|
|
15024
|
-
*
|
|
15084
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
15085
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
15025
15086
|
*
|
|
15026
|
-
*
|
|
15087
|
+
* - This method isn't supported when the add-in is loaded in a Gmail mailbox.
|
|
15027
15088
|
*
|
|
15028
|
-
*
|
|
15089
|
+
* - When you use the `makeEwsRequestAsync` method in add-ins that run in Outlook versions earlier than Version 15.0.4535.1004, you must set
|
|
15090
|
+
* 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
|
|
15091
|
+
* `mailbox.diagnostics.hostVersion` property. You don't need to set the encoding value when your add-in is running in Outlook on the web.
|
|
15092
|
+
* To determine the Outlook client in which your add-in is running, use the `mailbox.diagnostics.hostName` property.
|
|
15029
15093
|
*
|
|
15030
15094
|
* @param data - The EWS request.
|
|
15031
15095
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter
|
|
15032
|
-
* of type `Office.AsyncResult`.
|
|
15033
|
-
*
|
|
15034
|
-
* If the result exceeds 1 MB in size, an error message is returned instead.
|
|
15096
|
+
* of type `Office.AsyncResult`. The `value` property of the result is the XML of the EWS request provided as a string.
|
|
15097
|
+
* If the result exceeds 1 MB in size, an error message is returned in the `error` property.
|
|
15035
15098
|
* @param userContext - Optional. Any state data that is passed to the asynchronous method.
|
|
15036
15099
|
*/
|
|
15037
15100
|
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
|
|
@@ -15583,7 +15646,8 @@ declare namespace Office {
|
|
|
15583
15646
|
*
|
|
15584
15647
|
* **Important**:
|
|
15585
15648
|
*
|
|
15586
|
-
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
|
|
15649
|
+
* - 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
|
|
15650
|
+
* 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}.
|
|
15587
15651
|
*
|
|
15588
15652
|
* - 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.
|
|
15589
15653
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
@@ -15628,7 +15692,8 @@ declare namespace Office {
|
|
|
15628
15692
|
*
|
|
15629
15693
|
* **Important**:
|
|
15630
15694
|
*
|
|
15631
|
-
* - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
|
|
15695
|
+
* - 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
|
|
15696
|
+
* 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}.
|
|
15632
15697
|
*
|
|
15633
15698
|
* - 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.
|
|
15634
15699
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
@@ -15872,7 +15937,8 @@ declare namespace Office {
|
|
|
15872
15937
|
*
|
|
15873
15938
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15874
15939
|
*
|
|
15875
|
-
* **Important**: This method is supported in Message Compose on Outlook on Android and on iOS.
|
|
15940
|
+
* **Important**: This method is supported in Message Compose on Outlook on Android and on iOS. For more information on supported APIs in
|
|
15941
|
+
* 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}.
|
|
15876
15942
|
*
|
|
15877
15943
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15878
15944
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -15900,7 +15966,8 @@ declare namespace Office {
|
|
|
15900
15966
|
*
|
|
15901
15967
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15902
15968
|
*
|
|
15903
|
-
* **Important**: This method is supported in Message Compose in Outlook on Android and on iOS.
|
|
15969
|
+
* **Important**: This method is supported in Message Compose in Outlook on Android and on iOS. For more information on supported APIs in
|
|
15970
|
+
* 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}.
|
|
15904
15971
|
*
|
|
15905
15972
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
15906
15973
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
@@ -16009,7 +16076,8 @@ declare namespace Office {
|
|
|
16009
16076
|
*
|
|
16010
16077
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16011
16078
|
*
|
|
16012
|
-
* **Important**: This method is supported in Outlook on Android and on iOS.
|
|
16079
|
+
* **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
16080
|
+
* 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}.
|
|
16013
16081
|
*
|
|
16014
16082
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16015
16083
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -16032,7 +16100,8 @@ declare namespace Office {
|
|
|
16032
16100
|
*
|
|
16033
16101
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16034
16102
|
*
|
|
16035
|
-
* **Important**: This method is supported in Outlook on Android and on iOS.
|
|
16103
|
+
* **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
16104
|
+
* 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}.
|
|
16036
16105
|
*
|
|
16037
16106
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16038
16107
|
* type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
|
|
@@ -16648,13 +16717,15 @@ declare namespace Office {
|
|
|
16648
16717
|
/**
|
|
16649
16718
|
* Gets the date and time that an item was last modified.
|
|
16650
16719
|
*
|
|
16651
|
-
* **Note**: This member is not supported in Outlook on iOS or Android.
|
|
16652
|
-
*
|
|
16653
16720
|
* @remarks
|
|
16721
|
+
* [Api set: Mailbox 1.1]
|
|
16654
16722
|
*
|
|
16655
16723
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16656
16724
|
*
|
|
16657
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
16725
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16726
|
+
*
|
|
16727
|
+
* **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
16728
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16658
16729
|
*/
|
|
16659
16730
|
dateTimeModified: Date;
|
|
16660
16731
|
/**
|
|
@@ -16976,20 +17047,24 @@ declare namespace Office {
|
|
|
16976
17047
|
* Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the
|
|
16977
17048
|
* selected appointment.
|
|
16978
17049
|
*
|
|
16979
|
-
*
|
|
17050
|
+
* @remarks
|
|
17051
|
+
* [Api set: Mailbox 1.1]
|
|
16980
17052
|
*
|
|
16981
|
-
*
|
|
17053
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16982
17054
|
*
|
|
16983
|
-
*
|
|
16984
|
-
* 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.
|
|
17055
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
16985
17056
|
*
|
|
16986
|
-
* **
|
|
17057
|
+
* **Important**:
|
|
16987
17058
|
*
|
|
16988
|
-
*
|
|
17059
|
+
* - 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.
|
|
16989
17060
|
*
|
|
16990
|
-
*
|
|
17061
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
16991
17062
|
*
|
|
16992
|
-
*
|
|
17063
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17064
|
+
* 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.
|
|
17065
|
+
*
|
|
17066
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17067
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
16993
17068
|
*
|
|
16994
17069
|
* @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
|
|
16995
17070
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -17052,20 +17127,24 @@ declare namespace Office {
|
|
|
17052
17127
|
/**
|
|
17053
17128
|
* Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.
|
|
17054
17129
|
*
|
|
17055
|
-
*
|
|
17130
|
+
* @remarks
|
|
17131
|
+
* [Api set: Mailbox 1.1]
|
|
17056
17132
|
*
|
|
17057
|
-
*
|
|
17133
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17058
17134
|
*
|
|
17059
|
-
*
|
|
17060
|
-
* 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.
|
|
17135
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17061
17136
|
*
|
|
17062
|
-
* **
|
|
17137
|
+
* **Important**:
|
|
17063
17138
|
*
|
|
17064
|
-
*
|
|
17139
|
+
* - 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.
|
|
17065
17140
|
*
|
|
17066
|
-
*
|
|
17141
|
+
* - If any of the string parameters exceed their limits, `displayReplyForm` throws an exception.
|
|
17067
17142
|
*
|
|
17068
|
-
*
|
|
17143
|
+
* - When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17144
|
+
* 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.
|
|
17145
|
+
*
|
|
17146
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17147
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17069
17148
|
*
|
|
17070
17149
|
* @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
|
|
17071
17150
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
@@ -17228,31 +17307,35 @@ declare namespace Office {
|
|
|
17228
17307
|
/**
|
|
17229
17308
|
* Gets the entities found in the selected item's body.
|
|
17230
17309
|
*
|
|
17231
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17232
|
-
*
|
|
17233
17310
|
* @remarks
|
|
17311
|
+
* [Api set: Mailbox 1.1]
|
|
17234
17312
|
*
|
|
17235
17313
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17236
17314
|
*
|
|
17237
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17315
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17316
|
+
*
|
|
17317
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17318
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17238
17319
|
*/
|
|
17239
17320
|
getEntities(): Entities;
|
|
17240
17321
|
/**
|
|
17241
17322
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
17242
17323
|
*
|
|
17243
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17244
|
-
*
|
|
17245
17324
|
* @returns
|
|
17246
17325
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`.
|
|
17247
17326
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
17248
17327
|
* Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter.
|
|
17249
17328
|
*
|
|
17250
17329
|
* @remarks
|
|
17330
|
+
* [Api set: Mailbox 1.1]
|
|
17251
17331
|
*
|
|
17252
17332
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
17253
17333
|
*
|
|
17254
17334
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17255
17335
|
*
|
|
17336
|
+
* **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17337
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17338
|
+
*
|
|
17256
17339
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
17257
17340
|
*
|
|
17258
17341
|
* While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the
|
|
@@ -17304,24 +17387,27 @@ declare namespace Office {
|
|
|
17304
17387
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
|
|
17305
17388
|
/**
|
|
17306
17389
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
17307
|
-
*
|
|
17308
|
-
* **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)}.
|
|
17309
|
-
*
|
|
17310
|
-
* The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
|
|
17311
|
-
* in the manifest XML file with the specified `FilterName` element value.
|
|
17312
|
-
*
|
|
17313
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17314
17390
|
*
|
|
17315
|
-
* @returns
|
|
17316
|
-
* the
|
|
17317
|
-
*
|
|
17318
|
-
* the method
|
|
17391
|
+
* @returns
|
|
17392
|
+
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
17393
|
+
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
17394
|
+
* `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
|
|
17395
|
+
* `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
|
|
17319
17396
|
*
|
|
17320
17397
|
* @remarks
|
|
17398
|
+
* [Api set: Mailbox 1.1]
|
|
17321
17399
|
*
|
|
17322
17400
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17323
17401
|
*
|
|
17324
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17402
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17403
|
+
*
|
|
17404
|
+
* **Important**:
|
|
17405
|
+
*
|
|
17406
|
+
* - 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},
|
|
17407
|
+
* 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)}.
|
|
17408
|
+
*
|
|
17409
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17410
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17325
17411
|
*
|
|
17326
17412
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
17327
17413
|
*/
|
|
@@ -17362,55 +17448,58 @@ declare namespace Office {
|
|
|
17362
17448
|
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
17363
17449
|
/**
|
|
17364
17450
|
* Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
|
|
17365
|
-
*
|
|
17366
|
-
* **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)}.
|
|
17367
|
-
*
|
|
17368
|
-
* The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
|
|
17369
|
-
* `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
17370
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
17371
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
17372
|
-
*
|
|
17373
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter
|
|
17374
|
-
* the body and should not attempt to return the entire body of the item.
|
|
17375
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
17376
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17377
|
-
*
|
|
17378
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17379
17451
|
*
|
|
17380
17452
|
* @returns
|
|
17381
17453
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
17382
|
-
* The name of each array is equal to the corresponding value of the
|
|
17383
|
-
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
|
|
17454
|
+
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
17455
|
+
* or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
17456
|
+
* of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
17384
17457
|
*
|
|
17385
17458
|
* @remarks
|
|
17459
|
+
* [Api set: Mailbox 1.1]
|
|
17386
17460
|
*
|
|
17387
17461
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17388
17462
|
*
|
|
17389
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17463
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17464
|
+
*
|
|
17465
|
+
* **Important**:
|
|
17466
|
+
*
|
|
17467
|
+
* - 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},
|
|
17468
|
+
* 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)}.
|
|
17469
|
+
*
|
|
17470
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17471
|
+
* 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.
|
|
17472
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17473
|
+
*
|
|
17474
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17475
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17390
17476
|
*/
|
|
17391
17477
|
getRegExMatches(): any;
|
|
17392
17478
|
/**
|
|
17393
17479
|
* Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
|
|
17394
|
-
*
|
|
17395
|
-
* **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)}.
|
|
17396
|
-
*
|
|
17397
|
-
* The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the
|
|
17398
|
-
* `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value.
|
|
17399
|
-
*
|
|
17400
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter
|
|
17401
|
-
* the body and should not attempt to return the entire body of the item.
|
|
17402
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
17403
|
-
*
|
|
17404
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17405
17480
|
*
|
|
17406
17481
|
* @returns
|
|
17407
|
-
* An array that contains the strings that match the regular expression defined in the manifest XML file
|
|
17482
|
+
* An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
|
|
17483
|
+
* with the specified `RegExName` element value.
|
|
17408
17484
|
*
|
|
17409
17485
|
* @remarks
|
|
17486
|
+
* [Api set: Mailbox 1.1]
|
|
17410
17487
|
*
|
|
17411
17488
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17412
17489
|
*
|
|
17413
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**:
|
|
17490
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17491
|
+
*
|
|
17492
|
+
* **Important**:
|
|
17493
|
+
*
|
|
17494
|
+
* - 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},
|
|
17495
|
+
* 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)}.
|
|
17496
|
+
*
|
|
17497
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17498
|
+
* 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.
|
|
17499
|
+
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17500
|
+
*
|
|
17501
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17502
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17414
17503
|
*
|
|
17415
17504
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
17416
17505
|
*/
|
|
@@ -18062,7 +18151,8 @@ declare namespace Office {
|
|
|
18062
18151
|
* 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.
|
|
18063
18152
|
*
|
|
18064
18153
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
18065
|
-
* supported.
|
|
18154
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
18155
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18066
18156
|
*
|
|
18067
18157
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
18068
18158
|
*
|
|
@@ -18095,7 +18185,8 @@ declare namespace Office {
|
|
|
18095
18185
|
* 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.
|
|
18096
18186
|
*
|
|
18097
18187
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
18098
|
-
* supported.
|
|
18188
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
18189
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18099
18190
|
*
|
|
18100
18191
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
18101
18192
|
*
|
|
@@ -18216,7 +18307,8 @@ declare namespace Office {
|
|
|
18216
18307
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18217
18308
|
*
|
|
18218
18309
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
18219
|
-
* supported.
|
|
18310
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
18311
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18220
18312
|
*
|
|
18221
18313
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
18222
18314
|
*
|
|
@@ -18252,7 +18344,8 @@ declare namespace Office {
|
|
|
18252
18344
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18253
18345
|
*
|
|
18254
18346
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
18255
|
-
* supported.
|
|
18347
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
18348
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18256
18349
|
*
|
|
18257
18350
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
18258
18351
|
*
|
|
@@ -19577,6 +19670,10 @@ declare namespace Office {
|
|
|
19577
19670
|
*
|
|
19578
19671
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19579
19672
|
*
|
|
19673
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
19674
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
19675
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19676
|
+
*
|
|
19580
19677
|
* **Errors**:
|
|
19581
19678
|
*
|
|
19582
19679
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
|
@@ -19601,6 +19698,10 @@ declare namespace Office {
|
|
|
19601
19698
|
*
|
|
19602
19699
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19603
19700
|
*
|
|
19701
|
+
* **Important**: In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
19702
|
+
* supported. For more information on supported APIs in Outlook mobile, see
|
|
19703
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19704
|
+
*
|
|
19604
19705
|
* **Errors**:
|
|
19605
19706
|
*
|
|
19606
19707
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
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.401",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "d681f74eaebad27056acfd573282dc7b258a8fef40b94609140ac1af2ebdf377",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|