Package twitter4j.v1
Interface PlacesGeoResources
public interface PlacesGeoResources
- Since:
- Twitter4J 2.1.1
-
Method Summary
Modifier and TypeMethodDescriptiongetGeoDetails
(String placeId) Find out more details of a place that was returned from thereverseGeoCode(GeoQuery)
method.reverseGeoCode
(GeoQuery query) Search for places (cities and neighborhoods) that can be attached to a statuses/update.searchPlaces
(GeoQuery query) Search for places that can be attached to a statuses/update.
-
Method Details
-
getGeoDetails
Find out more details of a place that was returned from thereverseGeoCode(GeoQuery)
method.
This method calls https://api.twitter.com/1.1/geo/id/:id.json- Parameters:
placeId
- The ID of the location to query about.- Returns:
- details of the specified place
- Throws:
TwitterException
- when Twitter service or network is unavailable- Since:
- Twitter4J 2.1.1
- See Also:
-
reverseGeoCode
Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update.
There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.
This API call is meant to be an informative call and will deliver generalized results about geography.
This method calls https://api.twitter.com/1.1/geo/reverse_geocode.json- Parameters:
query
- search query- Returns:
- places (cities and neighborhoods) that can be attached to a statuses/update
- Throws:
TwitterException
- when Twitter service or network is unavailable- Since:
- Twitter4J 2.1.1
- See Also:
-
searchPlaces
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.
Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location with a call to statuses/update.
This is the recommended method to use find places that can be attached to statuses/update. Unlike geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user.
This method calls https://api.twitter.com/1.1/geo/search.json- Parameters:
query
- search query- Returns:
- places (cities and neighborhoods) that can be attached to a statuses/update
- Throws:
TwitterException
- when Twitter service or network is unavailable- Since:
- Twitter4J 2.1.7
- See Also:
-