CredentialOption.Builder
public
static
final
class
CredentialOption.Builder
extends Object
A builder for CredentialOption.
Summary
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
Builder
public Builder (String type,
Bundle credentialRetrievalData,
Bundle candidateQueryData)
| Parameters |
|---|
type |
String: the type of the credential option
This value cannot be null. |
credentialRetrievalData |
Bundle: the full request data
This value cannot be null. |
candidateQueryData |
Bundle: the partial request data that will be sent to the provider
during the initial credential candidate query stage.
This value cannot be null. |
Public methods
addAllowedProvider
public CredentialOption.Builder addAllowedProvider (ComponentName allowedProvider)
Adds a provider ComponentName to be queried while gathering credentials from
credential providers on the device.
If no candidate providers are specified, all user configured and system credential
providers will be queried in the candidate query phase.
If an invalid component name is provided, or a service corresponding to the
component name does not exist on the device, that component name is ignored.
If all component names are invalid, or not present on the device, no providers
are queried and no credentials are retrieved.
| Parameters |
|---|
allowedProvider |
ComponentName: This value cannot be null. |
setAllowedProviders
public CredentialOption.Builder setAllowedProviders (Set<ComponentName> allowedProviders)
Sets a set of provider ComponentName to be queried while gathering credentials
from credential providers on the device.
If no candidate providers are specified, all user configured and system credential
providers will be queried in the candidate query phase.
If an invalid component name is provided, or a service corresponding to the
component name does not exist on the device, that component name is ignored.
If all component names are invalid, or not present on the device, no providers
are queried and no credentials are retrieved.
| Parameters |
|---|
allowedProviders |
Set: This value cannot be null. |
setIsSystemProviderRequired
public CredentialOption.Builder setIsSystemProviderRequired (boolean isSystemProviderRequired)
Sets a true/false value corresponding to whether this option must be serviced by
system credentials providers only.
| Parameters |
|---|
isSystemProviderRequired |
boolean |
