java.lang.Object | |
↳ | com.google.android.gms.auth.api.signin.GoogleSignInAccount |
Class that holds the basic account information of the signed in Google user.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
A convenient wrapper for
getEmail() which returns an android.accounts.Account object. | |||||||||||
Returns the display name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or with requestProfile() configured; null otherwise. | |||||||||||
Returns the email address of the signed in user if
requestEmail() was configured; null otherwise. | |||||||||||
Returns the family name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or with requestProfile() configured; null otherwise. | |||||||||||
Returns the given name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or with requestProfile() configured; null otherwise. | |||||||||||
Returns all scopes that have been authorized to your application.
| |||||||||||
Returns the unique ID for the Google account if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or with requestId() configured; null otherwise. | |||||||||||
Returns an ID token that you can send to your server if
requestIdToken(String) was configured; null otherwise. | |||||||||||
Returns the photo url of the signed in user if the user has a profile picture and you built
your configuration either starting from
new
GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or with requestProfile() configured; null otherwise. | |||||||||||
Returns a one-time server auth code to send to your web server which can be exchanged for
access token and sometimes refresh token if
requestServerAuthCode(String) is configured; null otherwise. | |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Parameters | |
---|---|
obj |
Object |
Returns | |
---|---|
boolean |
A convenient wrapper for getEmail()
which returns an android.accounts.Account object.
See getEmail()
doc for details.
Returns | |
---|---|
Account |
Returns the display name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with requestProfile()
configured; null
otherwise. Not guaranteed
to be present for all users, even when configured.
Returns | |
---|---|
String |
Returns the email address of the signed in user if requestEmail()
was configured; null
otherwise.
Applications should not key users by email address since a Google account's email address
can change. Use getId()
as a key instead.
Important: Do not use this returned email address to communicate the currently signed in
user to your backend server. Instead, send an ID token (requestIdToken(String)
), which can be securely validated on the server; or
send server auth code (requestServerAuthCode(String)
) which can be
in turn exchanged for id token.
See Authenticate with a backend server for details.
Returns | |
---|---|
String |
Returns the family name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with requestProfile()
configured; null
otherwise. Not guaranteed
to be present for all users, even when configured.
Returns | |
---|---|
String |
Returns the given name of the signed in user if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with requestProfile()
configured; null
otherwise. Not guaranteed
to be present for all users, even when configured.
Returns | |
---|---|
String |
Returns all scopes that have been authorized to your application.
This can be a larger set than what you have requested via GoogleSignInOptions
. We
recommend apps requesting minimum scopes at user sign in time and later requesting additional
scopes incrementally when user is using a certain feature. For those apps following this
incremental auth practice, they can use the returned scope set to determine all authorized
scopes (across platforms and app re-installs) to turn on bonus features accordingly. The
returned set can also be larger due to other scope handling logic.
Returns | |
---|---|
Set<Scope> |
Returns the unique ID for the Google account if you built your configuration starting from
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with requestId()
configured; null
otherwise.
This is the preferred unique key to use for a user record.
Important: Do not use this returned Google ID to communicate the currently signed in user to
your backend server. Instead, send an ID token (requestIdToken(String)
), which can be securely validated on the server; or
send a server auth code (requestServerAuthCode(String)
) which can
be in turn exchanged for id token.
See Authenticate with a backend server for details.
Returns | |
---|---|
String |
Returns an ID token that you can send to your server if requestIdToken(String)
was configured; null
otherwise.
ID token is a JSON Web Token signed by Google that can be used to identify a user to a backend.
Returns | |
---|---|
String |
Returns the photo url of the signed in user if the user has a profile picture and you built
your configuration either starting from new
GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with requestProfile()
configured; null
otherwise. Not guaranteed
to be present for all users, even when configured.
Returns | |
---|---|
Uri |
Returns a one-time server auth code to send to your web server which can be exchanged for
access token and sometimes refresh token if requestServerAuthCode(String)
is configured; null
otherwise. for details.
Returns | |
---|---|
String |
See also:
Returns | |
---|---|
int |
Parameters | |
---|---|
out |
Parcel |
flags |
int |