AuthUaePass class - auth_uae_pass library

Constructors

AuthUaePass({UaePassConfig? config, void onEvent(UaePassEvent event)?, Client? httpClient}): const

Properties

config → UaePassConfig?: Optional configuration for UAE Pass service. If provided, methods like signInWithProfile will use these credentials.
final
hashCode → int: The hash code for this object.
no setterinherited
onEvent → void Function(UaePassEvent event)?: Optional callback to listen for SDK events (analytics, haptics, etc.).
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

authenticate(BuildContext context, {required UaePassAuthRequest request, void onEvent(UaePassEvent)?}) → Future<UaePassAuthResult>
authenticateWithResumption(BuildContext context, {required Uri deepLink, required UaePassAuthRequest originalRequest}) → Future<UaePassAuthResult>: Use this when the app is restarted via a deep link (cold start) or when the main flow was interrupted. It extracts the nested URL and opens a new WebView to complete the authentication.
getAccessToken({required UaePassAccessTokenRequest request}) → Future<UaePassUserToken?>
getUserProfile({required UaePassUserProfileRequest request}) → Future<UaePassUserProfile?>: GET userInfoUrl with Authorization: Bearer <access_token> (client or validated token).
introspectToken({required UaePassIntrospectRequest request}) → Future<UaePassIntrospectResult?>: Verifies an access token via idhub introspect using Basic auth (SP credentials).
isAppInstalled([UaePassEnvironment? environment]) → Future<bool>: Probes whether the UAE PASS app is installed on this device.
listenToDeepLinks({required BuildContext context, required UaePassAuthRequest defaultRequest, required void onResult(UaePassAuthResult), bool autoResumeOnColdStart = false}) → StreamSubscription<Uri>?
logout(BuildContext context, {UaePassEnvironment? environment, String? redirectUri, UaePassConfig? configOverride}) → Future<UaePassAuthResult>
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
signIn(BuildContext context, {required UaePassAuthRequest request}) → Future<String?>
signInWithProfile(BuildContext context, {String? clientId, String? clientSecret, String? redirectUri, UaePassEnvironment? environment, String? uiLocale, String? deepLinkScheme, String? acrValues, List<String> cancelledUriPatterns = const <String>[], UaePassConfig? configOverride}) → Future<UaePassAuthData>: A simplified high-level method to perform the full UAE PASS authentication flow.
toString() → String: A string representation of this object.
inherited
upgradeToSOP3(BuildContext context, {String? clientId, String? clientSecret, String? redirectUri, UaePassEnvironment? environment, String? uiLocale, String? deepLinkScheme}) → Future<UaePassAuthData>: Specialized method to trigger a FaceID/Biometric upgrade flow.

Operators

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

Static Properties

instance → AuthUaePass: Returns the global singleton instance of AuthUaePass.
no setter

Static Methods

authorizationUrl({required UaePassEnvironment environment, required String clientId, required String redirectUri, required String uiLocales, String? acrValues}) → String: Authorize URL (acr_values applied by package when environment is set).
clearCapturedLink() → void: Clears any buffered deep links.
initialize(UaePassConfig config, {void onEvent(UaePassEvent)?}) → void: Initializes the global AuthUaePass singleton with your configuration.
listenToDeepLinkStream() → Stream<Uri>: Returns the global deep link stream.
logoutUrl({required UaePassEnvironment environment, required String redirectUri}) → String
onDeepLinkReceived(Uri uri) → void: Call this from your app's deep link listener (e.g. app_links or uni_links) when a URL with your custom scheme is received.
reset() → void: For testing purposes only. Resets the internal static state.