-
Notifications
You must be signed in to change notification settings - Fork 167
Create and debug a search based message extension across Microsoft 365
Important
Content in this document has been moved to Teams platform documentation. Please do not refer to or update this document.
Search-based message extensions allow users to search an external system and share results through the compose message area of the Microsoft Teams client. You can now build and run your search-based message extensions in Teams, Outlook for Windows desktop and web experiences.
- NodeJS
- An M365 account. If you do not have M365 account, apply one from M365 developer program
- Set up your dev environment for extending Teams apps across Microsoft 365
Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.
- From Visual Studio Code, open the command palette (
Ctrl+Shift+P
), typeTeams: Create a new Teams app
- Select Search-based message extension
Follow below instructions to get started with this application template for local debugging.
-
Press
F5
or use theRun and Debug Activity Panel
in Visual Studio Code. -
Select a target Microsoft application where the message extension runs:
Debug in Teams
,Debug in Outlook
and click theRun and Debug
green arrow button. -
If you select
Debug in Outlook
, follow the instructions in a Visual Studio Code pop-up dialog. -
Click Install in Teams first and install the app in a Teams web client.
-
Click Configure Outlook to connect the bot with Outlook channel in the Bot Framework Portal.
-
Click Continue to continue to debug the app in Outlook.
-
Start debugging the project by executing the command
teamsfx preview --local --m365-host <m365-host>
in your project directory, where options form365-host
areteams
oroutlook
. -
If you select
m365-host
asoutlook
, follow the instructions in the command dialog. -
Select Install in Teams first and install the app in a Teams web client.
-
Click Configure Outlook to connect the bot with Outlook channel in the Bot Framework Portal.
-
Click Continue to continue to debug the app in Outlook.
This template provides a simple functionality to search for npm
packages and render the result in Adaptive Card.
-
@mention
Your message extension from thesearch box area
. -
@mention
your message extension from thecompose message area
. -
Click the
...
under compose message area, find your message extension.
- Click the "More apps" icon under compose email area, find your message extension.
Scenario-based Tutorials
- Send notifications to Teams
- Respond to chat commands in Teams
- Respond to card actions in Teams
- Embed a dashboard canvas in Teams
Extend Teams app across Microsoft 365
- Create and test a personal tab across Microsoft 365
- Create and test a search-based message extension across Microsoft 365
Documentation
- Manage Application settings with Teams Toolkit
- Manage Microsoft Entra Application Registration with Teams Toolkit
How To Guides
- How to use an existing Microsoft Entra app
- How to use a multi-tenant Microsoft Entra app
- How to customize debug tasks
- How to connect to existing APIs
- How to add single sign on in Teams Toolkit for Visual Studio Code
- How to enable Single Sign-on in Teams Toolkit for Visual Studio
- How to configure Tab capability within your Teams app
- How to configure Bot capability within your Teams app
- How to configure an Outlook Add-in capability within your Teams app
- How to configure Message Extension capability within your Teams app
- How to automate ci/cd pipelines
- How to integrate Azure Functions with your Teams app
- How to integrate Azure API Management