Compartilhar via

TextInput class

  • Referência
Pacote:
botbuilder-dialogs-adaptive

Entrada de texto declarativo para coletar dados de texto dos usuários.

Extends
InputDialog

Construtores

TextInput(string, Partial<Activity> | string)

Inicializa uma nova instância da classe InputDialog

Propriedades

$kind
outputFormat

Propriedades herdadas

allowInterruptions

Política de interrupção.
alwaysPrompt

Um valor que indica se a entrada deve sempre solicitar ao usuário, independentemente de haver um valor ou não.
defaultValue

O valor padrão da caixa de diálogo de entrada quando maxTurnCount é excedido.
defaultValueResponse

O modelo de atividade a ser enviado quando maxTurnCount for atingido e o valor padrão for usado.
disabled

Uma expressão opcional que, se for true, desabilitará essa ação.
EndOfTurn

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

O modelo de atividade a ser enviado ao usuário sempre que o valor fornecido for inválido ou não.
maxTurnCount

Número máximo de vezes para solicitar esse valor ao usuário antes que a caixa de diálogo descreva.
OPTIONS_PROPERTY
prompt

A atividade a ser enviada ao usuário.
property

A expressão de valor à qual a entrada será associada.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt

O modelo de atividade para tentar novamente o prompt.
validations

As expressões a serem executadas para validar a entrada.
value

Uma expressão de valor que pode ser usada para inicializar o prompt de entrada.
VALUE_PROPERTY

Métodos

getConverter(Object)

Métodos herdados

beginDialog(DialogContext, any)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogos.
configure(Record<string, unknown>)

Método fluente para configurar o objeto.
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)

Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
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.
repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, reprompta o usuário para entrada.
resumeDialog(DialogContext, DialogReason, any)

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

Detalhes do construtor

TextInput(string, Partial<Activity> | string)

Inicializa uma nova instância da classe InputDialog

new TextInput(property?: string, prompt?: Partial<Activity> | string)

Parâmetros

property

string

Opcional. A expressão de valor à qual a entrada será associada.

prompt

Partial<Activity> | string

Opcional. A atividade de para enviar ao usuário, se uma cadeia de caracteres for especificada, criará uma instância ActivityTemplate.

Detalhes da propriedade

$kind 

static $kind: string

Valor da propriedade

string

outputFormat 

outputFormat: StringExpression

Valor da propriedade

StringExpression

Detalhes das propriedades herdadas

allowInterruptions

Política de interrupção.

allowInterruptions: BoolExpression

Valor da propriedade

BoolExpression

herdado deInputDialog.allowInterruptions

alwaysPrompt

Um valor que indica se a entrada deve sempre solicitar ao usuário, independentemente de haver um valor ou não.

alwaysPrompt: BoolExpression

Valor da propriedade

BoolExpression

Herdado deInputDialog.alwaysPrompt

defaultValue

O valor padrão da caixa de diálogo de entrada quando maxTurnCount é excedido.

defaultValue?: ValueExpression

Valor da propriedade

ValueExpression

herdado deInputDialog.defaultValue

defaultValueResponse

O modelo de atividade a ser enviado quando maxTurnCount for atingido e o valor padrão for usado.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

herdado deInputDialog.defaultValueResponse

disabled

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

disabled?: BoolExpression

Valor da propriedade

BoolExpression

Herdado deInputDialog.disabled

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

invalidPrompt

O modelo de atividade a ser enviado ao usuário sempre que o valor fornecido for inválido ou não.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

herdado do InputDialog.invalidPrompt

maxTurnCount

Número máximo de vezes para solicitar esse valor ao usuário antes que a caixa de diálogo descreva.

maxTurnCount?: IntExpression

Valor da propriedade

IntExpression

herdado deInputDialog.maxTurnCount

OPTIONS_PROPERTY 

static OPTIONS_PROPERTY: string

Valor da propriedade

string

herdado deInputDialog.OPTIONS_PROPERTY

prompt

A atividade a ser enviada ao usuário.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

Herdado doInputDialog.prompt

property

A expressão de valor à qual a entrada será associada.

property: StringExpression

Valor da propriedade

StringExpression

Herdado deInputDialog.property

telemetryClient 

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de Dialog.telemetryClient

TURN_COUNT_PROPERTY 

static TURN_COUNT_PROPERTY: string

Valor da propriedade

string

herdado deInputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

O modelo de atividade para tentar novamente o prompt.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

Herdado deInputDialog.unrecognizedPrompt

validations

As expressões a serem executadas para validar a entrada.

validations: string[]

Valor da propriedade

string[]

Herdado deInputDialog.validations

value

Uma expressão de valor que pode ser usada para inicializar o prompt de entrada.

value: ValueExpression

Valor da propriedade

ValueExpression

herdado deInputDialog.value

VALUE_PROPERTY 

static VALUE_PROPERTY: string

Valor da propriedade

string

herdado deInputDialog.VALUE_PROPERTY

Detalhes do método

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.

Detalhes do método herdado

beginDialog(DialogContext, any)

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

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

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

options

any

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

Retornos

Promise<DialogTurnResult>

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

herdado deInputDialog.beginDialog

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

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 DialogTurnResultPromise que representa a operação assíncrona.

herdado do InputDialog.continueDialog do

endDialog(TurnContext, DialogInstance, DialogReason)

Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

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

_reason

DialogReason

O motivo pelo qual a caixa de diálogo está terminando.

Retornos

Promise<void>

Comentários

As caixas de diálogo derivadas que precisam executar o registro em log ou a limpeza antes de terminar devem substituir esse método. Por padrão, esse método não tem efeito.

O dialogContext chama esse método quando a caixa de diálogo atual está terminando.

Consulte também

Herdado de Dialog.endDialog

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

repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, reprompta o usuário para entrada.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

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

Retornos

Promise<void>

Comentários

Caixas de diálogo derivadas que dão suporte à validação e à lógica de nova solicitação devem substituir esse método. Por padrão, esse método não tem efeito.

O DialogContext chama esse método quando a caixa de diálogo atual deve solicitar novamente a entrada do usuário. Esse método é implementado para caixas de diálogo de prompt.

Consulte também

Herdado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo filho conclui 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), 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>

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

Herdado deInputDialog.resumeDialog