Class google.gdata.gbase.SnippetsQuery

Object
   |
   +--google.gdata.client.Query
         |
         +--google.gdata.gbase.SnippetsQuery

class google.gdata.gbase.SnippetsQuery

extends google.gdata.client.Query

Describes a query for the feed of snippets of public items.
Defined in gdata.js

Field Detail

CONTENT_ADJUSTMENTS

<static> <final> {string} CONTENT_ADJUSTMENTS

Specifies that gm:adjusted_name and gm:adjusted_value should be included in query results.

See Also:

Constant Field Values

CONTENT_ALL

<static> <final> {string} CONTENT_ALL

Specifies that elements from the atom:, g:, and gm: namespaces should be returned. all also returns thumbnails.

See Also:

Constant Field Values

CONTENT_ATTRIBUTES

<static> <final> {string} CONTENT_ATTRIBUTES

Specifies that elements from the atom: and g: namespaces should be returned.

See Also:

Constant Field Values

CONTENT_META

<static> <final> {string} CONTENT_META

Specifies that the tags gm:stats and gm:adjusted should be returned.

See Also:

Constant Field Values

CONTENT_NONE

<static> <final> {string} CONTENT_NONE

Specifies that only elements from the atom: namespace should be returned.

See Also:

Constant Field Values

CONTENT_STATS

<static> <final> {string} CONTENT_STATS

Specifies that the gm:stats elements should be returned.

See Also:

Constant Field Values

CONTENT_THUMBNAILS

<static> <final> {string} CONTENT_THUMBNAILS

Specifies that links to generated thumbnails should be included in query results.

See Also:

Constant Field Values

ORDERBY_MODIFICATION_TIME

<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.

See Also:

Constant Field Values

ORDERBY_RELEVANCY

<static> <final> {string} ORDERBY_RELEVANCY

Specifies that query results should be sorted by relevancy.

See Also:

Constant Field Values

SORTORDER_ASCENDING

<static> <final> {string} SORTORDER_ASCENDING

Specifies that items should be returned in increasing rank.

See Also:

Constant Field Values

SORTORDER_DESCENDING

<static> <final> {string} SORTORDER_DESCENDING

Specifies that items should be returned in decreasing rank.

See Also:

Constant Field Values

google.gdata.gbase.SnippetsQuery

google.gdata.gbase.SnippetsQuery(<string> feedUri)

Constructor.

Parameters:
feedUri - URI of feed.

getAdjust

Boolean? getAdjust()

Returns the whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags.

Returns:
Whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags or null to indicate that the parameter is disabled.

getAuthor

String? getAuthor()

Returns the author name or email address.

Returns:
Author name or email address or null to indicate that the parameter is disabled.

getBq

String? getBq()

Returns the query string that conforms to the Query Language Specification.

Returns:
Query string that conforms to the Query Language Specification or null to indicate that the parameter is disabled.

getContent

String? getContent()

Returns the parameter that controls the content returned for each entry in a query request.

Returns:
Parameter that controls the content returned for each entry in a query request or null to indicate that the parameter is disabled.

getCrowdby

String? getCrowdby()

Returns the crowding criteria for queries.

Returns:
Crowding criteria for queries or null to indicate that the parameter is disabled.

getFullTextQuery

String? getFullTextQuery()

Returns the full-text query string.

Returns:
Full-text query string or null to indicate that the parameter is disabled.

getMaxResults

Number? getMaxResults()

Returns the maximum number of results to be retrieved.

Returns:
Maximum number of results to be retrieved or null to indicate that the parameter is disabled.

getOrderby

String? getOrderby()

Returns the ranking order for sorted queries.

Returns:
Ranking order for sorted queries or null to indicate that the parameter is disabled.

getPublishedMax

google.gdata.DateTime? getPublishedMax()

Returns the maximum published date.

Returns:
Maximum published date or null to indicate that the parameter is disabled.

getPublishedMin

google.gdata.DateTime? getPublishedMin()

Returns the minimum published date.

Returns:
Minimum published date or null to indicate that the parameter is disabled.

getRefine

Boolean? getRefine()

Returns the whether to refine the query results.

Returns:
Whether to refine the query results or null to indicate that the parameter is disabled.

getSortorder

String? getSortorder()

Returns the whether sorted query results are returned in increasing or decreasing order.

Returns:
Whether sorted query results are returned in increasing or decreasing order or null to indicate that the parameter is disabled.

getStartIndex

Number? getStartIndex()

Returns the 1-based index of the first result to be retrieved.

Returns:
1-based index of the first result to be retrieved or null to indicate that the parameter is disabled.

getUpdatedMax

google.gdata.DateTime? getUpdatedMax()

Returns the maximum updated date.

Returns:
Maximum updated date or null to indicate that the parameter is disabled.

getUpdatedMin

google.gdata.DateTime? getUpdatedMin()

Returns the minimum updated date.

Returns:
Minimum updated date or null to indicate that the parameter is disabled.

setAdjust

void setAdjust(<Boolean|string|null> adjust)

Sets the whether adjusted query results should contain the gm:adjusted_name and gm:adjusted_value tags. The default value is false.

Parameters:
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.

setAuthor

void setAuthor(<String?> author)

Sets the author name or email address.

Parameters:
author - Author name or email address or null to disable this parameter.

setBq

void setBq(<String?> bq)

Sets the query string that conforms to the Query Language Specification.

Parameters:
bq - Query string that conforms to the Query Language Specification or null to disable this parameter.

setContent

void setContent(<String?> content)

Sets the parameter that controls the content returned for each entry in a query request. The default value is 'attributes'.

Parameters:
content - Parameter that controls the content returned for each entry in a query request or null to disable this parameter.

setCrowdby

void setCrowdby(<String?> crowdby)

Sets the crowding criteria for queries.

Parameters:
crowdby - Crowding criteria for queries or null to disable this parameter.

setFullTextQuery

void setFullTextQuery(<String?> fullTextQuery)

Sets the full-text query string.

Parameters:
fullTextQuery - Full-text query string or null to disable this parameter.

setMaxResults

void setMaxResults(<Number|string|null> maxResults)

Sets the maximum number of results to be retrieved.

Parameters:
maxResults - Maximum number of results to be retrieved or an equivalent string value or null to disable this parameter.

setOrderby

void setOrderby(<String?> orderby)

Sets the ranking order for sorted queries. The default value is 'relevancy'.

Parameters:
orderby - Ranking order for sorted queries or null to disable this parameter.

setPublishedMax

void setPublishedMax(<google.gdata.DateTime|string|null> publishedMax)

Sets the maximum published date.

Parameters:
publishedMax - Maximum published date or an equivalent string value or null to disable this parameter.

setPublishedMin

void setPublishedMin(<google.gdata.DateTime|string|null> publishedMin)

Sets the minimum published date.

Parameters:
publishedMin - Minimum published date or an equivalent string value or null to disable this parameter.

setRefine

void setRefine(<Boolean|string|null> refine)

Sets the whether to refine the query results. The default value is false.

Parameters:
refine - Whether to refine the query results or an equivalent string value or null to disable this parameter.

setSortorder

void setSortorder(<String?> sortorder)

Sets the whether sorted query results are returned in increasing or decreasing order. The default value is 'descending'.

Parameters:
sortorder - Whether sorted query results are returned in increasing or decreasing order or null to disable this parameter.

setStartIndex

void setStartIndex(<Number|string|null> startIndex)

Sets the 1-based index of the first result to be retrieved. The default value is 1.

Parameters:
startIndex - 1-based index of the first result to be retrieved or an equivalent string value or null to disable this parameter.

setUpdatedMax

void setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)

Sets the maximum updated date.

Parameters:
updatedMax - Maximum updated date or an equivalent string value or null to disable this parameter.

setUpdatedMin

void setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)

Sets the minimum updated date.

Parameters:
updatedMin - Minimum updated date or an equivalent string value or null to disable this parameter.