Package twitter4j.v1
Interface HelpResources
public interface HelpResources
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionReturns the list of languages supported by Twitter along with their ISO 639-1 code.Returns the current rate limits for methods belonging to the specified resource families.
Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation.getRateLimitStatus(String... resources) Returns the current rate limits for methods belonging to the specified resource families.
Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation.
-
Method Details
-
getLanguages
Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.- Returns:
- list of languages supported by Twitter
- Throws:
TwitterException- when Twitter service or network is unavailable- Since:
- Twitter4J 2.2.3
- See Also:
-
getRateLimitStatus
Returns the current rate limits for methods belonging to the specified resource families.
Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.
This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token context.
You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.
Read more about REST API Rate Limiting in v1.1 and review the limits.
This method calls https://api.twitter.com/1.1/application/rate_limit_status.json- Returns:
- the rate limit statuses
- Throws:
TwitterException- when Twitter service or network is unavailable- Since:
- Twitter4J 3.0.0
- See Also:
-
getRateLimitStatus
Returns the current rate limits for methods belonging to the specified resource families.
Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.
This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token context.
You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.
Read more about REST API Rate Limiting in v1.1 and review the limits.
As of Nov 4th 2012, supported resource names are as follows: "trends","application","users","saved_searches","geo","direct_messages","blocks","favorites","statuses","followers","help","friends","search","friendships","account","lists"
This method calls https://api.twitter.com/1.1/application/rate_limit_status.json- Parameters:
resources- resources- Returns:
- the rate limit statuses
- Throws:
TwitterException- when Twitter service or network is unavailable- Since:
- Twitter4J 3.0.0
- See Also:
-