public interface GeoMethods
Modifier and Type | Method and Description |
---|---|
Place |
createPlace(java.lang.String name,
java.lang.String containedWithin,
java.lang.String token,
GeoLocation location,
java.lang.String streetAddress)
Creates a new place at the given latitude and longitude.
|
Place |
getGeoDetails(java.lang.String id)
Find out more details of a place that was returned from the
GeoMethodsAsync.reverseGeoCode(twitter4j.GeoQuery) method. |
ResponseList<Place> |
getNearbyPlaces(GeoQuery query)
Deprecated.
|
SimilarPlaces |
getSimilarPlaces(GeoLocation location,
java.lang.String name,
java.lang.String containedWithin,
java.lang.String streetAddress)
Locates places near the given coordinates which are similar in name.
|
ResponseList<Place> |
reverseGeoCode(GeoQuery query)
Search for places (cities and neighborhoods) that can be attached to a statuses/update.
|
ResponseList<Place> |
searchPlaces(GeoQuery query)
Search for places that can be attached to a statuses/update.
|
ResponseList<Place> searchPlaces(GeoQuery query) throws TwitterException
query
- search queryTwitterException
- when Twitter service or network is unavailableSimilarPlaces getSimilarPlaces(GeoLocation location, java.lang.String name, java.lang.String containedWithin, java.lang.String streetAddress) throws TwitterException
location
- The latitude and longitude to search around.name
- The name a place is known as.containedWithin
- optional: the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.streetAddress
- optional: This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted. Learn more about Place Attributes.TwitterException
- when Twitter service or network is unavailableResponseList<Place> getNearbyPlaces(GeoQuery query) throws TwitterException
query
- search queryTwitterException
- when Twitter service or network is unavailableResponseList<Place> reverseGeoCode(GeoQuery query) throws TwitterException
query
- search queryTwitterException
- when Twitter service or network is unavailablePlace getGeoDetails(java.lang.String id) throws TwitterException
GeoMethodsAsync.reverseGeoCode(twitter4j.GeoQuery)
method.
id
- The ID of the location to query about.TwitterException
- when Twitter service or network is unavailablePlace createPlace(java.lang.String name, java.lang.String containedWithin, java.lang.String token, GeoLocation location, java.lang.String streetAddress) throws TwitterException
name
- The name a place is known as.containedWithin
- The place_id within which the new place can be found. Try and be as close as possible with the containing place. For example, for a room in a building, set the contained_within as the building place_id.token
- The token found in the response from geo/similar_places.location
- The latitude and longitude the place is located at.streetAddress
- optional: This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted. Learn more about Place Attributes.TwitterException
- when Twitter service or network is unavailable