Skip to main content

@wildix/xbees-conversations-client > RateLimitExceededException

RateLimitExceededException class​

Signature:

export declare class RateLimitExceededException extends __BaseException

Extends: __BaseException

Remarks​

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the RateLimitExceededException class.

Properties​

Property

Modifiers

Type

Description

$fault

readonly

"client"

name

readonly

"RateLimitExceededException"

rateLimit?

string | undefined

(Optional) Displays the applicable rate limits for the current request.

rateLimitRemaining?

number | undefined

(Optional) Indicates how many requests a user can still make within the current time window.

rateLimitReset?

number | undefined

(Optional) Shows the time in seconds until the rate limit resets.

retryAfter?

number | undefined

(Optional) Displays how many seconds the user agent should wait before making a follow-up request.