ComponentDialog Sınıf

Başvuru

Diğer iletişim kutusundan oluşan bir Dialog

ComponentDialog yeni bir örneğini başlatır

Oluşturucu

ComponentDialog(dialog_id: str)

Parametreler

Name	Description
dialog_id Gerekli	str Üst iletişim kutusu kümesindeki yeni iletişim kutusuna atanacak kimlik.

Değişkenler

Name	Description
state	<xref:persisted_dialog>

Yöntemler

add_dialog	Bileşen iletişim kutusuna bir <xref:botbuilder.dialogs.component_dialog.Dialog> ekler ve güncelleştirilmiş bileşeni döndürür.
begin_dialog	İletişim kutusu başlatıldığında ve üst iletişim kutusu yığınına gönderildiğinde çağrılır. Görev başarılı olursa, sonuç, sıra iletişim kutusu tarafından işlendikten sonra iletişim kutusunun hala etkin olup olmadığını gösterir.
continue_dialog	İletişim kutusu devam ettiğinde çağrılır; burada etkin iletişim kutusudur ve kullanıcı yeni bir etkinlikle yanıtlar.
end_component	Bileşen iletişim kutusunu üst öğesinin bağlamında sonlandırır.
end_dialog	İletişim kutusu sona erdiğinde çağrılır.
find_dialog	Kimliğine göre bir iletişim kutusu bulur.
on_begin_dialog	İletişim kutusu başlatıldığında ve üst iletişim kutusu yığınına gönderildiğinde çağrılır.
on_continue_dialog	İletişim kutusu devam ettiğinde çağrılır; burada etkin iletişim kutusudur ve kullanıcı yeni bir etkinlikle yanıtlar.
on_end_dialog	Bileşen iletişim kutusunu üst öğesinin bağlamında sonlandırır.
on_reprompt_dialog
reprompt_dialog	İletişim kutusunun kullanıcıdan yeniden giriş istemesi gerektiğinde çağrılır.
resume_dialog	Üst öğe iletişim kutusundaki bir alt iletişim kutusu bu dönüşü tamamladığında çağrılır ve denetimi bu iletişim kutusu bileşenine döndürür.

add_dialog

Bileşen iletişim kutusuna bir <xref:botbuilder.dialogs.component_dialog.Dialog> ekler ve güncelleştirilmiş bileşeni döndürür.

add_dialog(dialog: Dialog) -> object

Parametreler

Name	Description
dialog Gerekli	Eklenecek iletişim kutusu.

Döndürülenler

Tür	Description
ComponentDialog	Güncelleştirilmiş ComponentDialog.

begin_dialog

İletişim kutusu başlatıldığında ve üst iletişim kutusu yığınına gönderildiğinde çağrılır.

Görev başarılı olursa, sonuç, sıra iletişim kutusu tarafından işlendikten sonra iletişim kutusunun hala etkin olup olmadığını gösterir.

async begin_dialog(dialog_context: DialogContext, options: object = None) -> DialogTurnResult

Parametreler

Name	Description
dialog_context Gerekli	DialogContext Konuşmanın geçerli dönüşünün DialogContext.
options	object İsteğe bağlı, iletişim kutusuna iletecek ilk bilgiler. Default value: None

Döndürülenler

Tür	Description
end_of_turn	Dönüşün sonunu bildirir

continue_dialog

İletişim kutusu devam ettiğinde çağrılır; burada etkin iletişim kutusudur ve kullanıcı yeni bir etkinlikle yanıtlar.

async continue_dialog(dialog_context: DialogContext) -> DialogTurnResult

Parametreler

Name	Description
dialog_context Gerekli	DialogContext Konuşmanın geçerli dönüşü için üst iletişim kutusu bağlamı.

Döndürülenler

Tür	Description
end_of_turn	Dönüşün sonunu bildirir

Açıklamalar

Görev başarılı olursa, sonuç, sıra iletişim kutusu tarafından işlendikten sonra iletişim kutusunun hala etkin olup olmadığını gösterir. Sonuç bir dönüş değeri de içerebilir.

Bu yöntem geçersiz kılınmıyorsa, bileşen iletişim kutusu iç iletişim kutusu bağlamında continue_dialog yöntemini çağırır. İç iletişim kutusu yığını boşsa, bileşen iletişim kutusu sona erer ve bir result varsa, bileşen iletişim kutusu bunu dönüş değeri olarak kullanır.

end_component

Bileşen iletişim kutusunu üst öğesinin bağlamında sonlandırır.

async end_component(outer_dc: DialogContext, result: object) -> DialogTurnResult

Parametreler

Name	Description
outer_dc Gerekli	Konuşmanın geçerli dönüşü için üst iletişim kutusu bağlamı.
result Gerekli	object İsteğe bağlı, iletişim kutusu bileşeninden üst bağlama döndürülecek değer.

Döndürülenler

Tür	Description
result	Döndürülecek değer.

Açıklamalar

Görev başarılı olursa, sonuç, dönüş iletişim kutusu tarafından işlendikten sonra iletişim kutusunun sona erdiğini gösterir.

end_dialog

İletişim kutusu sona erdiğinde çağrılır.

async end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

Parametreler

Name	Description
context Gerekli	TurnContext Bu dönüş için bağlam nesnesi.
instance Gerekli	DialogInstance Bu bileşen iletişim kutusunun örneğiyle ilişkili durum bilgileri.
reason Gerekli	DialogReason İletişim kutusunun sona erme nedeni.

find_dialog

Kimliğine göre bir iletişim kutusu bulur.

async find_dialog(dialog_id: str) -> Dialog

Parametreler

Name	Description
dialog_id Gerekli	Eklenecek iletişim kutusu.

Döndürülenler

Tür	Description
Dialog	İletişim kutusu; veya Kimlik için bir eşleşme yoksa Hiçbiri.

on_begin_dialog

İletişim kutusu başlatıldığında ve üst iletişim kutusu yığınına gönderildiğinde çağrılır.

async on_begin_dialog(inner_dc: DialogContext, options: object) -> DialogTurnResult

Parametreler

Name	Description
inner_dc Gerekli	DialogContext Konuşmanın geçerli dönüşü için iç iletişim kutusu bağlamı.
options Gerekli	object İsteğe bağlı, iletişim kutusuna iletecek ilk bilgiler.

Açıklamalar

Görev başarılı olursa, sonuç, sıra iletişim kutusu tarafından işlendikten sonra iletişim kutusunun hala etkin olup olmadığını gösterir.

Varsayılan olarak, bileşen iletişim kutusunun ilk iletişim kutusunun begin_dialog yöntemini çağırır.

Kesme mantığını uygulamak için türetilmiş bir sınıfta bu yöntemi geçersiz kılın.

on_continue_dialog

İletişim kutusu devam ettiğinde çağrılır; burada etkin iletişim kutusudur ve kullanıcı yeni bir etkinlikle yanıtlar.

async on_continue_dialog(inner_dc: DialogContext) -> DialogTurnResult

Parametreler

Name	Description
inner_dc Gerekli	DialogContext Konuşmanın geçerli dönüşü için iç iletişim kutusu bağlamı.

on_end_dialog

Bileşen iletişim kutusunu üst öğesinin bağlamında sonlandırır.

async on_end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

Parametreler

Name	Description
turn_context Gerekli	TurnContext Konuşmanın geçerli dönüşünün TurnContext.
instance Gerekli	DialogInstance Bu bileşen iletişim kutusunun iç iletişim kutusu yığınıyla ilişkili durum bilgileri.
reason Gerekli	DialogReason İletişim kutusunun sona erme nedeni.
context Gerekli

on_reprompt_dialog

async on_reprompt_dialog(turn_context: TurnContext, instance: DialogInstance) -> None

Parametreler

Name	Description
turn_context Gerekli	DialogInstance Konuşmanın geçerli dönüşünün TurnContext.
instance Gerekli	DialogInstance Bu bileşen iletişim kutusunun iç iletişim kutusu yığınıyla ilişkili durum bilgileri.

reprompt_dialog

İletişim kutusunun kullanıcıdan yeniden giriş istemesi gerektiğinde çağrılır.

async reprompt_dialog(context: TurnContext, instance: DialogInstance) -> None

Parametreler

Name	Description
context Gerekli	TurnContext Bu dönüş için bağlam nesnesi.
instance Gerekli	DialogInstance Bu iletişim kutusu için durum bilgileri.

resume_dialog

Üst öğe iletişim kutusundaki bir alt iletişim kutusu bu dönüşü tamamladığında çağrılır ve denetimi bu iletişim kutusu bileşenine döndürür.

async resume_dialog(dialog_context: DialogContext, reason: DialogReason, result: object = None) -> DialogTurnResult

Parametreler

Name	Description
dialog_context Gerekli	DialogContext Konuşmanın geçerli dönüşünün iletişim kutusu bağlamı.
reason Gerekli	DialogReason İletişim kutusunun sürdürülmenin nedeni.
result	object İsteğe bağlı olarak, çağrılan iletişim kutusundan döndürülen değer. Default value: None

Döndürülenler

Tür	Description
end_of_turn	Dönüşün sonunu bildirir

Açıklamalar

Kapsayıcılar genellikle yığındaki yaprak düğümlerdir ancak geliştirme, yığının üzerine başka iletişim kutuları göndermekte serbesttir ve bu da kapsayıcının gönderilen iletişim kutusu sona erdiğinde beklenmeyen bir resume_dialog çağrısı almasına neden olur. Kapsayıcının erken bitmesini önlemek için bu yöntemi uygulamamız ve yalnızca iç iletişim kutusu yığınımızdan yeniden istem yapmasını istememiz gerekir.

Öznitelikler

persisted_dialog_state

persisted_dialog_state = 'dialogs'

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?