SkillDialog class

Pacote:

botbuilder-dialogs

Uma caixa de diálogo especializada que pode encapsular chamadas remotas para uma habilidade.

Extends

Dialog<Partial<BeginSkillDialogOptions>>

Comentários

O parâmetro de opções no beginDialog deve ser uma instância BeginSkillDialogOptions com os parâmetros iniciais da caixa de diálogo.

Construtores

SkillDialog(SkillDialogOptions, string)

Uma caixa de diálogo de exemplo que pode encapsular chamadas remotas para uma habilidade.

Propriedades

id	ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.
telemetryClient	Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo.

Propriedades herdadas

EndOfTurn

Obtém um resultado de fim de turno padrão.

Métodos

beginDialog(DialogContext, BeginSkillDialogOptions)	Chamado quando a caixa de diálogo de habilidade é iniciada e enviada por push para a pilha de diálogo.
continueDialog(DialogContext)	Chamado quando a caixa de diálogo de habilidade é continuada, em que é a caixa de diálogo ativa e o usuário responde com um novo Activity.
endDialog(TurnContext, DialogInstance, DialogReason)	Chamado quando a caixa de diálogo de habilidade está terminando.
repromptDialog(TurnContext, DialogInstance)	Chamado quando a caixa de diálogo de habilidade deve solicitar novamente entrada ao usuário.
resumeDialog(DialogContext, DialogReason, any)	Chamado quando uma caixa de diálogo de habilidade filho completou sua vez, retornando o controle para essa caixa de diálogo.

Métodos herdados

configure(Record<string, unknown>)	Método fluente para configurar o objeto.
getConverter(string)
getVersion()	Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
onDialogEvent(DialogContext, DialogEvent)	Chamado quando um evento foi gerado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

Detalhes do construtor

SkillDialog(SkillDialogOptions, string)

Uma caixa de diálogo de exemplo que pode encapsular chamadas remotas para uma habilidade.

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

Parâmetros

dialogOptions

SkillDialogOptions

As opções para executar a caixa de diálogo de habilidade.

dialogId

string

A ID da caixa de diálogo.

Comentários

O parâmetro de opções em beginDialog() deve ser um objeto SkillDialogArgs com os parâmetros iniciais da caixa de diálogo.

Detalhes da propriedade

id

ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.

string id

Valor da propriedade

string

A ID da caixa de diálogo.

Comentários

Isso será gerado automaticamente se não for especificado.

telemetryClient

Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo.

BotTelemetryClient telemetryClient

Valor da propriedade

BotTelemetryClient

O BotTelemetryClient a ser usado para registro em log.

Detalhes das propriedades herdadas

EndOfTurn

Obtém um resultado de fim de turno padrão.

static EndOfTurn: DialogTurnResult

Valor da propriedade

DialogTurnResult

Comentários

Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.

herdado doDialog.EndOfTurn

Detalhes do método

beginDialog(DialogContext, BeginSkillDialogOptions)

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

function beginDialog(dc: DialogContext, options: BeginSkillDialogOptions): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

options

BeginSkillDialogOptions

Informações iniciais a serem passadas para a caixa de diálogo.

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

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.

continueDialog(DialogContext)

Chamado quando a caixa de diálogo de habilidade é continuada, em que é a caixa de diálogo ativa e o usuário responde com um novo Activity.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

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.

endDialog(TurnContext, DialogInstance, DialogReason)

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

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parâmetros

context

TurnContext

O objeto TurnContext para esta curva.

instance

DialogInstance

Informações de estado associadas à instância dessa caixa de diálogo na pilha de diálogo.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) por que a caixa de diálogo terminou.

Retornos

Promise<void>

Uma promessa que representa a operação assíncrona.

repromptDialog(TurnContext, DialogInstance)

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

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Parâmetros

context

TurnContext

O objeto TurnContext para esta curva.

instance

DialogInstance

Informações de estado para esta caixa de diálogo.

Retornos

Promise<void>

Uma promessa que representa a operação assíncrona.

resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo de habilidade filho completou sua vez, retornando o controle para essa caixa de diálogo.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O DialogContext para a virada atual da conversa.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) por que a caixa de diálogo foi retomada.

_result

any

Opcional, o valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

Detalhes do método herdado

configure(Record<string, unknown>)

Método fluente para configurar o objeto.

function configure(config: Record<string, unknown>): this

Parâmetros

config

Record<string, unknown>

Configurações a serem aplicadas.

Retornos

this

O configurável após a conclusão da operação.

Herdado deConfigurble.configure

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parâmetros

_property

string

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

O conversor para a configuração do seletor.

herdado deconfigurable.getConverter

getVersion()

Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.

function getVersion(): string

Retornos

string

Cadeia de caracteres exclusiva que só deve ser alterada quando a caixa de diálogo foi alterada de uma maneira que deve reiniciar a caixa de diálogo.

Comentários

Esse padrão é retornar as caixas de diálogo id mas pode ser substituído para fornecer uma lógica de detecção de alterações mais precisa. Qualquer caixa de diálogo na pilha que tenha sua alteração de versão resultará em um evento versionChanged será gerado. Se esse evento não for tratado pelo bot, um erro será gerado, resultando na execução da lógica do manipulador de erros de bots.

Retornar uma cadeia de caracteres vazia desabilitará o acompanhamento de versão para o componente.

herdado dedialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chamado quando um evento foi gerado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parâmetros

dc

DialogContext

O contexto da caixa de diálogo para a virada atual da conversa.

e

DialogEvent

O evento que está sendo gerado.

Retornos

Promise<boolean>

True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.

herdado da caixa de diálogo.onDialogEvent