This class is deprecated.
Use Credential
Manager for authentication or Google Identity
Services for authorization.
Class that holds the basic account information of the signed in Google user.
Inherited Constant Summary
Field Summary
public static final Creator<GoogleSignInAccount> | CREATOR |
Public Method Summary
boolean | |
Account |
getAccount()
A convenient wrapper for
getEmail() which returns an android.accounts.Account object.
|
String |
getDisplayName()
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
GoogleSignInOptions.Builder.requestProfile() configured;
null otherwise.
|
String |
getEmail()
Returns the email address of the signed in user if
GoogleSignInOptions.Builder.requestEmail() was configured;
null otherwise.
|
String |
getFamilyName()
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
GoogleSignInOptions.Builder.requestProfile() configured;
null otherwise.
|
String |
getGivenName()
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
GoogleSignInOptions.Builder.requestProfile() configured;
null otherwise.
|
Set<Scope> |
getGrantedScopes()
Returns all scopes that have been authorized to your application.
|
String |
getId()
Returns the unique ID for the Google account if you built your configuration
starting from
new
GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) } or
with
GoogleSignInOptions.Builder.requestId() configured;
null otherwise.
|
String |
getIdToken()
Returns an ID token that you can send to your server if
GoogleSignInOptions.Builder.requestIdToken(String) was configured;
null otherwise.
|
Uri |
getPhotoUrl()
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
GoogleSignInOptions.Builder.requestProfile() configured;
null otherwise.
|
String |
getServerAuthCode()
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
GoogleSignInOptions.Builder.requestServerAuthCode(String) is
configured; null otherwise.
|
int |
hashCode()
|
void |
writeToParcel(Parcel out, int
flags)
|
Inherited Method Summary
Fields
public static final Creator<GoogleSignInAccount> CREATOR
Public Methods
public boolean equals (Object obj)
public Account getAccount ()
A convenient wrapper for
getEmail()
which returns an android.accounts.Account object. See
getEmail()
doc for details.
public String getDisplayName ()
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
GoogleSignInOptions.Builder.requestProfile()
configured; null
otherwise. Not guaranteed to be present for all users, even when configured.
public String getEmail ()
Returns the email address of the signed in user if
GoogleSignInOptions.Builder.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 (GoogleSignInOptions.Builder.requestIdToken(String)
),
which can be securely validated on the server; or send server auth code (GoogleSignInOptions.Builder.requestServerAuthCode(String)
)
which can be in turn exchanged for id token.
See Authenticate with a backend server for details.
public String getFamilyName ()
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
GoogleSignInOptions.Builder.requestProfile()
configured; null
otherwise. Not guaranteed to be present for all users, even when configured.
public String getGivenName ()
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
GoogleSignInOptions.Builder.requestProfile()
configured; null
otherwise. Not guaranteed to be present for all users, even when configured.
public Set<Scope> getGrantedScopes ()
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.
public String getId ()
Returns the unique ID for the Google account if you built your configuration
starting from new
GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
} or with
GoogleSignInOptions.Builder.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 (GoogleSignInOptions.Builder.requestIdToken(String)
),
which can be securely validated on the server; or send a server auth code
(GoogleSignInOptions.Builder.requestServerAuthCode(String)
)
which can be in turn exchanged for id token.
See Authenticate with a backend server for details.
public String getIdToken ()
Returns an ID token that you can send to your server if
GoogleSignInOptions.Builder.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.
public Uri getPhotoUrl ()
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
GoogleSignInOptions.Builder.requestProfile()
configured; null
otherwise. Not guaranteed to be present for all users, even when configured.
public String getServerAuthCode ()
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
GoogleSignInOptions.Builder.requestServerAuthCode(String)
is configured;
null
otherwise. for details.