Skip to content

Latest commit

 

History

History
 
 

csharp

README.md

page_type products languages title description extensions urlFragment
sample
office-teams
office
office-365
csharp
Microsoft Teams C# Helloworld Sample
Microsoft Teams "Hello world" application for .NET/C# which showcases tab, bot and messaging extension.
contentType platforms createdDate
samples
CSS
10/19/2022 10:02:21 PM
officedev-microsoft-teams-samples-app-hello-world-csharp

Microsoft Teams hello world sample app.

  • Microsoft Teams hello world sample app.

Included Features

  • Tabs
  • Bots
  • Messaging Extensions

Interaction with app

HelloTabGif

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

Microsoft Teams hello world sample app: Manifest

Prerequisites

Setup

1. Setup for Bot

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

2. Setup NGROK

  1. Run ngrok - point to port 5000

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

    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 5000 --allow-anonymous

3. Setup for code

  • Clone the repository

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

Run the bot from a terminal or from Visual Studio:

A) From a terminal, navigate to Microsoft.Teams.Samples.HelloWorld.Web

# run the bot
dotnet run

B) Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to Microsoft.Teams.Samples.HelloWorld.Web folder
  • Select Microsoft.Teams.Samples.HelloWorld.Web.csproj file
  • Press F5 to run the project

4. Setup Manifest for Teams

  • This step is specific to Teams.
  1. Modify the manifest.json in the /AppManifest folder and replace the following details:
  • {{Microsoft-App-Id}} with Application id generated from Step 1
  • {{domain-name}} with base Url domain. E.g. if you are using ngrok it would be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.

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

  1. Zip the contents of AppManifest or AppManifest_Hub folder into a manifest.zip.

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

  • {{Microsoft-App-Id}} - Generated from Step 1 is the application app id
  • {{ 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.
  1. 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: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

Install App:

InstallApp

Welcome Bot:

Hello Bot

Welcome UI:

HelloTab

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

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

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

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