OAuthPrompt Klas

Definitie

Naamruimte:

Microsoft.Bot.Builder.Dialogs

Assembly:

Microsoft.Bot.Builder.Dialogs.dll

Pakket:

Microsoft.Bot.Builder.Dialogs v4.22.7

Hiermee wordt een nieuwe prompt gemaakt waarin de gebruiker wordt gevraagd zich aan te melden met behulp van de Bot Frameworks SSO-service (Single Sign On).

public class OAuthPrompt : Microsoft.Bot.Builder.Dialogs.Dialog

type OAuthPrompt = class
    inherit Dialog

Public Class OAuthPrompt
Inherits Dialog

Overname

Object

Dialog

OAuthPrompt

Opmerkingen

De prompt probeert het huidige token van de gebruiker op te halen en als de gebruiker niet is aangemeld, wordt er een OAuthCard verzonden met een knop waarop ze kunnen drukken om zich aan te melden. Afhankelijk van het kanaal wordt de gebruiker verzonden via een van twee mogelijke aanmeldingsstromen:

- De automatische aanmeldingsstroom waarbij zodra de gebruiker zich aanmeldt en de SSO-service de bot het toegangstoken van de gebruiker doorstuurt met behulp van een gebeurtenis- of aanroepactiviteit. - De 'magic code'-stroom waarbij de gebruiker zich zodra deze zich aanmeldt, wordt gevraagd door de SSO-service om de bot een code van zes cijfers te sturen om hun identiteit te bevestigen. Deze code wordt verzonden als een standaard 'bericht'-activiteit.

Beide stromen worden automatisch ondersteund door de 'OAuthPrompt' en het enige waarmee u moet oppassen, is dat u de 'gebeurtenis' niet blokkeert en activiteiten aanroept waarop de prompt mogelijk wacht.

**Opmerking**: u moet voorkomen dat het toegangstoken wordt bewaard met de andere status van uw bots. De Bot Frameworks SSO-service slaat het token veilig op namens u. Als u deze opslaat in de status van uw bots, kan deze tussendoor verlopen of worden ingetrokken.

Wanneer u de prompt aanroept vanuit een watervalstap, moet u het token gebruiken in de stap na de prompt en vervolgens het token buiten het bereik laten vallen aan het einde van uw functie.

### Prompt Usage

Wanneer u deze gebruikt met die van DialogSet uw bot, kunt u eenvoudig een nieuw exemplaar van de prompt toevoegen als een benoemd dialoogvenster met behulp van Add(Dialog). U kunt de prompt vervolgens starten vanuit een watervalstap met behulp van BeginDialogAsync(String, Object, CancellationToken) of PromptAsync(String, PromptOptions, CancellationToken). De gebruiker wordt gevraagd zich zo nodig aan te melden en het toegangstoken wordt als argument doorgegeven aan de aanroepers van de volgende watervalstap.

Constructors

OAuthPrompt(String, OAuthPromptSettings, PromptValidator<TokenResponse>)

Initialiseert een nieuw exemplaar van de OAuthPrompt klasse.

Eigenschappen

Id	Hiermee wordt de id voor het dialoogvenster opgehaald of ingesteld. (Overgenomen van Dialog)
Source	Hiermee haalt u de informatie op van de cref="SourceRange"/>. (Overgenomen van Dialog)
TelemetryClient	Hiermee wordt de IBotTelemetryClient opgehaald of ingesteld voor gebruik voor logboekregistratie. (Overgenomen van Dialog)

Methoden

BeginDialogAsync(DialogContext, Object, CancellationToken)	Wordt aangeroepen wanneer een dialoogvenster wordt gepusht naar de dialoogvensterstack en wordt geactiveerd.
ContinueDialogAsync(DialogContext, CancellationToken)	Wordt aangeroepen wanneer een promptdialoogvenster het actieve dialoogvenster is en de gebruiker heeft gereageerd met een nieuwe activiteit.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Wordt aangeroepen wanneer het dialoogvenster wordt beëindigd. (Overgenomen van Dialog)
GetUserTokenAsync(ITurnContext, CancellationToken)	Probeert het token van de gebruiker op te halen.
GetVersion()	Hiermee haalt u een unieke tekenreeks op die de versie van dit dialoogvenster vertegenwoordigt. Als de versie verandert tussen bochten, zal het dialoogvenstersysteem een DialogChanged-gebeurtenis verzenden. (Overgenomen van Dialog)
OnComputeId()	Hiermee wordt de reken-id voor het dialoogvenster gemaakt. (Overgenomen van Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)	Wordt aangeroepen wanneer een gebeurtenis is gegenereerd, met behulp van DialogContext.emitEvent(), door het huidige dialoogvenster of een dialoogvenster dat het huidige dialoogvenster is gestart. (Overgenomen van Dialog)
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Aangeroepen nadat een gebeurtenis naar alle bovenliggende items is gebeld en niet is verwerkt. (Overgenomen van Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Aangeroepen voordat een gebeurtenis wordt gebeld naar het bovenliggende item. (Overgenomen van Dialog)
RecognizeTokenAsync(OAuthPromptSettings, DialogContext, CancellationToken)	Gedeelde implementatie van de functie RecognizeTokenAsync. Dit is bedoeld voor intern gebruik om de implementatie van OAuthPrompt en OAuthInput te consolideren. Toepassingslogica moet deze dialoogvensterklassen gebruiken.
RegisterSourceLocation(String, Int32)	Registreert een cref="SourceRange"/> op de opgegeven locatie. (Overgenomen van Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	Wordt aangeroepen wanneer het dialoogvenster de gebruiker opnieuw om invoer moet vragen. (Overgenomen van Dialog)
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)	Wordt aangeroepen wanneer een onderliggend dialoogvenster deze wending heeft voltooid, zodat het besturingselement wordt teruggezet naar dit dialoogvenster. (Overgenomen van Dialog)
SendOAuthCardAsync(OAuthPromptSettings, ITurnContext, IMessageActivity, CancellationToken)	Gedeelde implementatie van de functie SendOAuthCardAsync. Dit is bedoeld voor intern gebruik om de implementatie van OAuthPrompt en OAuthInput te consolideren. Toepassingslogica moet deze dialoogvensterklassen gebruiken.
SetCallerInfoInDialogState(IDictionary<String,Object>, ITurnContext)	Gedeelde implementatie van de functie SetCallerInfoInDialogState. Dit is bedoeld voor intern gebruik om de implementatie van OAuthPrompt en OAuthInput te consolideren. Toepassingslogica moet deze dialoogvensterklassen gebruiken.
SignOutUserAsync(ITurnContext, CancellationToken)	De gebruiker afmelden.

Extensiemethoden

RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

Hiermee maakt u een dialoogvensterstack en start u een dialoogvenster, waarbij deze naar de stack wordt gepusht.