54-Task-Module teams sample

libraries/bot-builder/src/main/java/com/microsoft/bot/builder/teams/TeamsActivityHandler.java

@@ -363,7 +363,7 @@ protected CompletableFuture<Void> onTeamsMessagingExtensionCardButtonClicked(
         return notImplemented();
     }
 
-    protected CompletableFuture<Void> onTeamsTaskModuleSubmit(
+    protected CompletableFuture<TaskModuleResponse> onTeamsTaskModuleSubmit(
         TurnContext turnContext,
         TaskModuleRequest taskModuleRequest
     ) {

libraries/bot-builder/src/test/java/com/microsoft/bot/builder/teams/TeamsActivityHandlerTests.java

@@ -1041,7 +1041,7 @@ protected CompletableFuture<Void> onTeamsMessagingExtensionCardButtonClicked(
         }
 
         @Override
-        protected CompletableFuture<Void> onTeamsTaskModuleSubmit(
+        protected CompletableFuture<TaskModuleResponse> onTeamsTaskModuleSubmit(
             TurnContext turnContext,
             TaskModuleRequest taskModuleRequest
         ) {

libraries/bot-schema/src/main/java/com/microsoft/bot/schema/teams/TaskModuleAction.java

@@ -10,6 +10,8 @@
 import com.microsoft.bot.schema.CardAction;
 import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
+
 /**
  * Adapter class to represent BotBuilder card action as adaptive card action (in
  * type of Action.Submit).
@@ -29,7 +31,18 @@ public TaskModuleAction(String withTitle, Object withValue) {
         ObjectMapper objectMapper = new ObjectMapper();
         objectMapper.findAndRegisterModules();
 
-        ObjectNode data = objectMapper.valueToTree(withValue);
+        ObjectNode data = null;
+        if (withValue instanceof String) {
+
+            try {
+                data = objectMapper.readValue((String) withValue, ObjectNode.class);
+            } catch (IOException e) {
+                LoggerFactory.getLogger(TaskModuleAction.class).error("TaskModuleAction", e);
+            }
+        } else {
+            data = objectMapper.valueToTree(withValue);
+        }
+
         data.put("type", "task/fetch");
 
         try {

libraries/bot-schema/src/main/java/com/microsoft/bot/schema/teams/TaskModuleMessageResponse.java

@@ -10,14 +10,14 @@
  */
 public class TaskModuleMessageResponse extends TaskModuleResponseBase {
     @JsonProperty(value = "value")
-    private TaskModuleTaskInfo value;
+    private String value;
 
     /**
      * Gets info teams will display the value of value in a popup message box.
      * 
      * @return The popup info.
      */
-    public TaskModuleTaskInfo getValue() {
+    public String getValue() {
         return value;
     }
 
@@ -26,7 +26,7 @@ public TaskModuleTaskInfo getValue() {
      * 
      * @param withValue The popup info.
      */
-    public void setValue(TaskModuleTaskInfo withValue) {
+    public void setValue(String withValue) {
         value = withValue;
     }
 }

samples/54.teams-task-module/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

samples/54.teams-task-module/README.md

@@ -0,0 +1,60 @@
+# Teams Task Module
+
+Bot Framework Teams Task Module sample.
+
+This bot has been created using [Bot Framework](https://dev.botframework.com). It shows how to fetch a Task Module from a Hero Card button and receive input from an Adaptive Card in the Task Module.
+
+## Prerequisites
+
+- Microsoft Teams is installed and you have an account
+- [ngrok](https://ngrok.com/) 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.
+
+1) Clone the repository
+
+    ```bash
+    git clone https://github.com/Microsoft/botbuilder-java.git
+    ```
+
+1) Run ngrok - point to port 8080
+
+    ```bash
+    ngrok http -host-header=rewrite 8080
+    ```
+
+1) Create [Bot Framework registration resource](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-quickstart-registration) in Azure
+    - Use the current `https` URL you were given by running ngrok. Append with the path `/api/messages` used by this sample
+    - Ensure that you've [enabled the Teams Channel](https://docs.microsoft.com/en-us/azure/bot-service/channel-connect-teams?view=azure-bot-service-4.0)
+    - __*If you don't have an Azure account*__ you can use this [Bot Framework registration](https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/create-a-bot-for-teams#register-your-web-service-with-the-bot-framework)
+
+1) 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.)
+
+1) __*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`)
+    - **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")
+
+1) 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](https://aka.ms/azuredeployment) for a complete list of deployment instructions.
+
+## Further reading
+
+- [How Microsoft Teams bots work](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-basics-teams?view=azure-bot-service-4.0&tabs=javascript)
+

samples/54.teams-task-module/deploymentTemplates/new-rg-parameters.json

@@ -0,0 +1,42 @@
+{
+    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
+    "contentVersion": "1.0.0.0",
+    "parameters": {
+        "groupLocation": {
+            "value": ""
+        },
+        "groupName": {
+            "value": ""
+        },
+        "appId": {
+            "value": ""
+        },
+        "appSecret": {
+            "value": ""
+        },
+        "botId": {
+            "value": ""
+        },
+        "botSku": {
+            "value": ""
+        },
+        "newAppServicePlanName": {
+            "value": ""
+        },
+        "newAppServicePlanSku": {
+            "value": {
+                "name": "S1",
+                "tier": "Standard",
+                "size": "S1",
+                "family": "S",
+                "capacity": 1
+            }
+        },
+        "newAppServicePlanLocation": {
+            "value": ""
+        },
+        "newWebAppName": {
+            "value": ""
+        }
+    }
+}

samples/54.teams-task-module/deploymentTemplates/preexisting-rg-parameters.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
+    "contentVersion": "1.0.0.0",
+    "parameters": {
+        "appId": {
+            "value": ""
+        },
+        "appSecret": {
+            "value": ""
+        },
+        "botId": {
+            "value": ""
+        },
+        "botSku": {
+            "value": ""
+        },
+        "newAppServicePlanName": {
+            "value": ""
+        },
+        "newAppServicePlanSku": {
+            "value": {
+                "name": "S1",
+                "tier": "Standard",
+                "size": "S1",
+                "family": "S",
+                "capacity": 1
+            }
+        },
+        "appServicePlanLocation": {
+            "value": ""
+        },
+        "existingAppServicePlan": {
+            "value": ""
+        },
+        "newWebAppName": {
+            "value": ""
+        }
+    }
+}