@types/office-js-preview 1.0.665 → 1.0.666
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 +134 -0
- 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: Fri, 14 Nov 2025
|
|
11
|
+
* Last updated: Fri, 14 Nov 2025 23:02:09 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -10402,6 +10402,35 @@ declare namespace Office {
|
|
|
10402
10402
|
*/
|
|
10403
10403
|
Subject = "subject"
|
|
10404
10404
|
}
|
|
10405
|
+
/**
|
|
10406
|
+
* Specifies the status of Exchange Web Services (EWS) callback tokens or REST API tokens in an organization.
|
|
10407
|
+
*
|
|
10408
|
+
* @remarks
|
|
10409
|
+
* [Api set: Mailbox preview]
|
|
10410
|
+
*
|
|
10411
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
10412
|
+
*
|
|
10413
|
+
* **Important**: Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants.
|
|
10414
|
+
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
10415
|
+
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
10416
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
10417
|
+
*
|
|
10418
|
+
* @beta
|
|
10419
|
+
*/
|
|
10420
|
+
enum TokenStatus {
|
|
10421
|
+
/**
|
|
10422
|
+
* EWS callback tokens or REST API tokens are turned off in the organization.
|
|
10423
|
+
*/
|
|
10424
|
+
Disabled = 0,
|
|
10425
|
+
/**
|
|
10426
|
+
* EWS callback tokens or REST API tokens are supported in the organization.
|
|
10427
|
+
*/
|
|
10428
|
+
Enabled = 1,
|
|
10429
|
+
/**
|
|
10430
|
+
* The mailbox is hosted in an Exchange Online environment where EWS tokens are turned off and are no longer supported.
|
|
10431
|
+
*/
|
|
10432
|
+
Removed = 2
|
|
10433
|
+
}
|
|
10405
10434
|
/**
|
|
10406
10435
|
* Specifies the week of the month.
|
|
10407
10436
|
*
|
|
@@ -14611,6 +14640,29 @@ declare namespace Office {
|
|
|
14611
14640
|
* property to get similar information.
|
|
14612
14641
|
*/
|
|
14613
14642
|
interface Diagnostics {
|
|
14643
|
+
/**
|
|
14644
|
+
* Gets an object to identify whether Exchange Web Services (EWS) callback tokens are supported in an organization.
|
|
14645
|
+
*
|
|
14646
|
+
* @remarks
|
|
14647
|
+
*
|
|
14648
|
+
* [Api set: Mailbox preview]
|
|
14649
|
+
*
|
|
14650
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
14651
|
+
*
|
|
14652
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14653
|
+
*
|
|
14654
|
+
* **Important**:
|
|
14655
|
+
*
|
|
14656
|
+
* - The `ews` property is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
14657
|
+
*
|
|
14658
|
+
* - Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants.
|
|
14659
|
+
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
14660
|
+
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
14661
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
14662
|
+
*
|
|
14663
|
+
* @beta
|
|
14664
|
+
*/
|
|
14665
|
+
ews: Ews;
|
|
14614
14666
|
/**
|
|
14615
14667
|
* Gets a string that represents the type of Outlook client.
|
|
14616
14668
|
*
|
|
@@ -15372,6 +15424,82 @@ declare namespace Office {
|
|
|
15372
15424
|
*/
|
|
15373
15425
|
urls: string[];
|
|
15374
15426
|
}
|
|
15427
|
+
/**
|
|
15428
|
+
* Provides methods to determine if Exchange Web Services (EWS) callback tokens are supported in an organization.
|
|
15429
|
+
*
|
|
15430
|
+
* @remarks
|
|
15431
|
+
*
|
|
15432
|
+
* [Api set: Mailbox preview]
|
|
15433
|
+
*
|
|
15434
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15435
|
+
*
|
|
15436
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15437
|
+
*
|
|
15438
|
+
* **Important**: Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants.
|
|
15439
|
+
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
15440
|
+
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
15441
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
15442
|
+
*
|
|
15443
|
+
* @beta
|
|
15444
|
+
*/
|
|
15445
|
+
interface Ews {
|
|
15446
|
+
/**
|
|
15447
|
+
* Gets the status of EWS callback tokens in an organization.
|
|
15448
|
+
*
|
|
15449
|
+
* @remarks
|
|
15450
|
+
*
|
|
15451
|
+
* [Api set: Mailbox preview]
|
|
15452
|
+
*
|
|
15453
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15454
|
+
*
|
|
15455
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15456
|
+
*
|
|
15457
|
+
* **Important**:
|
|
15458
|
+
*
|
|
15459
|
+
* - The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
15460
|
+
*
|
|
15461
|
+
* - The `getTokenStatusAsync` method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
|
|
15462
|
+
*
|
|
15463
|
+
* - Calling the `getTokenStatusAsync` method in compose mode requires you to have saved the item. The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
15464
|
+
*
|
|
15465
|
+
* @param options - An object literal that contains one or more of the following properties. `asyncContext`: Any data you want to access in the callback function.
|
|
15466
|
+
* `isRest`: Identifies whether the token needed is for EWS or Outlook REST APIs. By default, the `isRest` property is set to `false`.
|
|
15467
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of type Office.AsyncResult.
|
|
15468
|
+
* The `asyncResult.value` property returns the token status, which can be `Office.MailboxEnums.TokenStatus.Enabled`, `Office.MailboxEnums.TokenStatus.Disabled`, or
|
|
15469
|
+
* `Office.MailboxEnums.TokenStatus.Removed`. A `Office.MailboxEnums.TokenStatus.Removed` status indicates that the mailbox is hosted in an Exchange Online environment
|
|
15470
|
+
* where legacy Exchange tokens are turned off and are no longer supported.
|
|
15471
|
+
*
|
|
15472
|
+
* @beta
|
|
15473
|
+
*/
|
|
15474
|
+
getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
|
|
15475
|
+
/**
|
|
15476
|
+
* Gets the status of EWS callback tokens in an organization.
|
|
15477
|
+
*
|
|
15478
|
+
* @remarks
|
|
15479
|
+
*
|
|
15480
|
+
* [Api set: Mailbox preview]
|
|
15481
|
+
*
|
|
15482
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15483
|
+
*
|
|
15484
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15485
|
+
*
|
|
15486
|
+
* **Important**:
|
|
15487
|
+
*
|
|
15488
|
+
* - The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
15489
|
+
*
|
|
15490
|
+
* - The `getTokenStatusAsync` method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
|
|
15491
|
+
*
|
|
15492
|
+
* - Calling the `getTokenStatusAsync` method in compose mode requires you to have saved the item. The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
15493
|
+
*
|
|
15494
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of type Office.AsyncResult.
|
|
15495
|
+
* The `asyncResult.value` property returns the token status, which can be `Office.MailboxEnums.TokenStatus.Enabled`, `Office.MailboxEnums.TokenStatus.Disabled`, or
|
|
15496
|
+
* `Office.MailboxEnums.TokenStatus.Removed`. A `Office.MailboxEnums.TokenStatus.Removed` status indicates that the mailbox is hosted in an Exchange Online environment
|
|
15497
|
+
* where legacy Exchange tokens are turned off and are no longer supported.
|
|
15498
|
+
*
|
|
15499
|
+
* @beta
|
|
15500
|
+
*/
|
|
15501
|
+
getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
|
|
15502
|
+
}
|
|
15375
15503
|
/**
|
|
15376
15504
|
* Provides a method to get the from value of a message in an Outlook add-in.
|
|
15377
15505
|
*
|
|
@@ -18536,6 +18664,9 @@ declare namespace Office {
|
|
|
18536
18664
|
* add-ins to use {@link https://learn.microsoft.com/outlook/rest#outlook-rest-api-via-microsoft-graph | Microsoft Graph}. For guidance, see
|
|
18537
18665
|
* {@link https://learn.microsoft.com/outlook/rest/compare-graph | Compare Microsoft Graph and Outlook REST API endpoints}.
|
|
18538
18666
|
*
|
|
18667
|
+
* - To determine if REST or EWS tokens are available in an organization, call `Office.context.mailbox.diagnostics.ews.getTokenStatusAsync`.
|
|
18668
|
+
* The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
18669
|
+
*
|
|
18539
18670
|
* - This method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
|
|
18540
18671
|
*
|
|
18541
18672
|
* - This method is only supported in read mode in Outlook on Android and on iOS. For more information on supported APIs in Outlook mobile, see
|
|
@@ -18640,6 +18771,9 @@ declare namespace Office {
|
|
|
18640
18771
|
* attachment or item. For example, you can create a remote service to
|
|
18641
18772
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
|
|
18642
18773
|
*
|
|
18774
|
+
* - To determine if REST or EWS tokens are available in an organization, call `Office.context.mailbox.diagnostics.ews.getTokenStatusAsync`.
|
|
18775
|
+
* The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
18776
|
+
*
|
|
18643
18777
|
* - Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
18644
18778
|
*
|
|
18645
18779
|
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
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.666",
|
|
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",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "e195a2fd44f18161490f2fcfd9e5a2d94512e85db6e32df50b479d17b6b7ffe8",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|