ActivityHandler class

Referensi

Paket:: botbuilder-core

Penanganan aktivitas pemancar peristiwa untuk bot. Memperluas ActivityHandlerBase .

Memperluas: ActivityHandlerBase

Keterangan

Ini menyediakan kelas yang dapat diperluas untuk menangani aktivitas masuk dengan cara berbasis peristiwa. Anda dapat mendaftarkan sekumpulan handler arbitrer untuk setiap jenis peristiwa.

Untuk mendaftarkan handler untuk suatu peristiwa, gunakan yang sesuai pada metode peristiwa. Jika beberapa handler didaftarkan untuk suatu peristiwa, mereka dijalankan dalam urutan terdaftar.

Objek ini memancarkan serangkaian peristiwa saat memproses aktivitas masuk. Handler dapat menghentikan penyebaran peristiwa dengan tidak memanggil fungsi kelanjutan.

Jenis peristiwa	Deskripsi
Belok	Dipancarkan terlebih dahulu untuk setiap aktivitas.
Jenis khusus	Dipancarkan untuk jenis aktivitas tertentu, sebelum memancarkan peristiwa untuk subjenis apa pun.
Subtitik	Dipancarkan untuk peristiwa khusus tertentu, berdasarkan konten aktivitas.
Dialog	Dipancarkan sebagai peristiwa pemrosesan aktivitas akhir.

Misalnya:

const bot = new ActivityHandler();

server.post('/api/messages', (req, res) => {
    adapter.processActivity(req, res, async (context) => {
        // Route to bot's activity logic.
        await bot.run(context);
    });
});

bot.onTurn(async (context, next) => {
        // Handle a "turn" event.
        await context.sendActivity(`${ context.activity.type } activity received.`);
        // Continue with further processing.
        await next();
    })
    .onMessage(async (context, next) => {
        // Handle a message activity.
        await context.sendActivity(`Echo: ${ context.activity.text }`);
        // Continue with further processing.
        await next();
    });

Lihat juga

Skema Bot Framework Activity

Metode

onCommand(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk perintah aktivitas.
onCommandResult(BotHandler)	Mendaftarkan penanganan aktivitas untuk aktivitas CommandResult.
onConversationUpdate(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa pembaruan percakapan, yang dipancarkan untuk setiap aktivitas pembaruan percakapan yang masuk.
onDialog(BotHandler)	Mendaftarkan penanganan aktivitas untuk dialog peristiwa, yang dipancarkan sebagai peristiwa terakhir untuk aktivitas masuk.
onEndOfConversation(BotHandler)	Mendaftarkan penanganan aktivitas untuk akhir aktivitas percakapan.
onEvent(BotHandler)	Mendaftarkan penanganan aktivitas untuk peristiwa peristiwa, yang dipancarkan untuk setiap aktivitas peristiwa yang masuk.
onInstallationUpdate(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk aktivitas penginstalan.
onInstallationUpdateAdd(BotHandler)	Mendaftarkan penanganan aktivitas untuk aktivitas add penginstalan.
onInstallationUpdateRemove(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk penginstalan menghapus aktivitas.
onMembersAdded(BotHandler)	Mendaftarkan penanganan aktivitas untuk anggota yang ditambahkan peristiwa, yang dipancarkan untuk aktivitas pembaruan percakapan masuk yang menyertakan anggota yang ditambahkan ke percakapan.
onMembersRemoved(BotHandler)	Mendaftarkan penanganan aktivitas untuk anggota yang dihapus peristiwa, yang dipancarkan untuk aktivitas pembaruan percakapan masuk yang mencakup anggota yang dihapus dari percakapan.
onMessage(BotHandler)	Mendaftarkan penanganan aktivitas untuk peristiwa pesan, yang dipancarkan untuk setiap aktivitas pesan masuk.
onMessageReaction(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk reaksi pesan peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan yang masuk.
onReactionsAdded(BotHandler)	Mendaftarkan penanganan aktivitas untuk reaksi yang ditambahkan peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan masuk yang menjelaskan reaksi yang ditambahkan ke pesan.
onReactionsRemoved(BotHandler)	Mendaftarkan penanganan aktivitas untuk reaksi yang dihapus peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan masuk yang menjelaskan reaksi yang dihapus dari pesan.
onTokenResponseEvent(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa respons token, yang dipancarkan untuk aktivitas peristiwa `tokens/response` yang masuk. Ini dihasilkan sebagai bagian dari alur autentikasi OAuth.
onTurn(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa giliran, yang dipancarkan untuk setiap aktivitas masuk, terlepas dari jenisnya.
onTyping(BotHandler)	Mendaftarkan penanganan aktivitas untuk aktivitas pengetikan.
onUnrecognizedActivityType(BotHandler)	Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa jenis aktivitas tidak dikenal, yang dipancarkan untuk aktivitas masuk dengan jenis yang ActivityHandler tidak menyediakan penanganan aktivitas.
run(TurnContext)	Dipanggil untuk memulai proses emisi peristiwa.

Detail Metode

onCommand(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk perintah aktivitas.

function onCommand(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Untuk menangani peristiwa Perintah, gunakan penanganan aktivitas khusus jenis onCommand.

onCommandResult(BotHandler)

Mendaftarkan penanganan aktivitas untuk aktivitas CommandResult.

function onCommandResult(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Untuk menangani peristiwa CommandResult, gunakan onCommandResult penanganan aktivitas khusus jenis.

onConversationUpdate(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa pembaruan percakapan, yang dipancarkan untuk setiap aktivitas pembaruan percakapan yang masuk.

function onConversationUpdate(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Aktivitas pembaruan percakapan menjelaskan perubahan pada metadata percakapan, seperti judul, peserta, atau informasi khusus saluran lainnya.

Untuk menangani kapan anggota ditambahkan atau dihapus dari percakapan, gunakan onMembersAdded dan onMembersRemoved sub-type penanganan aktivitas.

onDialog(BotHandler)

Mendaftarkan penanganan aktivitas untuk dialog peristiwa, yang dipancarkan sebagai peristiwa terakhir untuk aktivitas masuk.

function onDialog(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

onEndOfConversation(BotHandler)

Mendaftarkan penanganan aktivitas untuk akhir aktivitas percakapan.

function onEndOfConversation(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Aktivitas ini biasanya dikirim dari Keterampilan ke pemanggil Keterampilan yang menunjukkan akhir percakapan anak tertentu.

Untuk menangani Akhir Percakapan, gunakan onEndOfConversation penanganan aktivitas khusus jenis.

onEvent(BotHandler)

Mendaftarkan penanganan aktivitas untuk peristiwa peristiwa, yang dipancarkan untuk setiap aktivitas peristiwa yang masuk.

function onEvent(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Aktivitas acara mengkomunikasikan informasi terprogram dari klien atau saluran ke bot. Arti aktivitas peristiwa didefinisikan oleh properti nama aktivitas, yang bermakna dalam cakupan saluran. Aktivitas peristiwa dirancang untuk membawa informasi interaktif (seperti klik tombol) dan informasi non-interaktif (seperti pemberitahuan klien secara otomatis memperbarui model ucapan yang disematkan).

Untuk menangani peristiwa tokens/response, gunakan penanganan aktivitas onTokenResponseEvent sub-jenis. Untuk menangani peristiwa bernama lainnya, tambahkan logika ke handler ini.

onInstallationUpdate(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk aktivitas penginstalan.

function onInstallationUpdate(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Untuk menangani peristiwa InstallationUpdate, gunakan onInstallationUpdate penanganan aktivitas khusus jenis.

onInstallationUpdateAdd(BotHandler)

Mendaftarkan penanganan aktivitas untuk aktivitas add penginstalan.

function onInstallationUpdateAdd(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler. Untuk menangani peristiwa InstallationUpdateAdd, gunakan onInstallationUpdateAdd penanganan aktivitas khusus jenis.

onInstallationUpdateRemove(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk penginstalan menghapus aktivitas.

function onInstallationUpdateRemove(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Untuk menangani peristiwa InstallationUpdateRemove, gunakan onInstallationUpdateRemove penanganan aktivitas khusus jenis.

onMembersAdded(BotHandler)

Mendaftarkan penanganan aktivitas untuk anggota yang ditambahkan peristiwa, yang dipancarkan untuk aktivitas pembaruan percakapan masuk yang menyertakan anggota yang ditambahkan ke percakapan.

function onMembersAdded(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Properti yang ditambahkan anggota aktivitas berisi anggota yang ditambahkan ke percakapan, yang dapat menyertakan bot.

Untuk menangani peristiwa pembaruan percakapan secara umum, gunakan onConversationUpdate penanganan aktivitas khusus jenis.

onMembersRemoved(BotHandler)

Mendaftarkan penanganan aktivitas untuk anggota yang dihapus peristiwa, yang dipancarkan untuk aktivitas pembaruan percakapan masuk yang mencakup anggota yang dihapus dari percakapan.

function onMembersRemoved(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Properti membersRemoved aktivitas berisi anggota yang dihapus dari percakapan, yang dapat menyertakan bot.

Untuk menangani peristiwa pembaruan percakapan secara umum, gunakan onConversationUpdate penanganan aktivitas khusus jenis.

onMessage(BotHandler)

Mendaftarkan penanganan aktivitas untuk peristiwa pesan, yang dipancarkan untuk setiap aktivitas pesan masuk.

function onMessage(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Aktivitas pesan mewakili konten yang dimaksudkan untuk ditampilkan dalam antarmuka percakapan dan dapat berisi teks, ucapan, kartu interaktif, dan lampiran biner atau tidak dikenal. Tidak semua aktivitas pesan berisi teks, properti teks aktivitas dapat null atau undefined.

onMessageReaction(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk reaksi pesan peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan yang masuk.

function onMessageReaction(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Aktivitas reaksi pesan mewakili interaksi sosial pada aktivitas pesan yang ada dalam percakapan. Aktivitas asli disebut oleh properti aktivitas reaksi pesan. Properti dari mewakili sumber reaksi, seperti pengguna yang bereaksi terhadap pesan.

Untuk menangani kapan reaksi ditambahkan atau dihapus dari pesan dalam percakapan, gunakan onReactionsAdded dan onReactionsRemoved sub-jenis penanganan aktivitas.

onReactionsAdded(BotHandler)

Mendaftarkan penanganan aktivitas untuk reaksi yang ditambahkan peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan masuk yang menjelaskan reaksi yang ditambahkan ke pesan.

function onReactionsAdded(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Reaksi aktivitasTambahkan properti mencakup satu atau beberapa reaksi yang ditambahkan.

Untuk menangani peristiwa reaksi pesan secara umum, gunakan onMessageReaction penanganan aktivitas khusus jenis.

onReactionsRemoved(BotHandler)

Mendaftarkan penanganan aktivitas untuk reaksi yang dihapus peristiwa, yang dipancarkan untuk setiap aktivitas reaksi pesan masuk yang menjelaskan reaksi yang dihapus dari pesan.

function onReactionsRemoved(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Reaksi aktivitasRemoved properti mencakup satu atau beberapa reaksi yang dihapus.

Untuk menangani peristiwa reaksi pesan secara umum, gunakan onMessageReaction penanganan aktivitas khusus jenis.

onTokenResponseEvent(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa respons token, yang dipancarkan untuk aktivitas peristiwa tokens/response yang masuk. Ini dihasilkan sebagai bagian dari alur autentikasi OAuth.

function onTokenResponseEvent(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Properti nilai aktivitas berisi token pengguna.

Jika bot Anda menangani autentikasi menggunakan OAuthPrompt dalam dialog, maka dialog harus menerima aktivitas ini untuk menyelesaikan alur autentikasi.

Untuk menangani peristiwa bernama dan peristiwa lainnya secara umum, gunakan onEvent penanganan aktivitas khusus jenis.

onTurn(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa giliran, yang dipancarkan untuk setiap aktivitas masuk, terlepas dari jenisnya.

function onTurn(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

onTyping(BotHandler)

Mendaftarkan penanganan aktivitas untuk aktivitas pengetikan.

function onTyping(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

Untuk menangani peristiwa Pengetikan, gunakan onTyping penanganan aktivitas khusus jenis.

onUnrecognizedActivityType(BotHandler)

Mendaftarkan penanganan aktivitas aktivitas untuk peristiwa jenis aktivitas tidak dikenal, yang dipancarkan untuk aktivitas masuk dengan jenis yang ActivityHandler tidak menyediakan penanganan aktivitas.

function onUnrecognizedActivityType(handler: BotHandler): this

Parameter

handler: BotHandler

Penanganan aktivitas.

Mengembalikan

this

Referensi ke objek ActivityHandler.

Keterangan

ActivityHandler tidak menentukan peristiwa untuk semua jenis aktivitas yang ditentukan dalam skema Aktivitas Kerangka Kerja Bot . Selain itu, saluran dan adaptor kustom dapat membuat Aktivitas dengan jenis yang tidak ada dalam skema. Ketika penanganan aktivitas menerima peristiwa seperti itu, aktivitas tersebut memancarkan peristiwa jenis aktivitas yang tidak dikenali.

Properti jenis aktivitas berisi jenis aktivitas.

run(TurnContext)

Dipanggil untuk memulai proses emisi peristiwa.

function run(context: TurnContext): Promise<void>

Parameter

context: TurnContext

Objek konteks untuk giliran saat ini.

Mengembalikan

Promise<void>

Keterangan

Biasanya, Anda akan menyediakan metode ini sebagai handler fungsi yang dipanggil adaptor untuk melakukan logika bot setelah aktivitas yang diterima telah diproses sebelumnya oleh adaptor dan dirutekan melalui middleware apa pun.

Misalnya:

 server.post('/api/messages', (req, res) => {
     adapter.processActivity(req, res, async (context) => {
         // Route to bot's activity logic.
         await bot.run(context);
     });
});

Lihat juga

BotFrameworkAdapter.processActivity

Bagikan melalui

ActivityHandler class

Keterangan

Metode

Detail Metode

onCommand(BotHandler)

Parameter

Mengembalikan

Keterangan

onCommandResult(BotHandler)

Parameter

Mengembalikan

Keterangan

onConversationUpdate(BotHandler)

Parameter

Mengembalikan

Keterangan

onDialog(BotHandler)

Parameter

Mengembalikan

onEndOfConversation(BotHandler)

Parameter

Mengembalikan

Keterangan

onEvent(BotHandler)

Parameter

Mengembalikan

Keterangan

onInstallationUpdate(BotHandler)

Parameter

Mengembalikan

Keterangan

onInstallationUpdateAdd(BotHandler)

Parameter

Mengembalikan

onInstallationUpdateRemove(BotHandler)

Parameter

Mengembalikan

Keterangan

onMembersAdded(BotHandler)

Parameter

Mengembalikan

Keterangan

onMembersRemoved(BotHandler)

Parameter

Mengembalikan

Keterangan

onMessage(BotHandler)

Parameter

Mengembalikan

Keterangan

onMessageReaction(BotHandler)

Parameter

Mengembalikan

Keterangan

onReactionsAdded(BotHandler)

Parameter

Mengembalikan

Keterangan

onReactionsRemoved(BotHandler)

Parameter

Mengembalikan

Keterangan

onTokenResponseEvent(BotHandler)

Parameter

Mengembalikan

Keterangan

onTurn(BotHandler)

Parameter

Mengembalikan

onTyping(BotHandler)

Parameter

Mengembalikan

Keterangan

onUnrecognizedActivityType(BotHandler)

Parameter

Mengembalikan

Keterangan

run(TurnContext)

Parameter