Name	Name	Last commit message	Last commit date
parent directory ..
Bots	Bots
Controllers	Controllers
DeploymentTemplates	DeploymentTemplates
Helper	Helper
Images	Images
M365Agent	M365Agent
Models	Models
Pages	Pages
Properties	Properties
Resources	Resources
assets	assets
demo-manifest	demo-manifest
wwwroot	wwwroot
.gitignore	.gitignore
AdapterWithErrorHandler.cs	AdapterWithErrorHandler.cs
Program.cs	Program.cs
README.md	README.md
Startup.cs	Startup.cs
TeamsTaskModule.csproj	TeamsTaskModule.csproj
TeamsTaskModule.sln	TeamsTaskModule.sln
TeamsTaskModule.slnLaunch.user	TeamsTaskModule.slnLaunch.user
appsettings.Development.json	appsettings.Development.json
appsettings.json	appsettings.json

page_type

sample

description

This sample app demonstrate how to use Dialogs (referred as task modules in TeamsJS v1.x) using Bot Framework v4

products

office-teams

office

office-365

languages

csharp

extensions

contentType	createdDate
samples	10/17/2019 13:38:25 PM

urlFragment

officedev-microsoft-teams-samples-bot-task-module-csharp

Teams Dialog (referred as task modules in TeamsJS v1.x)

Bot Framework Teams Dialogs (referred as task modules in TeamsJS v1.x) sample.

This bot has been created using Bot Framework. It shows how to fetch a Dialog (referred as task modules in TeamsJS v1.x) from Hero Card or Adaptive Card buttons and receive input from the Dialog (referred as task modules in TeamsJS v1.x) in the bot.

Included Features

Bots
Tabs
Dialogs (referred as task modules in TeamsJS v1.x)

Interaction with bot

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 manifest (.zip file link below) to your teams and/or as a personal app. (Uploading must be enabled for your tenant, see steps here).

Teams Dialogs (referred as task modules in TeamsJS v1.x): Manifest

Prerequisites

Microsoft Teams is installed and you have an account
.NET SDK version 6.0
dev tunnel or ngrok latest version or equivalent tunnelling solution
Microsoft 365 Agents Toolkit for Visual Studio

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.

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

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

Register your app with Azure AD.

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

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
```
Setup for Bot

In Azure portal, create a Azure Bot resource.
- For bot handle, make up a name.
- Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.)
- If you don't have an Azure account create an Azure free account here
In the new Azure Bot resource in the Portal,
- Ensure that you've enabled the Teams Channel
- In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunneling application. Append with the path /api/messages

Clone the repository

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

If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to samples/bot-task-module/csharp folder
- Select TeamsTaskModule.csproj or TeamsTaskModule.slnfile
Update the appsettings.json configuration for the bot to use the <<MicrosoftAppId>>, <<MicrosoftAppPassword>>, <<MicrosoftAppTenantId>> generated in Step 2 (App Registration creation). (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)
- Set <<MicrosoftAppType>> in the appsettings.json. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
- Set <<BaseUrl>> in the appsettings.json as per your application like the ngrok forwarding url (ie https://xxxx.ngrok-free.app) after starting ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.
Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.
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 bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
- Edit the manifest.json for <<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 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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
- Add the app in personal/groupchat/team scope (supported scopes)

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

Running the sample

Note this manifest.json specified that the bot will be installed in "personal", "team" and "groupchat" scope which is why you immediately entered a one on one chat conversation with the bot. You can at mention the bot in a group chat or in a Channel in the Team you installed it in. Please refer to Teams documentation for more details.

You can interact with this bot by sending it a message. The bot will respond with a Hero Card and Adaptive Card with buttons which will display a Dialog (referred as task modules in TeamsJS v1.x) when clicked. The Dialogs (referred as task modules in TeamsJS v1.x) demonstrate retrieving input from a user, or displaying custom web page content.