ImportUserRecord.Builder

public static class ImportUserRecord.Builder extends Object

Public Method Summary

ImportUserRecord.Builder	addAllUserProviders(List<UserProvider> providers) Associates all user provider's in the given list with this user.
ImportUserRecord.Builder	addUserProvider(UserProvider provider) Adds a user provider to be associated with this user.
ImportUserRecord	build() Builds a new ImportUserRecord.
ImportUserRecord.Builder	putAllCustomClaims(Map<String, Object> customClaims) Sets the custom claims associated with this user.
ImportUserRecord.Builder	putCustomClaim(String key, Object value) Sets the specified custom claim on this user account.
ImportUserRecord.Builder	setDisabled(boolean disabled) Sets whether the user account should be disabled by default or not.
ImportUserRecord.Builder	setDisplayName(String displayName) Sets the display name for the user.
ImportUserRecord.Builder	setEmail(String email) Sets an email address for the user.
ImportUserRecord.Builder	setEmailVerified(boolean emailVerified) Sets whether the user email address has been verified or not.
ImportUserRecord.Builder	setPasswordHash(byte[] passwordHash) Sets a byte array representing the user's hashed password.
ImportUserRecord.Builder	setPasswordSalt(byte[] passwordSalt) Sets a byte array representing the user's password salt.
ImportUserRecord.Builder	setPhoneNumber(String phoneNumber) Sets the phone number associated with this user.
ImportUserRecord.Builder	setPhotoUrl(String photoUrl) Sets the photo URL for the user.
ImportUserRecord.Builder	setUid(String uid) Sets a user ID for the user.
ImportUserRecord.Builder	setUserMetadata(UserMetadata userMetadata) Sets additional metadata about the user.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public ImportUserRecord.Builder addAllUserProviders (List<UserProvider> providers)

Associates all user provider's in the given list with this user.

Parameters

providers	A list of UserProvider instances.

Returns

• This builder.

public ImportUserRecord.Builder addUserProvider (UserProvider provider)

Adds a user provider to be associated with this user.

A UserProvider represents the identity of the user as specified by an identity provider that is linked to this user account. The identity provider can specify its own values for common user attributes like email, display name and photo URL.

Parameters

provider	A non-null UserProvider.

Returns

• This builder.

public ImportUserRecord build ()

Builds a new ImportUserRecord.

Returns

• A non-null ImportUserRecord.

public ImportUserRecord.Builder putAllCustomClaims (Map<String, Object> customClaims)

Sets the custom claims associated with this user.

Parameters

customClaims	a Map of custom claims

public ImportUserRecord.Builder putCustomClaim (String key, Object value)

Sets the specified custom claim on this user account.

Parameters

key	Name of the claim.
value	Value of the claim.

Returns

• This builder.

public ImportUserRecord.Builder setDisabled (boolean disabled)

Sets whether the user account should be disabled by default or not.

Parameters

disabled	a boolean indicating whether the account should be disabled.

Returns

• This builder.

public ImportUserRecord.Builder setDisplayName (String displayName)

Sets the display name for the user.

Parameters

displayName	a non-null, non-empty display name string.

Returns

• This builder.

public ImportUserRecord.Builder setEmail (String email)

Sets an email address for the user.

Parameters

email	a non-null, non-empty email address string.

Returns

• This builder.

public ImportUserRecord.Builder setEmailVerified (boolean emailVerified)

Sets whether the user email address has been verified or not.

Parameters

emailVerified	a boolean indicating the email verification status.

Returns

• This builder.

public ImportUserRecord.Builder setPasswordHash (byte[] passwordHash)

Sets a byte array representing the user's hashed password. If at least one user account carries a password hash, a UserImportHash must be specified when calling the importUsersAsync(List, UserImportOptions) method. See setHash(UserImportHash).

Parameters

passwordHash	A byte array.

Returns

• This builder.

public ImportUserRecord.Builder setPasswordSalt (byte[] passwordSalt)

Sets a byte array representing the user's password salt.

Parameters

passwordSalt	A byte array.

Returns

• This builder.

public ImportUserRecord.Builder setPhoneNumber (String phoneNumber)

Sets the phone number associated with this user.

Parameters

phoneNumber	a valid phone number string.

Returns

• This builder.

public ImportUserRecord.Builder setPhotoUrl (String photoUrl)

Sets the photo URL for the user.

Parameters

photoUrl	a non-null, non-empty URL string.

Returns

• This builder.

public ImportUserRecord.Builder setUid (String uid)

Sets a user ID for the user.

Parameters

uid	a non-null, non-empty user ID that uniquely identifies the user. The user ID must not be longer than 128 characters.

Returns

• This builder.

public ImportUserRecord.Builder setUserMetadata (UserMetadata userMetadata)

Sets additional metadata about the user.

Parameters

userMetadata	A UserMetadata instance.

Returns

• This builder.