nodejs

page_type	description	products	languages	extensions	urlFragment
sample	Microsoft Teams tab sample code which demonstrates how to build tabs with Adaptive Cards.	office-teams office office-365	nodejs	contentType createdDate samples 09/02/2021 19:54:22 PM	officedev-microsoft-teams-samples-tab-adaptive-cards-nodejs

Tabs with Adaptive Cards

This App talks about the Teams tab which displays Adaptive card with Node JS. For reference please check Build tabs with Adaptive Cards

This bot has been created using Bot Framework v4, it shows how to create a simple bot that accepts Adaptive Cards V1.4 to render in Teams tab.

This feature shown in this sample is in Public Developer Preview and is supported in desktop and mobile.

NOTE: Adaptive Card tabs will be deprecated in the new Microsoft Teams. Apps are expected to be available in the new Microsoft Teams by June 2023. If your app is using Adaptive Card tabs, it's recommended to rebuild the tab as a web-based tab. For more information, see Build tabs for Teams.

Included Features

• Tabs
• Adaptive Cards (in tabs)

Interaction with Adaptive Cards

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).

Tabs with Adaptive Cards: Manifest

Prerequisites

1. Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.

2. To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher).

   # determine node version
   node --version

3. Publicly addressable https url or tunnel such as ngrok latest version or Tunnel Relay

   If you are using Ngrok to test locally, you'll need Ngrok installed on your development machine. Make sure you've downloaded and installed Ngrok on your local machine. ngrok will tunnel requests from the Internet to your local computer and terminate the SSL connection from Teams.

4. Teams Toolkit for VS Code or TeamsFx CLI

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.

Setup

NOTE: The free ngrok plan will generate a new URL every time you run it, which requires you to update your Azure AD registration, the Teams app manifest, and the project configuration. A paid account with a permanent ngrok URL is recommended.

1. Setup for Bot

   • Register Azure AD application
   • Register a bot with Azure Bot Service, following the instructions here.
   • Ensure that you've enabled the Teams Channel
   • While registering the bot, use https://<your_tunnel_domain>/api/messages as the messaging endpoint.

   NOTE: When you create your Azure AD application registration, you will create an App ID and App password - make sure you keep these for later.

   Setup Azure Bot connection

2. Setup NGROK

• 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

• Clone the repository

  git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

• In a console, navigate to samples/tab-adaptive-cards/nodejs

• Install modules

  npm install

• Update the .env configuration for the bot to use the MicrosoftAppId (Microsoft App Id) and MicrosoftAppPassword (App Password) from the Microsoft Entra ID app registration in Azure portal or from bot Framework registration.

• Update the BaseUrl as per your application domain like if you are using ngrok, it would be https://1234.ngrok-free.app and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

• Update the ConnectionName with Azure Bot Registration connection name configured in step 1.

NOTE: the App Password is referred to as the client secret in the azure portal and you can always create a new client secret anytime.

• Run your bot at the command line:

  npm start

• Install modules & Run the NodeJS Server

  • Server will run on PORT: 3978
  • Open a terminal and navigate to project root directory

    npm run server

• This command is equivalent to: npm install > npm start

4. Setup Manifest for Teams (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 <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
   • Update the <<DOMAIN-NAME>> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
   • Zip up the contents of the appManifest folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
     • Go to Microsoft Teams. From the lower left corner, select Apps
     • From the lower left corner, choose Upload a custom App
     • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
     • Select Add in the pop-up dialog box. Your tab is uploaded to Teams.

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

Running the sample

You can use this tab by following the below steps:

• In the navigation bar located at the far left in Teams, select the ellipses ●●● and choose your app from the list.

Sign in card:

Home Page:

Task module:

Task module close:

Show Task module:

YouTube Tab:

Sign out card:

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

• Tab adaptive card
• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation