| Package | com.yahoo.webapis.search.params |
| Class | public class SearchParams |
| Property | Defined by | ||
|---|---|---|---|
| album : String
The album name or partial album string to search for (UTF-8 encoded).
| SearchParams | ||
| albumId : String
The specific id for an album.
| SearchParams | ||
| allowAdultContent : Boolean
Specifies whether to allow results with adult content.
| SearchParams | ||
| allowSimilarContent : Boolean
Specifies whether to allow multiple results with similar content.
| SearchParams | ||
| artist : String
The artist terms to look for.
| SearchParams | ||
| artistId : String
The search terms to look for.
| SearchParams | ||
| category : uint
Search only in the specified category name or names.
| SearchParams | ||
| city : String
The city name.
| SearchParams | ||
| coloration : String
The service returns only the images of the coloration specified (color or black-and-white).
| SearchParams | ||
| context : String
The context to extract meaning from (UTF-8 encoded).
| SearchParams | ||
| country : String
Filter based on country: You can enter multiple countrys.
| SearchParams | ||
| dateRange : String
Filter based on date submitted:
all: Anytime
7: Within 7 days
7-30: Within 7-30 days
30-60: Within 30-60 days
60-90: Within 60-90 days
more90: More than 90 days
| SearchParams | ||
| format : String
Specifies the kind of file to search for.
| SearchParams | ||
| language : String
The language the results are written in.
| SearchParams | ||
| latitude : Number
The latitude of the starting location.
| SearchParams | ||
| license : String
The Creative Commons license that the contents are licensed under.
| SearchParams | ||
| listingId : String
The id associated with a specific business listing.
| SearchParams | ||
| location : String
This free field lets users enter any of the following:
city, state
city, state, zip
zip
street, city, state
street, city, state, zip
street, zip
If location is specified, it will take priority over the individual fields in determining the location for the query.
| SearchParams | ||
| longitude : Number
The longitude of the starting location.
| SearchParams | ||
| maximumResults : uint
Number of pages to be returned.
| SearchParams | ||
| minimumRating : uint
The minimum average rating (on a five point scale) for a result.
| SearchParams | ||
| omitCategory : uint
The id of a category to omit results from.
| SearchParams | ||
| query : String
The search terms to look for.
| SearchParams | ||
| radius : String
How far (in miles) from the specified location to search for the query terms.
| SearchParams | ||
| searchIn : String
Search for keywords.
| SearchParams | ||
| site : String
The site to limit the search to.
| SearchParams | ||
| song : String
The song title or partial song title string to search for (UTF-8 encoded).
| SearchParams | ||
| songId : String
The specific id for a song.
| SearchParams | ||
| sort : String
Sorting order of result set:
relevance: By relevance.
| SearchParams | ||
| source : String
The source of the download.
| SearchParams | ||
| start : uint
Starting page to list, used to display further results.
| SearchParams | ||
| state : String
The starting result position to return (1-based).
| SearchParams | ||
| street : String
Street name.
| SearchParams | ||
| type : String
The type of search to submit.
| SearchParams | ||
| zipCode : String
zip The five-digit zip code, or the five-digit code plus four-digit extension.
| SearchParams | ||
| Method | Defined by | ||
|---|---|---|---|
|
SearchParams Constructor
| SearchParams | ||
|
collect():String
Returns a string containing all enumerable variables, in the MIME content encoding application/x-www-form-urlencoded.
| SearchParams | ||
|
toString():String
The params as a string
| SearchParams | ||
| album | property |
album:String [read-write]The album name or partial album string to search for (UTF-8 encoded).
Implementation public function get album():String
public function set album(value:String):void
| albumId | property |
albumId:String [read-write]The specific id for an album. Ids are internal to the Music Search Service and will be returned with album references. At least one of artist, artistid, album or albumid is required.
Implementation public function get albumId():String
public function set albumId(value:String):void
| allowAdultContent | property |
allowAdultContent:Boolean [read-write]Specifies whether to allow results with adult content. Enter a 1 to allow adult content.
Implementation public function get allowAdultContent():Boolean
public function set allowAdultContent(value:Boolean):void
| allowSimilarContent | property |
allowSimilarContent:Boolean [read-write]Specifies whether to allow multiple results with similar content. Enter a 1 to allow similar content.
Implementation public function get allowSimilarContent():Boolean
public function set allowSimilarContent(value:Boolean):void
| artist | property |
artist:String [read-write]The artist terms to look for.
Implementation public function get artist():String
public function set artist(value:String):void
| artistId | property |
artistId:String [read-write]The search terms to look for.
Implementation public function get artistId():String
public function set artistId(value:String):void
| category | property |
category:uint [read-write]Search only in the specified category name or names. Will match against the full path to the English category name as found on the Yahoo! Search site. Category names are case-sensitive and should be URL-encoded. Computers & Internet>Software, for example, looks like this: Computers+%26+Internet%3ESoftware.
Implementation public function get category():uint
public function set category(value:uint):void
| city | property |
city:String [read-write]The city name.
Implementation public function get city():String
public function set city(value:String):void
| coloration | property |
coloration:String [read-write]The service returns only the images of the coloration specified (color or black-and-white).
Implementation public function get coloration():String
public function set coloration(value:String):void
| context | property |
context:String [read-write]The context to extract meaning from (UTF-8 encoded).
Implementation public function get context():String
public function set context(value:String):void
| country | property |
country:String [read-write]Filter based on country: You can enter multiple countrys. The first will determine the destination country of hyperlinks.
Implementation public function get country():String
public function set country(value:String):void
See also
| dateRange | property |
dateRange:String [read-write]Filter based on date submitted: all: Anytime 7: Within 7 days 7-30: Within 7-30 days 30-60: Within 30-60 days 60-90: Within 60-90 days more90: More than 90 days
The default value is all.
public function get dateRange():String
public function set dateRange(value:String):void
| format | property |
format:String [read-write]Specifies the kind of file to search for. html, msword, pdf, ppt, rss, txt, xls
The default value is all.
public function get format():String
public function set format(value:String):void
| language | property |
language:String [read-write]The language the results are written in.
Implementation public function get language():String
public function set language(value:String):void
See also
| latitude | property |
latitude:Number [read-write]The latitude of the starting location.
Implementation public function get latitude():Number
public function set latitude(value:Number):void
| license | property |
license:String [read-write]The Creative Commons license that the contents are licensed under. cc_any, cc_commercial, cc_modifiable
The default value is all.
public function get license():String
public function set license(value:String):void
| listingId | property |
listingId:String [read-write]The id associated with a specific business listing. It corresponds with the id attribute of Result entities. At least one of query or listing id must be specified.
Implementation public function get listingId():String
public function set listingId(value:String):void
| location | property |
location:String [read-write]This free field lets users enter any of the following: city, state city, state, zip zip street, city, state street, city, state, zip street, zip If location is specified, it will take priority over the individual fields in determining the location for the query. City, state and zip will be ignored.
Implementation public function get location():String
public function set location(value:String):void
| longitude | property |
longitude:Number [read-write]The longitude of the starting location. If both latitude and longitude are specified, they will take priority over all other location data. If only one of latitude or longitude is specified, both will be ignored.
Implementation public function get longitude():Number
public function set longitude(value:Number):void
| maximumResults | property |
maximumResults:uint [read-write]Number of pages to be returned. Between 1 and 100
The default value is 10.
public function get maximumResults():uint
public function set maximumResults(value:uint):void
| minimumRating | property |
minimumRating:uint [read-write]The minimum average rating (on a five point scale) for a result. If this is specified, no results without ratings will be returned.
Implementation public function get minimumRating():uint
public function set minimumRating(value:uint):void
| omitCategory | property |
omitCategory:uint [read-write]The id of a category to omit results from. Multiple categories may be omitted (omit_category=1234&omit_category=5678), and a result will not be returned if it appears in any of the specified categories.
Implementation public function get omitCategory():uint
public function set omitCategory(value:uint):void
| query | property |
query:String [read-write]The search terms to look for. Use + to include terms, - to exclude terms, and put quotes around "exact phrase".
Implementation public function get query():String
public function set query(value:String):void
| radius | property |
radius:String [read-write]How far (in miles) from the specified location to search for the query terms. The default radius varies according to the location given.
Implementation public function get radius():String
public function set radius(value:String):void
| searchIn | property |
searchIn:String [read-write]Search for keywords. When ommited default is "all".
Implementation public function get searchIn():String
public function set searchIn(value:String):void
| site | property |
site:String [read-write]The site to limit the search to.
Implementation public function get site():String
public function set site(value:String):void
| song | property |
song:String [read-write]The song title or partial song title string to search for (UTF-8 encoded).
Implementation public function get song():String
public function set song(value:String):void
| songId | property |
songId:String [read-write]The specific id for a song. Ids are internal to the Music Search Service and will be returned with song references. At least one of artist, artistid, album, albumid, song or songid is required.
Implementation public function get songId():String
public function set songId(value:String):void
| sort | property |
sort:String [read-write]Sorting order of result set: relevance: By relevance. title: By the page title. distance: By distance (local only). rating: By rating (local only)
The default value is relevance.
public function get sort():String
public function set sort(value:String):void
| source | property |
source:String [read-write]The source of the download. You may specify multiple values and a file from any of the sources specified will be returned. Valid values are: audiolunchbox artistdirect buymusic dmusic emusic epitonic garageband itunes yahoo livedownloads mp34u msn musicmatch mapster passalong rhapsody soundclick theweb
Implementation public function get source():String
public function set source(value:String):void
| start | property |
start:uint [read-write]Starting page to list, used to display further results. default 0
Implementation public function get start():uint
public function set start(value:uint):void
| state | property |
state:String [read-write]The starting result position to return (1-based).
Implementation public function get state():String
public function set state(value:String):void
| street | property |
street:String [read-write]Street name. The number is optional.
Implementation public function get street():String
public function set street(value:String):void
| type | property |
type:String [read-write]The type of search to submit.
Implementation public function get type():String
public function set type(value:String):void
| zipCode | property |
zipCode:String [read-write]zip The five-digit zip code, or the five-digit code plus four-digit extension. If this location contradicts the city and state specified, the zip code will be used for determining the location and the city and state will be ignored.
Implementation public function get zipCode():String
public function set zipCode(value:String):void
| SearchParams | () | constructor |
public function SearchParams()SearchParams Constructor
| collect | () | method |
public function collect():StringReturns a string containing all enumerable variables, in the MIME content encoding application/x-www-form-urlencoded.
ReturnsString |
| toString | () | method |
public function toString():StringThe params as a string
ReturnsString |