TrendsResources.java example

Explorer
firetweet-master
/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package twitter4j.api;

import twitter4j.GeoLocation;
import twitter4j.Location;
import twitter4j.ResponseList;
import twitter4j.Trends;
import twitter4j.TwitterException;

/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface TrendsResources {
	/**
	 * Returns the locations that Twitter has trending topic information for.
	 * The response is an array of "locations" that encode the
	 * location's WOEID (a <a
	 * href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth
	 * ID</a>) and some other human-readable information such as a canonical
	 * name and country the location belongs in. <br>
	 * This method calls http://api.twitter.com/1.1/trends/available.json
	 * 
	 * @return the locations
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/trends/available">GET
	 *      trends/available | Twitter Developers</a>
	 * @since Twitter4J 2.1.1
	 */
	ResponseList<Location> getAvailableTrends() throws TwitterException;

	/**
	 * Returns the sorted locations that Twitter has trending topic information
	 * for. The response is an array of "locations" that encode the
	 * location's WOEID (a <a
	 * href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth
	 * ID</a>) and some other human-readable information such as a canonical
	 * name and country the location belongs in. <br>
	 * This method calls http://api.twitter.com/1.1/trends/available.json
	 * 
	 * @param location the available trend locations will be sorted by distance
	 *            to the lat and long passed in. The sort is nearest to
	 *            furthest.
	 * @return the locations
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/trends/available">GET
	 *      trends/available | Twitter Developers</a>
	 * @since Twitter4J 2.1.1
	 */
	ResponseList<Location> getAvailableTrends(GeoLocation location) throws TwitterException;

	/**
	 * Returns the locations that Twitter has trending topic information for,
	 * closest to a specified location.<br>
	 * The response is an array of "locations" that encode the location's WOEID
	 * and some other human-readable information such as a canonical name and
	 * country the location belongs in.<br>
	 * A WOEID is a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo!
	 * Where On Earth ID</a>. <br>
	 * This method calls http://api.twitter.com/1.1/trends/closest.json
	 * 
	 * @param location the available trend locations will be sorted by distance
	 *            to the lat and long passed in. The sort is nearest to
	 *            furthest.
	 * @return the locations
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a
	 *      href="https://dev.twitter.com/docs/api/1.1/get/trends/closest">GET
	 *      trends/closest | Twitter Developers</a>
	 * @since Twitter4J 3.0.2
	 */
	ResponseList<Location> getClosestTrends(GeoLocation location) throws TwitterException;

	/**
	 * Returns the top 10 trending topics for a specific location Twitter has
	 * trending topic information for. The response is an array of "trend"
	 * objects that encode the name of the trending topic, the query parameter
	 * that can be used to search for the topic on Search, and the direct URL
	 * that can be issued against Search. This information is cached for five
	 * minutes, and therefore users are discouraged from querying these
	 * endpoints faster than once every five minutes. Global trends information
	 * is also available from this API by using a WOEID of 1. <br>
	 * This method calls http://api.twitter.com/1.1/trends/:woeid.json
	 * 
	 * @param woeid The WOEID of the location to be querying for
	 * @return trends
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a href="https://dev.twitter.com/docs/api/1.1/get/trends/:woeid">GET
	 *      trends/:woeid | Twitter Developers</a>
	 * @since Twitter4J 2.1.1
	 */
	Trends getLocationTrends(int woeid) throws TwitterException;

	/**
	 * Returns the top 10 trending topics for a specific WOEID, if trending
	 * information is available for it.<br>
	 * The response is an array of "trend" objects that encode the name of the
	 * trending topic, the query parameter that can be used to search for the
	 * topic on <a href="http://search.twitter.com/">Twitter Search</a>, and the
	 * Twitter Search URL.<br>
	 * This information is cached for 5 minutes. Requesting more frequently than
	 * that will not return any more data, and will count against your rate
	 * limit usage.<br>
	 * <br>
	 * This method calls http://api.twitter.com/1.1/trends/place.json
	 * 
	 * @param woeid <a href="http://developer.yahoo.com/geo/geoplanet/">The
	 *            Yahoo! Where On Earth ID</a> of the location to return
	 *            trending information for. Global information is available by
	 *            using 1 as the WOEID.
	 * @return trends
	 * @throws twitter4j.TwitterException when Twitter service or network is
	 *             unavailable
	 * @see <a href="https://dev.twitter.com/docs/api/1.1/get/trends/place">GET
	 *      trends/place | Twitter Developers</a>
	 * @since Twitter4J 3.0.2
	 */
	Trends getPlaceTrends(int woeid) throws TwitterException;
}