OAuthPrompt Klasse

  • Referenz
Paket:
com.microsoft.bot.dialogs.prompts
Maven-Artefakt:
com.microsoft.bot:bot-dialogs:4.14.3

public class OAuthPrompt
extends Dialog

Erstellt eine neue Eingabeaufforderung, die den Benutzer auffordert, sich mit dem Bot Frameworks Single Sign On (SSO)-Dienst anzumelden. Die Eingabeaufforderung versucht, das aktuelle Token der Benutzer abzurufen, und wenn der Benutzer nicht angemeldet ist, sendet sie eine "OAuthCard", die eine Schaltfläche enthält, die sie drücken können, um sich anzumelden. Je nach Demchannel wird der Benutzer über einen von zwei möglichen Signin-Flüssen gesendet:- Der automatische Anmeldefluss, in dem der Benutzer sich anmeldet und der SSO-Dienst den Botthe-Benutzer-Zugriffstoken entweder über eine Aktivität "Ereignis" oder "Aufrufen" weiterleitet.- Der Fluss "Magischer Code", in dem sich der Benutzer anmeldet, wird vom SSOservice aufgefordert, dem Bot einen sechsstelligen Code zu senden, der seine Identität bestätigt. Dieser Code wird als standardmäßige Nachrichtenaktivität gesendet. Beide Flüsse werden automatisch von "OAuthPrompt" unterstützt, und das einzige, was Sie berücksichtigen müssen, besteht darin, dass Sie die Aktivitäten "Ereignis" und "Aufrufen" nicht blockieren, auf die die Eingabeaufforderung möglicherweise wartet. **Hinweis**:Sie sollten verhindern, dass das Zugriffstoken mit Ihren Bots in einem anderen Zustand beibehalten wird. Der Bot FrameworksSSO-Dienst speichert das Token sicher in Ihrem Auftrag. Wenn Sie sie in Ihrem Bots-Zustand speichern, kann es ablaufen oder zwischeneinander widerrufen werden. Wenn Sie die Eingabeaufforderung innerhalb eines Wasserfallschritts aufrufen, sollten Sie das Token innerhalb der Schrittfolge der Eingabeaufforderung verwenden und das Token dann am Ende Ihrer Funktion außerhalb des Gültigkeitsbereichs lassen.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
OAuthPrompt(String dialogId, OAuthPromptSettings settings)

Initialisiert eine neue Instanz der OAuthPrompt Klasse.
OAuthPrompt(String dialogId, OAuthPromptSettings settings, PromptValidator<TokenResponse> validator)

Initialisiert eine neue Instanz der OAuthPrompt Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.
java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext)

Versucht, das Token des Benutzers abzurufen.
static java.util.concurrent.CompletableFuture<PromptRecognizerResult<TokenResponse>> recognizeToken(OAuthPromptSettings settings, DialogContext dc)

Gemeinsame Implementierung der Funktion "ErkennenToken".
static java.util.concurrent.CompletableFuture<java.lang.Void> sendOAuthCard(OAuthPromptSettings settings, TurnContext turnContext, Activity prompt)

Gemeinsame Implementierung der OAuthOAuthCard-Funktion.
static void setCallerInfoInDialogState(Map<String,Object> state, TurnContext context)

Gemeinsame Implementierung der Funktion "SetCallerInfoInDialogState".
java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Meldet den Benutzer ab.

Geerbte Methoden von Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Details zum Konstruktor

OAuthPrompt

public OAuthPrompt(String dialogId, OAuthPromptSettings settings)

Initialisiert eine neue Instanz der OAuthPrompt Klasse.

Parameter:

dialogId - Der D, der dieser Eingabeaufforderung zugewiesen werden soll.
settings - Zusätzliche OAuth-Einstellungen, die mit dieser Instanz der Eingabeaufforderung verwendet werden sollen. 
              The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

OAuthPrompt

public OAuthPrompt(String dialogId, OAuthPromptSettings settings, PromptValidator validator)

Initialisiert eine neue Instanz der OAuthPrompt Klasse.

Parameter:

dialogId - Der D, der dieser Eingabeaufforderung zugewiesen werden soll.
settings - Zusätzliche OAuth-Einstellungen, die mit dieser Instanz der Eingabeaufforderung verwendet werden sollen.
validator - Optional, ein {@link PromptValidator{FoundChoice}} mit zusätzlicher, benutzerdefinierter Überprüfung für diese Eingabeaufforderung. 
              The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

Details zur Methode

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.

Überschreibt:

OAuthPrompt.beginDialog(DialogContext dc, Object options)

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
options - Optional, zusätzliche Informationen, die an die eingabeaufforderung übergeben werden sollen, die gestartet wird.

Gibt zurück:

Eine CompletableFuture, die den hronösen Vorgang darstellt. Wenn der Vorgang erfolgreich ist, gibt das Ergebnis an, ob die Eingabeaufforderung noch aktiv ist, nachdem die Aufforderung von der Eingabeaufforderung verarbeitet wurde.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Überschreibt:

OAuthPrompt.continueDialog(DialogContext dc)

Parameter:

dc - Der Dialogkontext für die aktuelle Unterhaltungswende.

Gibt zurück:

Eine CompletableFuture, die den hronösen Vorgang darstellt. Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde. Die Eingabeaufforderung empfängt in der Regel weiterhin die Antworten des Benutzers, bis sie die Antwort des Benutzers als gültige Eingabe für die Eingabeaufforderung akzeptiert.

getUserToken

public CompletableFuture getUserToken(TurnContext turnContext)

Versucht, das Token des Benutzers abzurufen.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. 
     If the task is successful and user already has a token or the user
     successfully signs in, the result contains the user's token.

recognizeToken

public static CompletableFuture> recognizeToken(OAuthPromptSettings settings, DialogContext dc)

Gemeinsame Implementierung der RecognizeToken-Funktion. Dies ist für die interne Verwendung vorgesehen, um die Implementierung von OAuthPrompt und OAuthInput zu konsolidieren. Anwendungslogik sollte diese Dialogfeldklassen verwenden.

Parameter:

settings - OAuthPromptSettings.
dc - DialogContext.

Gibt zurück:

PromptRecognizerResult.

sendOAuthCard

public static CompletableFuture sendOAuthCard(OAuthPromptSettings settings, TurnContext turnContext, Activity prompt)

Gemeinsame Implementierung der SendOAuthCard-Funktion. Dies ist für die interne Verwendung vorgesehen, um die Implementierung von OAuthPrompt und OAuthInput zu konsolidieren. Anwendungslogik sollte diese Dialogfeldklassen verwenden.

Parameter:

settings - OAuthSettings.
turnContext - TurnContext.
prompt - MessageActivity.

Gibt zurück:

Eine CompletableFuture, die das Ergebnis des hronösen Vorgangs darstellt.

setCallerInfoInDialogState

public static void setCallerInfoInDialogState(Map state, TurnContext context)

Gemeinsame Implementierung der SetCallerInfoInDialogState-Funktion. Dies ist für die interne Verwendung vorgesehen, um die Implementierung von OAuthPrompt und OAuthInput zu konsolidieren. Anwendungslogik sollte diese Dialogfeldklassen verwenden.

Parameter:

state - Der Dialogfeldstatus.
context - TurnContext.

signOutUser

public CompletableFuture signOutUser(TurnContext turnContext)

Meldet den Benutzer ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: