Packagecom.yahoo.maps.webservices.local
Classpublic class LocalSearchResults

This class stores the local listings result data returned by the Yahoo! Local Search API.



Public Properties
 PropertyDefined by
  begin : Number
[read-only] A number specifying the starting index in the query arguments.
LocalSearchResults
  city : String
[read-only] A String containing the city used in the query arguments.
LocalSearchResults
  latlon : LatLon
[read-only] A LatLon object representing the latitude and longitude used as the center point in the query arguments.
LocalSearchResults
  numListings : Number
[read-only] A number containing the amount of results returned.
LocalSearchResults
  results : Array
[read-only] An array of the LocalSearchItem results.
LocalSearchResults
  resultURL : String
[read-only] A string containing the URL to the Yahoo! Local search results page.
LocalSearchResults
  searchRadius : Number
[read-only] A number specifying the radius in the query arguments.
LocalSearchResults
  searchTotal : Number
[read-only] A number specifying the total amount of results found by the service.
LocalSearchResults
  state : String
[read-only] A String containing the state used in the query arguments.
LocalSearchResults
  street : String
[read-only] A String containing the street used in the query arguments.
LocalSearchResults
  term : String
[read-only] A String containing the query term used in the query arguments.
LocalSearchResults
  zip : String
[read-only] A String containing the zip code used in the query arguments.
LocalSearchResults
Public Methods
 MethodDefined by
  
Creates a new LocalSearchResults object
LocalSearchResults
Property detail
beginproperty
begin:Number  [read-only]

A number specifying the starting index in the query arguments.

Implementation
    public function get begin():Number
cityproperty 
city:String  [read-only]

A String containing the city used in the query arguments.

Implementation
    public function get city():String
latlonproperty 
latlon:LatLon  [read-only]

A LatLon object representing the latitude and longitude used as the center point in the query arguments.

Implementation
    public function get latlon():LatLon
numListingsproperty 
numListings:Number  [read-only]

A number containing the amount of results returned.

Implementation
    public function get numListings():Number
resultsproperty 
results:Array  [read-only]

An array of the LocalSearchItem results.

Implementation
    public function get results():Array
resultURLproperty 
resultURL:String  [read-only]

A string containing the URL to the Yahoo! Local search results page.

Implementation
    public function get resultURL():String
searchRadiusproperty 
searchRadius:Number  [read-only]

A number specifying the radius in the query arguments.

Implementation
    public function get searchRadius():Number
searchTotalproperty 
searchTotal:Number  [read-only]

A number specifying the total amount of results found by the service.

Implementation
    public function get searchTotal():Number
stateproperty 
state:String  [read-only]

A String containing the state used in the query arguments.

Implementation
    public function get state():String
streetproperty 
street:String  [read-only]

A String containing the street used in the query arguments.

Implementation
    public function get street():String
termproperty 
term:String  [read-only]

A String containing the query term used in the query arguments.

Implementation
    public function get term():String
zipproperty 
zip:String  [read-only]

A String containing the zip code used in the query arguments.

Implementation
    public function get zip():String
Constructor detail
LocalSearchResults()constructor
public function LocalSearchResults(xml:XML)

Creates a new LocalSearchResults object

Parameters
xml:XML