OAuthUserCredential class final
A credential that access OAuth token-secured ArcGIS resources using an OAuthUserConfiguration.
The OAuth user credential generates a short-lived access token that gives the user permission to access token-secured ArcGIS content and services, such as the ArcGIS location services.
The OAuth login process presents the user with an OAuth login page. You can configure the look and feel of this login page by setting OAuthUserConfiguration properties, such as OAuthUserConfiguration.showCancelButton or OAuthUserConfiguration.userInterfaceStyle.
If you use this OAuthUserCredential as part of the secure resource challenge handling, it will be stored in the ArcGISCredentialStore of the AuthenticationManager. It will be used by all subsequent requests that have a matching URL context.
- Inheritance
-
- Object
- ArcGISCredential
- OAuthUserCredential
Properties
-
An authorization code to generate the OAuth token.
no setter
- configuration → OAuthUserConfiguration
-
The OAuth configuration details of an application that can sign into an
ArcGIS Online or ArcGIS Enterprise portal using OAuth.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- referer → String
-
The referer used to generate a token.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverContext → Uri
-
The URL by which the root of a server is accessed.
no setterinherited
- username → String
-
The user associated with the credential.
no setterinherited
Methods
-
getTokenInfo(
) → Future< OAuthUserTokenInfo> - Returns an instance of OAuthUserTokenInfo generated by this credential.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
revokeToken(
) → Future< void> - Sends a network request to revoke OAuth refresh and access tokens.
-
toJson(
) → Map< String, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
{required OAuthUserConfiguration configuration}) → Future< OAuthUserCredential> - Creates an OAuthUserCredential with information needed to access an ArcGIS resource. This initiates the OAuth login process by presenting the OAuth login page.