RateLimit Class

A snapshot of an API account's rate limit.

Inheritance Hierarchy

SystemObject
DegreeDays.ApiRateLimit

Namespace: DegreeDays.Api
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

Copy

public sealed class RateLimit

Public NotInheritable Class RateLimit

The RateLimit type exposes the following members.

Properties

	Name	Description
	MinutesToReset	Gets the number of minutes until the rate limit is reset, at the time that this snapshot of the rate-limit state was taken.
	RequestUnitsAvailable	Gets the number of request units available for use before the next reset, at the time that this snapshot of the rate-limit state was taken.

Top

Methods

	Name	Description
	Equals	Returns true if obj is a RateLimit object with equal properties. (Overrides ObjectEquals(Object))
	GetHashCode	Overridden to ensure consistency with Equals. (Overrides ObjectGetHashCode)
	ToString	Returns a non-null, non-empty string representation of this instance for logging and debugging purposes. (Overrides ObjectToString)

Top

Remarks

The real state of an account's rate limit changes over time and as more requests are made to the API. So a RateLimit object, which is a snapshot, is best checked soon after it is received. It is accessible through the metadata that is included with each API Response and with each RequestFailureException.

Thread Safety

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Reference

DegreeDays.Api Namespace