ActivityHandler Kelas

Menangani aktivitas dan harus disubkelas.

Konstruktor

ActivityHandler()

Keterangan

Berasal dari kelas ini untuk menangani jenis aktivitas tertentu. Yon dapat menambahkan pra dan pasca pemrosesan aktivitas dengan memanggil kelas dasar di kelas turunan.

Metode

on_adaptive_card_invoke

Dipanggil saat bot dikirimi Eksekusi Tindakan Kartu Adaptif.

Ketika metode on_invoke_activity menerima Invoke dengan Activity.name adaptiveCard/action, metode ini memanggil metode ini.

on_conversation_update_activity

Dipanggil saat aktivitas pembaruan percakapan diterima dari saluran saat perilaku dasar on_turn digunakan.

on_end_of_conversation_activity

Dipanggil saat aktivitas akhir percakapan diterima dari saluran.

on_event

Dipanggil saat peristiwa selain token/respons diterima ketika perilaku dasar on_event_activity digunakan.

on_event_activity

Dipanggil saat aktivitas peristiwa diterima dari konektor saat perilaku dasar on_turn digunakan.

on_installation_update

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate.

on_installation_update_add

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate dengan 'tindakan' diatur ke 'add'.

on_installation_update_remove

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate dengan 'tindakan' diatur ke 'remove'.

on_invoke_activity

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

on_members_added_activity

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika anggota selain bot bergabung dengan percakapan. Anda dapat menambahkan logika selamat datang bot Anda.

aktivitas pembaruan percakapan :ketik members_added: List :p turn_context: Objek konteks untuk giliran ini :ketik turn_context: TurnContext

on_members_removed_activity

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika anggota selain bot meninggalkan percakapan. Anda dapat menambahkan logika selamat tinggal bot Anda.

aktivitas pembaruan percakapan :ketik members_added: List :p turn_context: Objek konteks untuk giliran ini :ketik turn_context: TurnContext

on_message_activity

Ambil alih metode ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas, seperti logika percakapan.

on_message_reaction_activity

Dipanggil saat aktivitas peristiwa diterima dari konektor saat perilaku dasar on_turn digunakan.

on_reactions_added

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika reaksi terhadap aktivitas sebelumnya ditambahkan ke percakapan.

on_reactions_removed

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika reaksi terhadap aktivitas sebelumnya dihapus dari percakapan.

on_sign_in_invoke

Dipanggil saat peristiwa signin/verifyState atau signin/tokenExchange diterima ketika perilaku dasar on_invoke_activity(TurnContext{InvokeActivity}) digunakan. Jika menggunakan OAuthPrompt, ambil alih metode ini untuk meneruskan Aktivitas ini"/ ke dialog saat ini. Secara default, metode ini tidak melakukan apa pun.

on_token_response_event

Dipanggil saat peristiwa token/respons diterima saat perilaku dasar on_event_activity digunakan. Jika menggunakan oauth_prompt, ambil alih metode ini untuk meneruskan aktivitas ini ke dialog saat ini.

on_turn

Dipanggil oleh adaptor (misalnya, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) pada runtime untuk memproses Activitymasuk .

on_typing_activity

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.typing, seperti logika percakapan.

on_unrecognized_activity_type

Dipanggil saat aktivitas selain pesan, pembaruan percakapan, atau peristiwa diterima saat perilaku dasar on_turn digunakan. Jika ditimpa, metode ini berpotensi merespons salah satu jenis aktivitas lainnya.

on_adaptive_card_invoke

Dipanggil saat bot dikirimi Eksekusi Tindakan Kartu Adaptif.

Ketika metode on_invoke_activity menerima Invoke dengan Activity.name adaptiveCard/action, metode ini memanggil metode ini.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini.

invoke_value
Diperlukan
<xref:botframework.schema.models.AdaptiveCardInvokeValue>

Objek berjenis string dari nilai aktivitas masuk.

Mengembalikan

Jenis Deskripsi

Objek HealthCheckResponse

on_conversation_update_activity

Dipanggil saat aktivitas pembaruan percakapan diterima dari saluran saat perilaku dasar on_turn digunakan.

async on_conversation_update_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_turn menerima aktivitas pembaruan percakapan, metode ini memanggil metode ini. Juga

  • Jika aktivitas pembaruan percakapan menunjukkan bahwa anggota selain bot bergabung dengan percakapan, aktivitas tersebut memanggil metode on_members_added_activity.
  • Jika aktivitas pembaruan percakapan menunjukkan bahwa anggota selain bot meninggalkan percakapan, aktivitas tersebut memanggil metode on_members_removed_activity.
  • Di kelas turunan, ambil alih metode ini untuk menambahkan logika yang berlaku untuk semua aktivitas pembaruan percakapan. Tambahkan logika untuk diterapkan sebelum anggota menambahkan atau menghapus logika sebelum panggilan ke metode kelas dasar ini.

on_end_of_conversation_activity

Dipanggil saat aktivitas akhir percakapan diterima dari saluran.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_event

Dipanggil saat peristiwa selain token/respons diterima ketika perilaku dasar on_event_activity digunakan.

async on_event(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_event_activity digunakan menerima peristiwa dengan nama aktivitas selain token/respons, metode ini memanggil metode ini. Metode ini dapat secara opsional ditimpa jika bot dimaksudkan untuk menangani peristiwa lain-lain.

on_event_activity

Dipanggil saat aktivitas peristiwa diterima dari konektor saat perilaku dasar on_turn digunakan.

async on_event_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_turn menerima aktivitas peristiwa, metode ini memanggil metode ini. Jika nama aktivitas token/respons, nama aktivitas memanggil on_token_response_event; jika tidak, ia memanggil on_event.

Di kelas turunan, ambil alih metode ini untuk menambahkan logika yang berlaku untuk semua aktivitas peristiwa. Tambahkan logika untuk diterapkan sebelum logika penanganan peristiwa tertentu sebelum panggilan ke metode kelas dasar ini. Tambahkan logika untuk diterapkan setelah logika penanganan peristiwa tertentu setelah panggilan ke metode kelas dasar ini.

Aktivitas acara mengkomunikasikan informasi terprogram dari klien atau saluran ke bot. Arti aktivitas peristiwa didefinisikan oleh properti nama aktivitas peristiwa, yang bermakna dalam cakupan saluran.

on_installation_update

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_installation_update_add

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate dengan 'tindakan' diatur ke 'add'.

async on_installation_update_add(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_installation_update_remove

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.InstallationUpdate dengan 'tindakan' diatur ke 'remove'.

async on_installation_update_remove(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_invoke_activity

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

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_members_added_activity

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika anggota selain bot bergabung dengan percakapan. Anda dapat menambahkan logika selamat datang bot Anda.

aktivitas pembaruan percakapan :ketik members_added: List :p turn_context: Objek konteks untuk giliran ini :ketik turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

Parameter

Nama Deskripsi
members_added
Diperlukan
turn_context
Diperlukan

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_conversation_update_activity menerima aktivitas pembaruan percakapan yang menunjukkan satu atau beberapa pengguna selain bot bergabung dengan percakapan, metode ini memanggil metode ini.

on_members_removed_activity

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika anggota selain bot meninggalkan percakapan. Anda dapat menambahkan logika selamat tinggal bot Anda.

aktivitas pembaruan percakapan :ketik members_added: List :p turn_context: Objek konteks untuk giliran ini :ketik turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

Parameter

Nama Deskripsi
members_removed
Diperlukan
turn_context
Diperlukan

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_conversation_update_activity menerima aktivitas pembaruan percakapan yang menunjukkan satu atau beberapa pengguna selain bot meninggalkan percakapan, metode ini memanggil metode ini.

on_message_activity

Ambil alih metode ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas, seperti logika percakapan.

async on_message_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_message_reaction_activity

Dipanggil saat aktivitas peristiwa diterima dari konektor saat perilaku dasar on_turn digunakan.

async on_message_reaction_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Reaksi pesan sesuai dengan pengguna yang menambahkan 'like' atau 'sad' dll. (sering emoji) ke aktivitas yang dikirim sebelumnya.

Reaksi pesan hanya didukung oleh beberapa saluran. Aktivitas yang sesuai dengan reaksi pesan ditunjukkan dalam properti balas ke Id. Nilai properti ini adalah id aktivitas dari aktivitas yang dikirim sebelumnya yang diberikan kembali ke bot sebagai respons dari panggilan kirim. Ketika metode on_turn menerima aktivitas reaksi pesan, metode ini memanggil metode ini.

  • Jika reaksi pesan menunjukkan bahwa reaksi ditambahkan ke pesan, itu memanggil

<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_added>.

  • Jika reaksi pesan menunjukkan bahwa reaksi dihapus dari pesan, ia memanggil <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

Dalam kelas turunan, ambil alih metode ini untuk menambahkan logika yang berlaku untuk semua aktivitas reaksi pesan. Tambahkan logika untuk diterapkan sebelum reaksi ditambahkan atau dihapus logika sebelum panggilan ke metode kelas dasar ini. Tambahkan logika untuk diterapkan setelah reaksi ditambahkan atau dihapus logika setelah panggilan ke metode kelas dasar ini.

on_reactions_added

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika reaksi terhadap aktivitas sebelumnya ditambahkan ke percakapan.

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parameter

Nama Deskripsi
message_reactions
Diperlukan

Daftar reaksi ditambahkan

turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Reaksi pesan sesuai dengan pengguna yang menambahkan 'suka' atau 'sedih' dll. (sering emoji) ke pesan yang dikirim sebelumnya pada percakapan. Reaksi pesan hanya didukung oleh beberapa saluran. Aktivitas yang menjadi reaksi pesan diidentifikasi oleh properti balas aktivitas ke ID. Nilai properti ini adalah ID aktivitas dari aktivitas yang dikirim sebelumnya. Saat bot mengirim aktivitas, saluran menetapkan ID ke dalamnya, yang tersedia di Id respons sumber daya hasil.

on_reactions_removed

Ambil alih metode ini di kelas turunan untuk memberikan logika ketika reaksi terhadap aktivitas sebelumnya dihapus dari percakapan.

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parameter

Nama Deskripsi
message_reactions
Diperlukan

Daftar reaksi dihapus

turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Reaksi pesan sesuai dengan pengguna yang menambahkan 'suka' atau 'sedih' dll. (sering emoji) ke pesan yang dikirim sebelumnya pada percakapan. Reaksi pesan hanya didukung oleh beberapa saluran. Aktivitas yang menjadi reaksi pesan diidentifikasi oleh properti balas aktivitas ke Id. Nilai properti ini adalah ID aktivitas dari aktivitas yang dikirim sebelumnya. Saat bot mengirim aktivitas, saluran menetapkan ID ke dalamnya, yang tersedia di Id respons sumber daya hasil.

on_sign_in_invoke

Dipanggil saat peristiwa signin/verifyState atau signin/tokenExchange diterima ketika perilaku dasar on_invoke_activity(TurnContext{InvokeActivity}) digunakan. Jika menggunakan OAuthPrompt, ambil alih metode ini untuk meneruskan Aktivitas ini"/ ke dialog saat ini. Secara default, metode ini tidak melakukan apa pun.

async on_sign_in_invoke(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_token_response_event

Dipanggil saat peristiwa token/respons diterima saat perilaku dasar on_event_activity digunakan. Jika menggunakan oauth_prompt, ambil alih metode ini untuk meneruskan aktivitas ini ke dialog saat ini.

async on_token_response_event(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_event menerima peristiwa dengan nama aktivitas token/respons , metode ini memanggil metode ini. Jika bot Anda menggunakan oauth_prompt, teruskan aktivitas masuk ke dialog saat ini.

on_turn

Dipanggil oleh adaptor (misalnya, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) pada runtime untuk memproses Activitymasuk .

async on_turn(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ini memanggil metode lain di kelas ini berdasarkan jenis aktivitas yang akan diproses, yang memungkinkan kelas turunan untuk menyediakan logika khusus jenis dengan cara yang terkontrol. Di kelas turunan, ambil alih metode ini untuk menambahkan logika yang berlaku untuk semua jenis aktivitas. Juga

  • Tambahkan logika untuk diterapkan sebelum logika khusus jenis dan sebelum memanggil on_turn.
  • Tambahkan logika untuk diterapkan setelah logika khusus jenis setelah memanggil on_turn.

on_typing_activity

Ambil alih ini dalam kelas turunan untuk menyediakan logika khusus untuk aktivitas ActivityTypes.typing, seperti logika percakapan.

async on_typing_activity(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

on_unrecognized_activity_type

Dipanggil saat aktivitas selain pesan, pembaruan percakapan, atau peristiwa diterima saat perilaku dasar on_turn digunakan. Jika ditimpa, metode ini berpotensi merespons salah satu jenis aktivitas lainnya.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parameter

Nama Deskripsi
turn_context
Diperlukan

Objek konteks untuk giliran ini

Mengembalikan

Jenis Deskripsi

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan

Keterangan

Ketika metode on_turn menerima aktivitas yang bukan merupakan pesan, pembaruan percakapan, reaksi pesan, atau aktivitas peristiwa, metode ini memanggil metode ini.