ZEROSPAM\Framework\SDK\Response\RateLimit\RateLimitData

Class RateLimitData.

Represent the number of request allowed in a minute
How many are still alowed and in the case there is too many done,
when can the next one be done

Synopsis

class RateLimitData implements IRateLimitData {

• // members
• private  $maxPerMinute;
• private  $remaining;
• private Carbon $endOfThrottle;
• // methods
• public int getMaxPerMinute()
• public $this setMaxPerMinute()
• public int getRemaining()
• public $this setRemaining()
• public Carbon getEndOfThrottle()
• public $this setEndOfThrottle()
}


Hierarchy

Implements

• ZEROSPAM\Framework\SDK\Response\RateLimit\IRateLimitData

Members

private

• $endOfThrottle — Carbon\Carbon
• $maxPerMinute — int
• $remaining — int

Methods

public

• getEndOfThrottle() — Getter for endOfThrottle.
• getMaxPerMinute() — Getter for maxPerMinute.
• getRemaining() — Getter for currentUsage.
• setEndOfThrottle()
• setMaxPerMinute()
• setRemaining()

History

• 2018-07-16T14:26:38+00:00 (commit #290a97d)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  feat(Response): Split Ratelimited from BaseResponse
  
  New type of response can now be easily build.