trait TwitterGeoClient extends AnyRef
Implements the available requests for the geo
resource.
- Source
- TwitterGeoClient.scala
- Alphabetic
- By Inheritance
- TwitterGeoClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val restClient: RestClient
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def advancedSearchGeoPlace(latitude: Option[Double] = None, longitude: Option[Double] = None, query: Option[String] = None, ip: Option[String] = None, granularity: Option[Granularity] = None, accuracy: Option[Accuracy] = None, max_results: Option[Int] = None, contained_within: Option[String] = None, street_address: Option[String] = None, callback: Option[String] = None): Future[RatedData[GeoSearch]]
Advanced search for places that can be attached to a statuses/update.
Advanced 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. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search.
- latitude
: Optional, by default it is
None
. The latitude to search around. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a correspondinglongitude
parameter.- longitude
: Optional, by default it is
None
. The longitude to search around. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if geo_enabled is disabled, or if there not a correspondinglatitude
parameter.- query
: Optional, by default it is
None
. Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.- ip
: Optional, by default it is
None
. An IP address. Used when attempting to fix geolocation based off of the user’s IP address.- granularity
: By default it is
Neighborhood
This is the minimal granularity of place types to return.- max_results
: Optional, by default it is
None
. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many “nearby” results to return. Ideally, only pass in the number of places you intend to display to the user here.- contained_within
: Optional, by default it is
None
. This is 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.- street_address
: Optional, by default it is
None
. 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.- callback
: Optional, by default it is
None
. If supplied, the response will use the JSONP format with a callback of the given name.- returns
: The geo search result.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def geoPlace(place_id: String): Future[RatedData[GeoPlace]]
Returns all the information about a known place.
Returns all the information about a known place. For more information see https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id.
- place_id
: A place id in the world.
- returns
: A set of information about place.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def reverseGeocode(latitude: Double, longitude: Double, accuracy: Accuracy = Accuracy.Default, granularity: Granularity = Granularity.Neighborhood, max_results: Option[Int] = None, callback: Option[String] = None): Future[RatedData[GeoSearch]]
Given a latitude and a longitude, searches for up to 20 places that can be used as a place id when updating a status.
Given a latitude and a longitude, searches for up to 20 places that can be used as a place id when updating a status. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode.
- latitude
: The latitude to search around. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding long parameter.
- longitude
: The longitude to search around. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter.
- accuracy
: By default it is
Default
, which is 0 meters. A hint on the “region” in which to search.- granularity
: By default it is
Neighborhood
This is the minimal granularity of place types to return.- max_results
: Optional, by default it is
None
. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many “nearby” results to return. Ideally, only pass in the number of places you intend to display to the user here.- callback
: Optional, by default it is
None
. If supplied, the response will use the JSONP format with a callback of the given name.- returns
: The geo search result.
- def searchGeoPlace(query: String): Future[RatedData[GeoSearch]]
Search for places that can be attached to a statuses/update.
Search for places that can be attached to a statuses/update. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search.
- query
: Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
- returns
: The geo search result.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])