public final class User extends java.lang.Object implements java.io.Serializable, java.lang.Comparable<User>
User
represents a specific user, represented by the
combination of an email address and a specific Google Apps domain
(which we call an authDomain
). For normal Google login,
authDomain
will be set to "gmail.com".Constructor and Description |
---|
User(java.lang.String email,
java.lang.String authDomain)
Creates a new User.
|
User(java.lang.String email,
java.lang.String authDomain,
java.lang.String userId)
Creates a new User.
|
User(java.lang.String email,
java.lang.String authDomain,
java.lang.String userId,
java.lang.String federatedIdentity)
Creates a new User with a federated identity.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(User user) |
boolean |
equals(java.lang.Object object) |
java.lang.String |
getAuthDomain() |
java.lang.String |
getEmail() |
java.lang.String |
getFederatedIdentity() |
java.lang.String |
getNickname()
Return this user's nickname.
|
java.lang.String |
getUserId()
Returns an opaque string that uniquely identifies the user
represented by this
User object. |
int |
hashCode() |
java.lang.String |
toString() |
public User(java.lang.String email, java.lang.String authDomain)
email
- a not null
email address.authDomain
- a not null
domain name into which this
user has authenticated, or "gmail.com" for normal Google
authentication.public User(java.lang.String email, java.lang.String authDomain, java.lang.String userId)
email
- a not null
email address.authDomain
- a not null
domain name into which this
user has authenticated, or "gmail.com" for normal Google
authentication.userId
- a possibly-null string uniquely identifying the specified user.public User(java.lang.String email, java.lang.String authDomain, java.lang.String userId, java.lang.String federatedIdentity)
email
- an optional field holding the user's email.authDomain
- the URL of the identity provider. Could be null.userId
- a unique id for this user. Could be null.federatedIdentity
- a not null
asserted federated identity.public java.lang.String getNickname()
public java.lang.String getAuthDomain()
public java.lang.String getEmail()
public java.lang.String getUserId()
User
object.
May be null if this User
object was created explicitly
and no user ID was supplied.
public java.lang.String getFederatedIdentity()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object