ClientOptions class
The options for the underlying SDK on the web platform.
Constructors
-
ClientOptions({required Account account, int? authorizeTimeoutInSeconds, CacheLocation? cacheLocation, String? cookieDomain, int? httpTimeoutInSeconds, bool? useLegacySameSiteCookie, int? sessionCheckExpiryInDays, bool? useCookiesForTransactions, bool? useFormData, bool? useRefreshTokens, bool? useRefreshTokensFallback, IdTokenValidationConfig? idTokenValidationConfig, String? audience, Set<
String> ? scopes, Map<String, String> parameters = const {}})
Properties
- account → Account
-
The account to use, including the
domain
andclientId
values.final - audience → String?
-
The default audience to be used for requesting API access.
final
-
A maximum number of seconds to wait before declaring background calls to
/authorize
as failed for timeout. Defaults to60
seconds.final - cacheLocation → CacheLocation?
-
The location to use when storing cache data. Valid values are
memory
orlocalstorage
. Defaults tomemory
.final -
The domain the cookie is accessible from.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpTimeoutInSeconds → int?
-
The timeout for HTTP calls using fetch.
final
- idTokenValidationConfig → IdTokenValidationConfig?
-
The configuration for validating ID tokens.
final
-
parameters
→ Map<
String, String> -
The default additional parameters to be sent to Auth0.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopes
→ Set<
String> ? -
The default scopes to be used on authentication requests.
final
- sessionCheckExpiryInDays → int?
-
The number of days until the cookie
auth0.is.authenticated
will expire.final - useCookiesForTransactions → bool?
-
Whether the SDK will use a cookie for transaction storage, instead of
session storage.
final
- useFormData → bool?
-
Whether
application/x-www-form-urlencoded
content type is used in the request to the token endpoint.final - useLegacySameSiteCookie → bool?
-
Whether an additional cookie with no SameSite attribute is set.
final
- useRefreshTokens → bool?
-
Whether refresh tokens are used to fetch new access tokens from the Auth0
server.
final
- useRefreshTokensFallback → bool?
-
Whether the client falls back to the technique of using a hidden iframe
and the authorization code grant with
prompt=none
when unable to use refresh tokens.final
Methods
-
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