csharp

page_type	description	products	languages	extensions	urlFragment
sample	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.	office-teams office office-365	csharp	contentType createdDate samples 10/11/2021 23:35:25 PM	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

Interaction with bot - Mobile View

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

Install app using barcode sample: Manifest

Prerequisites

• .NET Core SDK version 6.0

  determine dotnet version

  dotnet --version

• dev tunnel or ngrok (For local environment testing) latest version (any other tunneling software can also be used)

• Teams Microsoft Teams is installed and you have an account

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.

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

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

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

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

• Mobile View Hey command interaction:

Permission UI:

QR Code:

App added:

Polly App Install:

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

• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• Integrate media Capabilities inside your app