query


Description:

[ Version ( since = "0.9.0" ) ]
public Feed query (AuthorizationDomain? domain, string feed_uri, Query? query, Type entry_type, Cancellable? cancellable, QueryProgressCallback? progress_callback) throws Error

Queries the service's feed_uri feed to build a Feed.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled before or during network activity, the error CANCELLED will be returned. Cancellation has no effect after network activity has finished, however, and the query will return successfully (or return an error sent by the server) if it is first cancelled after network activity has finished. See the overview of cancellation for more details.

A PROTOCOL_ERROR will be returned if the server indicates there is a problem with the query, but subclasses may override this and return their own errors. See their documentation for more details.

For each entry in the response feed, progress_callback will be called in the main thread. If there was an error parsing the XML response, a ParserError will be returned.

If the query is successful and the feed supports pagination, query will be updated with the pagination URIs, and the next or previous page can then be loaded by calling next_page or previous_page before running the query again.

If the Query's ETag is set and it finds a match on the server, null will be returned, but error will remain unset. Otherwise, query's ETag will be updated with the ETag from the returned feed, if available.

Parameters:

this

a Service

domain

the AuthorizationDomain the query falls under, or null

feed_uri

the feed URI to query, including the host name and protocol

query

a Query with the query parameters, or null

entry_type

a Type for the Entrys to build from the XML

cancellable

optional Cancellable object, or null

progress_callback

a QueryProgressCallback to call when an entry is loaded, or null

progress_user_data

data to pass to the progress_callback function

Returns:

a Feed of query results, or null; unref with unref