Teams Adaptive Card Tabs (#5111)

* Teams Adaptive Card Tabs

* Change name of TabContext to TabEntityContext

* Add tests for tab/fetch and tab/submit

* Fix variable name on OnTeamsTabSubmitAsync

* Add adaptive schemas and triggers for teams tabs

* Add TaskModuleCardResponse

* minor fixes

* test sync

* Address feedback

Co-authored-by: Michael Richardson <v-micric@microsoft.com>

Author: EricDahlvang

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams.csproj

@@ -40,6 +40,8 @@
     <None Remove="Schemas\Actions\Teams.GetMeetingParticipant.schema" />
     <None Remove="Schemas\TriggerConditions\Microsoft.OnInvokeActivity.schema" />
     <None Remove="Schemas\TriggerConditions\Teams.OnChannelRestored.schema" />
+    <None Remove="Schemas\TriggerConditions\Teams.OnTabFetch.schema" />
+    <None Remove="Schemas\TriggerConditions\Teams.OnTabSubmit.schema" />
     <None Remove="Schemas\TriggerConditions\Teams.OnTeamArchived.schema" />
     <None Remove="Schemas\TriggerConditions\Teams.OnTeamDeleted.schema" />
     <None Remove="Schemas\TriggerConditions\Teams.OnTeamHardDeleted.schema" />

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/Schemas/TriggerConditions/Teams.OnTabFetch.schema

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
+    "$role": [ "implements(Microsoft.ITrigger)", "extends(Microsoft.OnCondition)" ],
+    "title": "On Teams Tab Fetch",
+    "description": "Actions triggered when a Teams InvokeActivity is received with activity.name='tab/fetch'.",
+    "type": "object",
+    "required": [
+    ]
+}

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/Schemas/TriggerConditions/Teams.OnTabSubmit.schema

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
+    "$role": [ "implements(Microsoft.ITrigger)", "extends(Microsoft.OnCondition)" ],
+    "title": "On Teams Tab Submit",
+    "description": "Actions triggered when a Teams InvokeActivity is received with activity.name='tab/submit'.",
+    "type": "object",
+    "required": [
+    ]
+}

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/TeamsComponentRegistration.cs

@@ -38,6 +38,8 @@ public virtual IEnumerable<DeclarativeType> GetDeclarativeTypes(ResourceExplorer
             yield return new DeclarativeType<OnTeamsTeamRenamed>(OnTeamsTeamRenamed.Kind);
             yield return new DeclarativeType<OnTeamsTeamRestored>(OnTeamsTeamRestored.Kind);
             yield return new DeclarativeType<OnTeamsTeamUnarchived>(OnTeamsTeamUnarchived.Kind);
+            yield return new DeclarativeType<OnTeamsTabFetch>(OnTeamsTabFetch.Kind);
+            yield return new DeclarativeType<OnTeamsTabSubmit>(OnTeamsTabSubmit.Kind);
 
             // Actions
             yield return new DeclarativeType<GetMeetingParticipant>(GetMeetingParticipant.Kind);

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/TriggerConditions/OnTeamsTabFetch.cs

@@ -0,0 +1,34 @@
+// Licensed under the MIT License.
+// Copyright (c) Microsoft Corporation. All rights reserved.
+
+using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+using AdaptiveExpressions;
+using Microsoft.Bot.Builder.Dialogs.Adaptive.Conditions;
+using Microsoft.Bot.Connector;
+using Newtonsoft.Json;
+
+namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Teams
+{
+    /// <summary>
+    /// Actions triggered when a Teams InvokeActivity is received with activity.name='tab/fetch'.
+    /// </summary>
+    public class OnTeamsTabFetch : OnInvokeActivity
+    {
+        [JsonProperty("$kind")]
+        public new const string Kind = "Teams.OnTabFetch";
+
+        [JsonConstructor]
+        public OnTeamsTabFetch(List<Dialog> actions = null, string condition = null, [CallerFilePath] string callerPath = "", [CallerLineNumber] int callerLine = 0)
+            : base(actions: actions, condition: condition, callerPath: callerPath, callerLine: callerLine)
+        {
+        }
+
+        /// <inheritdoc/>
+        protected override Expression CreateExpression()
+        {
+            // if name is 'tab/fetch'
+            return Expression.AndExpression(Expression.Parse($"{TurnPath.Activity}.ChannelId == '{Channels.Msteams}' && {TurnPath.Activity}.name == 'tab/fetch'"), base.CreateExpression());
+        }
+    }
+}

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive.Teams/TriggerConditions/OnTeamsTabSubmit.cs

@@ -0,0 +1,34 @@
+// Licensed under the MIT License.
+// Copyright (c) Microsoft Corporation. All rights reserved.
+
+using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+using AdaptiveExpressions;
+using Microsoft.Bot.Builder.Dialogs.Adaptive.Conditions;
+using Microsoft.Bot.Connector;
+using Newtonsoft.Json;
+
+namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Teams
+{
+    /// <summary>
+    /// Actions triggered when a Teams InvokeActivity is received with activity.name='tab/submit'.
+    /// </summary>
+    public class OnTeamsTabSubmit : OnInvokeActivity
+    {
+        [JsonProperty("$kind")]
+        public new const string Kind = "Teams.OnTabSubmit";
+
+        [JsonConstructor]
+        public OnTeamsTabSubmit(List<Dialog> actions = null, string condition = null, [CallerFilePath] string callerPath = "", [CallerLineNumber] int callerLine = 0)
+            : base(actions: actions, condition: condition, callerPath: callerPath, callerLine: callerLine)
+        {
+        }
+
+        /// <inheritdoc/>
+        protected override Expression CreateExpression()
+        {
+            // if name is 'tab/submit'
+            return Expression.AndExpression(Expression.Parse($"{TurnPath.Activity}.ChannelId == '{Channels.Msteams}' && {TurnPath.Activity}.name == 'tab/submit'"), base.CreateExpression());
+        }
+    }
+}

libraries/Microsoft.Bot.Builder/Teams/TeamsActivityHandler.cs

@@ -82,6 +82,12 @@ protected override async Task<InvokeResponse> OnInvokeActivityAsync(ITurnContext
 
                         case "task/submit":
                             return CreateInvokeResponse(await OnTeamsTaskModuleSubmitAsync(turnContext, SafeCast<TaskModuleRequest>(turnContext.Activity.Value), cancellationToken).ConfigureAwait(false));
+                        
+                        case "tab/fetch":
+                            return CreateInvokeResponse(await OnTeamsTabFetchAsync(turnContext, SafeCast<TabRequest>(turnContext.Activity.Value), cancellationToken).ConfigureAwait(false));
+                        
+                        case "tab/submit":
+                            return CreateInvokeResponse(await OnTeamsTabSubmitAsync(turnContext, SafeCast<TabSubmit>(turnContext.Activity.Value), cancellationToken).ConfigureAwait(false));
 
                         default:
                             return await base.OnInvokeActivityAsync(turnContext, cancellationToken).ConfigureAwait(false);
@@ -383,6 +389,32 @@ protected virtual Task<TaskModuleResponse> OnTeamsTaskModuleSubmitAsync(ITurnCon
             throw new InvokeResponseException(HttpStatusCode.NotImplemented);
         }
 
+        /// <summary>
+        /// Override this in a derived class to provide logic for when a tab is fetched.
+        /// </summary>
+        /// <param name="turnContext">A strongly-typed context object for this turn.</param>
+        /// <param name="tabRequest">The tab invoke request value payload.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects
+        /// or threads to receive notice of cancellation.</param>
+        /// <returns>A Tab Response for the request.</returns>
+        protected virtual Task<TabResponse> OnTeamsTabFetchAsync(ITurnContext<IInvokeActivity> turnContext, TabRequest tabRequest, CancellationToken cancellationToken)
+        {
+            throw new InvokeResponseException(HttpStatusCode.NotImplemented);
+        }
+
+        /// <summary>
+        /// Override this in a derived class to provide logic for when a tab is submitted.
+        /// </summary>
+        /// <param name="turnContext">A strongly-typed context object for this turn.</param>
+        /// <param name="tabSubmit">The tab submit invoke request value payload.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects
+        /// or threads to receive notice of cancellation.</param>
+        /// <returns>A Tab Response for the request.</returns>
+        protected virtual Task<TabResponse> OnTeamsTabSubmitAsync(ITurnContext<IInvokeActivity> turnContext, TabSubmit tabSubmit, CancellationToken cancellationToken)
+        {
+            throw new InvokeResponseException(HttpStatusCode.NotImplemented);
+        }
+
         /// <summary>
         /// Invoked when a conversation update activity is received from the channel.
         /// Conversation update activities are useful when it comes to responding to users being added to or removed from the channel.

libraries/Microsoft.Bot.Schema/Teams/TabContext.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using Newtonsoft.Json;
+    
+    /// <summary>
+    /// Current tab request context, i.e., the current theme.
+    /// </summary>
+    public partial class TabContext
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabContext"/> class.
+        /// </summary>
+        public TabContext()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets the current user's theme.
+        /// </summary>
+        /// <value>
+        /// The current user's theme.
+        /// </value>
+        [JsonProperty(PropertyName = "theme")]
+        public string Theme { get; set; }
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}

libraries/Microsoft.Bot.Schema/Teams/TabEntityContext.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Current TabRequest entity context, or 'tabEntityId'.
+    /// </summary>
+    public partial class TabEntityContext
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabEntityContext"/> class.
+        /// </summary>
+        public TabEntityContext()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets the entity id of the tab.
+        /// </summary>
+        /// <value>
+        /// The entity id of the tab.
+        /// </value>
+        [JsonProperty(PropertyName = "tabEntityId")]
+        public string TabEntityId { get; set; }
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}

libraries/Microsoft.Bot.Schema/Teams/TabRequest.cs

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Invoke ('tab/fetch') request value payload.
+    /// </summary>
+    public partial class TabRequest
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabRequest"/> class.
+        /// </summary>
+        public TabRequest()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets current tab entity request context.
+        /// </summary>
+        /// <value>
+        /// Tab context for this <see cref="TabRequest"/>.
+        /// </value>
+        [JsonProperty(PropertyName = "tabContext")]
+        public TabEntityContext TabEntityContext { get; set; }
+
+        /// <summary>
+        /// Gets or sets current user context, i.e., the current theme.
+        /// </summary>
+        /// <value>
+        /// Current user context, i.e., the current theme.
+        /// </value>
+        [JsonProperty(PropertyName = "context")]
+        public TabContext Context { get; set; }
+
+        /// <summary>
+        /// Gets or sets state, which is the magic code for OAuth Flow.
+        /// </summary>
+        /// <value>
+        /// State, which is the magic code for OAuth Flow.
+        /// </value>
+        [JsonProperty(PropertyName = "state")]
+        public string State { get; set; }
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}

libraries/Microsoft.Bot.Schema/Teams/TabResponse.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using Newtonsoft.Json;
+    
+    /// <summary>
+    /// Envelope for Card Tab Response Payload.
+    /// </summary>
+    public partial class TabResponse
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabResponse"/> class.
+        /// </summary>
+        public TabResponse()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets the response to the tab/fetch message.
+        /// Possible values for the tab type include: 'continue', 'auth' or 'silentAuth'.
+        /// </summary>
+        /// <value>
+        /// Cards in response to a <see cref="TabRequest"/>.
+        /// </value>
+        [JsonProperty(PropertyName = "tab")]
+        public TabResponsePayload Tab { get; set; }
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}

libraries/Microsoft.Bot.Schema/Teams/TabResponseCard.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using Newtonsoft.Json;
+    
+    /// <summary>
+    /// Envelope for cards for a Tab request.
+    /// </summary>
+    public partial class TabResponseCard
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabResponseCard"/> class.
+        /// </summary>
+        public TabResponseCard()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets adaptive card for this card tab response.
+        /// </summary>
+        /// <value>
+        /// Cards for this <see cref="TabResponse"/>.
+        /// </value>
+        [JsonProperty(PropertyName = "card")]
+        public object Card { get; set; }
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}

libraries/Microsoft.Bot.Schema/Teams/TabResponseCards.cs

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Schema.Teams
+{
+    using System.Collections.Generic;
+    using Newtonsoft.Json;
+    
+    /// <summary>
+    /// Envelope for cards for a <see cref="TabResponse"/>.
+    /// </summary>
+    public partial class TabResponseCards
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TabResponseCards"/> class.
+        /// </summary>
+        public TabResponseCards()
+        {
+            CustomInit();
+        }
+
+        /// <summary>
+        /// Gets or sets adaptive cards for this card tab response.
+        /// </summary>
+        /// <value>
+        /// Cards for this <see cref="TabResponse"/>.
+        /// </value>
+        [JsonProperty(PropertyName = "cards")]
+#pragma warning disable CA2227 // Collection properties should be read only
+        public IList<object> Cards { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
+
+        /// <summary>
+        /// An initialization method that performs custom operations like setting defaults.
+        /// </summary>
+        partial void CustomInit();
+    }
+}