@types/office-js 1.0.419 → 1.0.420
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 +1 -1
- office-js/index.d.ts +29 -27
- office-js/package.json +2 -2
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: Tue, 10 Sep 2024
|
|
11
|
+
* Last updated: Tue, 10 Sep 2024 19:07:18 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -10335,16 +10335,17 @@ declare namespace Office {
|
|
|
10335
10335
|
/**
|
|
10336
10336
|
* Gets the ID of the series that an instance belongs to.
|
|
10337
10337
|
*
|
|
10338
|
-
* In Outlook on the web
|
|
10339
|
-
*
|
|
10338
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
10339
|
+
* the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
10340
|
+
* However, in Outlook on Android and on iOS, `seriesId` returns the REST ID of the parent item.
|
|
10340
10341
|
*
|
|
10341
10342
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
10342
|
-
* The `seriesId` property
|
|
10343
|
+
* The `seriesId` property isn't identical to the Outlook IDs used by the Outlook REST API.
|
|
10343
10344
|
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
10344
10345
|
* 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}.
|
|
10345
10346
|
*
|
|
10346
|
-
* The `seriesId` property returns `null` for items that
|
|
10347
|
-
* and returns `undefined` for any other items that
|
|
10347
|
+
* The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
10348
|
+
* and returns `undefined` for any other items that aren't meeting requests.
|
|
10348
10349
|
*
|
|
10349
10350
|
* @remarks
|
|
10350
10351
|
* [Api set: Mailbox 1.7]
|
|
@@ -10672,7 +10673,7 @@ declare namespace Office {
|
|
|
10672
10673
|
* The behavior of the `close` method depends on the current state of the item being composed.
|
|
10673
10674
|
* If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
|
|
10674
10675
|
*
|
|
10675
|
-
* In
|
|
10676
|
+
* In Outlook on Windows (classic) and on Mac, the `close` method has no effect on a reply in the Reading Pane.
|
|
10676
10677
|
*
|
|
10677
10678
|
* @remarks
|
|
10678
10679
|
* [Api set: Mailbox 1.3]
|
|
@@ -10999,12 +11000,12 @@ declare namespace Office {
|
|
|
10999
11000
|
/**
|
|
11000
11001
|
* Gets if the client signature is enabled.
|
|
11001
11002
|
*
|
|
11002
|
-
*
|
|
11003
|
+
* In Outlook on Windows (classic) and on Mac, returns `true` if the default signature for new messages, replies, or forwards is set
|
|
11003
11004
|
* to a template for the sending Outlook account.
|
|
11004
|
-
*
|
|
11005
|
-
*
|
|
11006
|
-
* If the settings are set to "(none)" in Windows (classic) or Mac
|
|
11007
|
-
*
|
|
11005
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11006
|
+
* returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11007
|
+
* 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,
|
|
11008
|
+
* returns `false`.
|
|
11008
11009
|
*
|
|
11009
11010
|
* @remarks
|
|
11010
11011
|
* [Api set: Mailbox 1.10]
|
|
@@ -11022,12 +11023,12 @@ declare namespace Office {
|
|
|
11022
11023
|
/**
|
|
11023
11024
|
* Gets if the client signature is enabled.
|
|
11024
11025
|
*
|
|
11025
|
-
*
|
|
11026
|
+
* In Outlook on Windows (classic) and on Mac, returns `true` if the default signature for new messages, replies, or forwards is set
|
|
11026
11027
|
* to a template for the sending Outlook account.
|
|
11027
|
-
*
|
|
11028
|
-
*
|
|
11029
|
-
* If the settings are set to "(none)" in Windows (classic) or Mac
|
|
11030
|
-
*
|
|
11028
|
+
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
11029
|
+
* returns `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
11030
|
+
* 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,
|
|
11031
|
+
* returns `false`.
|
|
11031
11032
|
*
|
|
11032
11033
|
* @remarks
|
|
11033
11034
|
* [Api set: Mailbox 1.10]
|
|
@@ -11749,8 +11750,9 @@ declare namespace Office {
|
|
|
11749
11750
|
/**
|
|
11750
11751
|
* Gets the ID of the series that an instance belongs to.
|
|
11751
11752
|
*
|
|
11752
|
-
* In Outlook on the web
|
|
11753
|
-
*
|
|
11753
|
+
* In Outlook on the web, on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), and on Mac,
|
|
11754
|
+
* the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
|
|
11755
|
+
* However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
11754
11756
|
*
|
|
11755
11757
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
11756
11758
|
* 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
|
|
@@ -13766,8 +13768,8 @@ declare namespace Office {
|
|
|
13766
13768
|
*
|
|
13767
13769
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13768
13770
|
*
|
|
13769
|
-
* **Important**: The `Outlook` value is returned for Outlook
|
|
13770
|
-
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows
|
|
13771
|
+
* **Important**: The `Outlook` value is returned for Outlook on Windows (classic) and on Mac. `newOutlookWindows` is returned for
|
|
13772
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows}.
|
|
13771
13773
|
*/
|
|
13772
13774
|
hostName: string;
|
|
13773
13775
|
/**
|
|
@@ -14709,8 +14711,8 @@ declare namespace Office {
|
|
|
14709
14711
|
* Contains the following members.
|
|
14710
14712
|
*
|
|
14711
14713
|
* - `hostName` (string): A string that represents the name of the Office application.
|
|
14712
|
-
* It should be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`.
|
|
14713
|
-
* **Note**: The "Outlook" value is returned for Outlook on
|
|
14714
|
+
* It should be one of the following values: `Outlook`, `newOutlookWindows`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`.
|
|
14715
|
+
* **Note**: The "Outlook" value is returned for Outlook on Windows (classic) and on Mac.
|
|
14714
14716
|
*
|
|
14715
14717
|
* - `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0").
|
|
14716
14718
|
* 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
|
|
@@ -15130,7 +15132,7 @@ declare namespace Office {
|
|
|
15130
15132
|
* If you don't specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15131
15133
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15132
15134
|
*
|
|
15133
|
-
* In
|
|
15135
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15134
15136
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15135
15137
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15136
15138
|
*
|
|
@@ -15160,7 +15162,7 @@ declare namespace Office {
|
|
|
15160
15162
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15161
15163
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15162
15164
|
*
|
|
15163
|
-
* In
|
|
15165
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15164
15166
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15165
15167
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15166
15168
|
*
|
|
@@ -15193,7 +15195,7 @@ declare namespace Office {
|
|
|
15193
15195
|
* If you do not specify any attendees as input arguments, the method displays a form with a **Save** button.
|
|
15194
15196
|
* If you have specified attendees, the form would include the attendees and a **Send** button.
|
|
15195
15197
|
*
|
|
15196
|
-
* In
|
|
15198
|
+
* In Outlook on Windows (classic) and on Mac, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or
|
|
15197
15199
|
* `resources` parameter, this method displays a meeting form with a **Send** button.
|
|
15198
15200
|
* If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button.
|
|
15199
15201
|
*
|
|
@@ -16487,7 +16489,7 @@ declare namespace Office {
|
|
|
16487
16489
|
* The behavior of the `close` method depends on the current state of the item being composed.
|
|
16488
16490
|
* If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
|
|
16489
16491
|
*
|
|
16490
|
-
* In
|
|
16492
|
+
* In Outlook on Windows (classic) and on Mac, the `close` method has no effect on a reply in the Reading Pane.
|
|
16491
16493
|
*
|
|
16492
16494
|
* @remarks
|
|
16493
16495
|
* [Api set: Mailbox 1.3]
|
|
@@ -16508,7 +16510,7 @@ declare namespace Office {
|
|
|
16508
16510
|
*
|
|
16509
16511
|
* - Determine when a user cancels the save item dialog on a message being composed.
|
|
16510
16512
|
*
|
|
16511
|
-
* - Close a reply in the Reading Pane or an existing draft
|
|
16513
|
+
* - Close a reply in the Reading Pane or an existing draft.
|
|
16512
16514
|
*/
|
|
16513
16515
|
close(): void;
|
|
16514
16516
|
/**
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.420",
|
|
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": "
|
|
48
|
+
"typesPublisherContentHash": "e8183854d0fcc340bbf9614b6657e7246b4cb8c40b294f81bf50c420901042a6",
|
|
49
49
|
"typeScriptVersion": "4.8"
|
|
50
50
|
}
|