page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
Microsoft Teams meeting extensibility sample for iteracting with In-meeting tabs and bots. |
|
|
|
officedev-microsoft-teams-samples-meetings-details-tab-nodejs |
This sample app illustrates the implementation of Details Tab in Meeting. User can create a poll and post poll in meeting chat and participants can submit their feedback in Meeting.
- Tabs
- Bots
- Adaptive Cards
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).
Meetings Details Tab Sample: Manifest
-
Node.js version 10.14 or higher
# determine node version node --version
-
dev tunnel or Ngrok (Only for devbox testing) Latest (any other tunneling software can also be used)
-
Teams Microsoft Teams is installed and you have an account
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- In the browser that launches, select the Add button to install the app to Teams.
-
Register a new application in the Microsoft Entra ID – App Registrations portal.
-
Setup for Bot
- Register a Microsoft Entra ID aap registration in Azure portal.
- Also, 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 app registration, you will create an App ID and App password - make sure you keep these for later.
-
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
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-Modfiy the Go to .env file and add
BotId
,BotPassword
andBaseUrl as tunnel URL
information.-
In a terminal, navigate to
samples/meetings-details-tab/nodejs
cd samples/meetings-details-tab/nodejs
-
Install modules and Start the bot
-
Server will run on PORT:
4001
npm run server
This command is equivalent to: npm install > npm run build-client > npm start
-
Start client application
-
Client will run on PORT:
3978
npm run client
This command is equivalent to: cd client > npm install > npm start
-
-
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 app registration earlier) everywhere you see the place holder string{{Microsoft-App-Id}}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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 amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
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 app 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.
Interact with Details Tab in Meeting.
- Install the Details Tab manifest in meeting chat.
- Add the Details Tab in Meeting
- Click on Add Agenda
- Newly added agenda will be added to Tab.
- Click on Send button in Agenda from Tab.
- An Adaptive Card will be posted in meeting chat for feedback.
- Participants in meeting can submit their response in adaptive card
- Response will be recorded and Bot will send an new adaptive card with response.
- Participants in meeting can view the results from meeting chat or Tab itself.