SignRequestParams.Builder

  • SignRequestParams.Builder is used to build SignRequestParams.

  • An empty builder can be created using the Builder() constructor.

  • The build() method finalizes the building process and returns a SignRequestParams object.

  • Various methods like setAppId, setChannelIdValue, setDefaultSignChallenge, setDisplayHint, setRegisteredKeys, setRequestId, and setTimeoutSeconds are available to configure the sign request parameters.

  • Setting registered keys is a mandatory step when building SignRequestParams.
public static final class SignRequestParams.Builder extends Object

Builds SignRequestParams.

Public Constructor Summary

Builder()
Creates an empty builder.

Public Method Summary

SignRequestParams
build()
Builds a SignRequestParams.
SignRequestParams.Builder
setAppId(Uri appId)
Sets sign request appId.
SignRequestParams.Builder
setChannelIdValue(ChannelIdValue channelIdValue)
Sets channelId value for the sign request.
SignRequestParams.Builder
setDefaultSignChallenge(byte[] defaultSignChallenge)
Sets default sign challenge for the sign request.
SignRequestParams.Builder
setDisplayHint(String displayHint)
Sets the display hint that is shown to the user.
SignRequestParams.Builder
setRegisteredKeys(List<RegisteredKey> registeredKeys)
Sets registered keys for the sign request.
SignRequestParams.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 U2F request to the client and receives a reply) on a single device.
SignRequestParams.Builder
setTimeoutSeconds(Double timeoutSeconds)
Sets timeout in seconds, to indicate for how long this request remains valid.

Inherited Method Summary

Public Constructors

public Builder ()

Creates an empty builder.

Public Methods

public SignRequestParams build ()

Builds a SignRequestParams.

public SignRequestParams.Builder setAppId (Uri appId)

Sets sign request appId. This field is optional.

public SignRequestParams.Builder setChannelIdValue (ChannelIdValue channelIdValue)

Sets channelId value for the sign request. This field is optional.

public SignRequestParams.Builder setDefaultSignChallenge (byte[] defaultSignChallenge)

Sets default sign challenge for the sign request. This field is optional.

public SignRequestParams.Builder setDisplayHint (String displayHint)

Sets the display hint that is shown to the user. Note that if not null, the string should not be longer than SignRequestParams.MAX_DISPLAY_HINT_LENGTH characters. This field is optional.

public SignRequestParams.Builder setRegisteredKeys (List<RegisteredKey> registeredKeys)

Sets registered keys for the sign request. This field is mandatory.

public SignRequestParams.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 U2F request to the client and receives a reply) on a single device. This field is optional.

public SignRequestParams.Builder setTimeoutSeconds (Double timeoutSeconds)

Sets timeout in seconds, to indicate for how long this request remains valid. This field is optional.