org.apache.streams.twitter.api

Interface Geo

@Remoteable(path="https://api.twitter.com/1.1/geo")
public interface Geo

Interface for /geo methods.

See Also:

https://developer.twitter.com/en/docs/geo/place-information/overview, https://developer.twitter.com/en/docs/geo/places-near-location/overview

Method Summary

Modifier and Type	Method and Description
Place	geoid(String place_id) Returns all the information about a known place.
GeoSearchResponse	geosearch(GeoSearchRequest parameters) Search for places that can be attached to a statuses/update.
GeoSearchResponse	reverseGeocode(GeoSearchRequest parameters) Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

Method Detail

geoid

@RemoteMethod(httpMethod="GET",
              path="/id/{place_id}.json")
Place geoid(@Query(value="place_id")
                                                                                      String place_id)

Returns all the information about a known place.

Parameters:

place_id - A place in the world. These IDs can be retrieved from geo/reverse_geocode.

Returns:

Place

See Also:

https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id

geosearch

@RemoteMethod(httpMethod="GET",
              path="/search.json")
GeoSearchResponse geosearch(@QueryIfNE(value="*")
                                                                                               GeoSearchRequest parameters)

Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.

Parameters:

parameters - A place in the world. These IDs can be retrieved from geo/reverse_geocode.

Returns:

GeoSearchResponse

See Also:

https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search

reverseGeocode

@RemoteMethod(httpMethod="GET",
              path="/reverse_geocode.json")
GeoSearchResponse reverseGeocode(@QueryIfNE(value="*")
                                                                                                             GeoSearchRequest parameters)

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

Parameters:

parameters - A place in the world. These IDs can be retrieved from geo/reverse_geocode.

Returns:

GeoSearchResponse

See Also:

https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode