Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample application demonstrates proactive installation of a Teams app and sending notifications to users using Microsoft Graph APIs.
office-teams
office
office-365
csharp
contentType createdDate
samples
07/07/2021 01:38:26 PM
officedev-microsoft-teams-samples-graph-proactive-installation-csharp

Proactive Installation Sample App

This sample application showcases proactive installation of a Microsoft Teams app, allowing you to send notifications to users via Microsoft Graph APIs. With integrated bot functionality, this app facilitates user interaction and demonstrates how to efficiently manage app installations within Teams channels and group chats.s

Language Used : C#

Included Features

  • Bots

Interaction with app

Proactive Installtion Module

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

Proactive Installation Sample App: Manifest

Prerequisites

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.

Manually Setup and use the sample locally.

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

  1. Setup for Bot

    • Register a Microsoft Entra ID aap registration in Azure portal.
    • 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.

  2. Setup NGROK

  • Run ngrok - point to port 5130

    ngrok http 5130 --host-header="localhost:5130"

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

  • Clone the repository

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

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

    • {{YOUR-MICROSOFT-APP-ID}} - Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.
    • {{ YOUR-MICROSOFT-APP-PASSWORD}} - Generated from Step 1, also referred to as Client secret
    • {{ YOUR-APPCATALOG-TEAM-ID }} - To get TeamsappcatalogAppId you first navigate to following link in your browser Get TeamsAppCatalogId from Microsoft Graph explorer. Then search with app name or based on Manifest App id in Graph Explorer response and copy the Id [i.e teamApp.Id]

    MicGraph

  • Run the bot from Visual Studio:

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/graph-proactive-installation/csharp folder
    • Select ProactiveAppInstallation.sln file
    • Press F5 to run the project

Note In the debug dropdown menu of Visual Studio, select default startup project > ProactiveAppInstallation

  1. 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)
    • 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 an app to your org's app catalog")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload an app to your org's app catalog
    • 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.

Running the sample

Interacting with the Proactive installation App in Teams

  • Install the Proactive App Installation demo in a Team or GroupChat.

    Proactive installation

  • Run Check and install to pro-actively installs the App for all the users in team. Proactive installation

  • Run Check and install to pro-actively installs the App for all the users in team. After installation send 'Send message' command to send proactive message.

    Proactive installation

  • Group Chat

    Group

  • Team Scope

    Teams

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

Further reading