Skip to content

csharp

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

csharp

README.md

page_type sample
description This sample demonstrates how to install a Microsoft Teams app using QR code scanning, allowing users to generate a QR code with the app ID for seamless installation.
products
office-teams
office
office-365
languages
csharp
extensions
contentType createdDate
samples
10/11/2021 23:35:25 PM
urlFragment officedev-microsoft-teams-samples-app-installation-using-qr-code-csharp

Install app using barcode sample

This C# sample illustrates the process of installing Microsoft Teams apps via QR code scanning. Users can generate a QR code containing the app ID, making installation straightforward while leveraging features such as bot interaction, Teams SSO, adaptive cards, task modules, and media permissions.

Currently, Microsoft Teams support for QR or barcode scanner capability is only available for mobile clients.

Included Features

  • Bot
  • Teams SSO (bots)
  • Adaptive Cards
  • Task Modules
  • Device Permissions (media)
  • Graph API

Interaction with bot - Desktop View

App Installation Using QRCodeDesktopGif

Interaction with bot - Mobile View

App Installation Using QRCodeGif

Try it yourself - experience the App in your Microsoft Teams client

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. (Uploading must be enabled for your tenant, see steps here).

Install app using barcode sample: Manifest

Prerequisites

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio)

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

  1. Install Visual Studio 2022 Version 17.14 or higher Visual Studio
  2. Install Microsoft 365 Agents Toolkit for Visual Studio Microsoft 365 Agents 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. Right-click the 'M365Agent' project in Solution Explorer and select Microsoft 365 Agents Toolkit > Select Microsoft 365 Account
  5. Sign in to Microsoft 365 Agents Toolkit with a Microsoft 365 work or school account
  6. Set Startup Item as Microsoft Teams (browser).
  7. Press F5, or select Debug > Start Debugging menu in Visual Studio to start your app
    image
  8. In the opened web browser, select Add button to install the app in Teams

If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents 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.

Note: Add the following manually under 'Azure API permissions':

  • Delegated Permissions
    1. TeamsAppInstallation.ReadWriteAndConsentSelfForTeam
    2. TeamsAppInstallation.ReadWriteAndConsentForTeam

Setup

  1. Setup for Bot SSO

  • Refer to Bot SSO Setup document

  • Ensure that you've enabled the Teams Channel

  • While registering the Azure 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. Register a new application in the Microsoft Entra ID – App Registrations portal.

A) Select New Registration and on the register an application page, set following values: * Set name to your app name. * Choose the supported account types (any account type will work) * Leave Redirect URI empty. * Choose Register. B) On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json. C) Navigate to API Permissions, and make sure to add the follow permissions: Select Add a permission * Select Add a permission * Select Microsoft Graph -> Delegated permissions. * User.Read (enabled by default) * Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  1. Setup for code

  • Clone the repository

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

  • In a terminal, navigate to samples/app-installation-using-qr-code/csharp

    change into project folder

    cd # QRAppInstallation

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

    • {{Microsoft-App-Id}} - Generated from Step 1 from Microsoft Entra ID app registration in Azure portal
    • {{Microsoft-App-Password}} - Generated from Step 1, also referred to as Client secret
    • {{ Application Base Url }} - 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 https://12345.devtunnels.ms.
    • {{ Auth Connection Name }} - The OAuthConnection setting from step 1, from Azure Bot SSO setup

The Connection Name referred to is the name that we provide while adding OAuth connection setting in the Bot channel registration. Please follow link Add authentication to your bot to see how we can add the setting.

  • Run the bot from a terminal or from Visual Studio, choose option A or B.

    A) From a terminal

    # run the bot
dotnet run

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to QRAppInstallation folder
    • Select QRAppInstallation.csproj file
    • Press F5 to run the project

  • Modify the manifest.json in the /AppManifest folder and replace the following details:

    • {{Microsoft-App-Id}} with Microsoft Entra ID app registration Application id, generated from Step 1
    • {{domain-name}} 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 the contents of AppManifest folder into a manifest.zip, and use the manifest.zip to deploy in app store or add to Teams.

  • 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 Kindly add the app/bot in personal scope and login there, afterwards add the app/bot in any Teams channel.

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

Running the sample

  • Desktop View Card with actions Generate QR code and Install App:

Card

Generate QR code is used to generate a QR code by selecting the app:

QR Code

Install App is used to Scan the QR code and it then installs the app:

Install App

  • Mobile View Hey command interaction:

CardWithButtonsMobile

Permission UI:

Permission

QR Code:

QRCodeMobile

App added:

AppAddedMobile

Polly App Install:

AppInstallationMobile

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