Skip to content

Latest commit

 

History

History
 
 

54.teams-task-module

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

deploymentTemplates

deploymentTemplates

 
 

src

src

 
 

teamsAppManifest

teamsAppManifest

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

pom.xml

pom.xml

 
 

README.md

Teams Task Module

Bot Framework v4 Teams Task Module sample.

This bot has been created using Bot Framework. It shows how to fetch a Task Module from a Hero Card button and receive input from an Adaptive Card in the Task Module.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Prerequisites

  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.
  • Microsoft Teams is installed and you have an account
  • ngrok or equivalent tunnelling solution

To try this sample

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.

  • Run ngrok http -host-header=rewrite 3978

  • Create Bot Framework registration resource in Azure

  • Update the resources/application.properties configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (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.) The Task Modules using pages require the deployed bot's path in BaseUrl.

  • This step is specific to Teams.

    • Edit the manifest.json contained in the teamsAppManifest 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). Note: the Task Modules containing pages will require the deployed bot's domain in validDomains of the manifest.
    • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  • From the root of this project folder:

    • Build the sample using mvn package
    • Unless done previously, install the packages in the local cache by using mvn install
    • Run it by using java -jar .\target\bot-teams-task-module-sample.jar

Interacting with the bot in Teams

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 with a button which will display a Task Module when clicked. The Task Module demonstrates retrieving input from a user through a Text Block and a Submit button.

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