csharp

page_type	description	products	languages	extensions	urlFragment
sample	This sample app showcases how to implement app icon badging notifications in Teams meetings.	office-teams office office-365	csharp	contentType createdDate samples 12/06/2023 13:38:26 PM	officedev-microsoft-teams-samples-meetings-app-icon-badging-csharp

App Icon Badging In Teams Meeting Notification

Explore this sample app that demonstrates the implementation of app icon badging during Teams meetings notifications. It highlights features such as bots, in-meeting notifications, and resource-specific consent (RSC) permissions to enhance user interaction.

Included Features

• Bots
• In-Meeting Notifications
• RSC Permissions
• App Icon Badging

Interaction with app

Prerequisites

• Microsoft Teams is installed and you have an account
• .NET Core SDK version 6.0
• dev tunnel or ngrok latest version or equivalent tunnelling solution
• Teams Toolkit for Visual Studio

Run the app (Using Teams Toolkit for Visual Studio)

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

1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
3. In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
4. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
8. 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

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

2. Setup for Bot

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

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

4. Setup for code

• Clone the repository

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

• If you are using Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples/meetings-app-icon-badging/csharp folder
  • Select AppIconBadgingInMeetings.sln file

• Modify the /appsettings.json and fill in the following details:

  • {{MICROSOFT_APP_ID}} - Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.
  • {{ MICROSOFT_APP_PASSWORD}} - Generated from Step 1, also referred to as Client secret
  • {{ BaseURL }} - Your application's base url. E.g. https://12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

5. Setup Manifest for Teams

• This step is specific to Teams.

  • Edit the manifest.json contained in the ./appPackage 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 the manifest.json)
  • Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your 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 appPackage 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 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 ./appPackage 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.

Interacting with the app in Teams Meeting

Message the Bot by @ mentioning to interact with meetings notifications.

1. You will see an Adaptive Card.
2. Select option and click on App Icon badging button
3. You can send notification with red color icon on your configurable tab.

Running the sample

Setup Configurable Tab:

Interacting with the app in Teams Meeting

Type SendNotification in bot chat to send In-Meeting notifications.

Notification On Tab Icon as 'Icon Badging':

Further reading

• Enable app icon badging for your Teams app

• Grant RSC permissions to your app