RecaptchaTasksClient

public interface RecaptchaTasksClient


A client that enables Android Apps to trigger reCAPTCHA Enterprise.

Summary

Public methods

abstract @NonNull Task<@NonNull String>

Executes reCAPTCHA Enterprise on a user action.

abstract @NonNull Task<@NonNull String>
executeTask(@NonNull RecaptchaAction recaptchaAction, long timeout)

Executes reCAPTCHA Enterprise on a user action.

Public methods

executeTask

abstract @NonNull Task<@NonNull StringexecuteTask(@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 Task<@NonNull String>

A Task that would resolve with a reCAPTCHA Enterprise token.

executeTask

abstract @NonNull Task<@NonNull StringexecuteTask(@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 Task<@NonNull String>

A Task that would resolve with a reCAPTCHA Enterprise token.