![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/services/documents/gdata-documents-query.h> GDataDocumentsQuery; GDataDocumentsQueryClass; GDataDocumentsQuery * gdata_documents_query_new (const gchar *q); GDataDocumentsQuery * gdata_documents_query_new_with_limits (const gchar *q, gint start_index, gint max_results); gboolean gdata_documents_query_show_deleted (GDataDocumentsQuery *self); void gdata_documents_query_set_show_deleted (GDataDocumentsQuery *self, gboolean show_deleted); gboolean gdata_documents_query_show_folders (GDataDocumentsQuery *self); void gdata_documents_query_set_show_folders (GDataDocumentsQuery *self, gboolean show_folders); const gchar * gdata_documents_query_get_folder_id (GDataDocumentsQuery *self); void gdata_documents_query_set_folder_id (GDataDocumentsQuery *self, const gchar *folder_id); const gchar * gdata_documents_query_get_title (GDataDocumentsQuery *self); gboolean gdata_documents_query_get_exact_title (GDataDocumentsQuery *self); void gdata_documents_query_set_title (GDataDocumentsQuery *self, const gchar *title, gboolean exact_title); GList * gdata_documents_query_get_collaborator_addresses (GDataDocumentsQuery *self); void gdata_documents_query_add_collaborator (GDataDocumentsQuery *self, const gchar *email_address); GList * gdata_documents_query_get_reader_addresses (GDataDocumentsQuery *self); void gdata_documents_query_add_reader (GDataDocumentsQuery *self, const gchar *email_address);
"exact-title" gboolean : Read / Write "folder-id" gchar* : Read / Write "show-deleted" gboolean : Read / Write "show-folders" gboolean : Read / Write "title" gchar* : Read / Write
GDataDocumentsQuery represents a collection of query parameters specific to the Google Documents service, which go above and beyond those catered for by GDataQuery.
For more information on the custom GData query parameters supported by GDataDocumentsQuery, see the online documentation.
typedef struct _GDataDocumentsQuery GDataDocumentsQuery;
All the fields in the GDataDocumentsQuery structure are private and should never be accessed directly.
Since 0.4.0
typedef struct { } GDataDocumentsQueryClass;
All the fields in the GDataDocumentsQueryClass structure are private and should never be accessed directly.
Since 0.4.0
GDataDocumentsQuery * gdata_documents_query_new (const gchar *q);
Creates a new GDataDocumentsQuery with its "q" property set to q
.
|
a query string |
Returns : |
a new GDataDocumentsQuery |
Since 0.4.0
GDataDocumentsQuery * gdata_documents_query_new_with_limits (const gchar *q, gint start_index, gint max_results);
Creates a new GDataDocumentsQuery with its "q" property set to q
, and the limits start_index
and max_results
applied.
|
a query string |
|
a one-based start index for the results |
|
the maximum number of results to return |
Returns : |
a new GDataDocumentsQuery |
Since 0.4.0
gboolean gdata_documents_query_show_deleted (GDataDocumentsQuery *self);
Gets the "show_deleted" property.
|
a GDataDocumentsQuery |
Returns : |
TRUE if the request should return deleted entries, FALSE otherwise
|
Since 0.4.0
void gdata_documents_query_set_show_deleted (GDataDocumentsQuery *self, gboolean show_deleted);
Sets the "show_deleted" property to show_deleted
.
|
a GDataDocumentsQuery |
|
TRUE if the request should return deleted entries, FALSE otherwise
|
Since 0.4.0
gboolean gdata_documents_query_show_folders (GDataDocumentsQuery *self);
Gets the "show-folders" property.
|
a GDataDocumentsQuery |
Returns : |
TRUE if the request should return folders, FALSE otherwise
|
Since 0.4.0
void gdata_documents_query_set_show_folders (GDataDocumentsQuery *self, gboolean show_folders);
Sets the "show-folders" property to show_folders.
|
a GDataDocumentsQuery |
|
TRUE if the request should return folders, FALSE otherwise
|
Since 0.4.0
const gchar * gdata_documents_query_get_folder_id (GDataDocumentsQuery *self);
Gets the "folder-id" property.
|
a GDataDocumentsQuery |
Returns : |
the ID of the folder to be queried, or NULL
|
Since 0.4.0
void gdata_documents_query_set_folder_id (GDataDocumentsQuery *self, const gchar *folder_id);
Sets the "folder-id" property to folder_id
.
Set folder_id
to NULL
to unset the property in the query URI.
|
a GDataDocumentsQuery |
|
the ID of the folder to be queried, or NULL
|
Since 0.4.0
const gchar * gdata_documents_query_get_title (GDataDocumentsQuery *self);
Gets the "title" property.
|
a GDataDocumentsQuery |
Returns : |
the title (or title fragment) being queried for, or NULL
|
Since 0.4.0
gboolean gdata_documents_query_get_exact_title (GDataDocumentsQuery *self);
Gets the "exact-title" property.
|
a GDataDocumentsQuery |
Returns : |
TRUE if the query matches the exact title of documents with "title", FALSE otherwise
|
Since 0.4.0
void gdata_documents_query_set_title (GDataDocumentsQuery *self, const gchar *title, gboolean exact_title);
Sets the "title" property to title
.
Set title
to NULL
to unset the property in the query URI.
|
a GDataDocumentsQuery |
|
the title (or title fragment) to query for, or NULL
|
|
TRUE if the query should match the exact title , FALSE otherwise
|
Since 0.4.0
GList * gdata_documents_query_get_collaborator_addresses (GDataDocumentsQuery *self);
Gets a list of GDataGDEmailAddresses of the document collaborators whose documents will be queried.
|
a GDataDocumentsQuery |
Returns : |
a list of GDataGDEmailAddresses of the collaborators concerned by the query, or NULL
|
Since 0.4.0
void gdata_documents_query_add_collaborator (GDataDocumentsQuery *self, const gchar *email_address);
Add email_address
as a GDataGDEmailAddress to the list of collaborators whose edited documents will be queried.
|
a GDataDocumentsQuery |
|
the e-mail address of the collaborator to add |
Since 0.4.0
GList * gdata_documents_query_get_reader_addresses (GDataDocumentsQuery *self);
Gets a list of GDataGDEmailAddresses of the document readers whose documents will be queried.
|
a GDataDocumentsQuery |
Returns : |
a list of GDataGDEmailAddresses of the readers concerned by the query, or NULL
|
Since 0.4.0
void gdata_documents_query_add_reader (GDataDocumentsQuery *self, const gchar *email_address);
Add email_address
as a GDataGDEmailAddress to the list of readers, the documents readable by whom will be queried.
|
a GDataDocumentsQuery |
|
the e-mail address of the reader to add |
Since 0.4.0
"exact-title"
property"exact-title" gboolean : Read / Write
Specifies whether the query should search for an exact title match for the "title" parameter.
Default value: FALSE
Since 0.4.0
"folder-id"
property"folder-id" gchar* : Read / Write
Specifies the ID of the folder in which to search.
Default value: NULL
Since 0.4.0
"show-deleted"
property"show-deleted" gboolean : Read / Write
A shortcut to request all documents that have been deleted.
Default value: FALSE
Since 0.4.0
"show-folders"
property"show-folders" gboolean : Read / Write
Specifies if the request also returns folders.
Default value: FALSE
Since 0.4.0