@types/office-js-preview 1.0.353 → 1.0.355

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: Fri, 11 Nov 2022 19:32:52 GMT
11
+ * Last updated: Thu, 17 Nov 2022 00:03:04 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -13406,7 +13406,7 @@ declare namespace Office {
13406
13406
  * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
13407
13407
  * and is converted to a MIME message. These headers are stored as x-headers in the MIME message.
13408
13408
  *
13409
- * Internet headers are stored as key/value pairs on a per-item basis.
13409
+ * Internet headers are stored as string key-value pairs on a per-item basis.
13410
13410
  *
13411
13411
  * **Note**: This object is intended for you to set and get your custom headers on a message item. To learn more, see
13412
13412
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
@@ -13436,8 +13436,8 @@ declare namespace Office {
13436
13436
  */
13437
13437
  interface InternetHeaders {
13438
13438
  /**
13439
- * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
13440
- * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
13439
+ * Given an array of internet header names, this method returns a record containing those internet headers and their values.
13440
+ * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
13441
13441
  *
13442
13442
  * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
13443
13443
  *
@@ -13451,13 +13451,14 @@ declare namespace Office {
13451
13451
  * @param names - The names of the internet headers to be returned.
13452
13452
  * @param options - An object literal that contains one or more of the following properties:-
13453
13453
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13454
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13455
- * `asyncResult`, which is an `Office.AsyncResult` object.
13454
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13455
+ * `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
13456
+ * `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
13456
13457
  */
13457
- getAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
13458
+ getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
13458
13459
  /**
13459
- * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
13460
- * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
13460
+ * Given an array of internet header names, this method returns a record containing those internet headers and their values.
13461
+ * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
13461
13462
  *
13462
13463
  * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
13463
13464
  *
@@ -13469,10 +13470,11 @@ declare namespace Office {
13469
13470
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13470
13471
  *
13471
13472
  * @param names - The names of the internet headers to be returned.
13472
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13473
- * `asyncResult`, which is an `Office.AsyncResult` object.
13473
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13474
+ * `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
13475
+ * `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
13474
13476
  */
13475
- getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
13477
+ getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
13476
13478
  /**
13477
13479
  * Given an array of internet header names, this method removes the specified headers from the internet header collection.
13478
13480
  *
@@ -13489,9 +13491,9 @@ declare namespace Office {
13489
13491
  * @param options - An object literal that contains one or more of the following properties:-
13490
13492
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13491
13493
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13492
- * `asyncResult`, which is an `Office.AsyncResult` object.
13494
+ * `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
13493
13495
  */
13494
- removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
13496
+ removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13495
13497
  /**
13496
13498
  * Given an array of internet header names, this method removes the specified headers from the internet header collection.
13497
13499
  *
@@ -13506,9 +13508,9 @@ declare namespace Office {
13506
13508
  *
13507
13509
  * @param names - The names of the internet headers to be removed.
13508
13510
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13509
- * `asyncResult`, which is an `Office.AsyncResult` object.
13511
+ * `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
13510
13512
  */
13511
- removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
13513
+ removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13512
13514
  /**
13513
13515
  * Sets the specified internet headers to the specified values.
13514
13516
  *
@@ -13530,14 +13532,14 @@ declare namespace Office {
13530
13532
  *
13531
13533
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13532
13534
  *
13533
- * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
13534
- * internet headers and values being the values of the internet headers.
13535
+ * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
13536
+ * and values being the corresponding header value strings.
13535
13537
  * @param options - An object literal that contains one or more of the following properties:-
13536
13538
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13537
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13538
- * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13539
+ * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13540
+ * `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
13539
13541
  */
13540
- setAsync(headers: Object, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13542
+ setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13541
13543
  /**
13542
13544
  * Sets the specified internet headers to the specified values.
13543
13545
  *
@@ -13559,12 +13561,12 @@ declare namespace Office {
13559
13561
  *
13560
13562
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13561
13563
  *
13562
- * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
13563
- * internet headers and values being the values of the internet headers.
13564
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13565
- * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13564
+ * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
13565
+ * and values being the corresponding header value strings.
13566
+ * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13567
+ * `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
13566
13568
  */
13567
- setAsync(headers: Object, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13569
+ setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13568
13570
  }
13569
13571
  /**
13570
13572
  * The item namespace is used to access the currently selected message, meeting request, or appointment.
@@ -38219,6 +38221,23 @@ declare namespace Excel {
38219
38221
  * [Api set: ExcelApi 1.1]
38220
38222
  */
38221
38223
  delete(): void;
38224
+ /**
38225
+ * Gets the data source of the whole chart. If the data range is empty, this method will return the `EmptyChartSeries` error.
38226
+ *
38227
+ * @remarks
38228
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
38229
+ * @beta
38230
+ */
38231
+ getDataRange(): OfficeExtension.ClientResult<string>;
38232
+ /**
38233
+ * Gets the data source of the whole chart. If the data range is empty, then this method returns an object with its `isNullObject` property set to `true`.
38234
+ For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38235
+ *
38236
+ * @remarks
38237
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
38238
+ * @beta
38239
+ */
38240
+ getDataRangeOrNullObject(): OfficeExtension.ClientResult<string>;
38222
38241
  /**
38223
38242
  * Gets the data table on the chart. If the chart doesn't allow a data table, it will throw an exception.
38224
38243
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.353",
3
+ "version": "1.0.355",
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": "d68bf7be647e7a31d46e504dd63fb2fa5f2984d7e119a294f8ac1aee58fb1c72",
49
- "typeScriptVersion": "4.1"
48
+ "typesPublisherContentHash": "8694a0305ae64b82c2884086cdd9105a0304e7c1124d0ddccd90803f962a0d52",
49
+ "typeScriptVersion": "4.2"
50
50
  }