Skip to content

Latest commit

 

History

History
page_type description products languages extensions urlFragment
sample
This sample showcases the development of a custom personal tab for Microsoft Teams, utilizing ASP.NET Core MVC to enhance user interaction.
office-teams
office
office-365
csharp
contentType createdDate
samples
07/07/2021 01:38:27 PM
officedev-microsoft-teams-samples-tab-personal-mvc-csharp

Personal Tab with ASP. NET Core MVC

This sample application illustrates the process of building a custom personal tab in Microsoft Teams using ASP.NET Core MVC. It provides a comprehensive guide on setting up the environment, configuring the app manifest, and deploying the app across Teams and Office platforms, enabling seamless integration and enhanced user experience.

Included Features

  • Tabs

Interaction with app

personaltab

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

Personal Tab: 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 default startup project > Microsoft Teams (browser)
  4. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
  5. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
  6. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
  7. 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. 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
  2. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  3. If you are using Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples\tab-personal\mvc-csharp folder
  • Select PersonalTabMVC.sln file and open the solution
  1. Modify the manifest.json in the /appPackage or /Manifest_Hub folder and replace the following details:

    • <> with any random GUID.
    • <<Base-url>> 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.
    • validDomains 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.
  2. 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 or ./Manifest_Hub folder, select the zip folder, and choose Open.

Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the /Manifest_Hub folder with the required values.

Running the sample

personaltab

Greytab

tab

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

On the side bar, select More Apps. Your sideloaded app title appears among your installed apps

InstallOutlook

Select your app icon to launch and preview your app running in Outlook on the web

AppOutlook

**Click on 'Select Gray' button application will perform like below **

AppOutlook_Gray.png

**Click on 'Select Red' button application will perform like below **

AppOutlook_Red.png

Note: Similarly, you can test your application in the Outlook desktop app as well.

Office on the web

  • To preview your app running in Office on the web.

  • Log into office.com with test tenant credentials

Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps

InstallOffice

Select your app icon to launch your app in Office on the web

AppOffice

**Click on 'Select Gray' button application will perform like below **

AppOffice_Gray.png

**Click on 'Select Red' button application will perform like below **

AppOffice_Red.png

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Fruther Reading

Tab-personal Create a Custom Personal Tab with ASP. NET Core MVC

Tab-personal Create a Custom Personal Tab with ASP. NET Core MVC