RecaptchaClient

Kotlin |Java

public interface RecaptchaClient

---

A client that enables Android Apps to trigger reCAPTCHA Enterprise.

Summary

Public methods
abstract @NonNull Result<@NonNull String>	execute(@NonNull RecaptchaAction recaptchaAction) Executes reCAPTCHA Enterprise on a user action.
abstract @NonNull Result<@NonNull String>	execute(@NonNull RecaptchaAction recaptchaAction, long timeout) Executes reCAPTCHA Enterprise on a user action.

Public methods

execute

abstract @NonNull Result<@NonNull String> execute(@NonNull RecaptchaAction recaptchaAction)

Executes reCAPTCHA Enterprise on a user action.

This method will throw a timeout exception after 5 seconds.

Parameters
@NonNull RecaptchaAction recaptchaAction	The user action to protect.

Returns
@NonNull Result<@NonNull String>	A Result encapsulating a reCAPTCHA Enterprise token.

execute

abstract @NonNull Result<@NonNull String> execute(@NonNull RecaptchaAction recaptchaAction, long timeout)

Executes reCAPTCHA Enterprise on a user action.

It is suggested the usage of 10 seconds for the timeout. The minimum value is 5 seconds.

Parameters
@NonNull RecaptchaAction recaptchaAction	The user action to protect.
long timeout	Maximum amount of time of execute() call in milliseconds.

Returns
@NonNull Result<@NonNull String>	A Result encapsulating a reCAPTCHA Enterprise token.