RateLimitStatus (twitter4j-ads 5.0 API)

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RateLimitStatusImpl
```
public interface RateLimitStatus
extends java.io.Serializable
```
A data interface representing Twitter REST API's rate limit status

See Also:

Rate Limiting | Twitter Developers

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getLimit()` Returns the current limit in effect This value is identical to the "X-Rate-Limit-Limit" response header.
`int`	`getRemaining()` Returns the remaining number of API requests available. This value is identical to the "X-Rate-Limit-Remaining" response header.
`int`	`getRemainingHits()` Deprecated. use `getRemaining()` instead
`int`	`getResetTimeInSeconds()` Returns the seconds the current rate limiting period ends. This should be a same as getResetTime().getTime()/1000.
`int`	`getSecondsUntilReset()` Returns the amount of seconds until the current rate limiting period ends. This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.

- Method Detail
  - getRemaining
```
int getRemaining()
```
    Returns the remaining number of API requests available.
    This value is identical to the "X-Rate-Limit-Remaining" response header.
    
    Returns:
    
    the remaining number of API requests available
    
    Since:
    
    Twitter4J 3.0.0
  - getRemainingHits
```
int getRemainingHits()
```
    Deprecated. use getRemaining() instead
    
    Returns the remaining number of API requests available.
    This value is identical to the "X-Rate-Limit-Remaining" response header.
    
    Returns:
    
    the remaining number of API requests available
  - getLimit
```
int getLimit()
```
    Returns the current limit in effect
    This value is identical to the "X-Rate-Limit-Limit" response header.
    
    Returns:
    
    the current limit in effect
  - getResetTimeInSeconds
```
int getResetTimeInSeconds()
```
    Returns the seconds the current rate limiting period ends.
    This should be a same as getResetTime().getTime()/1000.
    
    Returns:
    
    the seconds the current rate limiting period ends
    
    Since:
    
    Twitter4J 2.0.9
  - getSecondsUntilReset
```
int getSecondsUntilReset()
```
    Returns the amount of seconds until the current rate limiting period ends.
    This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.
    
    Returns:
    
    the amount of seconds until next rate limiting period
    
    Since:
    
    Twitter4J 2.1.0

Interface RateLimitStatus

Method Summary

Method Detail

getRemaining

getRemainingHits

getLimit

getResetTimeInSeconds

getSecondsUntilReset