Recaptcha

Kotlin |Java

object Recaptcha

Summary

Public functions
`suspend RecaptchaClient`	`fetchClient(application: Application, siteKey: String)` Returns a `RecaptchaClient` associated with the `siteKey` to access all reCAPTCHA APIs.
`Task<RecaptchaTasksClient>`	`fetchTaskClient(application: Application, siteKey: String)` Returns a `Task` of `RecaptchaTasksClient` associated with the `siteKey` to access all reCAPTCHA APIs.
`suspend Result<RecaptchaClient>`	`getClient(application: Application, siteKey: String, timeout: Long)` This function is deprecated. Use fetchClient(Application, siteKey) instead.
`Task<RecaptchaTasksClient>`	`getTasksClient(application: Application, siteKey: String)` This function is deprecated. Use fetchTaskClient(Application, siteKey) instead.
`Task<RecaptchaTasksClient>`	`getTasksClient(application: Application, siteKey: String, timeout: Long)` This function is deprecated. Use fetchTaskClient(Application, siteKey) instead

Public functions

fetchClient

suspend fun fetchClient(application: Application, siteKey: String): RecaptchaClient

Returns a RecaptchaClient associated with the siteKey to access all reCAPTCHA APIs.

The SDK supports one site key. Passing a different site key throws an exception.

Parameters
`application: Application`	The context of the application that is protected by reCAPTCHA.
`siteKey: String`	A reCAPTCHA key for Android registered for the caller app at https://cloud.google.com/recaptcha/docs/create-key

Returns
`RecaptchaClient`	An instance of `RecaptchaClient`.

fetchTaskClient

fun fetchTaskClient(application: Application, siteKey: String): Task<RecaptchaTasksClient>

Returns a Task of RecaptchaTasksClient associated with the siteKey to access all reCAPTCHA APIs.

The SDK supports one site key. Passing a different site key throws an exception.

Parameters
`application: Application`	The context of the application that is protected by reCAPTCHA.
`siteKey: String`	A reCAPTCHA key for Android registered for the caller app at https://cloud.google.com/recaptcha/docs/create-key

Returns
`Task<RecaptchaTasksClient>`	An instance of `RecaptchaClient`.

getClient

suspend fun getClient(
    application: Application,
    siteKey: String,
    timeout: Long = DEFAULT_TIMEOUT_INIT
): Result<RecaptchaClient>

Returns a Result of RecaptchaClient associated with the siteKey to access all reCAPTCHA APIs.

The SDK supports one site key. Passing a different site key throws an exception.

At least a 10000 millisecond timeout is suggested to allow for slow networking, though in some cases longer timeouts may be necessary. The minimum allowable value is 5000 milliseconds.

Parameters
`application: Application`	The context of the application that is protected by reCAPTCHA.
`siteKey: String`	A reCAPTCHA key for Android registered for the caller app at https://cloud.google.com/recaptcha/docs/create-key
`timeout: Long = DEFAULT_TIMEOUT_INIT`	Maximum amount of time to initialize the `RecaptchaClient` in milliseconds. Default value is 10 seconds.

Returns
`Result<RecaptchaClient>`	An instance of `Result` encapsulating a `RecaptchaClient`.

getTasksClient

fun getTasksClient(application: Application, siteKey: String): Task<RecaptchaTasksClient>

Returns a Task of RecaptchaTasksClient associated with the siteKey to access all reCAPTCHA APIs.

The SDK supports one site key. Passing a different site key throws an exception.

This method will throw a timeout exception after 10 seconds.

Parameters
`application: Application`	The context of the application that is protected by reCAPTCHA.
`siteKey: String`	A reCAPTCHA key for Android registered for the caller app at https://cloud.google.com/recaptcha/docs/create-key

Returns
`Task<RecaptchaTasksClient>`	An instance of `Task` encapsulating a `RecaptchaTasksClient`.

getTasksClient

fun getTasksClient(application: Application, siteKey: String, timeout: Long): Task<RecaptchaTasksClient>

Returns a Task of RecaptchaTasksClient associated with the siteKey to access all reCAPTCHA APIs.

The SDK supports one site key. Passing a different site key throws an exception.

At least a 10000 millisecond timeout is suggested to allow for slow networking, though in some cases longer timeouts may be necessary. The minimum allowable value is 5000 milliseconds.

Parameters
`application: Application`	The context of the application that is protected by reCAPTCHA.
`siteKey: String`	A reCAPTCHA key for Android registered for the caller app at https://cloud.google.com/recaptcha/docs/create-key
`timeout: Long`	Maximum amount of time to initialize the `RecaptchaClient` in milliseconds. Default value is 10 seconds.

Returns
`Task<RecaptchaTasksClient>`	An instance of `Task` encapsulating a `RecaptchaTasksClient`.