public
static
final
class
Tenant.UpdateRequest
extends Object| java.lang.Object | |
| ↳ | com.google.firebase.auth.multitenancy.Tenant.UpdateRequest |
Class Overview
A class for updating the attributes of an existing tenant.
An instance of this class can be obtained via a Tenant object, or from a tenant ID
string. Specify the changes to be made to the tenant by calling the various setter methods
available in this class.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
UpdateRequest(String tenantId)
Creates a new
Tenant.UpdateRequest, which can be used to update the attributes of the
of the tenant identified by the specified tenant ID. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Tenant.UpdateRequest |
setDisplayName(String displayName)
Sets the display name of the existing tenant.
| ||||||||||
| Tenant.UpdateRequest |
setEmailLinkSignInEnabled(boolean emailLinkSignInEnabled)
Sets whether to enable email link user authentication.
| ||||||||||
| Tenant.UpdateRequest |
setPasswordSignInAllowed(boolean passwordSignInAllowed)
Sets whether to allow email/password user authentication.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public UpdateRequest (String tenantId)
Creates a new Tenant.UpdateRequest, which can be used to update the attributes of the
of the tenant identified by the specified tenant ID.
This method allows updating attributes of a tenant account, without first having to call
getTenant(String).
Parameters
| tenantId | a non-null, non-empty tenant ID string. |
|---|
Throws
| IllegalArgumentException | If the tenant ID is null or empty. |
|---|
Public Methods
public Tenant.UpdateRequest setDisplayName (String displayName)
Sets the display name of the existing tenant.
Parameters
| displayName | a non-null, non-empty display name string. |
|---|
public Tenant.UpdateRequest setEmailLinkSignInEnabled (boolean emailLinkSignInEnabled)
Sets whether to enable email link user authentication.
Parameters
| emailLinkSignInEnabled | a boolean indicating whether users can be authenticated using an email link. |
|---|
public Tenant.UpdateRequest setPasswordSignInAllowed (boolean passwordSignInAllowed)
Sets whether to allow email/password user authentication.
Parameters
| passwordSignInAllowed | a boolean indicating whether users can be authenticated using an email and password. |
|---|