hcaptcha/com.stripe.hcaptcha.config/HCaptchaConfig

HCaptchaConfig

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class HCaptchaConfig(val siteKey: String, val sentry: Boolean = true, val loading: Boolean = true, val hideDialog: Boolean = false, val rqdata: String? = null, val jsSrc: String = "https://js.hcaptcha.com/1/api.js", val endpoint: String? = null, val reportapi: String? = null, val assethost: String? = null, val imghost: String? = null, val locale: String = Locale.getDefault().language, val size: HCaptchaSize = HCaptchaSize.INVISIBLE, val orientation: HCaptchaOrientation = HCaptchaOrientation.PORTRAIT, val theme: HCaptchaTheme = HCaptchaTheme.LIGHT, val host: String? = null, val customTheme: String? = null, val retryPredicate: (HCaptchaConfig, HCaptchaException) -> Boolean? = null, val tokenExpiration: Duration = 120.seconds, val disableHardwareAcceleration: Boolean = true) : Serializable

hCaptcha config builder which allows further customization of UI and other logic. .siteKey is the only mandatory property.

Constructors

HCaptchaConfig

constructor(siteKey: String, sentry: Boolean = true, loading: Boolean = true, hideDialog: Boolean = false, rqdata: String? = null, jsSrc: String = "https://js.hcaptcha.com/1/api.js", endpoint: String? = null, reportapi: String? = null, assethost: String? = null, imghost: String? = null, locale: String = Locale.getDefault().language, size: HCaptchaSize = HCaptchaSize.INVISIBLE, orientation: HCaptchaOrientation = HCaptchaOrientation.PORTRAIT, theme: HCaptchaTheme = HCaptchaTheme.LIGHT, host: String? = null, customTheme: String? = null, retryPredicate: (HCaptchaConfig, HCaptchaException) -> Boolean? = null, tokenExpiration: Duration = 120.seconds, disableHardwareAcceleration: Boolean = true)

Types

Companion

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

object Companion

Properties

assethost

val assethost: String? = null

Points loaded hCaptcha assets to a user defined asset location, used for proxies. Default: https://newassets.hcaptcha.com (Override only if using first-party hosting feature.)

customTheme

val customTheme: String? = null

Custom theme JSON string

disableHardwareAcceleration

val disableHardwareAcceleration: Boolean = true

Disable hardware acceleration for WebView

endpoint

val endpoint: String? = null

Point hCaptcha JS Ajax Requests to alternative API Endpoint. Default: https://api.hcaptcha.com (Override only if using first-party hosting feature.)

hideDialog

val hideDialog: Boolean = false

Can be used in combination with passive sitekey to achieve full invisible flow. See enterprise docs for more information.

host

val host: String? = null

hCaptcha SDK host identifier. null value means that it will be generated by SDK

imghost

val imghost: String? = null

Points loaded hCaptcha challenge images to a user defined image location, used for proxies. Default: https://imgs.hcaptcha.com (Override only if using first-party hosting feature.)

jsSrc

val jsSrc: String

The url of api.js Default: https://js.hcaptcha.com/1/api.js (Override only if using first-party hosting feature.)

val loading: Boolean = true

Show / Hide loading dialog.

locale

val locale: String

The locale: 2 characters language code iso 639-1 Default: current default locale for this instance of the JVM.

orientation

val orientation: HCaptchaOrientation

The orientation of the challenge. Default is HCaptchaOrientation.PORTRAIT.

reportapi

val reportapi: String? = null

Point hCaptcha Bug Reporting Request to alternative API Endpoint. Default: https://accounts.hcaptcha.com (Override only if using first-party hosting feature.)

retryPredicate

@Transient

val retryPredicate: (HCaptchaConfig, HCaptchaException) -> Boolean? = null

The lambda will decide should we retry or not

rqdata

val rqdata: String? = null

Custom supplied challenge data.

sentry

val sentry: Boolean = true

Enable / Disable sentry error reporting.

siteKey

val siteKey: String