|
Spring Social Twitter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GeoOperations
Interface defining the Twitter operations for working with locations.
Method Summary | |
---|---|
Place |
createPlace(PlacePrototype placePrototype)
Creates a new place. |
SimilarPlaces |
findSimilarPlaces(double latitude,
double longitude,
java.lang.String name)
Finds places similar to a place described in the parameters. |
SimilarPlaces |
findSimilarPlaces(double latitude,
double longitude,
java.lang.String name,
java.lang.String streetAddress,
java.lang.String containedWithin)
Finds places similar to a place described in the parameters. |
Place |
getPlace(java.lang.String id)
Retrieves information about a plce |
java.util.List<Place> |
reverseGeoCode(double latitude,
double longitude)
Retrieves up to 20 places matching the given location. |
java.util.List<Place> |
reverseGeoCode(double latitude,
double longitude,
PlaceType granularity,
java.lang.String accuracy)
Retrieves up to 20 places matching the given location and criteria |
java.util.List<Place> |
search(double latitude,
double longitude)
Searches for up to 20 places matching the given location. |
java.util.List<Place> |
search(double latitude,
double longitude,
PlaceType granularity,
java.lang.String accuracy,
java.lang.String query)
Searches for up to 20 places matching the given location and criteria |
Method Detail |
---|
Place getPlace(java.lang.String id)
id
- the place ID
Place
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.java.util.List<Place> reverseGeoCode(double latitude, double longitude)
latitude
- the latitudelongitude
- the longitude
Place
s that the point is within
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.java.util.List<Place> reverseGeoCode(double latitude, double longitude, PlaceType granularity, java.lang.String accuracy)
latitude
- the latitudelongitude
- the longitudegranularity
- the minimal granularity of the places to return. If null, the default granularity (neighborhood) is assumed.accuracy
- a radius of accuracy around the given point. If given a number, the value is assumed to be in meters. The number may be qualified with "ft" to indicate feet. If null, the default accuracy (0m) is assumed.
Place
s that the point is within
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.java.util.List<Place> search(double latitude, double longitude)
latitude
- the latitudelongitude
- the longitude
Place
s that the point is within
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.java.util.List<Place> search(double latitude, double longitude, PlaceType granularity, java.lang.String accuracy, java.lang.String query)
latitude
- the latitudelongitude
- the longitudegranularity
- the minimal granularity of the places to return. If null, the default granularity (neighborhood) is assumed.accuracy
- a radius of accuracy around the given point. If given a number, the value is assumed to be in meters. The number may be qualified with "ft" to indicate feet. If null, the default accuracy (0m) is assumed.query
- a free form text value to help find places by name. If null, no query will be applied to the search.
Place
s that the point is within
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.SimilarPlaces findSimilarPlaces(double latitude, double longitude, java.lang.String name)
latitude
- the latitudelongitude
- the longitudename
- the name that the place is known as
SimilarPlaces
collection, including a token that can be used to create a new place.
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.SimilarPlaces findSimilarPlaces(double latitude, double longitude, java.lang.String name, java.lang.String streetAddress, java.lang.String containedWithin)
latitude
- the latitudelongitude
- the longitudename
- the name that the place is known asstreetAddress
- the place's street address. May be null.containedWithin
- the ID of the place that the place is contained within
SimilarPlaces
collection, including a token that can be used to create a new place.
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.Place createPlace(PlacePrototype placePrototype)
placePrototype
- the place prototype returned in a SimilarPlaces
from a call to findSimilarPlaces()
Place
object with the newly created place data
org.springframework.social.ApiException
- if there is an error while communicating with Twitter.
org.springframework.social.MissingAuthorizationException
- if TwitterTemplate was not created with OAuth credentials.
|
Spring Social Twitter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |