|
GData JavaScript Client 1.9 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.client.Query | +--google.gdata.gbase.SnippetsQuery
Describes a query for the feed of snippets of public items.
Defined in gdata.js
Field Summary | |
<static> <final> {string} |
CONTENT_ADJUSTMENTS
Specifies that gm:adjusted_name and gm:adjusted_value should be included in query results. |
<static> <final> {string} |
CONTENT_ALL
Specifies that elements from the atom:, g:, and gm: namespaces should be returned. |
<static> <final> {string} |
CONTENT_ATTRIBUTES
Specifies that elements from the atom: and g: namespaces should be returned. |
<static> <final> {string} |
CONTENT_META
Specifies that the tags gm:stats and gm:adjusted should be returned. |
<static> <final> {string} |
CONTENT_NONE
Specifies that only elements from the atom: namespace should be returned. |
<static> <final> {string} |
CONTENT_STATS
Specifies that the gm:stats elements should be returned. |
<static> <final> {string} |
CONTENT_THUMBNAILS
Specifies that links to generated thumbnails should be included in query results. |
<static> <final> {string} |
ORDERBY_MODIFICATION_TIME
Specifies that query results should be sorted by last modification time, where the most recently modified item has the highest rank. |
<static> <final> {string} |
ORDERBY_RELEVANCY
Specifies that query results should be sorted by relevancy. |
<static> <final> {string} |
SORTORDER_ASCENDING
Specifies that items should be returned in increasing rank. |
<static> <final> {string} |
SORTORDER_DESCENDING
Specifies that items should be returned in decreasing rank. |
Fields inherited from class google.gdata.client.Query |
feedUri
|
Constructor Summary | |
google.gdata.gbase.SnippetsQuery(<string> feedUri)
Constructor. |
Method Summary | |
Boolean?
|
getAdjust()
Returns the whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags. |
String?
|
getAuthor()
Returns the author name or email address. |
String?
|
getBq()
Returns the query string that conforms to the Query Language Specification. |
String?
|
getContent()
Returns the parameter that controls the content returned for each entry in a query request. |
String?
|
getCrowdby()
Returns the crowding criteria for queries. |
String?
|
getFullTextQuery()
Returns the full-text query string. |
Number?
|
getMaxResults()
Returns the maximum number of results to be retrieved. |
String?
|
getOrderby()
Returns the ranking order for sorted queries. |
google.gdata.DateTime?
|
getPublishedMax()
Returns the maximum published date. |
google.gdata.DateTime?
|
getPublishedMin()
Returns the minimum published date. |
Boolean?
|
getRefine()
Returns the whether to refine the query results. |
String?
|
getSortorder()
Returns the whether sorted query results are returned in increasing or decreasing order. |
Number?
|
getStartIndex()
Returns the 1-based index of the first result to be retrieved. |
google.gdata.DateTime?
|
getUpdatedMax()
Returns the maximum updated date. |
google.gdata.DateTime?
|
getUpdatedMin()
Returns the minimum updated date. |
void
|
setAdjust(<Boolean|string|null> adjust)
Sets the whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags. |
void
|
setAuthor(<String?> author)
Sets the author name or email address. |
void
|
setBq(<String?> bq)
Sets the query string that conforms to the Query Language Specification. |
void
|
setContent(<String?> content)
Sets the parameter that controls the content returned for each entry in a query request. |
void
|
setCrowdby(<String?> crowdby)
Sets the crowding criteria for queries. |
void
|
setFullTextQuery(<String?> fullTextQuery)
Sets the full-text query string. |
void
|
setMaxResults(<Number|string|null> maxResults)
Sets the maximum number of results to be retrieved. |
void
|
setOrderby(<String?> orderby)
Sets the ranking order for sorted queries. |
void
|
setPublishedMax(<google.gdata.DateTime|string|null> publishedMax)
Sets the maximum published date. |
void
|
setPublishedMin(<google.gdata.DateTime|string|null> publishedMin)
Sets the minimum published date. |
void
|
setRefine(<Boolean|string|null> refine)
Sets the whether to refine the query results. |
void
|
setSortorder(<String?> sortorder)
Sets the whether sorted query results are returned in increasing or decreasing order. |
void
|
setStartIndex(<Number|string|null> startIndex)
Sets the 1-based index of the first result to be retrieved. |
void
|
setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)
Sets the maximum updated date. |
void
|
setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)
Sets the minimum updated date. |
Methods inherited from class google.gdata.client.Query |
setParamDef, setParam, getPath, getUri, getParam
|
Field Detail |
<static> <final> {string} CONTENT_ADJUSTMENTS
<static> <final> {string} CONTENT_ALL
<static> <final> {string} CONTENT_ATTRIBUTES
<static> <final> {string} CONTENT_META
<static> <final> {string} CONTENT_NONE
<static> <final> {string} CONTENT_STATS
<static> <final> {string} CONTENT_THUMBNAILS
<static> <final> {string} ORDERBY_MODIFICATION_TIME
<static> <final> {string} ORDERBY_RELEVANCY
<static> <final> {string} SORTORDER_ASCENDING
<static> <final> {string} SORTORDER_DESCENDING
Constructor Detail |
google.gdata.gbase.SnippetsQuery(<string> feedUri)
feedUri
- URI of feed.
Method Detail |
Boolean? getAdjust()
null
to indicate that the parameter is disabled.
String? getAuthor()
null
to indicate that the parameter is disabled.
String? getBq()
null
to indicate that the parameter is disabled.
String? getContent()
null
to indicate that the parameter is disabled.
String? getCrowdby()
null
to indicate that the parameter is disabled.
String? getFullTextQuery()
null
to indicate that the parameter is disabled.
Number? getMaxResults()
null
to indicate that the parameter is disabled.
String? getOrderby()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getPublishedMax()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getPublishedMin()
null
to indicate that the parameter is disabled.
Boolean? getRefine()
null
to indicate that the parameter is disabled.
String? getSortorder()
null
to indicate that the parameter is disabled.
Number? getStartIndex()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getUpdatedMax()
null
to indicate that the parameter is disabled.
google.gdata.DateTime? getUpdatedMin()
null
to indicate that the parameter is disabled.
void setAdjust(<Boolean|string|null> adjust)
adjust
- Whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags or an equivalent string value or null
to disable this parameter.
void setAuthor(<String?> author)
author
- Author name or email address or null
to disable this parameter.
void setBq(<String?> bq)
bq
- Query string that conforms to the Query Language Specification or null
to disable this parameter.
void setContent(<String?> content)
content
- Parameter that controls the content returned for each entry in a query request or null
to disable this parameter.
void setCrowdby(<String?> crowdby)
crowdby
- Crowding criteria for queries or null
to disable this parameter.
void setFullTextQuery(<String?> fullTextQuery)
fullTextQuery
- Full-text query string or null
to disable this parameter.
void setMaxResults(<Number|string|null> maxResults)
maxResults
- Maximum number of results to be retrieved or an equivalent string value or null
to disable this parameter.
void setOrderby(<String?> orderby)
orderby
- Ranking order for sorted queries or null
to disable this parameter.
void setPublishedMax(<google.gdata.DateTime|string|null> publishedMax)
publishedMax
- Maximum published date or an equivalent string value or null
to disable this parameter.
void setPublishedMin(<google.gdata.DateTime|string|null> publishedMin)
publishedMin
- Minimum published date or an equivalent string value or null
to disable this parameter.
void setRefine(<Boolean|string|null> refine)
refine
- Whether to refine the query results or an equivalent string value or null
to disable this parameter.
void setSortorder(<String?> sortorder)
sortorder
- Whether sorted query results are returned in increasing or decreasing order or null
to disable this parameter.
void setStartIndex(<Number|string|null> startIndex)
startIndex
- 1-based index of the first result to be retrieved or an equivalent string value or null
to disable this parameter.
void setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)
updatedMax
- Maximum updated date or an equivalent string value or null
to disable this parameter.
void setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)
updatedMin
- Minimum updated date or an equivalent string value or null
to disable this parameter.
|
GData JavaScript Client 1.9 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |