@types/office-js-preview 1.0.358 → 1.0.360

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.
@@ -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: Mon, 05 Dec 2022 18:33:03 GMT
11
+ * Last updated: Tue, 06 Dec 2022 20:32:55 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -11691,7 +11691,9 @@ declare namespace Office {
11691
11691
  */
11692
11692
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
11693
11693
  /**
11694
- * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
11694
+ * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
11695
+ *
11696
+ * **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
11697
  *
11696
11698
  * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
11697
11699
  * in the manifest XML file with the specified `FilterName` element value.
@@ -11747,7 +11749,9 @@ declare namespace Office {
11747
11749
  */
11748
11750
  getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
11749
11751
  /**
11750
- * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
11752
+ * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
11753
+ *
11754
+ * **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)}.
11751
11755
  *
11752
11756
  * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
11753
11757
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -11774,7 +11778,9 @@ declare namespace Office {
11774
11778
  */
11775
11779
  getRegExMatches(): any;
11776
11780
  /**
11777
- * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
11781
+ * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
11782
+ *
11783
+ * **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)}.
11778
11784
  *
11779
11785
  * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule
11780
11786
  * element in the manifest XML file with the specified `RegExName` element value.
@@ -11799,6 +11805,8 @@ declare namespace Office {
11799
11805
  getRegExMatchesByName(name: string): string[];
11800
11806
  /**
11801
11807
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
11808
+ *
11809
+ * **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)}.
11802
11810
  *
11803
11811
  * **Note**: This method is not supported in Outlook on iOS or Android.
11804
11812
  *
@@ -11813,8 +11821,10 @@ declare namespace Office {
11813
11821
  */
11814
11822
  getSelectedEntities(): Entities;
11815
11823
  /**
11816
- * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
11824
+ * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
11817
11825
  * Highlighted matches apply to contextual add-ins.
11826
+ *
11827
+ * **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)}.
11818
11828
  *
11819
11829
  * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
11820
11830
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -14499,7 +14509,10 @@ declare namespace Office {
14499
14509
  * attachment or item. For example, you can create a remote service to
14500
14510
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
14501
14511
  *
14502
- * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
14512
+ * **Important**: EWS operations aren't supported in add-ins running in Outlook on iOS and Android. A REST token is always returned in Outlook
14513
+ * mobile clients even if `options.isRest` is set to `false`.
14514
+ *
14515
+ * **Note**: It's recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
14503
14516
  *
14504
14517
  * @remarks
14505
14518
  * [Api set: Mailbox 1.5]
@@ -14547,6 +14560,8 @@ declare namespace Office {
14547
14560
  * **Important**: For guidance on delegate or shared scenarios, see the
14548
14561
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
14549
14562
  *
14563
+ * **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.
14564
+ *
14550
14565
  * @remarks
14551
14566
  * [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
14552
14567
  *
@@ -16834,7 +16849,9 @@ declare namespace Office {
16834
16849
  */
16835
16850
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
16836
16851
  /**
16837
- * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
16852
+ * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
16853
+ *
16854
+ * **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)}.
16838
16855
  *
16839
16856
  * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
16840
16857
  * in the manifest XML file with the specified `FilterName` element value.
@@ -16890,7 +16907,9 @@ declare namespace Office {
16890
16907
  */
16891
16908
  getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
16892
16909
  /**
16893
- * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
16910
+ * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
16911
+ *
16912
+ * **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)}.
16894
16913
  *
16895
16914
  * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
16896
16915
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -16917,7 +16936,9 @@ declare namespace Office {
16917
16936
  */
16918
16937
  getRegExMatches(): any;
16919
16938
  /**
16920
- * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
16939
+ * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
16940
+ *
16941
+ * **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)}.
16921
16942
  *
16922
16943
  * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the
16923
16944
  * `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value.
@@ -16942,6 +16963,8 @@ declare namespace Office {
16942
16963
  getRegExMatchesByName(name: string): string[];
16943
16964
  /**
16944
16965
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
16966
+ *
16967
+ * **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)}.
16945
16968
  *
16946
16969
  * **Note**: This method is not supported in Outlook on iOS or Android.
16947
16970
  *
@@ -16956,8 +16979,10 @@ declare namespace Office {
16956
16979
  */
16957
16980
  getSelectedEntities(): Entities;
16958
16981
  /**
16959
- * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
16982
+ * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
16960
16983
  * Highlighted matches apply to contextual add-ins.
16984
+ *
16985
+ * **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)}.
16961
16986
  *
16962
16987
  * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
16963
16988
  * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.358",
3
+ "version": "1.0.360",
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": "7854d3831f7a8c3438a0ba84e49bc3e925d87aeff707600350cd9dad15e64ade",
48
+ "typesPublisherContentHash": "7a00fbeca65bd280ca493b8d05b8c325c400107715c662f5adb7cb7f56ec68d9",
49
49
  "typeScriptVersion": "4.2"
50
50
  }