Interface Query_ConstructProps

Hierarchy

GObject.Object_ConstructProps
- Query_ConstructProps

Index

Properties

Optional author

author?: string

An entry author. The service returns entries where the author name and/or e-mail address match your query string.

Optional categories

categories?: string

A category filter.

You can query on multiple categories by listing multiple categories separated by slashes. The service returns all entries that match all of the categories (like using AND between terms). For example: Fritz/Laurie returns entries that match both categories ("Fritz" and "Laurie").

To do an OR between terms, use a pipe character (|). For example: Fritz%7CLaurie returns entries that match either category.

An entry matches a specified category if the entry is in a category that has a matching term or label, as defined in the Atom specification. (Roughly, the "term" is the internal string used by the software to identify the category, while the "label" is the human-readable string presented to a user in a user interface.)

To exclude entries that match a given category, use the form -categoryname.

To query for a category that has a scheme – such as <category scheme="urn:google.com" term="public"/> – you must place the scheme in curly braces before the category name. For example: {urn:google.com}public. To match a category that has no scheme, use an empty pair of curly braces. If you don't specify curly braces, then categories in any scheme will match.

The above features can be combined. For example: A|-{urn:google.com}B/-C means (A OR (NOT B)) AND (NOT C).

Optional etag

etag?: string

The ETag against which to check for updates. If the server-side ETag matches this one, the requested feed hasn't changed, and is not returned unnecessarily.

Setting any of the other query properties will unset the ETag, as ETags match against entire queries. If the ETag should be used in a query, it must be set again using gdata_query_set_etag() after setting any other properties.

Optional is_strict

is_strict?: boolean

Strict query parameter checking. If this is enabled, an error will be returned by the online service if a parameter is not recognised.

Optional max_results

max_results?: number

Maximum number of results to be retrieved. Most services have a default #GDataQuery:max-results size imposed by the server; if you wish to receive the entire feed, specify a large number such as %G_MAXUINT for this property.

Use 0 to not specify a maximum number of results.

Optional published_max

published_max?: number

Upper bound on the entry publish date, exclusive.

Optional published_min

published_min?: number

Lower bound on the entry publish date, inclusive.

Optional q

q?: string

A full-text query string.

When creating a query, list search terms separated by spaces, in the form term1 term2 term3. (As with all of the query parameter values, the spaces must be URL encoded.) The service returns all entries that match all of the search terms (like using AND between terms). Like Google's web search, a service searches on complete words (and related words with the same stem), not substrings.

To search for an exact phrase, enclose the phrase in quotation marks: "exact phrase".

To exclude entries that match a given term, use the form -term.

The search is case-insensitive.

Example: to search for all entries that contain the exact phrase "Elizabeth Bennet" and the word "Darcy" but don't contain the word "Austen", use the following query: "Elizabeth Bennet" Darcy -Austen.

Optional start_index

start_index?: number

The one-based index of the first result to be retrieved. Use gdata_query_next_page() and gdata_query_previous_page() to implement pagination, rather than manually changing #GDataQuery:start-index.

Use 0 to not specify a start index.

Optional updated_max

updated_max?: number

Upper bound on the entry update date, exclusive.

Optional updated_min

updated_min?: number

Lower bound on the entry update date, inclusive.