@types/office-js 1.0.329 → 1.0.331

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: Fri, 09 Jun 2023 17:33:06 GMT
11
+ * Last updated: Mon, 19 Jun 2023 15:02:35 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
@@ -1544,17 +1544,21 @@ declare namespace Office {
1544
1544
  *
1545
1545
  * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
1546
1546
  *
1547
- * **Important**: In Outlook, this API isn't supported in the following scenarios.
1547
+ * **Important**:
1548
+ *
1549
+ * - In Outlook, this API isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
1548
1550
  *
1549
- * - If the add-in is loaded in an Outlook.com or Gmail mailbox.
1551
+ * - In Outlook on the web, this API isn't supported if you use the Safari browser. This results in error 13001 ("The user is not signed into Office").
1550
1552
  *
1551
- * - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
1553
+ * - In Outlook on the web, if you use the
1554
+ * {@link https://learn.microsoft.com/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1) | displayDialogAsync}
1555
+ * method to open a dialog, you must close the dialog before you can call `getAccessToken`.
1552
1556
  *
1553
- * **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
1557
+ * - In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
1554
1558
  * To retrieve an access token in older builds, use
1555
- * {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
1556
- * OfficeRuntime.auth.getAccessToken} instead. For more information, see
1557
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
1559
+ * {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
1560
+ * OfficeRuntime.auth.getAccessToken} instead. For more information, see
1561
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
1558
1562
  *
1559
1563
  * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
1560
1564
  * @returns Promise to the access token.
@@ -12223,13 +12227,10 @@ declare namespace Office {
12223
12227
  *
12224
12228
  * **Important**:
12225
12229
  *
12226
- * - After the content is prepended, the position of the cursor depends on which client the add-in is running.
12227
- *
12228
- * - **Windows, Web**: The cursor position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning
12229
- * of the body prior to the `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call.
12230
- *
12231
- * - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
12232
- * body of the mail item.
12230
+ * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on Windows and on the web, the cursor
12231
+ * position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
12232
+ * `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
12233
+ * position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
12233
12234
  *
12234
12235
  * - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
12235
12236
  * make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
@@ -12264,13 +12265,10 @@ declare namespace Office {
12264
12265
  *
12265
12266
  * **Important**:
12266
12267
  *
12267
- * - After the content is prepended, the position of the cursor depends on which client the add-in is running.
12268
- *
12269
- * - **Windows, Web**: The cursor position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning
12270
- * of the body prior to the `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call.
12271
- *
12272
- * - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
12273
- * body of the mail item.
12268
+ * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on Windows and on the web, the cursor
12269
+ * position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
12270
+ * `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
12271
+ * position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
12274
12272
  *
12275
12273
  * - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
12276
12274
  * make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
@@ -12381,14 +12379,10 @@ declare namespace Office {
12381
12379
  *
12382
12380
  * **Important**:
12383
12381
  *
12384
- * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
12385
- *
12386
- * - **Windows**: The cursor appears at the beginning of the body of the mail item.
12387
- *
12388
- * - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
12389
- * body of the mail item.
12390
- *
12391
- * - **Web**: The cursor appears at the end of the body of the mail item.
12382
+ * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running. In Outlook on Windows,
12383
+ * the cursor appears at the beginning of the body of the mail item, while in Outlook on the web, the cursor appears at the end of the body of the mail item.
12384
+ * In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects
12385
+ * something in the body of the mail item.
12392
12386
  *
12393
12387
  * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12394
12388
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
@@ -12427,14 +12421,10 @@ declare namespace Office {
12427
12421
  *
12428
12422
  * **Important**:
12429
12423
  *
12430
- * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
12431
- *
12432
- * - **Windows**: The cursor appears at the beginning of the body of the mail item.
12433
- *
12434
- * - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
12435
- * body of the mail item.
12436
- *
12437
- * - **Web**: The cursor appears at the end of the body of the mail item.
12424
+ * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running. In Outlook on Windows,
12425
+ * the cursor appears at the beginning of the body of the mail item, while in Outlook on the web, the cursor appears at the end of the body of the mail item.
12426
+ * In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects
12427
+ * something in the body of the mail item.
12438
12428
  *
12439
12429
  * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12440
12430
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.329",
3
+ "version": "1.0.331",
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": "c999fce12f63f793997cc192638b8d3ea904ce3e6b097605a62ff067972626ef",
48
+ "typesPublisherContentHash": "5666ed95bccc0a1b1d122dc4303e86ab515d310ef55a6daba6d9362a2551d8cc",
49
49
  "typeScriptVersion": "4.3"
50
50
  }