Skip to content

Commit 040f68c

Browse files
authored
Merge pull request #4956 from OfficeDev/main
[Admin] Publish
2 parents d03c77b + 50e5005 commit 040f68c

10 files changed

+194
-34
lines changed

docs/develop/development-kit-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code (preview)
2+
title: Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code
33
description: Learn how to create Office Add-in projects using Office Add-ins Development Kit extension.
4-
ms.date: 09/09/2024
4+
ms.date: 12/19/2024
55
ms.localizationpriority: high
66
---
77

8-
# Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code (preview)
8+
# Create Office Add-in projects using Office Add-ins Development Kit for Visual Studio Code
99

1010
The Office Add-ins Development Kit helps set up your environment, create Office Add-ins, and debug your code in a streamlined experience.
1111

docs/develop/enable-nested-app-authentication-in-your-add-in.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Enable SSO in an Office Add-in using nested app authentication
33
description: Learn how to enable SSO in an Office Add-in using nested app authentication.
4-
ms.date: 11/22/2024
4+
ms.date: 12/18/2024
55
ms.topic: how-to
66
ms.localizationpriority: high
77
---
@@ -45,7 +45,11 @@ To enable NAA, your app registration must include a specific redirect URI to ind
4545

4646
`brk-multihub://your-add-in-domain`
4747

48-
For example if you were testing your add-in on port 3000 on the localhost server, you would use `brk-multihub://localhost:3000` as the redirect value.
48+
Your domain must include only the origin and not its subpaths. For example:
49+
50+
✔️ brk-multihub://localhost:3000<br>
51+
✔️ brk-multihub://www.contoso.com<br>
52+
❌ brk-multihub://www.contoso.com/go
4953

5054
Trusted broker groups are dynamic by design and can be updated in the future to include additional hosts where your add-in may use NAA flows. Currently the brk-multihub group includes Office Word, Excel, PowerPoint, Outlook, and Teams (for when Office is activated inside).
5155

docs/includes/outlook-bundle-js.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
> [!TIP]
2-
> If the **bundle.js** file doesn't appear in the **Wef** folder, try the following:
32
>
4-
> - If your add-in is installed or sideloaded, restart Outlook.
5-
> - [Remove your add-in](../outlook/sideload-outlook-add-ins-for-testing.md#remove-a-sideloaded-add-in) from Outlook, then [sideload](../outlook/sideload-outlook-add-ins-for-testing.md) it again.
3+
> - There's no direct method to determine the Outlook profile GUID and mail account encoding used in the **bundle.js** file path. The most effective approach to locate your add-in's **bundle.js** file is to manually inspect each folder until you locate the **Javascript** folder that contains your add-in's ID.
4+
>
5+
> - If the **bundle.js** file doesn't appear in the **Wef** folder and your add-in is installed or sideloaded, restart Outlook. Alternatively, [remove your add-in](../outlook/sideload-outlook-add-ins-for-testing.md#remove-a-sideloaded-add-in) from Outlook, then [sideload](../outlook/sideload-outlook-add-ins-for-testing.md) it again.

docs/outlook/debug-autolaunch.md

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debug your event-based or spam-reporting Outlook add-in
33
description: Learn how to debug your Outlook add-in that implements event-based activation or integrated spam reporting.
4-
ms.date: 07/09/2024
4+
ms.date: 12/19/2024
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -28,7 +28,7 @@ For more information, see the "Debug your add-in" section of [Develop Outlook ad
2828

2929
# [Windows (classic)](#tab/windows)
3030

31-
If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generator-overview.md) to create your add-in project (for example, by completing an [event-based activation walkthrough](on-new-compose-events-walkthrough.md)), follow the **Created with Yeoman generator** option throughout this article. Otherwise, follow the **Other** steps. Visual Studio Code should be at least version 1.56.1.
31+
If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generator-overview.md) to create your add-in project (for example, by completing an [event-based activation walkthrough](on-new-compose-events-walkthrough.md)), follow the **Created with Yeoman generator** option throughout this article. Otherwise, follow the **Other** steps.
3232

3333
## Mark your add-in for debugging and set the debugger port
3434

@@ -37,19 +37,19 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato
3737
- **Add-in only manifest**: Use the value of the **\<Id\>** element child of the root **\<OfficeApp\>** element.
3838
- **Unified manifest for Microsoft 365**: Use the value of the "id" property of the root anonymous `{ ... }` object.
3939

40-
1. Create a registry `DWORD` value named `UseDirectDebugger` in `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]`. Replace `[Add-in ID]` with your add-in's ID from the manifest.
40+
1. In the registry, mark your add-in for debugging.
4141

42-
[!include[Developer registry key](../includes/developer-registry-key.md)]
42+
- **Created with Yeoman generator**: In a command line window, navigate to the root of your add-in folder then run the following command.
4343

44-
**Created with Yeoman generator**: In a command line window, navigate to the root of your add-in folder then run the following command.
44+
```command&nbsp;line
45+
npm start
46+
```
4547
46-
```command&nbsp;line
47-
npm start
48-
```
48+
In addition to building the code and starting the local server, this command sets the data of the `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger` registry DWORD value for this add-in to `1`. `[Add-in ID]` is your add-in's ID from the manifest.
4949
50-
In addition to building the code and starting the local server, this command sets the `UseDirectDebugger` registry DWORD value data for this add-in to `1`.
50+
- **Other**: In the `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger` registry DWORD value, where `[Add-in ID]` is your add-in's ID from the manifest, set its data to `1`.
5151
52-
**Other**: In the `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger` registry DWORD value, where `[Add-in ID]` is your add-in's ID from the manifest, set the value data to `1`.
52+
[!include[Developer registry key](../includes/developer-registry-key.md)]
5353
5454
1. In the registry key `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]`, where `[Add-in ID]` is your add-in's ID from the manifest, create a new `DWORD` value with the following configuration.
5555
@@ -63,11 +63,39 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato
6363
6464
![The Debug Event-based handler dialog in Windows.](../images/outlook-win-autolaunch-debug-dialog.png)
6565
66-
## Configure Visual Studio Code
66+
## Configure and attach the debugger
67+
68+
You can debug your add-in using the Microsoft Edge Inspect tool or Visual Studio Code.
69+
70+
### Debug with Microsoft Edge
71+
72+
1. Open Microsoft Edge and go to **edge://inspect/#devices**.
73+
1. In the **Remote Target** section, look for your add-in using its ID from the manifest. Then, select **Inspect**.
74+
75+
The DevTools window appears.
76+
77+
> [!NOTE]
78+
> It may take some time for your add-in to appear in the **Remote Target** section. You may need to refresh the page for the add-in to appear.
79+
80+
1. In the **Sources** tab, go to **file://** > **Users/[User]/AppData/Microsoft/Office/16.0/Wef/{[Outlook profile GUID]}/[Outlook mail account encoding]/Javascript/[Add-in ID]\_[Add-in Version]_[locale]** > **bundle.js**.
81+
82+
> [!TIP]
83+
> There's no direct method to determine the Outlook profile GUID or mail account encoding used in the **bundle.js** file path. If you're debugging multiple add-ins simultaneously, the easiest way to access an add-in's **bundle.js** file from the DevTools window is to locate the add-in's ID in the file path.
84+
85+
1. In the **bundle.js** file, place breakpoints where you want the debugger to stop.
86+
1. [Run the debugger](#run-the-debugger).
87+
88+
### Debug with Visual Studio Code
89+
90+
To debug your add-in in Visual Studio Code, you must have at least version 1.56.1 installed.
91+
92+
#### Configure the debugger
93+
94+
Configure the debugger in Visual Studio Code. Follow the steps applicable to your add-in project.
6795
68-
### Created with Yeoman generator
96+
##### Created with Yeoman generator
6997
70-
1. Back in the command line window, run the following to open your add-in project in Visual Studio Code.
98+
1. In the command line, run the following to open your add-in project in Visual Studio Code.
7199
72100
```command&nbsp;line
73101
code .
@@ -86,7 +114,7 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato
86114
}
87115
```
88116
89-
### Other
117+
##### Other
90118
91119
1. Create a new folder called **Debugging** (perhaps in your **Desktop** folder).
92120
1. Open Visual Studio Code.
@@ -113,11 +141,11 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato
113141
}
114142
```
115143
116-
## Attach the debugger
144+
#### Attach the debugger
117145
118146
The **bundle.js** file of an add-in contains the JavaScript code of your add-in. It's created when classic Outlook on Windows is opened. When Outlook starts, the **bundle.js** file of each installed add-in is cached in the **Wef** folder of your machine.
119147
120-
1. To find the add-in's **bundle.js** file, navigate to the following folder in File Explorer. Replace text enclosed in `[]` with your applicable Outlook and add-in information.
148+
1. To find the add-in's **bundle.js** file, navigate to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Outlook and add-in information.
121149
122150
```text
123151
%LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
@@ -133,9 +161,9 @@ The **bundle.js** file of an add-in contains the JavaScript code of your add-in.
133161
134162
## Run the debugger
135163
136-
1. After confirming that the debugger is attached, return to Outlook, and in the **Debug Event-based handler** dialog, choose **OK** .
164+
After confirming that the debugger is attached, return to Outlook. In the **Debug Event-based handler** dialog, choose **OK** .
137165
138-
1. You can now hit your breakpoints in Visual Studio Code, enabling you to debug your event-based activation or spam-reporting code.
166+
You can now hit your breakpoints to debug your event-based activation or spam-reporting code.
139167
140168
## Stop the debugger
141169

docs/outlook/faq-nested-app-auth-outlook-legacy-tokens.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Nested app authentication and Outlook legacy tokens deprecation FAQ
44
ms.service: microsoft-365
55
ms.subservice: add-ins
66
ms.topic: faq
7-
ms.date: 12/12/2024
7+
ms.date: 12/18/2024
88
---
99

1010
# Nested app authentication and Outlook legacy tokens deprecation FAQ
@@ -38,11 +38,15 @@ The general availability (GA) date for NAA depends on which channel you are usin
3838
| Jan 2025 | NAA will GA in Semi-Annual Channel. |
3939
| Jun 2025 | NAA will GA in Semi-Annual Extended Channel. |
4040

41+
### Are COM Add-ins affected by the deprecation of legacy Exchange Online tokens?
42+
43+
It's very unlikely any COM add-ins are affected by the deprecation of legacy Exchange Online tokens. Outlook web add-ins are primarily affected because they can use Office.js APIs that rely on Exchange tokens. For more information, see[How do i know if my outlook add in relies on legacy tokens](#how-do-i-know-if-my-outlook-add-in-relies-on-legacy-tokens). The Exchange tokens are used to access Exchange Web Services (EWS) or Outlook REST APIs, both of which are also deprecated. If you suspect a COM add-in might be affected, you can test it by using it on a tenant with Exchange tokens turned off. For more information, see [Turn legacy Exchange Online tokens on or off](turn-exchange-tokens-on-off.md).
44+
4145
## Microsoft 365 administrator questions
4246

4347
### Can I turn Exchange Online legacy tokens back on?
4448

45-
Yes, there are PowerShell commands you can use to turn legacy tokens on or off in any tenant. For more information on how to turn legacy tokens on or off, see [Turn legacy Exchange Online tokens on or off](turn-exchange-tokens-on-off.md).
49+
Yes, there are PowerShell commands you can use to turn legacy tokens on or off in any tenant. For more information on how to turn legacy tokens on or off, see [Turn legacy Exchange Online tokens on or off](turn-exchange-tokens-on-off.md). If you use the commands to enable legacy Exchange Online tokens, they will not be turned off in February 2025. They will remain on until June 2025, or until you use the tooling to turn them off.
4650

4751
In June 2025, legacy tokens will be turned off and you won't be able to turn them back on without a specific exception granted by Microsoft. In October 2025, it won't be possible to turn on legacy tokens and they'll be disabled for all tenants. We'll update this FAQ with additional information once the tool is available.
4852

docs/outlook/onmessagesend-onappointmentsend-events.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts
33
description: Learn about the Smart Alerts implementation and how it handles the OnMessageSend and OnAppointmentSend events in your event-based Outlook add-in.
4-
ms.date: 12/03/2024
4+
ms.date: 12/19/2024
55
ms.topic: concept-article
66
ms.localizationpriority: medium
77
---
@@ -234,10 +234,14 @@ You can customize the **Don't Send** button in the dialog to open a task pane or
234234
> [!NOTE]
235235
> Support to customize the **Don't Send** button was introduced in [Mailbox requirement set 1.14](/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14).
236236
237-
In Outlook on the web and in new Outlook on Windows:
237+
### Limitations in Outlook on the web and new Outlook on Windows
238+
239+
When developing a Smart Alerts add-in for Outlook on the web and new Outlook on Windows, you must be mindful of the following limitations.
238240

239241
- The `OnAppointmentSend` event only occurs when the meeting being sent was created through the **New Event** option. If the meeting being sent was created by selecting a date and time directly from the calendar, the `OnAppointmentSend` event doesn't occur.
240242
- When forwarding a meeting, the `OnAppointmentSend` event only occurs if the organizer forwards the meeting. It doesn't occur if an attendee forwards the meeting to which they're invited.
243+
- When an attendee responds to a meeting invite using the **Accept**, **Decline**, **Tentative**, or **Follow** option, the `OnMessageSend` event doesn't occur. This behavior applies even if the attendee includes a personalized message in their response.
244+
- When the organizer cancels a meeting and includes a cancellation message, the `OnMessageSend` event doesn't occur.
241245

242246
### Limitations to formatting the dialog message using Markdown
243247

docs/outlook/troubleshoot-event-based-and-spam-reporting-add-ins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ As you develop your [event-based](autolaunch.md) or [spam-reporting](spam-report
6161

6262
:::image type="content" source="../images/outlook-event-based-logs.png" alt-text="A sample of Event Viewer's Filter Current Log settings configured to only show Outlook errors with event ID 63 that occurred in the last hour.":::
6363

64-
- Verify that the **bundle.js** file is downloaded to the following folder in File Explorer. Replace text enclosed in `[]` with your applicable information.
64+
- Verify that the **bundle.js** file is downloaded to the following folder in File Explorer. The text enclosed in `[]` represents your applicable Outlook and add-in information.
6565

6666
```text
6767
%LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]

docs/outlook/turn-exchange-tokens-on-off.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Turn legacy Exchange Online tokens on or off
44
ms.service: microsoft-365
55
ms.subservice: add-ins
66
ms.topic: how-to
7-
ms.date: 12/12/2024
7+
ms.date: 12/18/2024
88
---
99

1010
# Turn legacy Exchange Online tokens on or off
@@ -22,7 +22,7 @@ To run the commands you need to connect to Exchange Online PowerShell.
2222
1. To be sure you are on the latest version of the module, run the command `Update-Module -Name ExchangeOnlineManagement`.
2323
1. Run the command `Connect-ExchangeOnline`. Sign in with your Microsoft 365 administrator credentials.
2424

25-
## Turn off legacy Exchange Online tokens in a test tenant
25+
## Turn off legacy Exchange Online tokens
2626

2727
The `Set-AuthenticationPolicy` command controls the issuance of legacy Exchange Online tokens. When issuance is turned off, add-ins can no longer request user identity tokens or callback tokens. Existing tokens already issued will continue to work until they expire. It can take up to 24 hours before all request from Outlook add-ins for legacy Exchange Online tokens are blocked.
2828

@@ -32,7 +32,10 @@ To turn legacy tokens off, run the following command.
3232

3333
The command turns off legacy tokens for the entire tenant. If an Outlook add-in requests a legacy token, it won’t be issued a token.
3434

35-
## Turn on legacy Exchange Online tokens in a test tenant
35+
> [!NOTE]
36+
> If you've confirmed that your tenant is not using any add-ins that require legacy Exchange Online tokens, we recommend you turn off legacy Exchange Online tokens as a security best practice. For more information on how to determine if you tenant has add-ins using legacy tokens, see the [Nested app authentication and Outlook legacy tokens deprecation FAQ](faq-nested-app-auth-outlook-legacy-tokens.md).
37+
38+
## Turn on legacy Exchange Online tokens
3639

3740
To turn legacy tokens on, run the following command. It can take up to 24 hours before all requests from Outlook add-ins for legacy tokens are allowed.
3841

0 commit comments

Comments
 (0)