Compartilhar via

BeginSkill class

  • Referência
Pacote:
botbuilder-dialogs-adaptive

Comece uma habilidade.

Extends

SkillDialog

Construtores

BeginSkill(SkillDialogOptions)

Cria uma nova instância 'BeginSkillDialog.

Propriedades

$kind
activity

Modelo para a atividade.
activityProcessed

Valor que indica se a nova caixa de diálogo deve processar a atividade.
allowInterruptions

A política de interrupção.
botId

A ID de Aplicativo da Microsoft que chamará a habilidade.
connectionName

Opcional. O nome da conexão OAuth para o bot pai.
disabled

Expressão opcional que, se for true, desabilitará essa ação.
resultProperty

Caminho de propriedade opcional para armazenar o resultado da caixa de diálogo.
skillAppId

A ID do aplicativo da Microsoft para a habilidade.
skillEndpoint

O ponto de extremidade /api/messages para a habilidade.
skillHostEndpoint

A URL de retorno de chamada para o host de habilidade.

Propriedades herdadas

EndOfTurn

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

Métodos

beginDialog(DialogContext, BeginSkillDialogOptions)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogos.
continueDialog(DialogContext)

Chamado quando a caixa de diálogo é continua, em que é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
endDialog(TurnContext, DialogInstance, DialogReason)

Chamado quando o da caixa de diálogo está terminando.
getConverter(Object)
repromptDialog(TurnContext, DialogInstance)

Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.
resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo filho concluído 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.
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

BeginSkill(SkillDialogOptions)

Cria uma nova instância 'BeginSkillDialog.

new BeginSkill(options?: SkillDialogOptions)

Parâmetros

options

SkillDialogOptions

Opções opcionais usadas para configurar a caixa de diálogo de habilidade.

Detalhes da propriedade

$kind 

static $kind: string

Valor da propriedade

string

activity

Modelo para a atividade.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

Valor que indica se a nova caixa de diálogo deve processar a atividade.

activityProcessed: BoolExpression

Valor da propriedade

BoolExpression

Comentários

O padrão para isso será true, o que significa que a nova caixa de diálogo não deve examinar a atividade. Você pode definir isso como false para expedir a atividade para a nova caixa de diálogo.

allowInterruptions

A política de interrupção.

allowInterruptions: BoolExpression

Valor da propriedade

BoolExpression

botId

A ID de Aplicativo da Microsoft que chamará a habilidade.

botId: StringExpression

Valor da propriedade

StringExpression

Comentários

Desfaule para um valor de =settings.MicrosoftAppId que recupera a ID dos bots das configurações.

connectionName

Opcional. O nome da conexão OAuth para o bot pai.

connectionName: StringExpression

Valor da propriedade

StringExpression

disabled

Expressão opcional que, se for true, desabilitará essa ação.

disabled?: BoolExpression

Valor da propriedade

BoolExpression

resultProperty

Caminho de propriedade opcional para armazenar o resultado da caixa de diálogo.

resultProperty?: StringExpression

Valor da propriedade

StringExpression

skillAppId

A ID do aplicativo da Microsoft para a habilidade.

skillAppId: StringExpression

Valor da propriedade

StringExpression

skillEndpoint

O ponto de extremidade /api/messages para a habilidade.

skillEndpoint: StringExpression

Valor da propriedade

StringExpression

skillHostEndpoint

A URL de retorno de chamada para o host de habilidade.

skillHostEndpoint: StringExpression

Valor da propriedade

StringExpression

Comentários

Desfaule para um valor de =settings.SkillHostEndpoint que recupera o ponto de extremidade das configurações.

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 de dialog.EndOfTurn

id 

id: string

Valor da propriedade

string

herdado de Dialog.id

telemetryClient 

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de Dialog.telemetryClient

Detalhes do método

beginDialog(DialogContext, BeginSkillDialogOptions)

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

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

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

options

BeginSkillDialogOptions

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

Retornos

Promise<DialogTurnResult>

Um Promise que representa a operação assíncrona.

continueDialog(DialogContext)

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

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

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

Retornos

Promise<DialogTurnResult>

Um Promise que representa a operação assíncrona.

endDialog(TurnContext, DialogInstance, DialogReason)

Chamado quando o da caixa de diálogo está terminando.

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

Parâmetros

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), o objeto de contexto para este turno.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informações de estado associadas à instância dessa caixa de diálogo na pilha de diálogos.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo pelo qual a caixa de diálogo terminou.

Retornos

Promise<void>

Um Promise que representa a operação assíncrona.

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Parâmetros

property

Object

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

O conversor para a configuração do seletor.

repromptDialog(TurnContext, DialogInstance)

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

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

Parâmetros

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), o objeto de contexto para este turno.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informações de estado para esta caixa de diálogo.

Retornos

Promise<void>

Um Promise que representa a operação assíncrona.

resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo filho concluído sua vez, retornando o controle para essa caixa de diálogo.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo pelo qual a caixa de diálogo foi retomada.

result

any

Opcional. 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<any>>

Um Promise 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 de Configurble.configure

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 de Dialog.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