Interface CodeConfigurationParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CodeConfigurationParameters.Builder,CodeConfigurationParameters>, SdkBuilder<CodeConfigurationParameters.Builder,CodeConfigurationParameters>, SdkPojo
Enclosing class:
CodeConfigurationParameters
@Mutable @NotThreadSafe public static interface CodeConfigurationParameters.Builder extends SdkPojo, CopyableBuilder<CodeConfigurationParameters.Builder,CodeConfigurationParameters>

  • Method Details

    • codeType

      CodeConfigurationParameters.Builder codeType(String codeType)

      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

      Parameters:
      codeType - The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeType

      CodeConfigurationParameters.Builder codeType(CodeType codeType)

      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

      Parameters:
      codeType - The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeLength

      CodeConfigurationParameters.Builder codeLength(Integer codeLength)

      The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

      Parameters:
      codeLength - The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validityPeriodMinutes

      CodeConfigurationParameters.Builder validityPeriodMinutes(Integer validityPeriodMinutes)

      The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.

      Parameters:
      validityPeriodMinutes - The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxAttempts

      CodeConfigurationParameters.Builder maxAttempts(Integer maxAttempts)

      The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

      Parameters:
      maxAttempts - The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.