OAuthInput class

Initialisiert eine neue Instanz der OAuthInput Klasse

new OAuthInput(connectionName?: string, title?: string, text?: string, timeout?: number)

Parameter

static $kind: string

Eigenschaftswert

Name der verwendeten OAuth-Verbindung.

connectionName: StringExpression

Eigenschaftswert

(Optional) Zusätzlicher Text, der auf der Anmeldekarte enthalten sein soll.

text?: StringExpression

Eigenschaftswert

(Optional) Anzahl von Millisekunden, die die Eingabeaufforderung wartet, bis der Benutzer sich authentifiziert hat. Der Standardwert ist ein Wert 900,000 (15 Minuten).)

timeout?: IntExpression

Eigenschaftswert

Titel der Kartenanmeldungsschaltfläche.

title: StringExpression

Eigenschaftswert

Unterbrechungsrichtlinie.

allowInterruptions: BoolExpression

Eigenschaftswert

VonInputDialog.allowInterruptions- geerbt

Ein Wert, der angibt, ob die Eingabe immer den Benutzer auffordern soll, unabhängig davon, ob ein Wert vorhanden ist oder nicht.

alwaysPrompt: BoolExpression

Eigenschaftswert

vonInputDialog.alwaysPrompt geerbt

Der Standardwert für das Eingabedialogfeld, wenn maxTurnCount überschritten wird.

defaultValue?: ValueExpression

Eigenschaftswert

vonInputDialog.defaultValue- geerbt

Die Aktivitätsvorlage, die gesendet werden soll, wenn maxTurnCount erreicht wurde und der Standardwert verwendet wird.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

vonInputDialog.defaultValueResponse

Ein optionaler Ausdruck, der bei "true" diese Aktion deaktiviert.

disabled?: BoolExpression

Eigenschaftswert

VonInputDialog.disabled geerbt

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

Hinweise

Dieses Ergebnis gibt an, dass ein Dialogfeld (oder ein logischer Schritt innerhalb eines Dialogfelds) die Verarbeitung für die aktuelle Drehung abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.

von Dialog.EndOfTurn geerbt

id: string

Eigenschaftswert

geerbt von Dialog.id

Die Aktivitätsvorlage, die an den Benutzer gesendet werden soll, wenn der angegebene Wert ungültig ist oder nicht.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

VonInputDialog.invalidPrompt geerbt

Maximale Anzahl von Malen, mit denen der Benutzer nach diesem Wert gefragt wird, bevor das Dialogfeld angezeigt wird.

maxTurnCount?: IntExpression

Eigenschaftswert

vonInputDialog.maxTurnCount geerbt

static OPTIONS_PROPERTY: string

Eigenschaftswert

geerbt vonInputDialog.OPTIONS_PROPERTY

Die Aktivität, die an den Benutzer gesendet werden soll.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

vonInputDialog.prompt geerbt

Der Wertausdruck, an den die Eingabe gebunden wird.

property: StringExpression

Eigenschaftswert

VonInputDialog.property geerbt

telemetryClient: BotTelemetryClient

Eigenschaftswert

Geerbt von Dialog.telemetryClient

static TURN_COUNT_PROPERTY: string

Eigenschaftswert

geerbt vonInputDialog.TURN_COUNT_PROPERTY

Die Aktivitätsvorlage zum Wiederholen der Eingabeaufforderung.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

vonInputDialog.unrecognizedPrompt-

Die Ausdrücke, die ausgeführt werden sollen, um die Eingabe zu überprüfen.

validations: string[]

Eigenschaftswert

VonInputDialog.validations geerbt

Ein Wertausdruck, der zum Initialisieren der Eingabeaufforderung verwendet werden kann.

value: ValueExpression

Eigenschaftswert

VonInputDialog.value geerbt

static VALUE_PROPERTY: string

Eigenschaftswert

geerbt vonInputDialog.VALUE_PROPERTY

Wird aufgerufen, wenn eine Eingabeaufforderung Dialog auf den Dialogstapel verschoben wird und aktiviert wird.

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

Wird aufgerufen, wenn eine Eingabeaufforderung Dialog das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

function getConverter(property: Object): Converter | ConverterFactory

Parameter

Gibt zurück

Der Konverter für die Selektorkonfiguration.

Versucht, das gespeicherte Token für den aktuellen Benutzer abzurufen.

function getUserToken(dc: DialogContext, code?: string): Promise<TokenResponse | undefined>

Parameter

Gibt zurück

Eine Zusage, die den asynchronen Vorgang darstellt.

Meldet den Benutzer vom Dienst ab.

function signOutUser(dc: DialogContext): Promise<void>

Parameter

Gibt zurück

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Dieses Beispiel zeigt das Erstellen einer Instanz der Eingabeaufforderung und anschließendes Abmelden des Benutzers.

const prompt = new OAuthPrompt({
    connectionName: 'GitConnection',
    title: 'Login To GitHub'
});
await prompt.signOutUser(context);

Fluent-Methode zum Konfigurieren des Objekts.

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

Parameter

Gibt zurück

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt.

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

Parameter

Gibt zurück

Hinweise

Abgeleitete Dialogfelder, die vor dem Beenden Protokollierung oder Bereinigung durchführen müssen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.

Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld beendet wird.

Siehe auch

• DialogContext.cancelAllDialogs
• DialogContext.endDialog-
• DialogContext.replaceDialog

von Dialog.endDialog geerbt

Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.

function getVersion(): string

Gibt zurück

Eindeutige Zeichenfolge, die sich nur ändern sollte, wenn sich das Dialogfeld auf eine Weise geändert hat, die das Dialogfeld neu starten soll.

Hinweise

Dadurch werden standardmäßig die Dialogfelder ID- zurückgegeben, können jedoch außer Kraft gesetzt werden, um präzisere Änderungserkennungslogik bereitzustellen. Jedes Dialogfeld im Stapel, das seine Versionsänderung hat, führt zu einem versionChanged Ereignis wird ausgelöst. Wenn dieses Ereignis nicht vom Bot behandelt wird, wird ein Fehler ausgelöst, der dazu führt, dass die Bots-Fehlerhandlerlogik ausgeführt wird.

Durch zurückgeben einer leeren Zeichenfolge wird die Versionsnachverfolgung für die Komponente insgesamt deaktiviert.

Geerbt von Dialog.getVersion

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

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

Parameter

Gibt zurück

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.

geerbt von Dialog.onDialogEvent

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.

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

Parameter

Gibt zurück

Hinweise

Abgeleitete Dialogfelder, die validierungs- und erneute Aufforderungslogik unterstützen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.

Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.

Siehe auch

• DialogContext.repromptDialog
• Prompt

geerbt von Dialog.repromptDialog

Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung beendet, und das Steuerelement wird an dieses Dialogfeld zurückgegeben.

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

vonInputDialog.resumeDialog