Class: PreludeSDK::Models::VerificationCreateParams::Options::AppRealm

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PreludeSDK::Models::VerificationCreateParams::Options::AppRealm

Defined in:

lib/prelude_sdk/models/verification_create_params.rb

Overview

See Also:

• #app_realm

Defined Under Namespace

Modules: Platform

Instance Attribute Summary

• #platform ⇒ Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform

  The platform for automatic OTP retrieval.

• #value ⇒ String

  The value depends on the platform:.

Instance Method Summary

• #initialize(platform:, value:) ⇒ Object constructor

  Some parameter documentations has been truncated, see AppRealm for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(platform:, value:) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::VerificationCreateParams::Options::AppRealm for more details.

This allows automatic OTP retrieval on mobile apps and web browsers. Supported platforms are Android (SMS Retriever API) and Web (WebOTP API).

Parameters:

• platform (Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform) —

  The platform for automatic OTP retrieval. Use “android” for the SMS Retriever AP

• value (String) —

  The value depends on the platform:

# File 'lib/prelude_sdk/models/verification_create_params.rb', line 238

Instance Attribute Details

#platform ⇒ Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform

The platform for automatic OTP retrieval. Use “android” for the SMS Retriever API or “web” for the WebOTP API.

Returns:

• (Symbol, PreludeSDK::Models::VerificationCreateParams::Options::AppRealm::Platform)

# File 'lib/prelude_sdk/models/verification_create_params.rb', line 225

required :platform, enum: -> { PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform }

#value ⇒ String

The value depends on the platform:

• For Android: The SMS Retriever API hash code (11 characters). See [Google documentation](developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).

• For Web: The origin domain (e.g., “example.com” or “www.example.com”). See [WebOTP API documentation](developer.mozilla.org/en-US/docs/Web/API/WebOTP_API).

Returns:

• (String)

# File 'lib/prelude_sdk/models/verification_create_params.rb', line 236

required :value, String