PlaceGeoResources

Abstract Value Members

abstract def createPlace(name: String, containedWithin: String, token: String, location: GeoLocation, streetAddress: String): Place

Creates a new place at the given latitude and longitude.
Creates a new place at the given latitude and longitude.
This method calls twitter4j.Twitter.createPlace.
createPlace calls http://api.twitter.com/1.1/geo/place.json
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.
returns
the created place

Since
Twitter4S 1.0.0
Exceptions thrown
TwitterException
when Twitter service or network is unavailable
See also
POST geo/place | Twitter Developers
abstract def getGeoDetails(id: String): Place

Find out more details of a place that was returned from the twitter4j.api.GeoMethods#reverseGeoCode(twitter4j.GeoQuery) method.
Find out more details of a place that was returned from the twitter4j.api.GeoMethods#reverseGeoCode(twitter4j.GeoQuery) method.
This method calls twitter4j.Twitter.getGeoDetails(id)
getGeoDetails calls http://api.twitter.com/1.1/geo/id/:id.json
id
The ID of the location to query about.
returns
details of the specified place

Since
Twitter4S 1.0.0
Exceptions thrown
TwitterException
when Twitter service or network is unavailable
See also
GET geo/id/:place_id | Twitter Developers
abstract def getSimilarPlaces(location: GeoLocation, name: String, containedWithin: String, streetAddress: String): SimilarPlaces

Locates places near the given coordinates which are similar in name.
Locates places near the given coordinates which are similar in name.
Conceptually you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to post/geo/place to create a new one.
The token contained in the response is the token needed to be able to create a new place.
This method calls twitter4j.Twitter.getSimilarPlaces
getSimilarPlaces calls http://api.twitter.com/1.1/geo/similar_places.json
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.
returns
places (cities and neighborhoods) that can be attached to a statuses/update

Since
Twitter4S 1.0.0
Exceptions thrown
TwitterException
when Twitter service or network is unavailable
abstract def reverseGeoCode(query: GeoQuery): ResponseList[twitter4j.Place]

Search for places (cities and neighborhoods) that can be attached to a statuses/update.
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 twitter4j.Twitter.reverseGeoCode
reverseGeoCode calls http://api.twitter.com/1.1/geo/reverse_geocode.json
query
search query
returns
places (cities and neighborhoods) that can be attached to a statuses/update

Since
Twitter4S 1.0.0
Exceptions thrown
TwitterException
when Twitter service or network is unavailable
See also
GET geo/reverse_geocode | Twitter Developers
abstract def searchPlaces(query: GeoQuery): ResponseList[twitter4j.Place]

Search for places that can be attached to a statuses/update.
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 twitter4j.Twitter.searchPlaces
searchPlaces calls http://api.twitter.com/1.1/geo/search.json
query
search query
returns
places (cities and neighborhoods) that can be attached to a statuses/update

Since
Twitter4S 1.0.0
Exceptions thrown
TwitterException
when Twitter service or network is unavailable
See also
GET geo/search | Twitter Developers

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait PlaceGeoResources extends AnyRef

Abstract Value Members

abstract def createPlace(name: String, containedWithin: String, token: String, location: GeoLocation, streetAddress: String): Place

abstract def getGeoDetails(id: String): Place

abstract def getSimilarPlaces(location: GeoLocation, name: String, containedWithin: String, streetAddress: String): SimilarPlaces

abstract def reverseGeoCode(query: GeoQuery): ResponseList[twitter4j.Place]

abstract def searchPlaces(query: GeoQuery): ResponseList[twitter4j.Place]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped