GithubAuthProvider class
This class should be used to either create a new GitHub credential with an access code, or use the provider to trigger user authentication flows.
For example, on web based platforms pass the provider to a Firebase method
(such as signInWithPopup):
var githubProvider = GithubAuthProvider();
githubProvider.addScope('repo');
githubProvider.setCustomParameters({
'allow_signup': 'false',
});
FirebaseAuth.instance.signInWithPopup(githubProvider)
.then(...);
If authenticating with GitHub via a 3rd party, use the returned
accessToken to sign-in or link the user with the created credential, for
example:
String accessToken = '...'; // From 3rd party provider
var githubAuthCredential = GithubAuthProvider.credential(accessToken);
FirebaseAuth.instance.signInWithCredential(githubAuthCredential)
.then(...);
- Inheritance
-
- Object
- AuthProvider
- GithubAuthProvider
Constructors
- GithubAuthProvider()
- Creates a new instance.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
parameters
→ Map<
String, String> -
Returns the parameters for this provider instance.
no setter
- providerId → String
-
The provider ID.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopes
→ List<
String> -
Returns the currently assigned scopes to this provider instance.
no setter
Methods
-
addScope(
String scope) → GithubAuthProvider - Adds GitHub OAuth scope.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setCustomParameters(
Map< String, String> customOAuthParameters) → GithubAuthProvider - Sets the OAuth custom parameters to pass in a GitHub OAuth request for popup and redirect sign-in operations.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- GITHUB_SIGN_IN_METHOD → String
-
This corresponds to the sign-in method identifier.
no setter
- PROVIDER_ID → String
-
no setter
Static Methods
-
credential(
String accessToken) → OAuthCredential -
Create a new GithubAuthCredential from a provided
accessToken;