Condividi tramite

ChoiceInput class

  • Riferimento
Pacchetto:
botbuilder-dialogs-adaptive

ChoiceInput: input dichiarativo per raccogliere le scelte dall'utente.

Extends
InputDialog

Costruttori

ChoiceInput(string, Partial<Activity> | string)

Inizializza una nuova istanza della classe InputDialog

Proprietà

$kind
choiceOptions

Opzioni aggiuntive passate al ChoiceFactory e usate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.
choices

Elenco di scelte da presentare all'utente.
defaultLocale

Vengono richieste le impostazioni locali predefinite che devono essere riconosciute.
outputFormat

Controllare il formato della risposta (valore o indice della scelta).
recognizerOptions

Opzioni aggiuntive passate alla funzione recognizeChoices() sottostante.
style

Stile delle scelte "sì" e "no" di cui viene eseguito il rendering all'utente quando richiesto.

Proprietà ereditate

allowInterruptions

Criteri di interruzione.
alwaysPrompt

Valore che indica se l'input deve sempre richiedere all'utente indipendentemente dal fatto che esista o meno un valore.
defaultValue

Valore predefinito per la finestra di dialogo di input quando viene superato maxTurnCount.
defaultValueResponse

Modello di attività da inviare quando viene raggiunto maxTurnCount e viene usato il valore predefinito.
disabled

Espressione facoltativa che, se è true, disabiliterà questa azione.
EndOfTurn

Ottiene un risultato di fine turno predefinito.
id
invalidPrompt

Modello di attività da inviare all'utente ogni volta che il valore specificato non è valido o meno.
maxTurnCount

Numero massimo di volte in cui chiedere all'utente questo valore prima che la finestra di dialogo venga rinunciata.
OPTIONS_PROPERTY
prompt

Attività da inviare all'utente.
property

Espressione di valore a cui verrà associato l'input.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt

Modello di attività per la richiesta di ripetizione dei tentativi.
validations

Espressioni da eseguire per convalidare l'input.
value

Espressione di valore che può essere utilizzata per inizializzare il prompt di input.
VALUE_PROPERTY

Metodi

getConverter(Object)

Metodi ereditati

beginDialog(DialogContext, any)

Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi.
configure(Record<string, unknown>)

Metodo Fluent per la configurazione dell'oggetto.
continueDialog(DialogContext)

Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.
endDialog(TurnContext, DialogInstance, DialogReason)

Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.
getVersion()

Stringa codificata usata per facilitare il rilevamento delle modifiche del bot nella ri-distribuzione.
onDialogEvent(DialogContext, DialogEvent)

Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.
repromptDialog(TurnContext, DialogInstance)

Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.
resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo figlio completa il suo turno, restituendo il controllo a questa finestra di dialogo.

Dettagli costruttore

ChoiceInput(string, Partial<Activity> | string)

Inizializza una nuova istanza della classe InputDialog

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

Parametri

property

string

Opzionale. Espressione di valore a cui verrà associato l'input.

prompt

Partial<Activity> | string

Opzionale. Il activity da inviare all'utente, se viene specificata una stringa, crea un'istanza di ActivityTemplate.

Dettagli proprietà

$kind 

static $kind: string

Valore della proprietà

string

choiceOptions

Opzioni aggiuntive passate al ChoiceFactory e usate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

Valore della proprietà

ObjectExpression<ChoiceFactoryOptions>

choices

Elenco di scelte da presentare all'utente.

choices: ObjectExpression<ChoiceSet>

Valore della proprietà

ObjectExpression<ChoiceSet>

defaultLocale

Vengono richieste le impostazioni locali predefinite che devono essere riconosciute.

defaultLocale?: StringExpression

Valore della proprietà

StringExpression

outputFormat

Controllare il formato della risposta (valore o indice della scelta).

outputFormat: EnumExpression<ChoiceOutputFormat>

Valore della proprietà

EnumExpression<ChoiceOutputFormat>

recognizerOptions

Opzioni aggiuntive passate alla funzione recognizeChoices() sottostante.

recognizerOptions?: ObjectExpression<FindChoicesOptions>

Valore della proprietà

ObjectExpression<FindChoicesOptions>

style

Stile delle scelte "sì" e "no" di cui viene eseguito il rendering all'utente quando richiesto.

style: EnumExpression<ListStyle>

Valore della proprietà

EnumExpression<ListStyle>

Commenti

Il valore predefinito è ListStyle.auto.

Dettagli proprietà ereditate

allowInterruptions

Criteri di interruzione.

allowInterruptions: BoolExpression

Valore della proprietà

BoolExpression

ereditato daInputDialog.allowInterruptions

alwaysPrompt

Valore che indica se l'input deve sempre richiedere all'utente indipendentemente dal fatto che esista o meno un valore.

alwaysPrompt: BoolExpression

Valore della proprietà

BoolExpression

ereditato daInputDialog.alwaysPrompt

defaultValue

Valore predefinito per la finestra di dialogo di input quando viene superato maxTurnCount.

defaultValue?: ValueExpression

Valore della proprietà

ValueExpression

ereditato daInputDialog.defaultValue

defaultValueResponse

Modello di attività da inviare quando viene raggiunto maxTurnCount e viene usato il valore predefinito.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valore della proprietà

TemplateInterface<Partial<Activity>, DialogStateManager>

Ereditato daInputDialog.defaultValueResponse

disabled

Espressione facoltativa che, se è true, disabiliterà questa azione.

disabled?: BoolExpression

Valore della proprietà

BoolExpression

ereditato daInputDialog.disabled

EndOfTurn

Ottiene un risultato di fine turno predefinito.

static EndOfTurn: DialogTurnResult

Valore della proprietà

DialogTurnResult

Commenti

Questo risultato indica che un dialogo (o un passaggio logico all'interno di una finestra di dialogo) ha completato l'elaborazione per il turno corrente, è ancora attiva ed è in attesa di più input.

ereditato da Dialog.EndOfTurn

id 

id: string

Valore della proprietà

string

ereditato da Dialog.id

invalidPrompt

Modello di attività da inviare all'utente ogni volta che il valore specificato non è valido o meno.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valore della proprietà

TemplateInterface<Partial<Activity>, DialogStateManager>

ereditato daInputDialog.invalidPrompt

maxTurnCount

Numero massimo di volte in cui chiedere all'utente questo valore prima che la finestra di dialogo venga rinunciata.

maxTurnCount?: IntExpression

Valore della proprietà

IntExpression

ereditato daInputDialog.maxTurnCount

OPTIONS_PROPERTY 

static OPTIONS_PROPERTY: string

Valore della proprietà

string

ereditato daInputDialog.OPTIONS_PROPERTY

prompt

Attività da inviare all'utente.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valore della proprietà

TemplateInterface<Partial<Activity>, DialogStateManager>

Ereditato daInputDialog.prompt

property

Espressione di valore a cui verrà associato l'input.

property: StringExpression

Valore della proprietà

StringExpression

Ereditato daInputDialog.property

telemetryClient 

telemetryClient: BotTelemetryClient

Valore della proprietà

BotTelemetryClient

ereditato da Dialog.telemetryClient

TURN_COUNT_PROPERTY 

static TURN_COUNT_PROPERTY: string

Valore della proprietà

string

ereditato daInputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

Modello di attività per la richiesta di ripetizione dei tentativi.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valore della proprietà

TemplateInterface<Partial<Activity>, DialogStateManager>

ereditato daInputDialog.unrecognizedPrompt

validations

Espressioni da eseguire per convalidare l'input.

validations: string[]

Valore della proprietà

string[]

ereditato daInputDialog.validations

value

Espressione di valore che può essere utilizzata per inizializzare il prompt di input.

value: ValueExpression

Valore della proprietà

ValueExpression

ereditato daInputDialog.value

VALUE_PROPERTY 

static VALUE_PROPERTY: string

Valore della proprietà

string

ereditato daInputDialog.VALUE_PROPERTY

Dettagli metodo

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Parametri

property

Object

Chiave della configurazione del selettore condizionale.

Restituisce

Converter | ConverterFactory

Convertitore per la configurazione del selettore.

Dettagli dei metodi ereditati

beginDialog(DialogContext, any)

Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

options

any

Opzionale. Informazioni iniziali da passare alla finestra di dialogo .

Restituisce

Promise<DialogTurnResult>

DialogTurnResultPromise che rappresenta l'operazione asincrona.

ereditato daInputDialog.beginDialog

configure(Record<string, unknown>)

Metodo Fluent per la configurazione dell'oggetto.

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

Parametri

config

Record<string, unknown>

Impostazioni di configurazione da applicare.

Restituisce

this

Configurabile al termine dell'operazione.

Ereditato da Configurable.configure

continueDialog(DialogContext)

Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

Restituisce

Promise<DialogTurnResult>

DialogTurnResultPromise che rappresenta l'operazione asincrona.

ereditato daInputDialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.

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

Parametri

_context

TurnContext

Oggetto di contesto per il turno.

_instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

_reason

DialogReason

Motivo per cui la finestra di dialogo sta terminando.

Restituisce

Promise<void>

Commenti

Le finestre di dialogo derivate che devono eseguire la registrazione o la pulizia prima di terminare devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo al termine della finestra di dialogo corrente.

Vedere anche

Ereditato da Dialog.endDialog

getVersion()

Stringa codificata usata per facilitare il rilevamento delle modifiche del bot nella ri-distribuzione.

function getVersion(): string

Restituisce

string

Stringa univoca che deve cambiare solo quando il dialogo è stato modificato in modo da riavviare la finestra di dialogo.

Commenti

Per impostazione predefinita, la restituzione dei dialoghi id ma può essere sottoposta a override per fornire una logica di rilevamento delle modifiche più precisa. Qualsiasi finestra di dialogo nello stack con la modifica della versione genererà un evento versionChanged verrà generato. Se questo evento non viene gestito dal bot, verrà generato un errore che causa l'esecuzione della logica del gestore errori dei bot.

La restituzione di una stringa vuota disabilita il rilevamento della versione per il componente insieme.

ereditato da Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.

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

Parametri

dc

DialogContext

Contesto del dialogo per il turno corrente della conversazione.

e

DialogEvent

Evento generato.

Restituisce

Promise<boolean>

True se l'evento viene gestito dalla finestra di dialogo corrente e il bubbling deve essere arrestato.

ereditato da Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.

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

Parametri

_context

TurnContext

Oggetto di contesto per il turno.

_instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

Restituisce

Promise<void>

Commenti

I dialoghi derivati che supportano la convalida e la logica di ripetizione della richiesta devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo quando la finestra di dialogo corrente deve richiedere nuovamente l'input dell'utente. Questo metodo viene implementato per i dialoghi di richiesta.

Vedere anche

ereditato da Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo figlio completa il suo turno, restituendo il controllo a questa finestra di dialogo.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo per cui il dialogo è ripreso.

_result

any

Opzionale. Valore restituito dalla finestra di dialogo di chiamata. Il tipo del valore restituito dipende dal dialogo figlio.

Restituisce

Promise<DialogTurnResult>

DialogTurnResultPromise che rappresenta l'operazione asincrona.

ereditato daInputDialog.resumeDialog