ボットの概念を理解する

ボットは、 @microsoft/teams.apps パッケージを使用して構築されます。 Appをインスタンス化し、ハンドラーを app.on(eventName, handler) に登録します。 SDK は、イベント名の文字列に基づいてアクティビティを正しいハンドラーにルーティングします。

channelCreated

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

const app = new App();

app.on('channelCreated', async ({ activity }) => {
  const channel = activity.channelData.channel; // { id, name }
  const team    = activity.channelData.team;    // { id, name }
  // Code logic here
});

channelDeleted

app.on('channelDeleted', async ({ activity }) => {
  // Code logic here
});

channelRenamed

app.on('channelRenamed', async ({ activity }) => {
  // Code logic here
});

teamRenamed

app.on('teamRenamed', async ({ activity }) => {
  // Code logic here
});

membersAdded / membersRemoved

app.on('membersAdded', async ({ activity, send }) => {
  for (const member of activity.membersAdded) {
    await send(`Welcome, ${member.name}!`);
  }
});

app.on('membersRemoved', async ({ activity }) => {
  // Code logic here
});

messageUpdate / messageDelete

メッセージの編集は、 messageUpdateとして表示されます。 論理的な削除は messageDelete として表示されます。 activity.channelData.eventType は 'softDeleteMessage'されます。

app.on('messageUpdate', async ({ activity }) => {
  // Code logic here
});

app.on('messageDelete', async ({ activity }) => {
  // activity.channelData.eventType === 'softDeleteMessage' for soft deletes
  // Code logic here
});

ボットは、 Microsoft.Teams.Apps パッケージを使用して構築されます。 OnMessage()、OnChannelCreated()などの拡張メソッドを使用して、Appとチェーン ハンドラーの登録をインスタンス化します。すべてのハンドラーは、IContext<TActivity> オブジェクトを受け取ります。

OnChannelCreated

using Microsoft.Teams.Apps;

var app = new App();

app.OnChannelCreated(async context => {
    var channel = context.Activity.ChannelData.Channel;
    var team    = context.Activity.ChannelData.Team;
    // Code logic here
});

OnChannelDeleted

app.OnChannelDeleted(async context => {
    // Code logic here
});

OnChannelRenamed

app.OnChannelRenamed(async context => {
    // Code logic here
});

OnTeamRenamed

app.OnTeamRenamed(async context => {
    // Code logic here
});

OnMembersAdded

app.OnMembersAdded(async context => {
    foreach (var member in context.Activity.MembersAdded) {
        // Code logic here
    }
});

OnMembersRemoved

app.OnMembersRemoved(async context => {
    foreach (var member in context.Activity.MembersRemoved) {
        // Code logic here
    }
});

OnMessageUpdate / OnMessageDelete

メッセージの編集は、 OnMessageUpdateを介して処理されます。 論理的な削除は、 OnMessageDelete経由で処理されます。

app.OnMessageUpdate(async context => {
    // Code logic here
});

app.OnMessageDelete(async context => {
    // Code logic here
});

ボットは、 microsoft-teams-apps パッケージを使用して構築されます。 ハンドラーは、 App インスタンスのデコレーターを使用して登録されます。 各ハンドラーは、ActivityContext[TActivity] オブジェクトを受け取るasync関数です。

on_channel_created

from microsoft_teams.apps import App, ActivityContext
from microsoft_teams.api.activities import ConversationUpdateActivity

app = App()

@app.on_channel_created
async def handle_channel_created(ctx: ActivityContext[ConversationUpdateActivity]):
    channel = ctx.activity.channel_data.channel
    team    = ctx.activity.channel_data.team
    # Code logic here

on_channel_deleted

@app.on_channel_deleted
async def handle_channel_deleted(ctx: ActivityContext[ConversationUpdateActivity]):
    # Code logic here

on_channel_renamed

@app.on_channel_renamed
async def handle_channel_renamed(ctx: ActivityContext[ConversationUpdateActivity]):
    # Code logic here

on_team_renamed

@app.on_team_renamed
async def handle_team_renamed(ctx: ActivityContext[ConversationUpdateActivity]):
    # Code logic here

on_conversation_update (メンバーの追加/削除)

追加および削除されたイベントのメンバーは、 on_conversation_updateを介して処理されます。 ctx.activity.members_addedとctx.activity.members_removedを検査します。

@app.on_conversation_update
async def handle_conversation_update(ctx: ActivityContext[ConversationUpdateActivity]):
    if ctx.activity.members_added:
        for member in ctx.activity.members_added:
            await ctx.send(f"Welcome, {member.name}!")
    if ctx.activity.members_removed:
        # Code logic here

on_edit_message / on_soft_delete_message / on_undelete_message

@app.on_edit_message
async def handle_edit_message(ctx: ActivityContext):
    # Code logic here

@app.on_soft_delete_message
async def handle_soft_delete_message(ctx: ActivityContext):
    # Code logic here

@app.on_undelete_message
async def handle_undelete_message(ctx: ActivityContext):
    # Code logic here

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

const app = new App();

app.on('message', async ({ activity, reply }) => {
  const senderName = activity.from.name;
  await send(`Hello <at>${senderName}</at>.`);
});

app.start().catch(console.error);

using Microsoft.Teams.Apps.Activities;
using Microsoft.Teams.Apps.Extensions;
using Microsoft.Teams.Plugins.AspNetCore.DevTools.Extensions;
using Microsoft.Teams.Plugins.AspNetCore.Extensions;

var builder = WebApplication.CreateBuilder(args);
builder.AddTeams().AddTeamsDevTools();
var app = builder.Build();
var teams = app.UseTeams();

teams.OnMessage(async (context, cancellationToken) =>
{
    var senderName = context.Activity.From.Name;
    await context.Send($"Hello <at>{senderName}</at>.", cancellationToken);
});

app.Run();

import asyncio
from microsoft_teams.apps import App, ActivityContext
from microsoft_teams.api import MessageActivity

app = App()

@app.on_message
async def handle_message(ctx: ActivityContext[MessageActivity]):
    sender_name = ctx.activity.from_property.name
    await ctx.send(f"Hello <at>{sender_name}</at>.")

if __name__ == "__main__":
    asyncio.run(app.start())

コア アクティビティ ハンドラー

app.on()でサポートされているイベント名の一覧には、次のものが含まれます。

Teams 固有のイベント ハンドラー

app.on() では、次の Teams 固有のイベント名文字列がサポートされています。

Teams の呼び出しアクティビティ

次の表に、 app.on()で使用できる呼び出しアクティビティ ハンドラーの一覧を示します。

コア アクティビティ ハンドラー

App クラスは、ハンドラーを登録するための拡張メソッドを公開します。 メソッドは、fluent チェーンの App を返します。

Teams 固有のアクティビティ ハンドラー

Teams の呼び出しアクティビティ

コア アクティビティ ハンドラー

App クラスは、デコレーター スタイルのハンドラー登録を公開します。

Teams 固有のアクティビティ ハンドラー

Teams の呼び出しアクティビティ