ActivityHandler Sınıf
Etkinlikleri işler ve alt sınıflandırılmalıdır.
Oluşturucu
ActivityHandler()
Açıklamalar
Belirli etkinlik türlerini işlemek için bu sınıftan türetilir. Yon, türetilmiş sınıftaki temel sınıfı çağırarak etkinliklerin ön ve son işlemesini ekleyebilir.
Yöntemler
| on_adaptive_card_invoke |
Bot bir Uyarlamalı Kart Eylemi Gönderildiğinde Çağrılır. on_invoke_activity yöntemi adaptiveCard/actionActivity.name ile bir Invoke aldığında bu yöntemi çağırır. |
| on_conversation_update_activity |
on_turn temel davranışı kullanıldığında kanaldan bir konuşma güncelleştirme etkinliği alındığında çağrılır. |
| on_end_of_conversation_activity |
Kanaldan konuşma sonu etkinliği alındığında çağrılır. |
| on_event |
temel davranışı kullanıldığında on_event_activity dışında bir olay alındığında çağrılır. |
| on_event_activity |
on_turn temel davranışı kullanıldığında bağlayıcıdan bir olay etkinliği alındığında çağrılır. |
| on_installation_update |
ActivityTypes.InstallationUpdate etkinliklerine özgü mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın. |
| on_installation_update_add |
ActivityTypes.InstallationUpdate etkinliklerine özgü mantığı 'ekle' olarak ayarlanmış 'action' ile sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın. |
| on_installation_update_remove |
ActivityTypes.InstallationUpdate etkinliklerine özgü 'action' 'remove' olarak ayarlanmış mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın. |
| on_invoke_activity |
Gelen her olay etkinliği için yayılan çağırma olayı için bir etkinlik olay işleyicisi kaydeder. |
| on_members_added_activity |
Bot dışındaki üyeler konuşmaya katıldığında mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. Botunuzun karşılama mantığını ekleyebilirsiniz. konuşma güncelleştirme etkinliği :type members_added: List :p aram turn_context: Bu dönüş için bağlam nesnesi :type turn_context: TurnContext |
| on_members_removed_activity |
Bot dışındaki üyeler konuşmadan ayrıldığında mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. Botunuzun veda mantığını ekleyebilirsiniz. konuşma güncelleştirme etkinliği :type members_added: List :p aram turn_context: Bu dönüş için bağlam nesnesi :type turn_context: TurnContext |
| on_message_activity |
Konuşma mantığı gibi etkinliklere özgü mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. |
| on_message_reaction_activity |
on_turn temel davranışı kullanıldığında bağlayıcıdan bir olay etkinliği alındığında çağrılır. |
| on_reactions_added |
Önceki bir etkinliğe yapılan tepkilerin konuşmaya ne zaman eklendiğine yönelik mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. |
| on_reactions_removed |
Önceki bir etkinliğe yönelik tepkilerin konuşmadan ne zaman kaldırıldığının mantığını sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. |
| on_sign_in_invoke |
on_invoke_activity(TurnContext{InvokeActivity}) temel davranışı kullanıldığında signin/verifyState veya signin/tokenExchange olayı alındığında çağrılır. OAuthPrompt kullanıyorsanız, bu Etkinliği"/ geçerli iletişim kutusuna iletmek için bu yöntemi geçersiz kılın. Varsayılan olarak, bu yöntem hiçbir şey yapmaz. |
| on_token_response_event |
temel davranışı kullanıldığında bir on_event_activity olayı alındığında çağrılır. oauth_promptkullanıyorsanız, bu etkinliği geçerli iletişim kutusuna iletmek için bu yöntemi geçersiz kılın. |
| on_turn |
Gelen <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>işlemek için çalışma zamanında bağdaştırıcı (örneğin, Activity) tarafından çağrılır. |
| on_typing_activity |
Konuşma mantığı gibi ActivityTypes.yazma etkinliklerine özgü mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın. |
| on_unrecognized_activity_type |
on_turn temel davranışı kullanıldığında ileti, konuşma güncelleştirmesi veya olay dışında bir etkinlik alındığında çağrılır. Geçersiz kılınırsa, bu yöntem diğer etkinlik türlerinden herhangi birine yanıt verebilir. |
on_adaptive_card_invoke
Bot bir Uyarlamalı Kart Eylemi Gönderildiğinde Çağrılır.
on_invoke_activity yöntemi adaptiveCard/actionActivity.name ile bir Invoke aldığında bu yöntemi çağırır.
async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bir bağlam nesnesi. |
|
invoke_value
Gerekli
|
<xref:botframework.schema.models.AdaptiveCardInvokeValue>
Gelen etkinliğin değerinden dize türüne sahip bir nesne. |
Döndürülenler
| Tür | Description |
|---|---|
|
HealthCheckResponse nesnesi |
on_conversation_update_activity
on_turn temel davranışı kullanıldığında kanaldan bir konuşma güncelleştirme etkinliği alındığında çağrılır.
async on_conversation_update_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_turn yöntemi bir konuşma güncelleştirme etkinliği aldığında bu yöntemi çağırır. De
- Konuşma güncelleştirme etkinliği bot dışındaki üyelerin konuşmaya katıldığını gösteriyorsa, on_members_added_activity yöntemini çağırır.
- Konuşma güncelleştirme etkinliği bot dışındaki üyelerin konuşmayı bıraktığını gösteriyorsa, on_members_removed_activity yöntemini çağırır.
- Türetilmiş bir sınıfta, tüm konuşma güncelleştirme etkinliklerine uygulanan mantık eklemek için bu yöntemi geçersiz kılın. Üye bu temel sınıf yöntemine çağrıdan önce mantık eklemeden veya kaldırmadan önce uygulanacak mantık ekleyin.
on_end_of_conversation_activity
Kanaldan konuşma sonu etkinliği alındığında çağrılır.
async on_end_of_conversation_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_event
temel davranışı kullanıldığında on_event_activity dışında bir olay alındığında çağrılır.
async on_event(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_event_activity yöntemi kullanıldığında, belirteçleri/yanıtdışında bir etkinlik adına sahip bir olay aldığında, bu yöntemi çağırır. Botun çeşitli olayları işlemesi amaçlanıyorsa bu yöntem isteğe bağlı olarak geçersiz kılınabilir.
on_event_activity
on_turn temel davranışı kullanıldığında bağlayıcıdan bir olay etkinliği alındığında çağrılır.
async on_event_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_turn yöntemi bir olay etkinliği aldığında bu yöntemi çağırır. Etkinlik adı belirteç/yanıtise on_token_response_eventçağırır; aksi takdirde, on_eventçağırır.
Türetilmiş bir sınıfta, tüm olay etkinliklerine uygulanan mantık eklemek için bu yöntemi geçersiz kılın. Bu temel sınıf yöntemine çağrıdan önce belirli olay işleme mantığından önce uygulanacak mantık ekleyin. Bu temel sınıf yöntemine yapılan çağrıdan sonra belirli olay işleme mantığından sonra uygulanacak mantığı ekleyin.
Olay etkinlikleri, programlı bilgileri bir istemciden veya kanaldan bota iletir. Bir olay etkinliğinin anlamı, bir kanal kapsamında anlamlı olan olay etkinliği adı özelliğiyle tanımlanır.
on_installation_update
ActivityTypes.InstallationUpdate etkinliklerine özgü mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın.
async on_installation_update(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_installation_update_add
ActivityTypes.InstallationUpdate etkinliklerine özgü mantığı 'ekle' olarak ayarlanmış 'action' ile sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın.
async on_installation_update_add(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_installation_update_remove
ActivityTypes.InstallationUpdate etkinliklerine özgü 'action' 'remove' olarak ayarlanmış mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın.
async on_installation_update_remove(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_invoke_activity
Gelen her olay etkinliği için yayılan çağırma olayı için bir etkinlik olay işleyicisi kaydeder.
async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_members_added_activity
Bot dışındaki üyeler konuşmaya katıldığında mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. Botunuzun karşılama mantığını ekleyebilirsiniz.
konuşma güncelleştirme etkinliği :type members_added: List :p aram turn_context: Bu dönüş için bağlam nesnesi :type turn_context: TurnContext
async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
members_added
Gerekli
|
|
|
turn_context
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_conversation_update_activity yöntemi, bot dışındaki bir veya daha fazla kullanıcının konuşmaya katıldığını belirten bir konuşma güncelleştirme etkinliği aldığında, bu yöntemi çağırır.
on_members_removed_activity
Bot dışındaki üyeler konuşmadan ayrıldığında mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın. Botunuzun veda mantığını ekleyebilirsiniz.
konuşma güncelleştirme etkinliği :type members_added: List :p aram turn_context: Bu dönüş için bağlam nesnesi :type turn_context: TurnContext
async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
members_removed
Gerekli
|
|
|
turn_context
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_conversation_update_activity yöntemi, bot dışındaki bir veya daha fazla kullanıcının konuşmadan ayrıldığını belirten bir konuşma güncelleştirme etkinliği aldığında, bu yöntemi çağırır.
on_message_activity
Konuşma mantığı gibi etkinliklere özgü mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın.
async on_message_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_message_reaction_activity
on_turn temel davranışı kullanıldığında bağlayıcıdan bir olay etkinliği alındığında çağrılır.
async on_message_reaction_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
İleti tepkileri, daha önce gönderilen bir etkinliğe 'like' veya 'üzgün' vb. (genellikle emoji) ekleyen kullanıcıya karşılık gelir.
İleti tepkileri yalnızca birkaç kanal tarafından desteklenir. İleti tepkisinin karşılık olduğu etkinlik, Id yanıt özelliğinde gösterilir. Bu özelliğin değeri, gönderme çağrısından gelen yanıt olarak bota geri verilen daha önce gönderilmiş bir etkinliğin etkinlik kimliğidir. on_turn yöntemi bir ileti tepkisi etkinliği aldığında bu yöntemi çağırır.
- İleti tepkisi, bir iletiye tepkilerin eklendiğini gösteriyorsa,
<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_added>.
- İleti tepkisi, bir iletiden tepkilerin kaldırıldığını gösteriyorsa, <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>çağırır.
Türetilmiş bir sınıfta, tüm ileti tepkisi etkinliklerine uygulanan mantık eklemek için bu yöntemi geçersiz kılın. Bu temel sınıf yöntemine yapılan çağrıdan önce eklenen veya kaldırılan tepkilerden önce uygulanacak mantık ekleyin. Bu temel sınıf yöntemine yapılan çağrıdan sonra eklenen veya kaldırılan tepkilerden sonra uygulanacak mantığı ekleyin.
on_reactions_added
Önceki bir etkinliğe yapılan tepkilerin konuşmaya ne zaman eklendiğine yönelik mantık sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın.
async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
message_reactions
Gerekli
|
Eklenen tepkilerin listesi |
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
İleti tepkileri, kullanıcının konuşmada daha önce gönderilen bir iletiye 'like' veya 'üzgün' vb. eklemesine (genellikle emoji) karşılık gelir. İleti tepkileri yalnızca birkaç kanal tarafından desteklenir. İletinin tepki verdiği etkinlik, etkinliğin ID'ye yanıt verme özelliği tarafından tanımlanır. Bu özelliğin değeri, daha önce gönderilmiş bir etkinliğin etkinlik kimliğidir. Bot bir etkinlik gönderdiğinde, kanal buna sonucun kaynak yanıt kimliğinde bulunan bir kimlik atar.
on_reactions_removed
Önceki bir etkinliğe yönelik tepkilerin konuşmadan ne zaman kaldırıldığının mantığını sağlamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın.
async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
message_reactions
Gerekli
|
Kaldırılan tepkilerin listesi |
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
İleti tepkileri, kullanıcının konuşmada daha önce gönderilen bir iletiye 'like' veya 'üzgün' vb. eklemesine (genellikle emoji) karşılık gelir. İleti tepkileri yalnızca birkaç kanal tarafından desteklenir. İletinin tepki verdiği etkinlik, etkinliğin Id özelliğine yanıt verme özelliği tarafından tanımlanır. Bu özelliğin değeri, daha önce gönderilmiş bir etkinliğin etkinlik kimliğidir. Bot bir etkinlik gönderdiğinde, kanal buna sonucun kaynak yanıt kimliğinde bulunan bir kimlik atar.
on_sign_in_invoke
on_invoke_activity(TurnContext{InvokeActivity}) temel davranışı kullanıldığında signin/verifyState veya signin/tokenExchange olayı alındığında çağrılır. OAuthPrompt kullanıyorsanız, bu Etkinliği"/ geçerli iletişim kutusuna iletmek için bu yöntemi geçersiz kılın. Varsayılan olarak, bu yöntem hiçbir şey yapmaz.
async on_sign_in_invoke(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_token_response_event
temel davranışı kullanıldığında bir on_event_activity olayı alındığında çağrılır. oauth_promptkullanıyorsanız, bu etkinliği geçerli iletişim kutusuna iletmek için bu yöntemi geçersiz kılın.
async on_token_response_event(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_event yöntemi belirteçler/yanıtetkinlik adına sahip bir olay aldığında bu yöntemi çağırır. Botunuz bir oauth_promptkullanıyorsa, gelen etkinliği geçerli iletişim kutusuna iletin.
on_turn
Gelen <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>işlemek için çalışma zamanında bağdaştırıcı (örneğin, Activity) tarafından çağrılır.
async on_turn(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
Türetilmiş bir sınıfın türe özgü mantığı denetimli bir şekilde sağlamasına olanak tanıyan, işlenmek üzere etkinliğin türüne göre bu sınıftaki diğer yöntemleri çağırır. Türetilmiş bir sınıfta, tüm etkinlik türlerine uygulanan mantık eklemek için bu yöntemi geçersiz kılın. De
on_typing_activity
Konuşma mantığı gibi ActivityTypes.yazma etkinliklerine özgü mantık sağlamak için bunu türetilmiş bir sınıfta geçersiz kılın.
async on_typing_activity(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
on_unrecognized_activity_type
on_turn temel davranışı kullanıldığında ileti, konuşma güncelleştirmesi veya olay dışında bir etkinlik alındığında çağrılır. Geçersiz kılınırsa, bu yöntem diğer etkinlik türlerinden herhangi birine yanıt verebilir.
async on_unrecognized_activity_type(turn_context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
Bu dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Açıklamalar
on_turn yöntemi ileti, konuşma güncelleştirmesi, ileti tepkisi veya olay etkinliği olmayan bir etkinlik aldığında bu yöntemi çağırır.