Skip to content

Latest commit

 

History

History
115 lines (84 loc) · 6.51 KB

README.md

File metadata and controls

115 lines (84 loc) · 6.51 KB
Raw
page_type description products languages extensions urlFragment
sample
This sample app demonstrate the bot that performs simple card based on parameters entered by the user from a Task Module
office-teams
office
office-365
Java
contentType createdDate
samples
12/12/2019 13:38:25 PM
officedev-microsoft-teams-samples-bot-msgext-action-preview-java

Teams Messaging Extensions Action Preview

Bot Framework v4 Teams Messaging Extension Action Preview sample.

This Messaging Extension has been created using Bot Framework.

  • It shows how to create a simple card based on parameters entered by the user from a Task Module.
  • It also displays the scenario where a Bot sends messages on behalf of a User. Attributing the message to that user can help with engagement and showcase a more natural interaction flow.

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

Included Features

  • Bots
  • Message Extensions
  • Action Commands

Interaction with Messaging Extension Action Preview

MsgExtAction

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

Teams Messaging Extensions Action Preview: Manifest

Prerequisites

  • Intall Java 1.8+ Java
  • Install Maven
  • Setup for Java and Maven Setup
  • 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

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.

  1. Run ngrok - point to port 3978

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

  2. 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 Azure Active Directory 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 ngrok. Append with the path /api/messages

  3. Clone the repository

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

  4. Update the resources/application.properties file configuration in your project, 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.)

  5. From the root of this project folder: (samples/msgext-action-preview/java)

    • Open a terminal and build the sample using mvn package command
    • Install the packages in the local cache by using mvn install command in a terminal
    • Run it by using java -jar .\target\bot-teams-messaging-extensions-action-preview-sample.jar command in a terminal

  6. 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)
    • Edit the manifest.json for 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.
    • Zip up the contents of the TeamsAppManifest 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 team scope (Supported app scope)

Running the sample

Note the manifest.json specifies that this bot will be available in "personal", "team" and "groupchat" scopes and the command will be available in the "commandBox", "compose" and "message" context.

Click the Messaging Extension icon in the Compose Box's Messaging Extension menu. OpenAppFromChat

CardPreview

CardSent

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