Struct RateLimitInfo

Namespace

Discord.Net

Assembly

Discord.Net.Rest.dll

Represents a REST-Based ratelimit info.

public struct RateLimitInfo : IRateLimitInfo

Implements

IRateLimitInfo

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Bucket

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

public readonly string Bucket { get; }

Property Value

string

Endpoint

Gets the endpoint that this ratelimit info came from.

public readonly string Endpoint { get; }

Property Value

string

IsGlobal

Gets whether or not this ratelimit info is global.

public readonly bool IsGlobal { get; }

Property Value

bool

Lag

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

public readonly TimeSpan? Lag { get; }

Property Value

TimeSpan?

Limit

Gets the number of requests that can be made.

public readonly int? Limit { get; }

Property Value

int?

Remaining

Gets the number of remaining requests that can be made.

public readonly int? Remaining { get; }

Property Value

int?

Reset

Gets the DateTimeOffset at which the rate limit resets.

public readonly DateTimeOffset? Reset { get; }

Property Value

DateTimeOffset?

ResetAfter

Gets the absolute time when this ratelimit resets.

public readonly TimeSpan? ResetAfter { get; }

Property Value

TimeSpan?

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.

public readonly int? RetryAfter { get; }

Property Value

int?