OidcProvider class

A provider for OIDC OAuth

Constructors

OidcProvider({required String providerId, required OidcProviderButtonStyle style, Map<String, String> customParameters = const {}, Set<String> scopes = const {}, ValueGetter<Future<OidcToken>>? getToken})
Constructor

Properties

auth ↔ FirebaseAuth
The FirebaseAuth instance used to perform authentication against. By default, FirebaseAuth.instance is used.
getter/setter pairinherited
authListener ↔ OAuthListener
An instance of the AuthListener that is used to notify about the current state of the authentication process.
getter/setter pairinherited
defaultRedirectUri → String
no setterinherited
desktopSignInArgs → ProviderArgs
no setter
firebaseAuthProvider → OAuthProvider
final
getToken → ValueGetter<Future<OidcToken>>?
A custom getter for the ID token
final
hashCode → int
The hash code for this object.
no setterinherited
providerId → String
String identifer of the auth provider, for example: 'password', 'phone' or 'google.com'.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldUpgradeAnonymous → bool
Indicates whether the user should be upgraded and new credential should be linked.
no setterinherited
style → OidcProviderButtonStyle
An object that is being used to resolve a style of the button.
final

Methods

desktopSignIn(AuthAction action) → void
Handles authentication logic on desktop platforms
findProvidersForEmail(String email, [AuthCredential? credential]) → void
Fetches available providers for the given email.
inherited
fromDesktopAuthResult(AuthResult result) → OAuthCredential
Creates OAuthCredential based on AuthResult.
linkWithCredential(OAuthCredential credential) → void
Links a provided AuthCredential with the currently signed in user account.
inherited
logOutProvider() → Future<void>
mobileSignIn(AuthAction action) → void
Handles authentication logic on mobile platforms.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onCredentialReceived(OAuthCredential credential, AuthAction action) → void
A method that is called when the user has successfully completed the authentication process and decides what to do with the obtained credential.
inherited
platformSignIn(TargetPlatform platform, AuthAction action) → void
Redirects the flow to the mobileSignIn or desktopSignIn based on current platform.
signIn(TargetPlatform platform, AuthAction action) → void
inherited
signInWithCredential(OAuthCredential credential) → void
Signs the user in with the provided AuthCredential.
inherited
supportsPlatform(TargetPlatform platform) → bool
Supported on platforms that support the official Firebase plugins
toString() → String
A string representation of this object.
inherited

Operators

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