MakeCredentialOptions.Builder | Doclava
public static final class

MakeCredentialOptions.Builder

extends Object
java.lang.Object
   ↳ com.google.android.gms.fido.fido2.api.common.MakeCredentialOptions.Builder

Class Overview

Builds MakeCredentialOptions.

Summary

Public Constructors
MakeCredentialOptions.Builder()
Creates an empty builder.
Public Methods
MakeCredentialOptions build()
MakeCredentialOptions.Builder setAuthenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection)
Sets attachment.
MakeCredentialOptions.Builder setChallenge(byte[] challenge)
Sets challenge.
MakeCredentialOptions.Builder setExcludeList(List<PublicKeyCredentialDescriptor> excludeList)
Sets exclude list.
MakeCredentialOptions.Builder setParameters(List<PublicKeyCredentialParameters> parameters)
Sets scoped credential parameters.
MakeCredentialOptions.Builder setRequestId(Integer requestId)
Sets the request id in order to link together events into a single session (the span of events between the time that the server initiates a single FIDO2 request to the client and receives reply) on a single device.
MakeCredentialOptions.Builder setRp(PublicKeyCredentialEntity rp)
Sets information for a relying party, on whose behalf a given registration operation is being performed.
MakeCredentialOptions.Builder setTimeoutSeconds(Double timeoutSeconds)
Sets timeout in seconds.
MakeCredentialOptions.Builder setTokenBindingIdValue(TokenBindingIdValue tokenBindingIdValue)
Sets token binding id value associated with the calling origin.
MakeCredentialOptions.Builder setUser(PublicKeyCredentialUserEntity user)
Sets user information.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MakeCredentialOptions.Builder ()

Creates an empty builder.

Public Methods

public MakeCredentialOptions.Builder setAuthenticatorSelection (AuthenticatorSelectionCriteria authenticatorSelection)

Sets attachment. This field is optional.

Parameters
authenticatorSelection AuthenticatorSelectionCriteria
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setChallenge (byte[] challenge)

Sets challenge.

Parameters
challenge byte
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setExcludeList (List<PublicKeyCredentialDescriptor> excludeList)

Sets exclude list. This field is optional.

Parameters
excludeList List
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setParameters (List<PublicKeyCredentialParameters> parameters)

Sets scoped credential parameters.

Parameters
parameters List
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setRequestId (Integer requestId)

Sets the request id in order to link together events into a single session (the span of events between the time that the server initiates a single FIDO2 request to the client and receives reply) on a single device. This field is optional.

Parameters
requestId Integer
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setRp (PublicKeyCredentialEntity rp)

Sets information for a relying party, on whose behalf a given registration operation is being performed.

Note: the RpId should be an effective domain (aka, without scheme or port); and it should also be in secure context (aka https connection). Apps-facing API needs to check the package signature against Digital Asset Links, whose resource is the RP ID with prepended "https://". Privileged (browser) API doesn't need the check.

Parameters
rp PublicKeyCredentialEntity
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setTimeoutSeconds (Double timeoutSeconds)

Sets timeout in seconds. This field is optional.

Parameters
timeoutSeconds Double
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setTokenBindingIdValue (TokenBindingIdValue tokenBindingIdValue)

Sets token binding id value associated with the calling origin. This field is optional.

Parameters
tokenBindingIdValue TokenBindingIdValue
Returns
MakeCredentialOptions.Builder

public MakeCredentialOptions.Builder setUser (PublicKeyCredentialUserEntity user)

Sets user information.

Parameters
user PublicKeyCredentialUserEntity
Returns
MakeCredentialOptions.Builder