ComponentDialog Classe

Referência

Um Dialog composto por outros diálogos

Inicializa uma nova instância do ComponentDialog

Construtor

ComponentDialog(dialog_id: str)

Parâmetros

Nome	Description
dialog_id Obrigatório	str A ID a ser atribuída à nova caixa de diálogo dentro do conjunto de diálogo pai.

Variáveis

Nome	Description
state	<xref:persisted_dialog>

Métodos

add_dialog	Adiciona um <xref:botbuilder.dialogs.component_dialog.Dialog> à caixa de diálogo do componente e retorna o componente atualizado.
begin_dialog	Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo do pai. Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.
continue_dialog	Chamado quando a caixa de diálogo é continuada, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
end_component	Termina a caixa de diálogo do componente no contexto do pai.
end_dialog	Chamado quando a caixa de diálogo está terminando.
find_dialog	Localiza uma caixa de diálogo por ID.
on_begin_dialog	Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo do pai.
on_continue_dialog	Chamado quando a caixa de diálogo é continuada, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
on_end_dialog	Termina a caixa de diálogo do componente no contexto do pai.
on_reprompt_dialog
reprompt_dialog	Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.
resume_dialog	Chamado quando uma caixa de diálogo filho na pilha de diálogo do pai concluiu essa curva, retornando o controle para esse componente de caixa de diálogo.

add_dialog

Adiciona um <xref:botbuilder.dialogs.component_dialog.Dialog> à caixa de diálogo do componente e retorna o componente atualizado.

add_dialog(dialog: Dialog) -> object

Parâmetros

Nome	Description
dialog Obrigatório	A caixa de diálogo a ser adicionada.

Retornos

Tipo	Description
ComponentDialog	O ComponentDialogatualizado.

begin_dialog

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo do pai.

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

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

Parâmetros

Nome	Description
dialog_context Obrigatório	DialogContext O DialogContext para a virada atual da conversa.
options	object Informações iniciais opcionais a serem passadas para a caixa de diálogo. Valor padrão: None

Retornos

Tipo	Description
end_of_turn	Sinaliza o final da curva

continue_dialog

Chamado quando a caixa de diálogo é continuada, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

async continue_dialog(dialog_context: DialogContext) -> DialogTurnResult

Parâmetros

Nome	Description
dialog_context Obrigatório	DialogContext O contexto da caixa de diálogo pai para a virada atual da conversa.

Retornos

Tipo	Description
end_of_turn	Sinaliza o final da curva

Comentários

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo. O resultado também pode conter um valor retornado.

Se esse método não substituído, a caixa de diálogo do componente chamará o método continue_dialog no contexto da caixa de diálogo interna. Se a pilha de diálogo interno estiver vazia, a caixa de diálogo do componente terminará e, se um result estiver disponível, a caixa de diálogo do componente usará isso como seu valor retornado.

end_component

Termina a caixa de diálogo do componente no contexto do pai.

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

Parâmetros

Nome	Description
outer_dc Obrigatório	O contexto da caixa de diálogo pai para a virada atual da conversa.
result Obrigatório	object Opcional, valor a ser retornado do componente de caixa de diálogo para o contexto pai.

Retornos

Tipo	Description
result	Valor a ser retornado.

Comentários

Se a tarefa for bem-sucedida, o resultado indicará que a caixa de diálogo terminou depois que a curva foi processada pela caixa de diálogo.

end_dialog

Chamado quando a caixa de diálogo está terminando.

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

Parâmetros

Nome	Description
context Obrigatório	TurnContext O objeto de contexto para este turno.
instance Obrigatório	DialogInstance Informações de estado associadas à instância dessa caixa de diálogo de componente.
reason Obrigatório	DialogReason Motivo pelo qual a caixa de diálogo terminou.

find_dialog

Localiza uma caixa de diálogo por ID.

async find_dialog(dialog_id: str) -> Dialog

Parâmetros

Nome	Description
dialog_id Obrigatório	A caixa de diálogo a ser adicionada.

Retornos

Tipo	Description
Dialog	A caixa de diálogo; ou Nenhum se não houver uma correspondência para a ID.

on_begin_dialog

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo do pai.

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

Parâmetros

Nome	Description
inner_dc Obrigatório	DialogContext O contexto da caixa de diálogo interna para a virada atual da conversa.
options Obrigatório	object Informações iniciais opcionais a serem passadas para a caixa de diálogo.

Comentários

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

Por padrão, isso chama o método begin_dialog da caixa de diálogo inicial do componente.

Substitua esse método em uma classe derivada para implementar a lógica de interrupção.

on_continue_dialog

Chamado quando a caixa de diálogo é continuada, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

async on_continue_dialog(inner_dc: DialogContext) -> DialogTurnResult

Parâmetros

Nome	Description
inner_dc Obrigatório	DialogContext O contexto da caixa de diálogo interna para a virada atual da conversa.

on_end_dialog

Termina a caixa de diálogo do componente no contexto do pai.

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

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O TurnContext para a virada atual da conversa.
instance Obrigatório	DialogInstance Informações de estado associadas à pilha de diálogo interna dessa caixa de diálogo do componente.
reason Obrigatório	DialogReason Motivo pelo qual a caixa de diálogo terminou.
context Obrigatório

on_reprompt_dialog

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

Parâmetros

Nome	Description
turn_context Obrigatório	DialogInstance O TurnContext para a virada atual da conversa.
instance Obrigatório	DialogInstance Informações de estado associadas à pilha de diálogo interna dessa caixa de diálogo do componente.

reprompt_dialog

Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.

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

Parâmetros

Nome	Description
context Obrigatório	TurnContext O objeto de contexto para este turno.
instance Obrigatório	DialogInstance Informações de estado para esta caixa de diálogo.

resume_dialog

Chamado quando uma caixa de diálogo filho na pilha de diálogo do pai concluiu essa curva, retornando o controle para esse componente de caixa de diálogo.

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

Parâmetros

Nome	Description
dialog_context Obrigatório	DialogContext O contexto da caixa de diálogo para a virada atual da conversa.
reason Obrigatório	DialogReason Motivo pelo qual a caixa de diálogo foi retomada.
result	object Opcional, o valor retornado da caixa de diálogo que foi chamada. Valor padrão: None

Retornos

Tipo	Description
end_of_turn	Sinaliza o final da curva

Comentários

Normalmente, os contêineres são nós folha na pilha, mas o desenvolvimento é livre para enviar por push outros diálogos na parte superior da pilha, o que resultará no recebimento de uma chamada inesperada para resume_dialog quando a caixa de diálogo enviada por push terminar. Para evitar que o contêiner termine prematuramente, precisamos implementar esse método e simplesmente pedir à nossa pilha de diálogo interna para solicitar novamente.

Atributos

persisted_dialog_state

persisted_dialog_state = 'dialogs'

Comentários

Esta página foi útil?