twitter4jads.internal.models4j.RateLimitStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twitter-ads4j Show documentation

TwitterAds sdk

There is a newer version: 1.4.0

package twitter4jads.internal.models4j;

/**
 * A data interface representing Twitter REST API's rate limit status
 *
 *
 * @see Rate Limiting | Twitter Developers
 */
public interface RateLimitStatus extends java.io.Serializable {
    /**
     * Returns the remaining number of API requests available.

     * This value is identical to the "X-Rate-Limit-Remaining" response header.
     *
     * @return the remaining number of API requests available
     * @since Twitter4J 3.0.0
     */
    int getRemaining();

    /**
     * Returns the remaining number of API requests available.

     * This value is identical to the "X-Rate-Limit-Remaining" response header.
     *
     * @return the remaining number of API requests available
     * @deprecated use {@link #getRemaining()} instead
     */
    int getRemainingHits();

    /**
     * Returns the current limit in effect

     * This value is identical to the "X-Rate-Limit-Limit" response header.
     *
     * @return the current limit in effect
     */
    int getLimit();

    /**
     * Returns the seconds the current rate limiting period ends.

     * This should be a same as getResetTime().getTime()/1000.
     *
     * @return the seconds the current rate limiting period ends
     * @since Twitter4J 2.0.9
     */
    int getResetTimeInSeconds();

    /**
     * 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.
     *
     * @return the amount of seconds until next rate limiting period
     * @since Twitter4J 2.1.0
     */
    int getSecondsUntilReset();

}