Generate meeting side panel
Microsoft Teams meeting side panel enhances your in-meeting experience and helps organizers and presenters to have different sets of views and actions.
Key features of the meeting side panel are:
- Provisions to add a new agenda point.
- Adds the agenda as text input to the meeting side panel list.
- Publishes the agenda list to the meeting chat.
This step-by-step guide helps you to generate a meeting side panel to add and publish an agenda. You'll see the following output:
Prerequisites
Ensure that you install the following tools and set up your development environment:
| Install | For using... | |
|---|---|---|
| Microsoft Teams | Microsoft Teams to collaborate with everyone you work with through apps for chat, meetings, and call all in one place. | |
| Visual Studio 2022 | You can install the enterprise version in Visual Studio 2022, and install the ASP.NET and web development workloads. Use the latest version. | |
| .NET Core SDK | Customized bindings for local debugging and Azure Functions app deployments. Use the latest version or install the portable version. | |
| Node.js and NPM | Back-end JavaScript runtime environment. For more information, see Node.js version compatibility table for project type. | |
| Microsoft Teams JavaScript client library (TeamsJS) | You can install the package using npm or yarn. Use the latest version. | |
| Live Share SDK | Live Share enables collaborative app experiences. | |
| Dev tunnel | Teams app features (conversational bots, message extensions, and incoming webhooks) need inbound connections. A tunnel connects your development system to Teams. Dev tunnel is a powerful tool to securely open your localhost to the internet and control who has access. Dev tunnel is available in Visual Studio 2022 version 17.7.0 or later. Or You can also use ngrok as a tunnel to connect your development system to Teams. It isn't required for apps that only include tabs. This package is installed within the project directory (using npm devDependencies). |
Nota
After downloading ngrok, sign up and install authtoken.
Set up local environment
Open Microsoft-Teams-Samples.
Select Code.
From the dropdown menu, select Open with GitHub Desktop.
Select Clone.
Nota
If you encounter the error Filename too long, apply the git command git config --system core.longpaths true in your administrator terminal of choice.
Register Microsoft Entra app
To create and register your bot in Microsoft Entra ID, perform the following steps:
- Create Azure Bot resource to register bot with Azure Bot service.
- Create client secret to enable single sign-on (SSO) authentication of the bot.
- Add Teams channel to deploy the bot.
- Create a ngrok or dev tunnel to your web server's endpoints.
- Add messaging endpoint to the ngrok or dev tunnel you created.
Add App registration
Go to Azure portal.
Select App registrations.
Select + New registration.
Enter the name of your app.
Select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant).
Select Register.
Your app is registered in Microsoft Entra ID. The app overview page appears.
Nota
Save the app ID from Application (client) ID and Directory (tenant) ID for further use.
Create a tunnel
Open Visual Studio.
Select Create a new project.
In the search box, enter ASP.NET. From the search results, select ASP.NET Core Web App.
Select Next.
Enter Project name and select Next.
Select Create.
An overview window appears.
In the debug dropdown list, select Dev Tunnels (no active tunnel) > Create a Tunnel....
A pop-up window appears.
Update the following details in the pop-up window:
- Account: Enter a Microsoft or GitHub account.
- Name: Enter a name for your tunnel.
- Tunnel Type: From the dropdown list, select Temporary.
- Access: From the dropdown list, select Public.
Select OK.
A pop-up window appears showing that dev tunnel is successfully created.
Select OK.
You can find the tunnel you've created in the debug dropdown list as follows:
Select F5 to run the application in the debug mode.
If a Security Warning dialog appears, select Yes.
A pop-up window appears.
Select Continue.
The dev tunnel home page opens in a new browser window and the dev tunnel is now active.
Go to Visual Studio, select View > Output.
From the Output console dropdown menu, select Dev Tunnels.
The Output console shows the dev tunnel URL.
Add a web authentication
In the left pane, under Manage, select Authentication.
Select Add a platform > Web.
Enter the redirect URI for your app by appending
auth-endto the fully qualified domain name. For example,https://your-devtunnel-domain/auth-endorhttps://your-ngrok-domain/auth-end.Under Implicit grant and hybrid flows, select the Access tokens and ID tokens checkboxes.
Select Configure.
Under Web, select Add URI.
Enter
https://token.botframework.com/.auth/web/redirect.Select Save.
Create a client secret
In the left pane, under Manage, select Certificates & secrets.
Under Client secrets, select + New client secret.
The Add a client secret window appears.
Enter Description.
Select Add.
Under Value, select Copy to clipboard to save the client secret value for further use.
Add API permission
In the left pane, under Manage, select API permissions.
Select + Add a permission.
Select Microsoft Graph.
Select Delegated permissions.
Select the following permissions:
- OpenId permissions > email, offline_access, openid, profile.
- User > User.Read.
Select Add permissions.
Nota
- If an app isn't granted IT admin consent, users must provide consent the first time they use an app.
- Users need to consent to the API permissions only if the Microsoft Entra app is registered in a different tenant.
Add Application ID URI
In the left pane, under Manage, select Expose an API.
Next to Application ID URI, select Add.
Update the Application ID URI in the
api://your-devtunnel-domain/botid-{AppID}orapi://your-ngrok-domain/botid-{AppID}format and select Save.
The following image shows the domain name:
Add a scope
In the left pane, under Manage, select Expose an API.
Select + Add a scope.
Enter access_as_user as the Scope name.
Under Who can consent?, select Admins and users.
Update the values for the rest of the fields as follows:
Enter Teams can access the user’s profile as Admin consent display name.
Enter Allows Teams to call the app’s web APIs as the current user as Admin consent description.
Enter Teams can access the user profile and make requests on the user’s behalf as User consent display name.
Enter Enable Teams to call this app’s APIs with the same rights as the user as User consent description.
Ensure that State is set to Enabled.
Select Add scope.
The following image shows the fields and the values:
Nota
The Scope name must match with the Application ID URI with
/access_as_userappended at the end.
Add client application
In the left pane, under Manage, select Expose an API.
Under Authorized client applications, identify the applications that you want to authorize for your app’s web application.
Select + Add a client application.
Add Teams mobile or desktop and Teams web application.
For Teams mobile or desktop: Enter the Client ID as
1fec8e78-bce4-4aaf-ab1b-5451cc387264.
For Teams web: Enter the Client ID as
5e3ce6c0-2b1f-4285-8d4b-75ee78787346.
Select the Authorized scopes checkbox.
Select Add application.
The following image displays the Client Id:
Create your bot
Create an Azure bot resource
Nota
If you're already testing your bot in Teams, sign out of this app and Teams. To see this change, sign in again.
Go to Home.
Select + Create a resource.
In the search box, enter Azure Bot.
Select Enter.
Select Azure Bot.
Select Create.
Enter the bot name in Bot handle.
Select your Subscription from the dropdown list.
Select your Resource group from the dropdown list.
If you don't have an existing resource group, you can create a new resource group. To create a new resource group, follow these steps:
- Select Create new.
- Enter the resource name and select OK.
- Select a location from New resource group location dropdown list.
Under Pricing, select Change plan.
Select FO Free > Select.
Under Microsoft App ID, select Type of App as Multi Tenant.
In the Creation type, select Use existing app registration.
Enter the App ID.
Nota
You can't create more than one bot with the same Microsoft App ID.
Select Review + create.
After the validation passes, select Create.
The bot takes a few minutes to provision.
Select Go to resource.
You've successfully created your Azure bot.
Add a Teams channel
In the left pane, select Channels.
Under Available Channels, select Microsoft Teams.
Select the checkbox to accept the Terms of Service.
Select Agree.
Select Apply.
To add a messaging endpoint
Use the dev tunnel URL in the Output console as the messaging endpoint.
In the left pane, under Settings, select Configuration.
Update the Messaging endpoint in the format
https://your-devtunnel-domain/api/messages.
Select Apply.
You've successfully set up a bot in Azure Bot service.
Nota
If the Application Insights Instrumentation key shows an error, update with App ID.
Set up app settings and manifest files
Go to the appsettings.json file in the cloned repository.
Open the appsettings.json file in Visual Studio and update the following information:
- Replace
<<MicrosoftAppId>>to your bot's Microsoft App ID. - Replace
<<MicrosoftAppPassword>>to Value of your bot's Client secret. - Replace
<<BaseUrl>>to the ngrok or dev tunnel domain name.
- Replace
Go to the manifest.json file in the cloned repository.
Open the manifest.json file in Visual Studio and make the following changes:
- Replace
<<Manifest-id>>to a unique manifest ID. You can also enter your Microsoft App ID. - Replace all occurrences of
{{domain-name}}and{{Base_URL}}with your ngrok or dev tunnel domain name. - Replace all occurrences of
<<YOUR-MICROSOFT-APP-ID>>with your bot's Microsoft App ID.
- Replace
Build and run the service
To build and run the service, use Visual Studio or Command line:
Open Visual Studio.
Go to File > Open > Project/Solution...
Select the SidePanel.csproj file from csharp > SidePanel folder.
Press F5 to run the project. You can run the project using Visual Studio or .NET in the appropriate folder.
Go to samples > meetings-sidepanel > csharp > ClientApp folder and run the following command:
Bashnpm install npm startSelect Yes if the following dialog appears:
A webpage appears with a message, Your bot is ready!
Add meeting side panel to Teams
In your cloned repository, go to csharp > SidePanel > AppManifest.
Create a .zip file with the following files that are present in the AppManifest folder:
manifest.json
outline.png
color.png
Create a meeting with a few presenters and attendees.
After the meeting is created, join the meeting.
Go to the meeting details page, and select the Apps icon to add an app.
In the pop-up window, select Manage apps.
Select Upload an app.
Go to csharp > SidePanel > AppManifest.
Select Open to upload the .zip file that you created in the AppManifest folder.
Select Add.
Select Open to open the app in personal scope.
Alternatively, you can either search and select the required scope or select a chat or meeting from the list, and move through the dialog to select Go.
The Manage apps section displays the list of applications.
Go to Teams meeting.
Select Apps.
In the app selection page, the Side Panel app is displayed.
Select the Side Panel app.
Select Save.
The app is visible in the meeting side panel.
Interact with the app in Teams
Let's interact with the app in Teams!
Select Add New Agenda Item to add a new agenda to the default agenda list.
Enter a new agenda item and select Add.
The new agenda is added to the list.
Select Publish Agenda.
The new agenda list is displayed in the meeting chat.
Complete challenge
Did you come up with output like this?
Congratulations!
You've completed the tutorial to get started with a Side Panel app!
Have an issue with this section? If so, please give us some feedback so we can improve this section.
Feedback ta’ Platform Docs
Platform Docs huwa proġett b’sors miftuħ. Agħżel link biex tipprovdi l-feedback: