@types/office-js 1.0.303 → 1.0.305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: 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
 
office-js/index.d.ts CHANGED
@@ -11512,7 +11512,9 @@ declare namespace Office {
11512
11512
  */
11513
11513
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
11514
11514
  /**
11515
- * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
11515
+ * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
11516
+ *
11517
+ * **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)}.
11516
11518
  *
11517
11519
  * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
11518
11520
  * in the manifest XML file with the specified `FilterName` element value.
@@ -11568,7 +11570,9 @@ declare namespace Office {
11568
11570
  */
11569
11571
  getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
11570
11572
  /**
11571
- * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
11573
+ * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
11574
+ *
11575
+ * **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)}.
11572
11576
  *
11573
11577
  * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
11574
11578
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -11595,7 +11599,9 @@ declare namespace Office {
11595
11599
  */
11596
11600
  getRegExMatches(): any;
11597
11601
  /**
11598
- * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
11602
+ * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
11603
+ *
11604
+ * **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)}.
11599
11605
  *
11600
11606
  * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule
11601
11607
  * element in the manifest XML file with the specified `RegExName` element value.
@@ -11620,6 +11626,8 @@ declare namespace Office {
11620
11626
  getRegExMatchesByName(name: string): string[];
11621
11627
  /**
11622
11628
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
11629
+ *
11630
+ * **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)}.
11623
11631
  *
11624
11632
  * **Note**: This method is not supported in Outlook on iOS or Android.
11625
11633
  *
@@ -11634,8 +11642,10 @@ declare namespace Office {
11634
11642
  */
11635
11643
  getSelectedEntities(): Entities;
11636
11644
  /**
11637
- * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
11645
+ * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
11638
11646
  * Highlighted matches apply to contextual add-ins.
11647
+ *
11648
+ * **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)}.
11639
11649
  *
11640
11650
  * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
11641
11651
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -14237,7 +14247,10 @@ declare namespace Office {
14237
14247
  * attachment or item. For example, you can create a remote service to
14238
14248
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
14239
14249
  *
14240
- * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
14250
+ * **Important**: EWS operations aren't supported in add-ins running in Outlook on iOS and Android. A REST token is always returned in Outlook
14251
+ * mobile clients even if `options.isRest` is set to `false`.
14252
+ *
14253
+ * **Note**: It's recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
14241
14254
  *
14242
14255
  * @remarks
14243
14256
  * [Api set: Mailbox 1.5]
@@ -14285,6 +14298,8 @@ declare namespace Office {
14285
14298
  * **Important**: For guidance on delegate or shared scenarios, see the
14286
14299
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | delegate access} article.
14287
14300
  *
14301
+ * **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.
14302
+ *
14288
14303
  * @remarks
14289
14304
  * [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support]
14290
14305
  *
@@ -16489,7 +16504,9 @@ declare namespace Office {
16489
16504
  */
16490
16505
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
16491
16506
  /**
16492
- * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
16507
+ * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
16508
+ *
16509
+ * **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)}.
16493
16510
  *
16494
16511
  * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
16495
16512
  * in the manifest XML file with the specified `FilterName` element value.
@@ -16545,7 +16562,9 @@ declare namespace Office {
16545
16562
  */
16546
16563
  getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
16547
16564
  /**
16548
- * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
16565
+ * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
16566
+ *
16567
+ * **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)}.
16549
16568
  *
16550
16569
  * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
16551
16570
  * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -16572,7 +16591,9 @@ declare namespace Office {
16572
16591
  */
16573
16592
  getRegExMatches(): any;
16574
16593
  /**
16575
- * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
16594
+ * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
16595
+ *
16596
+ * **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)}.
16576
16597
  *
16577
16598
  * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the
16578
16599
  * `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value.
@@ -16597,6 +16618,8 @@ declare namespace Office {
16597
16618
  getRegExMatchesByName(name: string): string[];
16598
16619
  /**
16599
16620
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
16621
+ *
16622
+ * **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)}.
16600
16623
  *
16601
16624
  * **Note**: This method is not supported in Outlook on iOS or Android.
16602
16625
  *
@@ -16611,8 +16634,10 @@ declare namespace Office {
16611
16634
  */
16612
16635
  getSelectedEntities(): Entities;
16613
16636
  /**
16614
- * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
16637
+ * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
16615
16638
  * Highlighted matches apply to contextual add-ins.
16639
+ *
16640
+ * **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)}.
16616
16641
  *
16617
16642
  * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
16618
16643
  * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.303",
3
+ "version": "1.0.305",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "b99b45aad8c3e58287be33e6d5fb4c9b39ce01e297a41c9e733063993d479b0f",
48
+ "typesPublisherContentHash": "24d36736ef95e23c53387a10258c67a09c1ca2f36d474731842dad90e8de4fac",
49
49
  "typeScriptVersion": "4.2"
50
50
  }