Interface IRateLimitInfo

Represents a generic ratelimit info.

Namespace: Discord
Assembly: Discord.Net.Core.dll
Syntax
public interface IRateLimitInfo

Properties

| Improve this Doc View Source

Bucket

Gets a unique string denoting the rate limit being encountered (non-inclusive of major parameters in the route path).

Declaration
string Bucket { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Endpoint

Gets the endpoint that this ratelimit info came from.

Declaration
string Endpoint { get; }
Property Value
Type Description
String
| Improve this Doc View Source

IsGlobal

Gets whether or not this ratelimit info is global.

Declaration
bool IsGlobal { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Lag

Gets the amount of lag for the request. This is used to denote the precise time of when the ratelimit expires.

Declaration
TimeSpan? Lag { get; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

Limit

Gets the number of requests that can be made.

Declaration
int? Limit { get; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

Remaining

Gets the number of remaining requests that can be made.

Declaration
int? Remaining { get; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

Reset

Gets the at which the rate limit resets.

Declaration
DateTimeOffset? Reset { get; }
Property Value
Type Description
Nullable<DateTimeOffset>
| Improve this Doc View Source

ResetAfter

Gets the absolute time when this ratelimit resets.

Declaration
TimeSpan? ResetAfter { get; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

RetryAfter

Gets the total time (in seconds) of when the current rate limit bucket will reset. Can have decimals to match previous millisecond ratelimit precision.

Declaration
int? RetryAfter { get; }
Property Value
Type Description
Nullable<Int32>