OAuthFlow Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates a new prompt that asks the user to sign in using the Token Service. service.
public class OAuthFlowtype OAuthFlow = classPublic Class OAuthFlow- Inheritance
-
OAuthFlow
Remarks
The prompt will attempt to retrieve the users current token and if the user isn't signed in, it will send them an `OAuthCard|SigninCard` containing a button they can press to signin. Depending on the channel, the user will be sent through one of two possible signin flows:
- The automatic signin flow where once the user signs in and the SSO service will forward the Agent the users access token using either an `event` or `invoke` activity.
- The "magic code" flow where once the user signs in they will be prompted by the SSO service to send the Agent a six digit code confirming their identity. This code will be sent as a standard `message` activity.
Both flows are automatically supported by the `OAuthFlow` and the only thing you need to be careful of is that you don't block the `event` and `invoke` activities that the prompt might be waiting on.
Constructors
| Name | Description |
|---|---|
| OAuthFlow(OAuthSettings) |
Creates a new prompt that asks the user to sign in using the Token Service. service. |
Properties
| Name | Description |
|---|---|
| Settings | |
Methods
| Name | Description |
|---|---|
| BeginFlowAsync(ITurnContext, Func<Task<IActivity>>, CancellationToken) | |
| ChannelRequiresSignInLink(ChannelId) | |
| ContinueFlowAsync(ITurnContext, DateTime, CancellationToken) |
Called when a prompt dialog is the active dialog and the user replied with a new activity. |
| IsSignInFailureInvoke(ITurnContext) | |
| IsTokenExchangeRequestInvoke(ITurnContext) | |
| IsTokenResponseEvent(ITurnContext) | |
| IsVerificationInvoke(ITurnContext) | |
| SignOutUserAsync(ITurnContext, CancellationToken) |
Signs out the user. |