@types/office-js-preview 1.0.296 → 1.0.299
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 +64 -15
- 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, 21 Apr 2022 23:31:47 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
|
@@ -8864,6 +8864,11 @@ declare namespace Office {
|
|
|
8864
8864
|
* [Api set: Mailbox 1.1]
|
|
8865
8865
|
*
|
|
8866
8866
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8867
|
+
*
|
|
8868
|
+
* **Important**: A `recipientType` property value isn't returned by the
|
|
8869
|
+
* {@link https://docs.microsoft.com/javascript/api/outlook/office.from?view=outlook-js-preview#outlook-office-from-getasync-member(1) | Office.context.mailbox.item.from.getAsync}
|
|
8870
|
+
* and {@link https://docs.microsoft.com/javascript/api/outlook/office.organizer?view=outlook-js-preview#outlook-office-organizer-getasync-member(1) | Office.context.mailbox.item.organizer.getAsync} methods.
|
|
8871
|
+
* The email sender or appointment organizer is always a user whose email address is on the Exchange server.
|
|
8867
8872
|
*/
|
|
8868
8873
|
enum RecipientType {
|
|
8869
8874
|
/**
|
|
@@ -12962,6 +12967,12 @@ declare namespace Office {
|
|
|
12962
12967
|
appointmentResponse: MailboxEnums.ResponseType | string;
|
|
12963
12968
|
/**
|
|
12964
12969
|
* Gets the email address type of a recipient.
|
|
12970
|
+
*
|
|
12971
|
+
* @remarks
|
|
12972
|
+
* **Important**: A `recipientType` property value isn't returned by the
|
|
12973
|
+
* {@link https://docs.microsoft.com/javascript/api/outlook/office.from?view=outlook-js-preview#outlook-office-from-getasync-member(1) | Office.context.mailbox.item.from.getAsync}
|
|
12974
|
+
* and {@link https://docs.microsoft.com/javascript/api/outlook/office.organizer?view=outlook-js-preview#outlook-office-organizer-getasync-member(1) | Office.context.mailbox.item.organizer.getAsync} methods.
|
|
12975
|
+
* The email sender or appointment organizer is always a user whose email address is on the Exchange server.
|
|
12965
12976
|
*/
|
|
12966
12977
|
recipientType: MailboxEnums.RecipientType | string;
|
|
12967
12978
|
}
|
|
@@ -13212,6 +13223,9 @@ declare namespace Office {
|
|
|
13212
13223
|
*
|
|
13213
13224
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13214
13225
|
*
|
|
13226
|
+
* **Important**: A `recipientType` property value isn't returned by the getAsync method.
|
|
13227
|
+
* The email sender is always a user whose email address is on the Exchange server.
|
|
13228
|
+
*
|
|
13215
13229
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13216
13230
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
13217
13231
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -13232,6 +13246,9 @@ declare namespace Office {
|
|
|
13232
13246
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
13233
13247
|
*
|
|
13234
13248
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13249
|
+
*
|
|
13250
|
+
* **Important**: A `recipientType` property value isn't returned by the getAsync methods.
|
|
13251
|
+
* The email sender is always a user whose email address is on the Exchange server.
|
|
13235
13252
|
*
|
|
13236
13253
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13237
13254
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
@@ -14359,7 +14376,7 @@ declare namespace Office {
|
|
|
14359
14376
|
*
|
|
14360
14377
|
* The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls.
|
|
14361
14378
|
*
|
|
14362
|
-
* You can pass both the token and either an attachment identifier or item identifier to
|
|
14379
|
+
* You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
|
|
14363
14380
|
* the token as a bearer authorization token to call the Exchange Web Services (EWS)
|
|
14364
14381
|
* {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or
|
|
14365
14382
|
* {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
|
|
@@ -14399,7 +14416,7 @@ declare namespace Office {
|
|
|
14399
14416
|
*
|
|
14400
14417
|
* The token is returned as a string in the `asyncResult.value` property.
|
|
14401
14418
|
*
|
|
14402
|
-
* You can pass both the token and either an attachment identifier or item identifier to
|
|
14419
|
+
* You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
|
|
14403
14420
|
* the token as a bearer authorization token to call the Exchange Web Services (EWS)
|
|
14404
14421
|
* {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} or
|
|
14405
14422
|
* {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
|
|
@@ -14447,7 +14464,7 @@ declare namespace Office {
|
|
|
14447
14464
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14448
14465
|
*
|
|
14449
14466
|
* The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
|
|
14450
|
-
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with
|
|
14467
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with an external system}.
|
|
14451
14468
|
*
|
|
14452
14469
|
* **Errors**:
|
|
14453
14470
|
*
|
|
@@ -17336,6 +17353,9 @@ declare namespace Office {
|
|
|
17336
17353
|
*
|
|
17337
17354
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17338
17355
|
*
|
|
17356
|
+
* **Important**: A `recipientType` property value isn't returned by the getAsync method.
|
|
17357
|
+
* The appointment organizer is always a user whose email address is on the Exchange server.
|
|
17358
|
+
*
|
|
17339
17359
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17340
17360
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
17341
17361
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -17353,6 +17373,9 @@ declare namespace Office {
|
|
|
17353
17373
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
17354
17374
|
*
|
|
17355
17375
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
17376
|
+
*
|
|
17377
|
+
* **Important**: A `recipientType` property value isn't returned by the getAsync method.
|
|
17378
|
+
* The appointment organizer is always a user whose email address is on the Exchange server.
|
|
17356
17379
|
*
|
|
17357
17380
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17358
17381
|
* `asyncResult`, which is an `AsyncResult` object. The `value` property of the result is the appointment's organizer value,
|
|
@@ -20009,7 +20032,7 @@ declare namespace Excel {
|
|
|
20009
20032
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20010
20033
|
* @beta
|
|
20011
20034
|
*/
|
|
20012
|
-
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & CellValueExtraProperties;
|
|
20035
|
+
type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
|
|
20013
20036
|
/**
|
|
20014
20037
|
* These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
|
|
20015
20038
|
*
|
|
@@ -20045,7 +20068,7 @@ declare namespace Excel {
|
|
|
20045
20068
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20046
20069
|
* @beta
|
|
20047
20070
|
*/
|
|
20048
|
-
type CellValueAndPropertyMetadata = CellValue & EntityPropertyExtraProperties;
|
|
20071
|
+
type CellValueAndPropertyMetadata = (CellValue) & EntityPropertyExtraProperties;
|
|
20049
20072
|
/**
|
|
20050
20073
|
* The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source.
|
|
20051
20074
|
*
|
|
@@ -21499,7 +21522,7 @@ declare namespace Excel {
|
|
|
21499
21522
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21500
21523
|
* @beta
|
|
21501
21524
|
*/
|
|
21502
|
-
|
|
21525
|
+
rowCount?: number;
|
|
21503
21526
|
/**
|
|
21504
21527
|
* Represents the number of columns that would spill if there were no #SPILL! error.
|
|
21505
21528
|
*
|
|
@@ -21507,7 +21530,7 @@ declare namespace Excel {
|
|
|
21507
21530
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21508
21531
|
* @beta
|
|
21509
21532
|
*/
|
|
21510
|
-
|
|
21533
|
+
columnCount?: number;
|
|
21511
21534
|
}
|
|
21512
21535
|
/**
|
|
21513
21536
|
* Represents the value of a cell containing a string.
|
|
@@ -31836,7 +31859,7 @@ declare namespace Excel {
|
|
|
31836
31859
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31837
31860
|
* @beta
|
|
31838
31861
|
*/
|
|
31839
|
-
readonly valueAsJson: CellValue;
|
|
31862
|
+
readonly valueAsJson: CellValue | string;
|
|
31840
31863
|
/**
|
|
31841
31864
|
* A JSON representation of the values in this named item.
|
|
31842
31865
|
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
@@ -31846,7 +31869,7 @@ declare namespace Excel {
|
|
|
31846
31869
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31847
31870
|
* @beta
|
|
31848
31871
|
*/
|
|
31849
|
-
readonly valueAsJsonLocal: CellValue
|
|
31872
|
+
readonly valueAsJsonLocal: CellValue | string;
|
|
31850
31873
|
/**
|
|
31851
31874
|
* Specifies if the object is visible.
|
|
31852
31875
|
*
|
|
@@ -37660,13 +37683,32 @@ declare namespace Excel {
|
|
|
37660
37683
|
* @param color HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
37661
37684
|
*/
|
|
37662
37685
|
setSolidColor(color: string): void;
|
|
37686
|
+
/**
|
|
37687
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37688
|
+
*
|
|
37689
|
+
* @param options Provides options for which properties of the object to load.
|
|
37690
|
+
*/
|
|
37691
|
+
load(options?: Excel.Interfaces.ChartFillLoadOptions): Excel.ChartFill;
|
|
37692
|
+
/**
|
|
37693
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37694
|
+
*
|
|
37695
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
37696
|
+
*/
|
|
37697
|
+
load(propertyNames?: string | string[]): Excel.ChartFill;
|
|
37698
|
+
/**
|
|
37699
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37700
|
+
*
|
|
37701
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
37702
|
+
*/
|
|
37703
|
+
load(propertyNamesAndPaths?: {
|
|
37704
|
+
select?: string;
|
|
37705
|
+
expand?: string;
|
|
37706
|
+
}): Excel.ChartFill;
|
|
37663
37707
|
/**
|
|
37664
37708
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
37665
37709
|
* Whereas the original Excel.ChartFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
37666
37710
|
*/
|
|
37667
|
-
toJSON():
|
|
37668
|
-
[key: string]: string;
|
|
37669
|
-
};
|
|
37711
|
+
toJSON(): Excel.Interfaces.ChartFillData;
|
|
37670
37712
|
}
|
|
37671
37713
|
/**
|
|
37672
37714
|
* Represents the border formatting of a chart element.
|
|
@@ -52572,7 +52614,14 @@ declare namespace Excel {
|
|
|
52572
52614
|
* @remarks
|
|
52573
52615
|
* [Api set: ExcelApi 1.7]
|
|
52574
52616
|
*/
|
|
52575
|
-
|
|
52617
|
+
workbookNavigationObjectChanged = "WorkbookNavigationObjectChanged",
|
|
52618
|
+
/**
|
|
52619
|
+
* WorksheetRowHeightChanged represents the type of event registered when the height of a worksheet row is changed.
|
|
52620
|
+
* @remarks
|
|
52621
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
52622
|
+
* @beta
|
|
52623
|
+
*/
|
|
52624
|
+
worksheetRowHeightChanged = "WorksheetRowHeightChanged"
|
|
52576
52625
|
}
|
|
52577
52626
|
/**
|
|
52578
52627
|
* @remarks
|
|
@@ -65777,7 +65826,7 @@ declare namespace Excel {
|
|
|
65777
65826
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65778
65827
|
* @beta
|
|
65779
65828
|
*/
|
|
65780
|
-
valueAsJson?: CellValue;
|
|
65829
|
+
valueAsJson?: CellValue | string;
|
|
65781
65830
|
/**
|
|
65782
65831
|
* A JSON representation of the values in this named item.
|
|
65783
65832
|
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
@@ -65787,7 +65836,7 @@ declare namespace Excel {
|
|
|
65787
65836
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65788
65837
|
* @beta
|
|
65789
65838
|
*/
|
|
65790
|
-
valueAsJsonLocal?: CellValue
|
|
65839
|
+
valueAsJsonLocal?: CellValue | string;
|
|
65791
65840
|
/**
|
|
65792
65841
|
* Specifies if the object is visible.
|
|
65793
65842
|
*
|
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.299",
|
|
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": "5ea408168763b5ed21b48fa4b37180b91869c041a2418069143c29ae9e8e1fb0",
|
|
49
49
|
"typeScriptVersion": "3.9"
|
|
50
50
|
}
|