Skip to content

Latest commit

 

History

History
page_type description products languages extensions urlFragment
sample
This sample demonstrates a Node.js Messaging Extension for Microsoft Teams that utilizes adaptive card-based loop components, enabling link unfurling and dynamic interactions within the compose area.
office-teams
office
office-365
nodejs
contentType createdDate
samples
08-21-2023 20:32:25
officedev-microsoft-teams-samples-msgext-unfurling-ac-loop-components-nodejs

Messaging Extension with Adaptive Card Loop Components

This comprehensive Node.js sample illustrates the development of a Messaging Extension for Microsoft Teams, featuring adaptive card-based loop components that facilitate link unfurling and user interaction. By enabling users to copy and paste URLs from platforms like GitHub, the extension enriches the messaging experience with rich previews and dynamic functionality, making it easier to engage with shared content.

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main or your ngrok base url, it wil unfurl inside compose area.

Included Features

  • Message Extensions
  • Search Commands
  • Link Unfurling
  • Adaptive card based loop component

Interaction with teams

msgext-unfurling-ac-loop-components

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Msgext-Unfurling-Adaptive-Card-Loop-Components: Manifest

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Run the sample locally

1. Register you app with Azure AD

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.
  2. Select New Registration and on the register an application page, set following values:
    • Set name to your app name.
    • Choose the supported account types (any account type will work)
    • Leave Redirect URI empty.
    • Choose Register.
  3. On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the .env.
  4. Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description(Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the .env.

2. Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

3. Setup for code

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  2. In a terminal, navigate to samples/msgext-unfurling-ac-loop-components/nodejs

  3. Install modules

    npm install
  4. Open .env file from this path folder samples/msgext-unfurling-ac-loop-components/nodejs and update

    • {{BOT_ID}} - Generated from Step 1 (Application (client) ID)is the application app id
    • {{BOT_PASSWORD}} - Generated from Step 1.4, also referred to as Client secret
  5. Run your bot at the command line:

    npm start
  6. This step is specific to Teams.

    • Edit the manifest.json contained in the appManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string {{BOT_ID}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the <<Your Tunnel Domain>> - Your application's base url domain. E.g. for https://12345.ngrok-free.app the base url domain will be 12345.ngrok-free.app if you are using ngrok and if you are using dev tunnel then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

4. Running the sample

Note the Teams manifest.json for this sample also includes a Search Query. This Messaging Extension is only introduced in order to enable installation, because there is no mechanism for installing a link unfurling feature in isolation.

Install App: 1.InstallApp

Add to a chat: 2.SelectAddToChat

Add to a group chat: 3.GroupChat

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main into the compose message area the link will unfurl: 4.AdaptiveCardLoopComponent

Search for actions and apps: 5.SelectACloopComponent

Search: 6.MsgextSearch

Search Results: 7.MsgextSearchResults

Adaptive Card Based Loop Components: 8.AdaptiveCardLoopComponentMsgextSearch

Click Execute: 9.ClickExecute

Successfully Execute: 10.SuccessfullyExecute

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

After opening Outlook web, click the "New mail" button: 1.OutlookClickmail

On the tool bar on top,select Apps icon. Your sideloaded app title appears among your installed apps: 2.OutlookOpenApp

Select your app icon: 3.OutlookSelectApp

Search for actions and apps: 4.OutlookMsgext

Search Results: 5.OutlookSearchCard

Adaptive Card Based Loop Components: 6.OutlookClickCard

Click Execute: 7.OutlookClickEx

Successfully Execute: 8.OutlookOutput

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main into the compose message area the link will unfurl: 9.OutlookAClink

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading