Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

author?: string

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

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

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.

future_events?: boolean

A shortcut to request all events scheduled for the future. Overrides the #GDataCalendarQuery:start-min and #GDataCalendarQuery:start-max properties.

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.

max_attendees?: number

Specifies the maximum number of attendees to list for an event. If the actual number of attendees for an event is greater than this value, only the current user and the event organiser are listed.

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.

order_by?: string

Specifies order of entries in a feed. Supported values are lastmodified and starttime.

published_max?: number

Upper bound on the entry publish date, exclusive.

published_min?: number

Lower bound on the entry publish date, inclusive.

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.

show_deleted?: boolean

Whether to include deleted/cancelled events in the query feed. Deleted events have their #GDataCalendarEvent:status property set to %GDATA_GD_EVENT_STATUS_CANCELED. They do not normally appear in query results.

single_events?: boolean

Indicates whether recurring events should be expanded or represented as a single event.

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.

start_max?: number

Together with #GDataCalendarQuery:start-min, creates a timespan such that only events within the timespan are returned

#GDataCalendarQuery:start-min is inclusive, while #GDataCalendarQuery:start-max is exclusive. Events that overlap the range are included. Both are specified in seconds since the UNIX epoch.

If not specified, the default #GDataCalendarQuery:start-max is 2031-01-01.

start_min?: number

Together with #GDataCalendarQuery:start-max, creates a timespan such that only events within the timespan are returned.

#GDataCalendarQuery:start-min is inclusive, while #GDataCalendarQuery:start-max is exclusive. Events that overlap the range are included. Both are specified in seconds since the UNIX epoch.

If not specified, the default #GDataCalendarQuery:start-min is 1970-01-01.

timezone?: string

The current timezone. If this is not specified, all times are returned in UTC.

updated_max?: number

Upper bound on the entry update date, exclusive.

updated_min?: number

Lower bound on the entry update date, inclusive.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method