Authgear class

Constructors

Authgear({required String clientID, required String endpoint, String name = "default", bool isSsoEnabled = false, bool preAuthenticatedURLEnabled = false, TokenStorage? tokenStorage, UIImplementation? uiImplementation, Client? httpClient})

Properties

accessToken → String?
no setter
authTime → DateTime?
no setter
canReauthenticate → bool
no setter
clientID → String
final
endpoint → String
final
experimental ↔ AuthgearExperimental
latefinal
hashCode → int
The hash code for this object.
no setterinherited
idTokenHint → String?
no setter
isSsoEnabled → bool
final
name → String
final
onSessionStateChange → Stream<SessionStateChangeEvent>
no setter
preAuthenticatedURLEnabled → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionState → SessionState
no setter
shouldRefreshAccessToken → bool
no setter

Methods

addEmail({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
addPhone({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
addUsername({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
authenticate({required String redirectURI, List<PromptOption>? prompt, List<String>? uiLocales, ColorScheme? colorScheme, AuthenticationPage? page, String? oauthProviderAlias, String? wechatRedirectURI, String? authenticationFlowGroup}) → Future<UserInfo>
authenticateAnonymously() → Future<UserInfo>
authenticateBiometric({required BiometricOptionsIOS ios, required BiometricOptionsAndroid android}) → Future<UserInfo>
changeEmail({required String redirectURI, required String originalEmail, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
changePassword({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
changePhoneNumber({required String redirectURI, required String originalPhoneNumber, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
changeUsername({required String redirectURI, required String originalUsername, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
checkBiometricSupported({required BiometricOptionsIOS ios, required BiometricOptionsAndroid android}) → Future<void>
configure() → Future<void>
deleteAccount({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<void>
disableBiometric() → Future<void>
enableBiometric({required BiometricOptionsIOS ios, required BiometricOptionsAndroid android}) → Future<void>
getUserInfo() → Future<UserInfo>
internalBuildAuthorizationURL(OIDCAuthenticationRequest oidcRequest) → Future<Uri>
internalCreateAuthenticateRequest(AuthenticateOptions options) → Future<InternalAuthenticateRequest>
internalCreateReauthenticateRequest(String idTokenHint, ReauthenticateOptions options) → Future<InternalAuthenticateRequest>
internalCreateSettingsActionRequest(String clientID, String idTokenHint, String loginHint, SettingsActionOptions options) → Future<InternalAuthenticateRequest>
internalFinishAuthentication({required Uri url, required String redirectURI, required CodeVerifier codeVerifier}) → Future<UserInfo>
internalGenerateURL({required String redirectURI, List<String>? uiLocales, ColorScheme? colorScheme, String? wechatRedirectURI}) → Future<Uri>
isBiometricEnabled() → Future<bool>
logout({bool force = false}) → Future<void>
makePreAuthenticatedURL({required String webApplicationClientID, required String webApplicationURI, String? state}) → Future<Uri>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open({required SettingsPage page, List<String>? uiLocales, ColorScheme? colorScheme, String? wechatRedirectURI}) → Future<void>
openURL({required String url, String? wechatRedirectURI}) → Future<void>
promoteAnonymousUser({required String redirectURI, String? wechatRedirectURI, List<String>? uiLocales, ColorScheme? colorScheme}) → Future<UserInfo>
reauthenticate({required String redirectURI, int maxAge = 0, List<String>? uiLocales, ColorScheme? colorScheme, String? oauthProviderAlias, String? wechatRedirectURI, BiometricOptionsIOS? biometricIOS, BiometricOptionsAndroid? biometricAndroid, String? authenticationFlowGroup}) → Future<UserInfo>
refreshAccessToken() → Future<void>
refreshIDToken() → Future<void>
toString() → String
A string representation of this object.
inherited
wechatAuthCallback({required String state, required String code}) → Future<void>
wrapHttpClient(Client inner) → Client

Operators

operator ==(Object other) → bool
The equality operator.
inherited