ダイアログの作成と送信

• SDK レファレンス
• サンプル コード参照

using Microsoft.Teams.Apps.MessageExtensions;

// ...

teams.OnFetchTask(async (context, cancellationToken) =>
{
    // Handle fetch task
  MessageExtensionAction? action = context.Activity.Value;
  string? commandId = action?.CommandId;

  return MessageExtensionActionResponse.CreateBuilder().Build();
});

using Microsoft.Teams.Api.MessageExtensions;

// ...

teams.OnFetchTask(async (ctx) =>
{
    // Handle fetch task
    var commandId = ctx.Activity.Value?.CommandId;

    return new ActionResponse();
});

• サンプル コード参照

import { App } from '@microsoft/teams.apps';

// ...

app.on('message.ext.open', async ({ activity }) => {
  // Handle fetch task
  const commandId: string | undefined = activity.value?.commandId;
});

• サンプル コード参照

from microsoft_teams.api import MessageExtensionFetchTaskInvokeActivity
from microsoft_teams.apps import ActivityContext, App

# ...

@app.on_message_ext_open
async def handle_fetch_task(
    ctx: ActivityContext[MessageExtensionFetchTaskInvokeActivity]
):
    # Handle fetch task
    command_id = ctx.activity.value.command_id

{
  "name": "composeExtension/fetchTask",
  "type": "invoke",
  "timestamp": "2019-07-01T22:57:22.175Z",
  "localTimestamp": "2019-07-01T15:57:22.175-07:00",
  "id": "f:0123456878990178955",
  "channelId": "msteams",
  "serviceURL": "https://smba.trafficmanager.net/amer/",
  "from": {
    "id": "29:1test2GgHIa0DXzDT_OGwL5vSMZdAxDlGR7hYxZ6_JBVqHz2Zq9Nm44FUNWqHCdGBwHg8WrlFRsYrd0cCAS7dig",
    "name": "John Smith",
    "aadObjectId": "1234567d-1234-462a-8952-35b75f16f1e1"
  },
  "conversation": {
    "isGroup": true,
    "conversationType": "channel",
    "tenantId": "1234abcd-1234-12ab-12ab-35b75f16f1e1",
    "id": "19:83ed1d507cb5427c93495cf914326310@thread.skype"
  },
  "recipient": {
    "id": "28:049566e0-4401-4bcf-86a1-ce22082ce03a",
    "name": "mess"
  },
  "entities": [
    {
      "locale": "en-US",
      "country": "US",
      "platform": "Windows",
      "type": "clientInfo"
    }
  ],
  "channelData": {
    "channel": {
      "id": "19:83ab1d507cb5427c93495cf912345678@thread.skype"
    },
    "team": {
      "id": "19:83ab1d507cb5427c93495cf912345678@thread.skype"
    },
    "tenant": {
      "id": "1234abcd-1234-12ab-12ab-35b75f16f1e1"
    },
    "source": {
      "name": "compose"
    }
  },
  "value": {
    "commandId": "hello",
    "commandContext": "compose",
    "context": {
      "theme": "dark"
    }
  },
  "locale": "en-US"
}

• SDK レファレンス
• サンプル コード参照

using Microsoft.Teams.Apps.MessageExtensions;

// ...

teams.OnFetchTask(async (context, cancellationToken) =>
{
  MessageExtensionAction? action = context.Activity.Value;

  var messageText = action?.MessagePayload?.Body?.Content;
  var fromId = action?.MessagePayload?.From?.User?.Id;

  return MessageExtensionActionResponse.CreateBuilder().Build();
});

teams.OnFetchTask(async (ctx) =>
{
    var messageText =
        ctx.Activity.Value?.MessagePayload?.Body?.Content;

    var fromId =
        ctx.Activity.Value?.MessagePayload?.From?.User?.Id;

    // Finish handling the fetchTask
    return new ActionResponse();
});

• サンプル コード参照

app.on('message.ext.open', async ({ activity }) => {
    const messageText: string | undefined =
        activity.value?.messagePayload?.body?.content;

    // Finish handling the fetchTask
});

• サンプル コード参照

@app.on_message_ext_open
async def handle_fetch_task(
    ctx: ActivityContext[MessageExtensionFetchTaskInvokeActivity]
):
    message_text = ctx.activity.value.message_payload.body.content
    from_id = ctx.activity.value.message_payload.from_property.user.id

    # Finish handling the fetchTask

{
  "name": "composeExtension/submitAction",
  "type": "invoke",
...
  "value": {
    "commandId": "setReminder",
    "commandContext": "message",
    "messagePayload": {
      "id": "1111111111",
      "replyToId": null,
      "createdDateTime": "2019-02-25T21:29:36.065Z",
      "lastModifiedDateTime": null,
      "deleted": false,
      "subject": "Message subject",
      "summary": null,
      "importance": "normal",
      "locale": "en-us",
      "body": {
        "contentType": "html",
        "content": "This is the message the messaging extension was invoked from."
    },
      "from": {
        "device": null,
        "conversation": null,
        "user": {
          "userIdentityType": "aadUser",
          "id": "wxyz12ab8-ab12-cd34-ef56-098abc123876",
          "displayName": "Jamie Smythe"
        },
        "application": null
      },
      "reactions": [
        {
          "reactionType": "like",
          "createdDateTime": "2019-02-25T22:40:40.806Z",
          "user": {
            "device": null,
            "conversation": null,
            "user": {
              "userIdentityType": "aadUser",
              "id": "qrst12346-ab12-cd34-ef56-098abc123876",
              "displayName": "Jim Brown"
            },
            "application": null
          }
        }
      ],
      "mentions": [
        {
          "id": 0,
          "mentionText": "Sarah",
          "mentioned": {
            "device": null,
            "conversation": null,
            "user": {
              "userIdentityType": "aadUser",
              "id": "ab12345678-ab12-cd34-ef56-098abc123876",
              "displayName": "Sarah"
            },
            "application": null
          }
        }
      ]
    }
  ...

このサンプルでは、Teams SDK に含まれている Microsoft.Teams.Cards パッケージを使用します。

• SDK レファレンス
• サンプル コード参照

using System.Text.Json;
using Microsoft.Teams.Apps.MessageExtensions;
using Microsoft.Teams.Apps.Schema;
using Microsoft.Teams.Apps.TaskModules;
using Microsoft.Teams.Cards;

// ...

teams.OnFetchTask(async (context, cancellationToken) =>
{
    string placeholder = "Not invoked from message";

  MessageExtensionAction? action = context.Activity.Value;

  if (action?.MessagePayload != null)
    {
    var messageText = action.MessagePayload.Body?.Content;
    var fromId = action.MessagePayload.From?.User?.Id;
        placeholder = "Invoked from message";
    }

    var card = new AdaptiveCard
    {
        Version = "1.5",
        Body = new List<CardElement>
        {
            new TextInput { Id = "FormField1", Placeholder = placeholder },
            new TextInput { Id = "FormField2", Placeholder = "FormField2" },
            new TextInput { Id = "FormField3", Placeholder = "FormField3" }
        },
        Actions = new List<Cards.Action>
        {
            new SubmitAction { Title = "Submit" }
        }
    };

    TeamsAttachment attachment = TeamsAttachment.CreateBuilder()
      .WithAdaptiveCard(JsonSerializer.SerializeToElement(card))
      .Build();

    return MessageExtensionActionResponse.CreateBuilder()
      .WithTask(TaskModuleResponse.CreateBuilder()
        .WithType(TaskModuleResponseTypes.Continue)
        .WithTitle("Example dialog")
        .WithHeight(TaskModuleSizes.Small)
        .WithWidth(TaskModuleSizes.Small)
        .WithCard(attachment))
      .Build();
});

using Microsoft.Teams.Api;
using Microsoft.Teams.Api.MessageExtensions;
using Microsoft.Teams.Api.TaskModules;
using Microsoft.Teams.Cards;
using Microsoft.Teams.Common;

// ...

teams.OnFetchTask(async (ctx) =>
{
    string placeholder = "Not invoked from message";

    if (ctx.Activity.Value?.MessagePayload != null)
    {
        var messageText = ctx.Activity.Value.MessagePayload.Body?.Content;
        var fromId = ctx.Activity.Value.MessagePayload.From?.User?.Id;
        placeholder = "Invoked from message";
    }

    var card = new AdaptiveCard
    {
        Body = new List<CardElement>
        {
            new TextInput { Id = "FormField1", Placeholder = placeholder },
            new TextInput { Id = "FormField2", Placeholder = "FormField2" },
            new TextInput { Id = "FormField3", Placeholder = "FormField3" }
        },
        Actions = new List<Cards.Action>
        {
            new SubmitAction { Title = "Submit" }
        }
    };

    return new ActionResponse
    {
        Task = new ContinueTask(
            new TaskInfo
            {
                Title = "Example dialog",
                Height = new Union<int, Size>(Size.Small),
                Width  = new Union<int, Size>(Size.Small),
                Card   = new Attachment(card)
            })
    };
});

• サンプル コード参照

import { cardAttachment } from '@microsoft/teams.api';
import { App } from '@microsoft/teams.apps';
import { AdaptiveCard } from '@microsoft/teams.cards';

// ...

app.on('message.ext.open', async ({ activity }) => {
  const userText: string =
    activity.value?.messagePayload?.body?.content || '';

  const card: AdaptiveCard = AdaptiveCard.from({
    type: 'AdaptiveCard',
    version: '1.0',
    body: [
      {
        type: 'TextBlock',
        text: 'Task Module',
        weight: 'bolder',
      },
      {
        type: 'TextBlock',
        text: 'Enter text for Question:',
      },
      {
        type: 'Input.Text',
        id: 'Question',
        placeholder: 'Question text here',
        value: userText,
      },
      {
        type: 'TextBlock',
        text: 'Options for Question:',
      },
      {
        type: 'Input.Text',
        id: 'Option1',
        placeholder: 'Option 1 here',
      },
      {
        type: 'Input.Text',
        id: 'Option2',
        placeholder: 'Option 2 here',
      },
    ],
    actions: [
      {
        type: 'Action.Submit',
        title: 'Submit',
        data: {
          submitLocation: 'messagingExtensionFetchTask',
        },
      },
    ],
  });

  return {
    task: {
      type: 'continue' as const,
      value: {
        card: cardAttachment('adaptive', card),
        height: 450,
        width: 500,
        title: 'Task Module Fetch Example',
      },
    },
  };
});

• サンプル コード参照

from microsoft_teams.api import (
    AdaptiveCardAttachment,
    MessageExtensionFetchTaskInvokeActivity,
    card_attachment,
)
from microsoft_teams.api.models import (
    CardTaskModuleTaskInfo,
    MessagingExtensionActionInvokeResponse,
    TaskModuleContinueResponse,
)
from microsoft_teams.apps import ActivityContext, App
from microsoft_teams.cards import AdaptiveCard


# ...


@app.on_message_ext_open
async def handle_fetch_task(
    ctx: ActivityContext[MessageExtensionFetchTaskInvokeActivity],
):
    placeholder = "Not invoked from message"

    if ctx.activity.value.message_payload:
        message_text = ctx.activity.value.message_payload.body.content
        placeholder = "Invoked from message"

    card = AdaptiveCard.model_validate(
        {
            "type": "AdaptiveCard",
            "version": "1.0",
            "body": [
                {
                    "type": "Input.Text",
                    "id": "FormField1",
                    "placeholder": placeholder,
                },
                {
                    "type": "Input.Text",
                    "id": "FormField2",
                    "placeholder": "FormField2",
                },
                {
                    "type": "Input.Text",
                    "id": "FormField3",
                    "placeholder": "FormField3",
                },
            ],
            "actions": [
                {"type": "Action.Submit", "title": "Submit"},
            ],
        }
    )

    card_info = CardTaskModuleTaskInfo(
        title="Example dialog",
        height="small",
        width="small",
        card=card_attachment(
            AdaptiveCardAttachment(content=card)
        ),
    )

    task = TaskModuleContinueResponse(value=card_info)
    return MessagingExtensionActionInvokeResponse(task=task)

 {​
  "task": {​
    "type": "continue",
    "value": {​
      "title": "Dialog title",
      "height": 500,
      "width": "medium",
      "card": {​
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "type": "AdaptiveCard",
        "version": "1.0",
        "body": [
          {​
            "type": "Input.Text",
            "placeholder": "FormField1",
            "id": "FormField1"
          }​,
          {​
            "type": "Input.Text",
            "placeholder": "FormField2",
            "id": "FormField2"
          }​,
          {​
            "type": "Input.Text",
            "placeholder": "FormField3",
            "id": "FormField3"
          }​,
          {​
            "type": "ActionSet",
            "actions": [
              {​
                "type": "Action.Submit",
                "title": "Action.Submit",
                "id": "submitAction"
              }​
            ]
          }​
        ]
      }​
    }​
  }​
}​

using Microsoft.Teams.Apps.MessageExtensions;
using Microsoft.Teams.Apps.TaskModules;

// ...

teams.OnFetchTask(async (context, cancellationToken) =>
{
    await Task.CompletedTask;

    return MessageExtensionActionResponse.CreateBuilder()
        .WithTask(TaskModuleResponse.CreateBuilder()
            .WithType(TaskModuleResponseTypes.Continue)
            .WithTitle("Example dialog")
            .WithHeight(TaskModuleSizes.Small)
            .WithWidth(TaskModuleSizes.Small)
            .WithUrl("https://contoso.com/msteams/taskmodules/newcustomer"))
        .Build();
});

using Microsoft.Teams.Api.MessageExtensions;
using Microsoft.Teams.Api.TaskModules;
using Microsoft.Teams.Common;

// ...

teams.OnFetchTask(async (ctx) =>
{
    return new ActionResponse
    {
        Task = new ContinueTask(
            new TaskInfo
            {
                Title = "Example dialog",
                Height = new Union<int, Size>(Size.Small),
                Width = new Union<int, Size>(Size.Small),
                Url = "https://contoso.com/msteams/taskmodules/newcustomer"
            })
    };
});

app.on('message.ext.open', async ({ activity }) => {
  return {
    task: {
      type: 'continue' as const,
      value: {
        width: 500,
        height: 450,
        title: 'Task Module Fetch Example',
        url: 'https://contoso.com/msteams/taskmodules/newcustomer',
        fallbackUrl: 'https://contoso.com/msteams/taskmodules/newcustomer',
      },
    },
  };
});

@app.on_message_ext_open
async def handle_fetch_task(
    ctx: ActivityContext[MessageExtensionFetchTaskInvokeActivity]
):
    card_info = CardTaskModuleTaskInfo(
        title="Example dialog",
        height="small",
        width="small",
        url="https://contoso.com/msteams/taskmodules/newcustomer",
    )

    task = TaskModuleContinueResponse(value=card_info)
    return MessagingExtensionActionInvokeResponse(task=task)

{
  "task": {
    "type": "continue",
    "value": {
      "title": "Dialog title",
      "height": 500,
      "width": "medium",
      "url": "https://contoso.com/msteams/taskmodules/newcustomer",
      "fallbackUrl": "https://contoso.com/msteams/taskmodules/newcustomer"
    }
  }
}