@types/office-js-preview 1.0.505 → 1.0.507
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 +28 -26
- 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-preview (https://github.com
|
|
|
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: Wed, 11 Sep 2024 18:39:09 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -10399,16 +10399,17 @@ declare namespace Office {
|
|
|
10399
10399
|
/**
|
|
10400
10400
|
* Gets the ID of the series that an instance belongs to.
|
|
10401
10401
|
*
|
|
10402
|
-
* In Outlook on the web
|
|
10403
|
-
*
|
|
10402
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
10403
|
+
* the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
10404
|
+
* However, in Outlook on Android and on iOS, `seriesId` returns the REST ID of the parent item.
|
|
10404
10405
|
*
|
|
10405
10406
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
10406
|
-
* The `seriesId` property
|
|
10407
|
+
* The `seriesId` property isn't identical to the Outlook IDs used by the Outlook REST API.
|
|
10407
10408
|
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
10408
10409
|
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
10409
10410
|
*
|
|
10410
|
-
* The `seriesId` property returns `null` for items that
|
|
10411
|
-
* and returns `undefined` for any other items that
|
|
10411
|
+
* The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
10412
|
+
* and returns `undefined` for any other items that aren't meeting requests.
|
|
10412
10413
|
*
|
|
10413
10414
|
* @remarks
|
|
10414
10415
|
* [Api set: Mailbox 1.7]
|
|
@@ -10736,7 +10737,7 @@ declare namespace Office {
|
|
|
10736
10737
|
* The behavior of the `close` method depends on the current state of the item being composed.
|
|
10737
10738
|
* If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
|
|
10738
10739
|
*
|
|
10739
|
-
* In
|
|
10740
|
+
* In Outlook on Windows (classic) and on Mac, the `close` method has no effect on a reply in the Reading Pane.
|
|
10740
10741
|
*
|
|
10741
10742
|
* @remarks
|
|
10742
10743
|
* [Api set: Mailbox 1.3]
|
|
@@ -11063,10 +11064,10 @@ declare namespace Office {
|
|
|
11063
11064
|
/**
|
|
11064
11065
|
* Gets if the client signature is enabled.
|
|
11065
11066
|
*
|
|
11066
|
-
*
|
|
11067
|
-
*
|
|
11068
|
-
* If the settings are set to "(none)" in Windows (classic) or Mac
|
|
11069
|
-
*
|
|
11067
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11068
|
+
* returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11069
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or on Mac or disabled in Outlook on the web or new Outlook on Windows,
|
|
11070
|
+
* returns `false`.
|
|
11070
11071
|
*
|
|
11071
11072
|
* @remarks
|
|
11072
11073
|
* [Api set: Mailbox 1.10]
|
|
@@ -11084,10 +11085,10 @@ declare namespace Office {
|
|
|
11084
11085
|
/**
|
|
11085
11086
|
* Gets if the client signature is enabled.
|
|
11086
11087
|
*
|
|
11087
|
-
*
|
|
11088
|
-
*
|
|
11089
|
-
* If the settings are set to "(none)" in Windows (classic) or Mac
|
|
11090
|
-
*
|
|
11088
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11089
|
+
* returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11090
|
+
* If the settings are set to "(none)" in Outlook on Windows (classic) or on Mac or disabled in Outlook on the web or new Outlook on Windows,
|
|
11091
|
+
* returns `false`.
|
|
11091
11092
|
*
|
|
11092
11093
|
* @remarks
|
|
11093
11094
|
* [Api set: Mailbox 1.10]
|
|
@@ -11822,8 +11823,9 @@ declare namespace Office {
|
|
|
11822
11823
|
/**
|
|
11823
11824
|
* Gets the ID of the series that an instance belongs to.
|
|
11824
11825
|
*
|
|
11825
|
-
* In Outlook on the web
|
|
11826
|
-
*
|
|
11826
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
11827
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
11828
|
+
* However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
11827
11829
|
*
|
|
11828
11830
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
11829
11831
|
* The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it
|
|
@@ -13830,8 +13832,8 @@ declare namespace Office {
|
|
|
13830
13832
|
*
|
|
13831
13833
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13832
13834
|
*
|
|
13833
|
-
* **Important**: The `Outlook` value is returned for Outlook
|
|
13834
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
13835
|
+
* **Important**: The `Outlook` value is returned for Outlook on Windows (classic) and on Mac. `newOutlookWindows` is returned for
|
|
13836
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
13835
13837
|
*/
|
|
13836
13838
|
hostName: string;
|
|
13837
13839
|
/**
|
|
@@ -14968,8 +14970,8 @@ declare namespace Office {
|
|
|
14968
14970
|
* Contains the following members.
|
|
14969
14971
|
*
|
|
14970
14972
|
* - `hostName` (string): A string that represents the name of the Office application.
|
|
14971
|
-
* It should be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`.
|
|
14972
|
-
* **Note**: The "Outlook" value is returned for Outlook on
|
|
14973
|
+
* It should be one of the following values: `Outlook`, `newOutlookWindows`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`.
|
|
14974
|
+
* **Note**: The "Outlook" value is returned for Outlook on Windows (classic) and on Mac.
|
|
14973
14975
|
*
|
|
14974
14976
|
* - `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0").
|
|
14975
14977
|
* If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the `hostVersion` property returns the version of the
|
|
@@ -15388,7 +15390,7 @@ declare namespace Office {
|
|
|
15388
15390
|
* If you don't specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15389
15391
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15390
15392
|
*
|
|
15391
|
-
* In
|
|
15393
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15392
15394
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15393
15395
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15394
15396
|
*
|
|
@@ -15418,7 +15420,7 @@ declare namespace Office {
|
|
|
15418
15420
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15419
15421
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15420
15422
|
*
|
|
15421
|
-
* In
|
|
15423
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15422
15424
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15423
15425
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15424
15426
|
*
|
|
@@ -15451,7 +15453,7 @@ declare namespace Office {
|
|
|
15451
15453
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15452
15454
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15453
15455
|
*
|
|
15454
|
-
* In
|
|
15456
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15455
15457
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15456
15458
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15457
15459
|
*
|
|
@@ -16745,7 +16747,7 @@ declare namespace Office {
|
|
|
16745
16747
|
* The behavior of the `close` method depends on the current state of the item being composed.
|
|
16746
16748
|
* If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
|
|
16747
16749
|
*
|
|
16748
|
-
* In
|
|
16750
|
+
* In Outlook on Windows (classic) and on Mac, the `close` method has no effect on a reply in the Reading Pane.
|
|
16749
16751
|
*
|
|
16750
16752
|
* @remarks
|
|
16751
16753
|
* [Api set: Mailbox 1.3]
|
|
@@ -16766,7 +16768,7 @@ declare namespace Office {
|
|
|
16766
16768
|
*
|
|
16767
16769
|
* - Determine when a user cancels the save item dialog on a message being composed.
|
|
16768
16770
|
*
|
|
16769
|
-
* - Close a reply in the Reading Pane or an existing draft
|
|
16771
|
+
* - Close a reply in the Reading Pane or an existing draft.
|
|
16770
16772
|
*/
|
|
16771
16773
|
close(): void;
|
|
16772
16774
|
/**
|
|
@@ -90250,7 +90252,7 @@ declare namespace Word {
|
|
|
90250
90252
|
* @remarks
|
|
90251
90253
|
* [Api set: WordApi 1.8]
|
|
90252
90254
|
*/
|
|
90253
|
-
popupOptions
|
|
90255
|
+
popupOptions?: Word.CritiquePopupOptions;
|
|
90254
90256
|
/**
|
|
90255
90257
|
* Gets the start index of the critique inside paragraph.
|
|
90256
90258
|
*
|
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.507",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "2f57a94a274dd8c3d73a1c323edf7fb76f0eedea6b3c61dbd2ec6a4c03c30a56",
|
|
49
49
|
"typeScriptVersion": "4.8",
|
|
50
50
|
"nonNpm": true
|
|
51
51
|
}
|