java.lang.Object | |
↳ | com.google.android.gms.auth.api.signin.GoogleSignInOptions.Builder |
Builder for GoogleSignInOptions
,
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Default Builder for
GoogleSignInOptions which starts with clean configuration. | |||||||||||
A Builder for
GoogleSignInOptions which you can specify one of the default
configurations Google (will) provide and make additional configurations based on it. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Specifies additional sign-in options via the given extension.
| |||||||||||
Builds the
GoogleSignInOptions object. | |||||||||||
Specifies that email info is requested by your application.
| |||||||||||
Specifies that user ID is requested by your application.
| |||||||||||
Specifies that an ID token for authenticated users is requested.
| |||||||||||
Specifies that user's profile info is requested by your application.
| |||||||||||
Specifies OAuth 2.0 scopes your application requests.
| |||||||||||
Specifies that offline access is requested.
| |||||||||||
Specifies that offline access is requested.
| |||||||||||
Specifies an account name on the device that should be used.
| |||||||||||
Specifies a hosted domain restriction.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Default Builder for GoogleSignInOptions
which starts with clean configuration.
If you are trying to implement Sign In, i.e. you want to get back user identity, you can
start with new GoogleSignInOptions(GoogleSignInOptions.DEFAULT_SIGN_IN)
,
A Builder for GoogleSignInOptions
which you can specify one of the default
configurations Google (will) provide and make additional configurations based on it.
e.g.DEFAULT_SIGN_IN
.
Parameters | |
---|---|
googleSignInOptions |
GoogleSignInOptions
|
Specifies additional sign-in options via the given extension.
Parameters | |
---|---|
extension |
GoogleSignInOptionsExtension :
A sign-in extension used to further configure API specific sign-in
options. Supported values include:
Games.GamesOptions .
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Builds the GoogleSignInOptions
object.
Returns | |
---|---|
GoogleSignInOptions |
a GoogleSignInOptions instance.
|
Specifies that email info is requested by your application. Note that we don't recommend keying user by email address since email address might change. Keying user by ID is the preferable approach.
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies that user ID is requested by your application.
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies that an ID token for authenticated users is requested. Requesting an ID token requires that the server client ID be specified.
Parameters | |
---|---|
serverClientId |
String :
The client ID of the server that will verify the integrity of the
token.
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies that user's profile info is requested by your application.
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies OAuth 2.0 scopes your application requests. See Scopes
for more
information.
Parameters | |
---|---|
scope |
Scope :
An OAuth 2.0 scope requested by your app. |
scopes |
Scope :
More OAuth 2.0 scopes requested by your app.
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies that offline access is requested. Requesting offline access requires that the server client ID be specified.
You don't need to use requestIdToken(String)
when you use this option. When your
server exchanges the code for tokens, an ID token will be returned together (as long as
you either use requestEmail()
or requestProfile()
along with your configuration).
The first time you retrieve a code, a refresh_token will be granted automatically. Subsequent requests will only return codes that can be exchanged for access token.
Parameters | |
---|---|
serverClientId |
String :
The client ID of the server that will need the auth code.
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies that offline access is requested. Requesting offline access requires that the server client ID be specified.
You don't need to use requestIdToken(String)
when you use this option. When your
server exchanges the code for tokens, an ID token will be returned together (as long as
you either use requestEmail()
or requestProfile()
along with this configuration).
Parameters | |
---|---|
serverClientId |
String :
The client ID of the server that will need the auth code. |
forceCodeForRefreshToken |
boolean :
If true, the granted code can be exchanged for an access
token and a refresh token. The first time you retrieve a code, a refresh_token will
be granted automatically. Subsequent requests will require additional user consent.
Use false by default; only use true if your server has suffered some failure and
lost the user's refresh token.
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies an account name on the device that should be used. If this is never called, the client will use the current default account for this application.
Parameters | |
---|---|
accountName |
String :
The account name on the device that should be used to sign in.
|
Returns | |
---|---|
GoogleSignInOptions.Builder |
Specifies a hosted domain restriction. By setting this, sign in will be restricted to accounts of the user in the specified domain.
Parameters | |
---|---|
hostedDomain |
String :
domain of the user to restrict (for example, "mycollege.edu"),
|
Returns | |
---|---|
GoogleSignInOptions.Builder |