Class google.gdata.client.Query
Object
|
+--google.gdata.client.Query
-
Direct Known Subclasses:
-
google.gdata.finance.PositionQuery, google.gdata.contacts.ContactQuery, google.gdata.gbase.ItemsQuery, google.gdata.blogger.BlogQuery, google.gdata.gbase.ItemTypesQuery, google.gdata.gbase.AttributesQuery, google.gdata.blogger.BlogPostQuery, google.gdata.gbase.LocalesQuery, google.gdata.blogger.BlogCommentQuery, google.gdata.gbase.SnippetsQuery, google.gdata.calendar.CalendarEventQuery, google.gdata.finance.PortfolioQuery, google.gdata.calendar.CalendarCommentQuery, google.gdata.blogger.PostCommentQuery
- class
google.gdata.client.Query
Query. Sample usage:
var query = new Query('http://feedUrl');
query.setParam('q', 'search text');
query.setParam('max-results', 10);
query.setParam('updated-min', '2007-07-07');
var uri = query.getUri();
Defined in gdata.js
Field Summary |
{string} |
feedUri
Feed URI. |
Method Summary |
Object|Null
|
getParam(<string> name)
Returns the value of a parameter.
|
string
|
getPath()
Gets path of URI
|
string
|
getUri()
Gets URI of query
|
void
|
setParam(<string> name, <Object> value)
Sets a parameter of the query.
|
void
|
setParamDef(<string> name, <Object> paramDef)
Sets the definition of a parameter.
|
feedUri
{string} feedUri
google.gdata.client.Query
google.gdata.client.Query(<string> feedUri)
Creates a Query instance.
getParam
Object|Null getParam(<string> name)
Returns the value of a parameter.
Parameters:
name
- Name of the parameter.
Returns:
Parameter value or null
if not defined or if it is the same as the default value.
getPath
string getPath()
getUri
string getUri()
setParam
void setParam(<string> name, <Object> value)
Sets a parameter of the query. If a parameter definition does not already
exist for the parameter, we create a default for it before setting the
parameter. The default definition is no value decoration and no default
value.
Parameters:
name
- Name of the parameter.
value
- Value of the parameter.
setParamDef
void setParamDef(<string> name, <Object> paramDef)
Sets the definition of a parameter.
Parameters:
name
- Name of the parameter.
paramDef
- Definition of the parameter which can have any of the following properties:
decorator {Function}: Optional value decorator. defaultValue {any}: Optional default value; if parameter value is the same as default value, parameter is not included in query string.
Documentation generated by
JSDoc on Mon Mar 30 15:50:55 2009