RateLimitExceededEvent

Deprecated

This Android-only event will be removed in a future release. Android consumers using the legacy OAuth2Client can suppress this warning — there is no drop-in replacement on the Android path. If you have migrated to the KMP OAuth2Client, observe com.okta.authfoundation.client.kmp.events.RateLimitExceededEvent via OAuth2Client.events instead (note: the KMP event carries requestUrl/responseHeaders instead of OkHttp Request/Response).

Emitted via EventHandler.onEvent when a network request receives 429 HTTP status code (rate limit exceeded). See Rate Limits Overview for additional details.

The default implementation retries the request 3 times, with a minimum delay of 1 seconds between each request. See maxRetries and minDelaySeconds

Properties

Link copied to clipboard

Allows the app developer to change how many times, at most, request should be retried when a 429 status code is received.

Link copied to clipboard

Allows the app developer to change the minimum amount of time, in seconds, to wait before retrying request when a 429 status code is received.

Link copied to clipboard
val request: Request

The Request that caused the event.

Link copied to clipboard
val response: Response

The Response with 429 HTTP status code.

Link copied to clipboard

Number of retry attempts for request so far.