java.lang.Object
- com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

Enclosing class:: PublicKeyCredentialRequestOptions

public static class PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`allowCredentials(@NonNull java.util.Optional<java.util.List<PublicKeyCredentialDescriptor>> allowCredentials)`	A list of `PublicKeyCredentialDescriptor` objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`allowCredentials(java.util.List<PublicKeyCredentialDescriptor> allowCredentials)`	A list of `PublicKeyCredentialDescriptor` objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
`PublicKeyCredentialRequestOptions`	`build()`
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`challenge(@NonNull ByteArray challenge)`	A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion.
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`extensions(@NonNull AssertionExtensionInputs extensions)`	Additional parameters requesting additional processing by the client and authenticator.
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`rpId(@NonNull java.util.Optional<java.lang.String> rpId)`	Specifies the relying party identifier claimed by the caller.
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`rpId(java.lang.String rpId)`	Specifies the relying party identifier claimed by the caller.
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`timeout(long timeout)`	Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`timeout(@NonNull java.util.Optional<java.lang.Long> timeout)`	Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
`java.lang.String`	`toString()`
`PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder`	`userVerification(UserVerificationRequirement userVerification)`	Describes the Relying Party's requirements regarding user verification for the `navigator.credentials.get()` operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - timeout
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder timeout(@NonNull
                                                                                          @NonNull java.util.Optional<java.lang.Long> timeout)
```
    Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
    This is treated as a hint, and MAY be overridden by the client.
  - timeout
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder timeout(long timeout)
```
    Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
    This is treated as a hint, and MAY be overridden by the client.
  - rpId
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder rpId(@NonNull
                                                                                       @NonNull java.util.Optional<java.lang.String> rpId)
```
    Specifies the relying party identifier claimed by the caller.
    If omitted, its value will be set by the client.
  - rpId
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder rpId(java.lang.String rpId)
```
    Specifies the relying party identifier claimed by the caller.
    If omitted, its value will be set by the client.
  - allowCredentials
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder allowCredentials(@NonNull
                                                                                                   @NonNull java.util.Optional<java.util.List<PublicKeyCredentialDescriptor>> allowCredentials)
```
    A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
  - allowCredentials
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder allowCredentials(java.util.List<PublicKeyCredentialDescriptor> allowCredentials)
```
    A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
  - challenge
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder challenge(@NonNull
                                                                                            @NonNull ByteArray challenge)
```
    A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion. See the §13.1 Cryptographic Challenges security consideration.
    
    Returns:
    
    this.
  - userVerification
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder userVerification(UserVerificationRequirement userVerification)
```
    Describes the Relying Party's requirements regarding user verification for the navigator.credentials.get() operation.
    Eligible authenticators are filtered to only those capable of satisfying this requirement.
    By default, this is not set. When not set, the default in the browser is UserVerificationRequirement.PREFERRED.
    
    Returns:
    
    this.
    
    See Also:
    
    UserVerificationRequirement, §5.8.6. User Verification Requirement Enumeration (enum UserVerificationRequirement), User Verification
  - extensions
```
public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder extensions(@NonNull
                                                                                             @NonNull AssertionExtensionInputs extensions)
```
    Additional parameters requesting additional processing by the client and authenticator.
    For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.
    
    Returns:
    
    this.
  - build
```
public PublicKeyCredentialRequestOptions build()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

timeout

timeout

rpId

rpId

allowCredentials

allowCredentials

challenge

userVerification

extensions

build

toString