Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This sample app shows how to send app icon badging in Teams meetings using targeted notifications API.
office-teams
office
office-365
nodejs
contentType createdDate
samples
23/05/2023 13:38:26 PM
officedev-microsoft-teams-samples-meetings-app-icon-badging-nodejs

App Icon Badging In Teams Meeting Notification

This sample illustrates how to send app icon badging notification on tab icon in Teams meetings.

Included Features

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

Interaction with app

App Icon Badging

Prerequisites

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

    # determine node version
node --version

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

  • dev tunnel or ngrok latest version or equivalent tunnelling solution

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

  • 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 resource in Azure portal

  • In Azure portal, create a Azure Bot resource.

  • 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 in Azure portal, you will create an App ID and App password - make sure you keep these for later.

  1. 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
  1. Setup for code

  • Clone the repository

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

  • In a terminal, navigate to samples\meetings-app-icon-badging\nodejs

    cd samples/meetings-app-icon-badging/nodejs

  • Install modules

    npm install

  • Go to .env file in your project folder and update MicrosoftAppId, MicrosoftAppPassword with the values received from your Microsoft Entra ID app registration.

  • Start the bot

    npm start
  1. Setup Manifest for Teams
  • Modify the manifest.json file placed in /appManifest folder and replace the <> with your Microsoft App Id received via doing Microsoft Entra ID app registration in your Azure Portal.
    • Edit the manifest.json for validDomains and replace <> 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
        • Select Apps from the left panel.
        • Then select Upload a custom app from the lower right corner.
        • Then select the manifest.zip file from appManifest.
        • Install the App in Teams Meeting

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

Running the sample

Setup Configurable Tab:

Setup 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':

App Icon Badging

Stage View and App Icon Badging Notification:

Stage View and AppIconBadging

Further reading