All Implemented Interfaces:


public final class VerificationCreateParams.Options.Builder

A builder for Options.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final VerificationCreateParams.Options.Builder`	`appRealm(VerificationCreateParams.Options.AppRealm appRealm)`	This allows you to automatically retrieve and fill the OTP code on mobile apps.
`final VerificationCreateParams.Options.Builder`	`appRealm(JsonField<VerificationCreateParams.Options.AppRealm> appRealm)`	This allows you to automatically retrieve and fill the OTP code on mobile apps.
`final VerificationCreateParams.Options.Builder`	`callbackUrl(String callbackUrl)`	The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes.
`final VerificationCreateParams.Options.Builder`	`callbackUrl(JsonField<String> callbackUrl)`	The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes.
`final VerificationCreateParams.Options.Builder`	`codeSize(Long codeSize)`	The size of the code generated.
`final VerificationCreateParams.Options.Builder`	`codeSize(JsonField<Long> codeSize)`	The size of the code generated.
`final VerificationCreateParams.Options.Builder`	`customCode(String customCode)`	The custom code to use for OTP verification.
`final VerificationCreateParams.Options.Builder`	`customCode(JsonField<String> customCode)`	The custom code to use for OTP verification.
`final VerificationCreateParams.Options.Builder`	`locale(String locale)`	A BCP-47 formatted locale string with the language the text message will be sent to.
`final VerificationCreateParams.Options.Builder`	`locale(JsonField<String> locale)`	A BCP-47 formatted locale string with the language the text message will be sent to.
`final VerificationCreateParams.Options.Builder`	`senderId(String senderId)`	The Sender ID to use for this message.
`final VerificationCreateParams.Options.Builder`	`senderId(JsonField<String> senderId)`	The Sender ID to use for this message.
`final VerificationCreateParams.Options.Builder`	`templateId(String templateId)`	The identifier of a verification template.
`final VerificationCreateParams.Options.Builder`	`templateId(JsonField<String> templateId)`	The identifier of a verification template.
`final VerificationCreateParams.Options.Builder`	`variables(VerificationCreateParams.Options.Variables variables)`	The variables to be replaced in the template.
`final VerificationCreateParams.Options.Builder`	`variables(JsonField<VerificationCreateParams.Options.Variables> variables)`	The variables to be replaced in the template.
`final VerificationCreateParams.Options.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final VerificationCreateParams.Options.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final VerificationCreateParams.Options.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final VerificationCreateParams.Options.Builder`	`removeAdditionalProperty(String key)`
`final VerificationCreateParams.Options.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final VerificationCreateParams.Options`	`build()`

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

- Constructor Detail
- Method Detail
  - appRealm
```
 final VerificationCreateParams.Options.Builder appRealm(VerificationCreateParams.Options.AppRealm appRealm)
```
    This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.
  - appRealm
```
 final VerificationCreateParams.Options.Builder appRealm(JsonField<VerificationCreateParams.Options.AppRealm> appRealm)
```
    This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.
  - callbackUrl
```
 final VerificationCreateParams.Options.Builder callbackUrl(String callbackUrl)
```
    The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes. For more details, refer to /api-reference/v2/verify/webhook.
  - callbackUrl
```
 final VerificationCreateParams.Options.Builder callbackUrl(JsonField<String> callbackUrl)
```
    The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes. For more details, refer to /api-reference/v2/verify/webhook.
  - codeSize
```
 final VerificationCreateParams.Options.Builder codeSize(Long codeSize)
```
    The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.
  - codeSize
```
 final VerificationCreateParams.Options.Builder codeSize(JsonField<Long> codeSize)
```
    The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.
  - customCode
```
 final VerificationCreateParams.Options.Builder customCode(String customCode)
```
    The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case. For more details, refer to /concepts/multi-routing.
  - customCode
```
 final VerificationCreateParams.Options.Builder customCode(JsonField<String> customCode)
```
    The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case. For more details, refer to /concepts/multi-routing.
  - locale
```
 final VerificationCreateParams.Options.Builder locale(String locale)
```
    A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, it defaults to US English.
  - locale
```
 final VerificationCreateParams.Options.Builder locale(JsonField<String> locale)
```
    A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, it defaults to US English.
  - senderId
```
 final VerificationCreateParams.Options.Builder senderId(String senderId)
```
    The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.
  - senderId
```
 final VerificationCreateParams.Options.Builder senderId(JsonField<String> senderId)
```
    The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.
  - templateId
```
 final VerificationCreateParams.Options.Builder templateId(String templateId)
```
    The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.
  - templateId
```
 final VerificationCreateParams.Options.Builder templateId(JsonField<String> templateId)
```
    The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.
  - variables
```
 final VerificationCreateParams.Options.Builder variables(VerificationCreateParams.Options.Variables variables)
```
    The variables to be replaced in the template.
  - variables
```
 final VerificationCreateParams.Options.Builder variables(JsonField<VerificationCreateParams.Options.Variables> variables)
```
    The variables to be replaced in the template.
  - additionalProperties
```
 final VerificationCreateParams.Options.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final VerificationCreateParams.Options.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final VerificationCreateParams.Options.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final VerificationCreateParams.Options.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final VerificationCreateParams.Options.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final VerificationCreateParams.Options build()
```

Class VerificationCreateParams.Options.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

appRealm

appRealm

callbackUrl

callbackUrl

codeSize

codeSize

customCode

customCode

locale

locale

senderId

senderId

templateId

templateId

variables

variables

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build