Prompt Preview Support

Libraries/Microsoft.Teams.Api/Account.cs

@@ -37,6 +37,7 @@ public class Account
 
     [JsonPropertyName("isTargeted")]
     [JsonPropertyOrder(6)]
+    [JsonInclude]
     [Experimental("ExperimentalTeamsTargeted")]
     public bool? IsTargeted { get; internal set; }
 }

Libraries/Microsoft.Teams.Api/Entities/Entity.cs

@@ -117,6 +117,7 @@ public override bool CanConvert(Type typeToConvert)
                 "message" or "https://schema.org/Message" => (Entity?)element.Deserialize<IMessageEntity>(options),
                 "ProductInfo" => element.Deserialize<ProductInfoEntity>(options),
                 "streaminfo" => element.Deserialize<StreamInfoEntity>(options),
+                "targetedMessageInfo" => element.Deserialize<TargetedMessageInfoEntity>(options),
                 _ => null
             };
 
@@ -161,6 +162,12 @@ public override void Write(Utf8JsonWriter writer, Entity value, JsonSerializerOp
                 return;
             }
 
+            if (value is TargetedMessageInfoEntity targetedMessageInfo)
+            {
+                JsonSerializer.Serialize(writer, targetedMessageInfo, options);
+                return;
+            }
+
             JsonSerializer.Serialize(writer, value.ToJsonObject(options), options);
         }
     }

Libraries/Microsoft.Teams.Api/Entities/TargetedMessageInfoEntity.cs

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Text.Json.Serialization;
+
+namespace Microsoft.Teams.Api.Entities;
+
+public class TargetedMessageInfoEntity : Entity
+{
+    [JsonPropertyName("messageId")]
+    [JsonPropertyOrder(3)]
+    public required string MessageId { get; set; }
+
+    public TargetedMessageInfoEntity() : base("targetedMessageInfo") { }
+}

Libraries/Microsoft.Teams.Apps/Contexts/Context.Send.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using Microsoft.Teams.Api.Activities;
+using Microsoft.Teams.Api.Entities;
 
 namespace Microsoft.Teams.Apps;
 
@@ -67,6 +68,20 @@ public partial class Context<TActivity> : IContext<TActivity>
 {
     public async Task<T> Send<T>(T activity, CancellationToken cancellationToken = default) where T : IActivity
     {
+        // Auto-populate targetedMessageInfo entity for prompt preview
+        // when the incoming activity was a targeted message (reactive flow).
+        #pragma warning disable ExperimentalTeamsTargeted
+        if (Activity.Recipient?.IsTargeted == true && Activity.Id is not null)
+        {
+            var hasEntity = activity.Entities?.Any(e => e is TargetedMessageInfoEntity) ?? false;
+            if (!hasEntity)
+            {
+                activity.Entities ??= new List<IEntity>();
+                activity.Entities.Add(new TargetedMessageInfoEntity { MessageId = Activity.Id });
+            }
+        }
+        #pragma warning restore ExperimentalTeamsTargeted
+
         var res = await Sender.Send(activity, Ref, CancellationToken);
         await OnActivitySent(res, ToActivityType<IActivity>());
         return res;

Samples/Samples.TargetedMessages/Program.cs

@@ -1,5 +1,6 @@
 using Microsoft.Teams.Api;
 using Microsoft.Teams.Api.Activities;
+using Microsoft.Teams.Api.Entities;
 using Microsoft.Teams.Apps.Activities;
 using Microsoft.Teams.Apps.Extensions;
 using Microsoft.Teams.Plugins.AspNetCore.DevTools.Extensions;
@@ -116,6 +117,32 @@ await context.Reply(
 
         context.Log.Info("[REPLY] Sent targeted reply");
     }
+    else if (text.Contains("preview"))
+    {
+        // PROMPT PREVIEW (reactive): The SDK auto-populates the targetedMessageInfo
+        // entity when the incoming activity is a targeted message. The reply is sent
+        // as a targeted message with a collapsible preview of the original prompt.
+        await context.Send(
+            new MessageActivity("📋 Here is the information you requested - only you can see this, with prompt preview!")
+                .WithRecipient(context.Activity.From, true),
+            cancellationToken);
+
+        context.Log.Info("[PREVIEW] Sent targeted reply with auto-populated prompt preview");
+    }
+    else if (text.Contains("preview-proactive"))
+    {
+        // PROMPT PREVIEW (proactive): The developer manually includes the
+        // targetedMessageInfo entity with the targeted message ID.
+        var targetedMessageId = activity.Id;
+
+        await context.Send(
+            new MessageActivity("📋 Here is the proactive result - with prompt preview!")
+                .WithRecipient(context.Activity.From, true)
+                .AddEntity(new TargetedMessageInfoEntity { MessageId = targetedMessageId }),
+            cancellationToken);
+
+        context.Log.Info("[PREVIEW-PROACTIVE] Sent targeted reply with manually attached prompt preview");
+    }
     else if (text.Contains("help"))
     {
         await context.Send(
@@ -124,7 +151,9 @@ await context.Send(
             "- `send` - Send a targeted message (only you see it)\n" +
             "- `update` - Send a message, then update it after 3 seconds\n" +
             "- `delete` - Send a message, then delete it after 3 seconds\n" +
-            "- `reply` - Get a targeted reply (threaded)\n\n" +
+            "- `reply` - Get a targeted reply (threaded)\n" +
+            "- `preview` - Reply with auto-populated prompt preview (reactive)\n" +
+            "- `preview-proactive` - Reply with manually attached prompt preview (proactive)\n\n" +
             "_Targeted messages are only visible to you, even in group chats!_", cancellationToken);
     }
     else

Tests/Microsoft.Teams.Api.Tests/Entities/TargetedMessageInfoEntityTests.cs

@@ -0,0 +1,73 @@
+using System.Text.Json;
+
+using Microsoft.Teams.Api.Entities;
+
+namespace Microsoft.Teams.Api.Tests.Entities;
+
+public class TargetedMessageInfoEntityTests
+{
+    [Fact]
+    public void TargetedMessageInfoEntity_JsonSerialize()
+    {
+        var entity = new TargetedMessageInfoEntity()
+        {
+            MessageId = "1772129782775"
+        };
+
+        var json = JsonSerializer.Serialize(entity, new JsonSerializerOptions()
+        {
+            WriteIndented = true,
+            IndentSize = 2,
+            DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull
+        });
+
+        Assert.Equal(File.ReadAllText(
+            @"../../../Json/Entities/TargetedMessageInfoEntity.json"
+        ), json);
+    }
+
+    [Fact]
+    public void TargetedMessageInfoEntity_JsonSerialize_Derived()
+    {
+        Entity entity = new TargetedMessageInfoEntity()
+        {
+            MessageId = "1772129782775"
+        };
+
+        var json = JsonSerializer.Serialize(entity, new JsonSerializerOptions()
+        {
+            WriteIndented = true,
+            IndentSize = 2,
+            DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull
+        });
+
+        Assert.Equal(File.ReadAllText(
+            @"../../../Json/Entities/TargetedMessageInfoEntity.json"
+        ), json);
+    }
+
+    [Fact]
+    public void TargetedMessageInfoEntity_JsonDeserialize()
+    {
+        var json = File.ReadAllText(@"../../../Json/Entities/TargetedMessageInfoEntity.json");
+        var entity = JsonSerializer.Deserialize<TargetedMessageInfoEntity>(json);
+
+        Assert.NotNull(entity);
+        Assert.Equal("targetedMessageInfo", entity.Type);
+        Assert.Equal("1772129782775", entity.MessageId);
+    }
+
+    [Fact]
+    public void TargetedMessageInfoEntity_JsonDeserialize_Derived()
+    {
+        var json = File.ReadAllText(@"../../../Json/Entities/TargetedMessageInfoEntity.json");
+        var entity = JsonSerializer.Deserialize<Entity>(json);
+
+        Assert.NotNull(entity);
+        Assert.IsType<TargetedMessageInfoEntity>(entity);
+
+        var targeted = (TargetedMessageInfoEntity)entity;
+        Assert.Equal("targetedMessageInfo", targeted.Type);
+        Assert.Equal("1772129782775", targeted.MessageId);
+    }
+}

Tests/Microsoft.Teams.Api.Tests/Json/Entities/TargetedMessageInfoEntity.json

@@ -0,0 +1,4 @@
+{
+  "type": "targetedMessageInfo",
+  "messageId": "1772129782775"
+}

Tests/Microsoft.Teams.Apps.Tests/Activities/PromptPreviewTests.cs

@@ -0,0 +1,124 @@
+using Microsoft.Teams.Api;
+using Microsoft.Teams.Api.Activities;
+using Microsoft.Teams.Api.Auth;
+using Microsoft.Teams.Api.Entities;
+using Microsoft.Teams.Apps.Activities;
+using Microsoft.Teams.Apps.Testing.Plugins;
+
+namespace Microsoft.Teams.Apps.Tests.Activities;
+
+public class PromptPreviewTests
+{
+    private readonly App _app = new();
+    private readonly IToken _token = Globals.Token;
+
+    public PromptPreviewTests()
+    {
+        _app.AddPlugin(new TestPlugin());
+    }
+
+    [Fact]
+    public async Task Send_AutoPopulates_TargetedMessageInfoEntity_WhenIncomingIsTargeted()
+    {
+        IActivity? sentActivity = null;
+
+        _app.OnMessage(async (context, cancellationToken) =>
+        {
+            sentActivity = await context.Send("Here is the result!", cancellationToken);
+        });
+
+        // Simulate an incoming targeted message (bot's Recipient.IsTargeted = true)
+        var incomingActivity = new MessageActivity("summarize")
+            .WithId("1772129782775")
+            .WithFrom(new Account() { Id = "user1", Name = "User" })
+            .WithRecipient(new Account() { Id = "bot1", Name = "Bot" }, true);
+
+        await _app.Process<TestPlugin>(_token, incomingActivity);
+
+        Assert.NotNull(sentActivity);
+        Assert.NotNull(sentActivity!.Entities);
+
+        var targetedEntity = sentActivity.Entities!.OfType<TargetedMessageInfoEntity>().SingleOrDefault();
+        Assert.NotNull(targetedEntity);
+        Assert.Equal("1772129782775", targetedEntity!.MessageId);
+    }
+
+    [Fact]
+    public async Task Reply_AutoPopulates_TargetedMessageInfoEntity_WhenIncomingIsTargeted()
+    {
+        IActivity? sentActivity = null;
+
+        _app.OnMessage(async (context, cancellationToken) =>
+        {
+            sentActivity = await context.Reply("Here is the result!", cancellationToken);
+        });
+
+        var incomingActivity = new MessageActivity("summarize")
+            .WithId("1772129782775")
+            .WithFrom(new Account() { Id = "user1", Name = "User" })
+            .WithConversation(new Api.Conversation() { Id = "conv1" })
+            .WithRecipient(new Account() { Id = "bot1", Name = "Bot" }, true);
+
+        await _app.Process<TestPlugin>(_token, incomingActivity);
+
+        Assert.NotNull(sentActivity);
+        Assert.NotNull(sentActivity!.Entities);
+
+        var targetedEntity = sentActivity.Entities!.OfType<TargetedMessageInfoEntity>().SingleOrDefault();
+        Assert.NotNull(targetedEntity);
+        Assert.Equal("1772129782775", targetedEntity!.MessageId);
+    }
+
+    [Fact]
+    public async Task Send_DoesNotAdd_TargetedMessageInfoEntity_WhenNotTargeted()
+    {
+        IActivity? sentActivity = null;
+
+        _app.OnMessage(async (context, cancellationToken) =>
+        {
+            sentActivity = await context.Send("Hello!", cancellationToken);
+        });
+
+        // Normal (non-targeted) incoming message
+        var incomingActivity = new MessageActivity("hello")
+            .WithId("123456")
+            .WithRecipient(new Account() { Id = "bot1", Name = "Bot" });
+
+        await _app.Process<TestPlugin>(_token, incomingActivity);
+
+        Assert.NotNull(sentActivity);
+        var targetedEntity = sentActivity!.Entities?.OfType<TargetedMessageInfoEntity>().SingleOrDefault();
+        Assert.Null(targetedEntity);
+    }
+
+    [Fact]
+    public async Task Send_DoesNotDuplicate_TargetedMessageInfoEntity_WhenAlreadyPresent()
+    {
+        IActivity? sentActivity = null;
+
+        _app.OnMessage(async (context, cancellationToken) =>
+        {
+            // Developer manually adds the entity (proactive-like scenario)
+            var activity = new MessageActivity("Result")
+                .AddEntity(new TargetedMessageInfoEntity { MessageId = "9999" });
+
+            sentActivity = await context.Send(activity, cancellationToken);
+        });
+
+        // Incoming activity is targeted
+        var incomingActivity = new MessageActivity("summarize")
+            .WithId("1772129782775")
+            .WithFrom(new Account() { Id = "user1", Name = "User" })
+            .WithRecipient(new Account() { Id = "bot1", Name = "Bot" }, true);
+
+        await _app.Process<TestPlugin>(_token, incomingActivity);
+
+        Assert.NotNull(sentActivity);
+        Assert.NotNull(sentActivity!.Entities);
+
+        var targetedEntities = sentActivity.Entities!.OfType<TargetedMessageInfoEntity>().ToList();
+        Assert.Single(targetedEntities);
+        // The developer-provided entity should be preserved, not overwritten
+        Assert.Equal("9999", targetedEntities[0].MessageId);
+    }
+}