Blame docs/reference/html/GDataDocumentsQuery.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataDocumentsQuery: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch16.html" title="Google Documents/Drive API">
Packit 4b6dd7
<link rel="prev" href="GDataDocumentsFeed.html" title="GDataDocumentsFeed">
Packit 4b6dd7
<link rel="next" href="GDataDocumentsUploadQuery.html" title="GDataDocumentsUploadQuery">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsQuery

Packit 4b6dd7

GDataDocumentsQuery — GData Documents query object

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsQuery *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_new ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsQuery *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_new_with_limits ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_show_deleted ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_set_show_deleted ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_show_folders ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_set_show_folders ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_get_folder_id ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_set_folder_id ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_get_title ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_get_exact_title ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_set_title ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GList *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_get_collaborator_addresses ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_add_collaborator ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GList *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_get_reader_addresses ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_add_reader ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
exact-title
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
folder-id
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
show-deleted
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
show-folders
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
title
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsQuery
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsQueryClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataQuery
Packit 4b6dd7
        ╰── GDataDocumentsQuery
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/services/documents/gdata-documents-query.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataDocumentsQuery represents a collection of query parameters specific to the Google Documents service, which go above and beyond

Packit 4b6dd7
those catered for by GDataQuery.

Packit 4b6dd7

For more information on the custom GData query parameters supported by GDataDocumentsQuery, see the online documentation.

Packit 4b6dd7
Packit 4b6dd7

Example 30. Querying for Documents

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
        
GDataDocumentsService *service;
Packit 4b6dd7
GDataDocumentsQuery *query;
Packit 4b6dd7
GDataFeed *feed;
Packit 4b6dd7
GTimeVal current_time;
Packit 4b6dd7
GList *i;
Packit 4b6dd7
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service */
Packit 4b6dd7
service = create_documents_service ();
Packit 4b6dd7
Packit 4b6dd7
/* Create the query to use. We're going to query for the last 10 documents modified by example@gmail.com in the past week, including
Packit 4b6dd7
 * deleted documents. */
Packit 4b6dd7
query = gdata_documents_query_new_with_limits (NULL, 0, 10);
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_query_add_collaborator (query, "example@gmail.com");
Packit 4b6dd7
gdata_documents_query_set_show_deleted (query, TRUE);
Packit 4b6dd7
Packit 4b6dd7
g_get_current_time (&current_time);
Packit 4b6dd7
gdata_query_set_updated_min (GDATA_QUERY (query), current_time.tv_sec - 7 * 24 * 60 * 60);
Packit 4b6dd7
gdata_query_set_updated_max (GDATA_QUERY (query), current_time.tv_sec);
Packit 4b6dd7
Packit 4b6dd7
/* Execute the query */
Packit 4b6dd7
feed = gdata_documents_service_query_documents (service, query, NULL, NULL, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (query);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error querying for documents: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Iterate through the returned documents and do something with them */
Packit 4b6dd7
for (i = gdata_feed_get_entries (feed); i != NULL; i = i->next) {
Packit 4b6dd7
    GDataDocumentsDocument *document = GDATA_DOCUMENTS_DOCUMENT (i->data);
Packit 4b6dd7
Packit 4b6dd7
    /* Do something with the document here, such as insert it into a UI */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (feed);
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_new ()

Packit 4b6dd7
GDataDocumentsQuery *
Packit 4b6dd7
gdata_documents_query_new (const gchar *q);
Packit 4b6dd7

Creates a new GDataDocumentsQuery with its “q” property set to q

Packit 4b6dd7
.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

q

Packit 4b6dd7

a query string, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataDocumentsQuery

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_new_with_limits ()

Packit 4b6dd7
GDataDocumentsQuery *
Packit 4b6dd7
gdata_documents_query_new_with_limits (const gchar *q,
Packit 4b6dd7
                                       guint start_index,
Packit 4b6dd7
                                       guint max_results);
Packit 4b6dd7

Creates a new GDataDocumentsQuery with its “q” property set to q

Packit 4b6dd7
, and the limits start_index
Packit 4b6dd7
 and max_results
Packit 4b6dd7
Packit 4b6dd7
applied.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

q

Packit 4b6dd7

a query string, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

start_index

Packit 4b6dd7

a one-based start index for the results, or 0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

max_results

Packit 4b6dd7

the maximum number of results to return, or 0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataDocumentsQuery

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_show_deleted ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_documents_query_show_deleted (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets the “show_deleted” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the request should return deleted entries, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_set_show_deleted ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_set_show_deleted
Packit 4b6dd7
                               (GDataDocumentsQuery *self,
Packit 4b6dd7
                                gboolean show_deleted);
Packit 4b6dd7

Sets the “show_deleted” property to show_deleted

Packit 4b6dd7
.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

show_deleted

Packit 4b6dd7

TRUE if the request should return deleted entries, FALSE otherwise

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_show_folders ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_documents_query_show_folders (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets the “show-folders” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the request should return folders, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_set_show_folders ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_set_show_folders
Packit 4b6dd7
                               (GDataDocumentsQuery *self,
Packit 4b6dd7
                                gboolean show_folders);
Packit 4b6dd7

Sets the “show-folders” property to show_folders.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

show_folders

Packit 4b6dd7

TRUE if the request should return folders, FALSE otherwise

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_get_folder_id ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_documents_query_get_folder_id (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets the “folder-id” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the ID of the folder to be queried, or NULL

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_set_folder_id ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_set_folder_id (GDataDocumentsQuery *self,
Packit 4b6dd7
                                     const gchar *folder_id);
Packit 4b6dd7

Sets the “folder-id” property to folder_id

Packit 4b6dd7
.

Packit 4b6dd7

Set folder_id

Packit 4b6dd7
 to NULL to unset the property in the query URI.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

folder_id

Packit 4b6dd7

the ID of the folder to be queried, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_get_title ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_documents_query_get_title (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets the “title” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the title (or title fragment) being queried for, or NULL

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_get_exact_title ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_documents_query_get_exact_title (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets the “exact-title” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the query matches the exact title of documents with “title”, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_set_title ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_set_title (GDataDocumentsQuery *self,
Packit 4b6dd7
                                 const gchar *title,
Packit 4b6dd7
                                 gboolean exact_title);
Packit 4b6dd7

Sets the “title” property to title

Packit 4b6dd7
.

Packit 4b6dd7

Set title

Packit 4b6dd7
 to NULL to unset the property in the query URI.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

title

Packit 4b6dd7

the title (or title fragment) to query for, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

exact_title

Packit 4b6dd7

TRUE if the query should match the exact title

Packit 4b6dd7
, FALSE otherwise

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_get_collaborator_addresses ()

Packit 4b6dd7
GList *
Packit 4b6dd7
gdata_documents_query_get_collaborator_addresses
Packit 4b6dd7
                               (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets a list of GDataGDEmailAddresses of the document collaborators whose documents will be queried.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a list of GDataGDEmailAddresses of the collaborators concerned by the

Packit 4b6dd7
query, or NULL. 

Packit 4b6dd7

[element-type GData.GDEmailAddress][transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_add_collaborator ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_add_collaborator
Packit 4b6dd7
                               (GDataDocumentsQuery *self,
Packit 4b6dd7
                                const gchar *email_address);
Packit 4b6dd7

Add email_address

Packit 4b6dd7
 as a GDataGDEmailAddress to the list of collaborators whose edited documents will be queried.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

email_address

Packit 4b6dd7

the e-mail address of the collaborator to add

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_get_reader_addresses ()

Packit 4b6dd7
GList *
Packit 4b6dd7
gdata_documents_query_get_reader_addresses
Packit 4b6dd7
                               (GDataDocumentsQuery *self);
Packit 4b6dd7

Gets a list of GDataGDEmailAddresses of the document readers whose documents will be queried.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a list of GDataGDEmailAddresses of the readers concerned by the query,

Packit 4b6dd7
or NULL. 

Packit 4b6dd7

[element-type GData.GDEmailAddress][transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_query_add_reader ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_query_add_reader (GDataDocumentsQuery *self,
Packit 4b6dd7
                                  const gchar *email_address);
Packit 4b6dd7

Add email_address

Packit 4b6dd7
 as a GDataGDEmailAddress to the list of readers, the documents readable by whom will be queried.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataDocumentsQuery

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

email_address

Packit 4b6dd7

the e-mail address of the reader to add

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsQuery

Packit 4b6dd7
typedef struct _GDataDocumentsQuery GDataDocumentsQuery;
Packit 4b6dd7

All the fields in the GDataDocumentsQuery structure are private and should never be accessed directly.

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsQueryClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
} GDataDocumentsQueryClass;
Packit 4b6dd7
Packit 4b6dd7

All the fields in the GDataDocumentsQueryClass structure are private and should never be accessed directly.

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “exact-title” property

Packit 4b6dd7
  “exact-title”              gboolean
Packit 4b6dd7

Specifies whether the query should search for an exact title match for the “title” parameter.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: FALSE

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “folder-id” property

Packit 4b6dd7
  “folder-id”                gchar *
Packit 4b6dd7

Specifies the ID of the folder in which to search.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “show-deleted” property

Packit 4b6dd7
  “show-deleted”             gboolean
Packit 4b6dd7

A shortcut to request all documents that have been deleted.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: FALSE

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “show-folders” property

Packit 4b6dd7
  “show-folders”             gboolean
Packit 4b6dd7

Specifies if the request also returns folders.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: FALSE

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “title” property

Packit 4b6dd7
  “title”                    gchar *
Packit 4b6dd7

A title (or title fragment) to be searched for. If “exact-title” is TRUE, an exact

Packit 4b6dd7
title match will be searched for, otherwise substring matches will also be returned.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>