Meetings SidePanel
This sample illustrates how to implement Side Panel In-Meeting Experience.
Included Features
- Meeting Stage
- Meeting SidePanel
- Live Share SDK
- Adaptive Cards
- RSC Permissions
- App Theme
Interaction with app
Interaction with app theme
Prerequisites
Node.js version 10.14 or higher
# determine node version node --version
Teams Microsoft Teams is installed and you have an account
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.
- 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.
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
Register an Microsoft Entra ID app in Azure portal and 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 bot you will create an App ID and App password - make sure you keep these for later.
Run ngrok - point to port 3001 (pointing to ClientApp)
ngrok http 3001 --host-header="localhost:3001"
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 3001 --allow-anonymous
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
Open .env file from this path folder (samples/meetings-sidepanel/nodejs/server) and update
MicrosoftAppId
,MicrosoftAppPassword
information with values generated values while doing Microsoft Entra ID App Registration.
- Update
BaseURL
with your application domain URL like ngrok URL: https://xxxx.ngrok-free.app and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.
Install node modules
Inside node js folder, navigate to
samples/meetings-sidepanel/nodejs/server
open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.- Repeat the same step in folder
samples/meetings-sidepanel/nodejs/ClientApp
npm install
- Repeat the same step in folder
We have two different solutions to run, so follow below steps:
- In a terminal, navigate to
samples/meetings-sidepanel/nodejs/server
folder, Open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code
npm install
npm start
If you face any dependency error while installing node modules, try using below command
npm install --legacy-peer-deps
- In a different terminal, navigate to
samples/meetings-sidepanel/nodejs/ClientApp
folder, Open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code
cd client
npm install
npm start
If you face any dependency error while installing node modules, try using below command
npm install --legacy-peer-deps
- Run your app, either from Visual Studio code with
npm start
or usingRun
in the Terminal.
- Setup Manifest for Teams (This step is specific to Teams.)
Edit the
manifest.json
contained in theappManifest
folder and replace your Microsoft App Id (that was created when you registered your app 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 themanifest.json
)Edit the
manifest.json
forconfigurationUrl
insideconfigurableTabs
. Replace{{BASE-URL}}
with base Url 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
.Update the
manifest.json
forvalidDomains
with base Url 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
.Update the
manifest.json
for<<Manifest-id>>
with any GUID or with your MicrosoftAppId, generated during App registration in Azure portal.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)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.
Running the sample
Interacting with the app in Teams Meeting
Interact with SidePanel by clicking on the App icon present on the top menu beside the "more actions" during a meeting.
- Once the app is clicked, sidepanel appears with the default agenda list. Only organizer gets the feasibility to add new agenda points to the list using "Add New Agenda Item" button.
Installation and setup meetings sidepanel.
- On click of "Add" button, agenda point will be added to the agenda list by organizer.
- On click of "Publish Agenda", the agenda list will be sent to the meeting chat.
User interactions(Meeting Organizer)
- Add New Agenda Item - Gives provision to add new Agenda point.
- Add - Adds the agenda from Textinput to the SidePanel agenda list.
- Publish Agenda - Sends the agenda list to the meeting chat.
Interaction with app theme when Teams theme changes.
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.
- Meeting apps APIs
- Meeting Side Panel
- Build tabs for meeting
- Install the App in Teams Meeting
- Handle theme change