HelpResources.java example

Explorer
firetweet-master
/*
 * Firetweet - Twitter client for Android
 *
 *  Copyright (C) 2012-2015 Mariotaku Lee <mariotaku.lee@gmail.com>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package twitter4j.api;

import java.util.Map;

import twitter4j.RateLimitStatus;
import twitter4j.ResponseList;
import twitter4j.TwitterAPIConfiguration;
import twitter4j.TwitterException;

/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface HelpResources {
	/**
	 * Returns the current configuration used by Twitter including twitter.com
	 * slugs which are not usernames, maximum photo resolutions, and t.co URL
	 * lengths.</br> It is recommended applications request this endpoint when
	 * they are loaded, but no more than once a day.
	 * 
	 * @return configuration
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/help/configuration">GET
	 *      help/configuration | Twitter Developers</a>
	 * @since Twitter4J 2.2.3
	 */
	TwitterAPIConfiguration getAPIConfiguration() throws TwitterException;

	/**
	 * 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.
	 * 
	 * @return list of languages supported by Twitter
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/help/languages">GET
	 *      help/languages | Twitter Developers</a>
	 * @since Twitter4J 2.2.3
	 */
	ResponseList<Language> getLanguages() throws TwitterException;

	/**
	 * Returns Twitter's Privacy Policy. <br>
	 * This method calls http://api.twitter.com/1.1/legal/privacy.json
	 * 
	 * @return privacy policy
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a href="https://dev.twitter.com/docs/api/1.1/get/legal/privacy">GET
	 *      legal/privacy | Twitter Developers</a>
	 * @since Twitter4J 2.1.7
	 */
	String getPrivacyPolicy() throws TwitterException;

	/**
	 * Returns the current rate limits for methods belonging to the specified
	 * resource families.<br>
	 * 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.<br>
	 * 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.<br>
	 * 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.<br>
	 * Read more about REST API Rate Limiting in v1.1 and review the limits.<br>
	 * <br>
	 * This method calls
	 * http://api.twitter.com/1.1/application/rate_limit_status.json
	 * 
	 * @return the rate limit statuses
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status">GET
	 *      application/rate_limit_status</a>
	 * @since Twitter4J 3.0.0
	 */
	Map<String, RateLimitStatus> getRateLimitStatus() throws TwitterException;

	/**
	 * Returns the current rate limits for methods belonging to the specified
	 * resource families.<br>
	 * 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.<br>
	 * 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.<br>
	 * 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.<br>
	 * Read more about REST API Rate Limiting in v1.1 and review the limits.<br>
	 * As of Nov 4th 2012, supported resource names are as follows:
	 * "trends&
	 * quot;,"application","users","saved_searches
	 * "
	 * ,"geo","direct_messages","blocks","
	 * ;favorites
	 * ","statuses","followers","help"
	 * ;,"friends
	 * ","search","friendships","account
	 * ","lists" <br>
	 * This method calls
	 * http://api.twitter.com/1.1/application/rate_limit_status.json
	 * 
	 * @return the rate limit statuses
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status">GET
	 *      application/rate_limit_status</a>
	 * @since Twitter4J 3.0.0
	 */
	Map<String, RateLimitStatus> getRateLimitStatus(String... resources) throws TwitterException;

	/**
	 * Returns Twitter's' Terms of Service. <br>
	 * This method calls http://api.twitter.com/1.1/legal/tos.json
	 * 
	 * @return Terms of Service
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a href="https://dev.twitter.com/docs/api/1.1/get/legal/tos">GET
	 *      legal/tos | Twitter Developers</a>
	 * @since Twitter4J 2.1.7
	 */
	String getTermsOfService() throws TwitterException;

	public static interface Language {
		String getCode();

		String getName();

		String getStatus();
	}
}