OAuthConfiguration class
- Inheritance
-
- Object
- BaseConfiguration
- OAuthConfiguration
Constructors
-
OAuthConfiguration({required String authorizationEndpointUrl, required String tokenEndpointUrl, required String redirectUrl, String? baseUrl, required String clientId, String? clientSecret, String? delimiter, bool? basicAuth, Client? httpClient, List<
String> ? scopes, String? loginHint, List<String> ? promptValues, ValueChanged<Credentials> ? onSuccessAuth, ValueChanged? onError, VoidCallback? onCancel, CertificateValidator? onCertificateValidate, Map<String, String> ? headers, Stream<String> ? urlStream, ThemeData? themeData, Map<String, String> ? textLocales, Locale? contentLocale, bool? goBackBtnVisible, bool? goForwardBtnVisible, bool? refreshBtnVisible, bool? clearCacheBtnVisible, bool? closeBtnVisible}) -
const
Properties
-
A URL provided by the authorization server that serves as the base for the
URL that the resource owner will be redirected to to authorize this
client.
final
- backButtonTooltip → String?
-
no setterinherited
- baseUrl → String?
-
It is another redirectUrl to be used by the authorization server when the
user decides to go back to application instead of completing
authorization flow.
final
- basicAuth → bool?
-
Whether to use HTTP Basic authentication for authorizing the client.
final
- clearCacheBtnVisible → bool
-
finalinherited
- clearCacheButtonTooltip → String?
-
no setterinherited
- clearCacheWarningMessage → String?
-
no setterinherited
- clientId → String
-
The client identifier for this client.
final
- clientSecret → String?
-
The client secret for this client.
final
- closeBtnVisible → bool
-
finalinherited
- closeButtonTooltip → String?
-
no setterinherited
- contentLocale → Locale?
-
Not available for Web
finalinherited
- delimiter → String?
-
A String used to separate scopes; defaults to
" ".final - forwardButtonTooltip → String?
-
no setterinherited
- goBackBtnVisible → bool
-
finalinherited
- goForwardBtnVisible → bool
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
→ Map<
String, String> -
Not available for Web
finalinherited
- httpClient → Client?
-
The HTTP client used to make HTTP requests.
final
- initialUrl → String
-
finalinherited
- loginHint → String?
-
/// Hint to the Authorization Server about the login identifier the End-User might use to log in.
final
- onCancel → VoidCallback?
-
This function will be called when user cancels authentication.
finalinherited
- onCertificateValidate → CertificateValidator?
-
This function will be called when authorizationEndpointUrl is first loaded.
If false is returned then a CertificateException() will be thrown
Not available for Web
finalinherited
- onError → ValueChanged?
-
This function will be called if any error occurs.
It will receive the error data which could be some Exception or Error
finalinherited
-
onSuccessAuth
→ ValueChanged<
Credentials> ? -
This function will be called when user successfully authenticates.
It will receive the OAuth Credentials
final
-
onSuccessRedirect
→ ValueChanged<
String> ? -
This function will be called when any of the redirectUrls is loaded in web view.
It will pass the url it causes redirect.
finalinherited
-
promptValues
→ List<
String> ? -
List of ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.
e.g: promptValues:
'login'. In this case it prompts the user login even if they have already signed in. The list of supported values depends on the identity provider.final - redirectUrl → String
-
The redirectUrl to which the authorization server will redirect to when
authorization flow completes.
final
-
redirectUrls
→ List<
String> -
finalinherited
- refreshBtnVisible → bool
-
finalinherited
- reloadButtonTooltip → String?
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopes
→ List<
String> ? -
The scopes that the client is requesting access to.
final
-
textLocales
→ Map<
String, String> ? -
Not available for Web
finalinherited
- themeData → ThemeData?
-
Not available for Web
finalinherited
- tokenEndpointUrl → String
-
A URL provided by the authorization server that this library uses to
obtain long-lasting credentials.
final
-
urlStream
→ Stream<
String> ? -
Use this stream when you need to asynchronously navigate to a specific url
Not available for Web
finalinherited
Methods
-
copyWith(
{String? authorizationEndpointUrl, String? tokenEndpointUrl, String? redirectUrl, String? baseUrl, String? clientId, String? clientSecret, String? delimiter, bool? basicAuth, Client? httpClient, List< String> ? scopes, String? loginHint, List<String> ? promptValues, ValueChanged<Credentials> ? onSuccessAuth, String? initialUrl, List<String> ? redirectUrls, ValueChanged<String> ? onSuccessRedirect, ValueChanged? onError, VoidCallback? onCancel, CertificateValidator? onCertificateValidate, Map<String, String> ? headers, Stream<String> ? urlStream, ThemeData? themeData, Map<String, String> ? textLocales, Locale? contentLocale, bool? goBackBtnVisible, bool? goForwardBtnVisible, bool? refreshBtnVisible, bool? clearCacheBtnVisible, bool? closeBtnVisible}) → OAuthConfiguration -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited