~ubuntu-branches/ubuntu/natty/libgdata/natty-updates

« back to all changes in this revision

Viewing changes to docs/reference/html/GDataDocumentsService.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2011-01-05 11:09:00 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20110105110900-gkjnbslnr18s45us
Tags: 0.8.0-0ubuntu1
* New upstream release
* debian/control:
  - Use gir1.2 packages
  - Use standards version 3.9.1
  - Add Vcs-Bzr link
  - Rename libgdata10 to libgdata11
* debian/rules:
  - Drop simple-patchsys.mk
* debian/source:
  - Use source version 3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
47
47
</div>
48
48
<div class="refsynopsisdiv">
49
49
<a name="GDataDocumentsService.synopsis"></a><h2>Synopsis</h2>
50
 
<pre class="synopsis">
 
50
<a name="GDataDocumentsServiceError"></a><pre class="synopsis">
51
51
#include &lt;gdata/services/documents/gdata-documents-service.h&gt;
52
52
 
53
53
                    <a class="link" href="GDataDocumentsService.html#GDataDocumentsService-struct" title="GDataDocumentsService">GDataDocumentsService</a>;
54
54
                    <a class="link" href="GDataDocumentsService.html#GDataDocumentsServiceClass" title="GDataDocumentsServiceClass">GDataDocumentsServiceClass</a>;
55
 
enum                <a class="link" href="GDataDocumentsService.html#GDataDocumentsServiceError" title="enum GDataDocumentsServiceError">GDataDocumentsServiceError</a>;
56
 
<a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="returnvalue">GDataDocumentsService</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-new" title="gdata_documents_service_new ()">gdata_documents_service_new</a>     (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>);
 
55
enum                <a class="link" href="GDataDocumentsService.html#GDataDocumentsServiceError">GDataDocumentsServiceError</a>;
 
56
<a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="returnvalue">GDataDocumentsService</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-new" title="gdata_documents_service_new ()">gdata_documents_service_new</a>     (<em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>);
57
57
<a class="link" href="GDataDocumentsFeed.html" title="GDataDocumentsFeed"><span class="returnvalue">GDataDocumentsFeed</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-query-documents" title="gdata_documents_service_query_documents ()">gdata_documents_service_query_documents</a>
58
58
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
59
59
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> *query</code></em>,
60
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
60
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
62
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
63
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
62
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
 
63
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
64
64
<span class="returnvalue">void</span>                <a class="link" href="GDataDocumentsService.html#gdata-documents-service-query-documents-async" title="gdata_documents_service_query_documents_async ()">gdata_documents_service_query_documents_async</a>
65
65
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
66
66
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> *query</code></em>,
67
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
67
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
68
68
                                                         <em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
69
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
70
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
71
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
72
 
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-upload-document" title="gdata_documents_service_upload_document ()">gdata_documents_service_upload_document</a>
73
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
74
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
75
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *document_file</code></em>,
76
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
77
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
78
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
79
 
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-update-document" title="gdata_documents_service_update_document ()">gdata_documents_service_update_document</a>
80
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
81
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
82
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *document_file</code></em>,
83
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
84
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
85
 
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-move-document-to-folder" title="gdata_documents_service_move_document_to_folder ()">gdata_documents_service_move_document_to_folder</a>
86
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
87
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
88
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
89
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
90
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
91
 
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-document-from-folder" title="gdata_documents_service_remove_document_from_folder ()">gdata_documents_service_remove_document_from_folder</a>
92
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
93
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
94
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
95
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
96
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
97
 
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="GDataDocumentsService.html#gdata-documents-service-get-upload-uri" title="gdata_documents_service_get_upload_uri ()">gdata_documents_service_get_upload_uri</a>
 
69
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
 
70
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
71
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
72
<a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="returnvalue">GDataUploadStream</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-upload-document" title="gdata_documents_service_upload_document ()">gdata_documents_service_upload_document</a>
 
73
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
74
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> *document</code></em>,
 
75
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
 
76
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
 
77
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
78
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
79
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
80
<a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="returnvalue">GDataUploadStream</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-update-document" title="gdata_documents_service_update_document ()">gdata_documents_service_update_document</a>
 
81
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
82
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> *document</code></em>,
 
83
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
 
84
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
 
85
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
86
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
87
<a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="returnvalue">GDataDocumentsDocument</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-finish-upload" title="gdata_documents_service_finish_upload ()">gdata_documents_service_finish_upload</a>
 
88
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
89
                                                         <em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *upload_stream</code></em>,
 
90
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
91
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder" title="gdata_documents_service_add_entry_to_folder ()">gdata_documents_service_add_entry_to_folder</a>
 
92
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
93
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
94
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
95
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
96
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
97
<span class="returnvalue">void</span>                <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder-async" title="gdata_documents_service_add_entry_to_folder_async ()">gdata_documents_service_add_entry_to_folder_async</a>
 
98
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
99
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
100
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
101
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
102
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
103
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
104
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder-finish" title="gdata_documents_service_add_entry_to_folder_finish ()">gdata_documents_service_add_entry_to_folder_finish</a>
 
105
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
106
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *async_result</code></em>,
 
107
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
108
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder" title="gdata_documents_service_remove_entry_from_folder ()">gdata_documents_service_remove_entry_from_folder</a>
 
109
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
110
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
111
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
112
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
113
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
114
<span class="returnvalue">void</span>                <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder-async" title="gdata_documents_service_remove_entry_from_folder_async ()">gdata_documents_service_remove_entry_from_folder_async</a>
 
115
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
116
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
117
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
118
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
119
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
120
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
121
<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder-finish" title="gdata_documents_service_remove_entry_from_folder_finish ()">gdata_documents_service_remove_entry_from_folder_finish</a>
 
122
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
123
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *async_result</code></em>,
 
124
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
125
<a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="GDataDocumentsService.html#gdata-documents-service-get-upload-uri" title="gdata_documents_service_get_upload_uri ()">gdata_documents_service_get_upload_uri</a>
98
126
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>);
99
127
</pre>
100
128
</div>
101
129
<div class="refsect1">
102
130
<a name="GDataDocumentsService.object-hierarchy"></a><h2>Object Hierarchy</h2>
103
131
<pre class="synopsis">
104
 
  <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
132
  <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
105
133
   +----<a class="link" href="GDataService.html" title="GDataService">GDataService</a>
106
134
         +----GDataDocumentsService
107
135
</pre>
 
136
<pre class="synopsis">
 
137
  GEnum
 
138
   +----GDataDocumentsServiceError
 
139
</pre>
108
140
</div>
109
141
<div class="refsect1">
110
142
<a name="GDataDocumentsService.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
133
165
<a class="ulink" href="http://groups.google.com/group/Google-Docs-Data-APIs/browse_thread/thread/bfc50e94e303a29a?pli=1" target="_top">
134
166
online explanation about the problem</a>.
135
167
</p>
 
168
<p>
 
169
</p>
 
170
<div class="example">
 
171
<a name="id665406"></a><p class="title"><b>Example 21. Uploading a Document from Disk</b></p>
 
172
<div class="example-contents">
 
173
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
174
    <tbody>
 
175
      <tr>
 
176
        <td class="listing_lines" align="right"><pre>1
 
177
2
 
178
3
 
179
4
 
180
5
 
181
6
 
182
7
 
183
8
 
184
9
 
185
10
 
186
11
 
187
12
 
188
13
 
189
14
 
190
15
 
191
16
 
192
17
 
193
18
 
194
19
 
195
20
 
196
21
 
197
22
 
198
23
 
199
24
 
200
25
 
201
26
 
202
27
 
203
28
 
204
29
 
205
30
 
206
31
 
207
32
 
208
33
 
209
34
 
210
35
 
211
36
 
212
37
 
213
38
 
214
39
 
215
40
 
216
41
 
217
42
 
218
43
 
219
44
 
220
45
 
221
46
 
222
47
 
223
48
 
224
49
 
225
50
 
226
51
 
227
52
 
228
53
 
229
54
 
230
55
 
231
56
 
232
57
 
233
58
 
234
59
 
235
60
 
236
61
 
237
62
 
238
63
 
239
64
 
240
65
 
241
66
 
242
67
 
243
68
 
244
69
 
245
70
 
246
71
 
247
72
 
248
73
 
249
74
 
250
75
 
251
76
 
252
77
 
253
78
 
254
79
 
255
80
 
256
81
 
257
82
 
258
83
 
259
84
 
260
85
 
261
86
 
262
87
 
263
88
 
264
89
 
265
90
 
266
91
 
267
92
 
268
93
 
269
94
 
270
95</pre></td>
 
271
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GDataDocumentsService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
 
272
<span class="usertype">GDataDocumentsDocument</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">document</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">uploaded_document</span><span class="symbol">;</span>
 
273
<span class="usertype">GFile</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">document_file</span><span class="symbol">;</span>
 
274
<span class="usertype">GDataDocumentsFolder</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">destination_folder</span><span class="symbol">;</span>
 
275
<span class="usertype">GFileInfo</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file_info</span><span class="symbol">;</span>
 
276
<span class="keyword">const</span><span class="normal"> </span><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">slug</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">content_type</span><span class="symbol">;</span>
 
277
<span class="usertype">GFileInputStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file_stream</span><span class="symbol">;</span>
 
278
<span class="usertype">GDataUploadStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">upload_stream</span><span class="symbol">;</span>
 
279
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
 
280
 
 
281
<span class="comment">/* Create a service */</span>
 
282
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_documents_service</span><span class="normal"> </span><span class="symbol">();</span>
 
283
 
 
284
<span class="comment">/* Get the document file to upload and the folder to upload it into */</span>
 
285
<span class="normal">document_file </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#g-file-new-for-path">g_file_new_for_path</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"document.odt"</span><span class="symbol">);</span>
 
286
<span class="normal">destination_folder </span><span class="symbol">=</span><span class="normal"> </span><span class="function">query_user_for_destination_folder</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
287
 
 
288
<span class="comment">/* Get the file's display name and content type */</span>
 
289
<span class="normal">file_info </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#g-file-query-info">g_file_query_info</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document_file</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFileInfo.html#G-FILE-ATTRIBUTE-STANDARD-DISPLAY-NAME:CAPS">G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</a> </span><span class="string">","</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFileInfo.html#G-FILE-ATTRIBUTE-STANDARD-CONTENT-TYPE:CAPS">G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</a></span><span class="symbol">,</span>
 
290
<span class="normal">                               <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#G-FILE-QUERY-INFO-NONE:CAPS">G_FILE_QUERY_INFO_NONE</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
291
 
 
292
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
293
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error getting document file information: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
294
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
295
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">destination_folder</span><span class="symbol">);</span>
 
296
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document_file</span><span class="symbol">);</span>
 
297
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
298
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
299
<span class="cbracket">}</span>
 
300
 
 
301
<span class="normal">slug </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFileInfo.html#g-file-info-get-display-name">g_file_info_get_display_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>
 
302
<span class="normal">content_type </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFileInfo.html#g-file-info-get-content-type">g_file_info_get_content_type</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>
 
303
 
 
304
<span class="comment">/* Get an input stream for the file */</span>
 
305
<span class="normal">file_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#g-file-read">g_file_read</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document_file</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
306
 
 
307
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document_file</span><span class="symbol">);</span>
 
308
 
 
309
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
310
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error getting document file stream: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
311
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
312
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>
 
313
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">destination_folder</span><span class="symbol">);</span>
 
314
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
315
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
316
<span class="cbracket">}</span>
 
317
 
 
318
<span class="comment">/* Create the document metadata to upload */</span>
 
319
<span class="normal">document </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsText.html#gdata-documents-text-new">gdata_documents_text_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
 
320
<span class="function"><a href="GDataEntry.html#gdata-entry-set-title">gdata_entry_set_title</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_ENTRY</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"Document Title"</span><span class="symbol">);</span>
 
321
 
 
322
<span class="comment">/* Get an upload stream for the document */</span>
 
323
<span class="normal">upload_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-upload-document">gdata_documents_service_upload_document</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">,</span><span class="normal"> document</span><span class="symbol">,</span><span class="normal"> slug</span><span class="symbol">,</span><span class="normal"> content_type</span><span class="symbol">,</span><span class="normal"> destination_folder</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
324
 
 
325
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">document</span><span class="symbol">);</span>
 
326
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>
 
327
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">destination_folder</span><span class="symbol">);</span>
 
328
 
 
329
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
330
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error getting upload stream: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
331
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
332
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_stream</span><span class="symbol">);</span>
 
333
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
334
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
335
<span class="cbracket">}</span>
 
336
 
 
337
<span class="comment">/* Upload the document. This is a blocking operation, and should normally be done asynchronously. */</span>
 
338
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#g-output-stream-splice">g_output_stream_splice</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">G_OUTPUT_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">),</span><span class="normal"> </span><span class="function">G_INPUT_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_stream</span><span class="symbol">),</span>
 
339
<span class="normal">                        <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#G-OUTPUT-STREAM-SPLICE-CLOSE-SOURCE:CAPS">G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE</a> </span><span class="symbol">|</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#G-OUTPUT-STREAM-SPLICE-CLOSE-TARGET:CAPS">G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
340
 
 
341
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_stream</span><span class="symbol">);</span>
 
342
 
 
343
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
344
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error splicing streams: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
345
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
346
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">);</span>
 
347
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
348
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
349
<span class="cbracket">}</span>
 
350
 
 
351
<span class="comment">/* Finish off the upload by parsing the returned updated document metadata entry */</span>
 
352
<span class="normal">uploaded_document </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-finish-upload">gdata_documents_service_finish_upload</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">,</span><span class="normal"> upload_stream</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
353
 
 
354
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">);</span>
 
355
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
356
 
 
357
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
358
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error uploading document: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
359
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
360
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
361
<span class="cbracket">}</span>
 
362
 
 
363
<span class="comment">/* Do something with the uploaded document */</span>
 
364
 
 
365
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">uploaded_document</span><span class="symbol">);</span></pre></td>
 
366
      </tr>
 
367
    </tbody>
 
368
  </table>
 
369
</div>
 
370
 
 
371
</div>
 
372
<p><br class="example-break">
 
373
</p>
 
374
<p>
 
375
The Documents service can be manipulated using batch operations, too. See the
 
376
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#ACLBatch" target="_top">online documentation on batch
 
377
operations</a> for more information.
 
378
</p>
 
379
<p>
 
380
</p>
 
381
<div class="example">
 
382
<a name="id692889"></a><p class="title"><b>Example 22. Performing a Batch Operation on Documents</b></p>
 
383
<div class="example-contents">
 
384
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
385
    <tbody>
 
386
      <tr>
 
387
        <td class="listing_lines" align="right"><pre>1
 
388
2
 
389
3
 
390
4
 
391
5
 
392
6
 
393
7
 
394
8
 
395
9
 
396
10
 
397
11
 
398
12
 
399
13
 
400
14
 
401
15
 
402
16
 
403
17
 
404
18
 
405
19
 
406
20
 
407
21
 
408
22
 
409
23
 
410
24
 
411
25
 
412
26
 
413
27
 
414
28
 
415
29
 
416
30
 
417
31
 
418
32
 
419
33
 
420
34
 
421
35
 
422
36
 
423
37
 
424
38
 
425
39
 
426
40
 
427
41
 
428
42
 
429
43
 
430
44
 
431
45
 
432
46
 
433
47
 
434
48
 
435
49
 
436
50
 
437
51
 
438
52
 
439
53
 
440
54
 
441
55
 
442
56
 
443
57
 
444
58
 
445
59
 
446
60</pre></td>
 
447
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GDataDocumentsService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
 
448
<span class="usertype">GDataBatchOperation</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">operation</span><span class="symbol">;</span>
 
449
<span class="usertype">GDataFeed</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">feed</span><span class="symbol">;</span>
 
450
<span class="usertype">GDataLink</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">batch_link</span><span class="symbol">;</span>
 
451
<span class="usertype">GList</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">i</span><span class="symbol">;</span>
 
452
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
 
453
 
 
454
<span class="comment">/* Create a service */</span>
 
455
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_documents_service</span><span class="normal"> </span><span class="symbol">();</span>
 
456
 
 
457
<span class="comment">/* Create the batch operation; this requires that we have done a query first so that we can get the batch link */</span>
 
458
<span class="normal">feed </span><span class="symbol">=</span><span class="normal"> </span><span class="function">do_some_query</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
459
<span class="normal">batch_link </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataFeed.html#gdata-feed-look-up-link">gdata_feed_look_up_link</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">feed</span><span class="symbol">,</span><span class="normal"> <a href="GDataLink.html#GDATA-LINK-BATCH:CAPS">GDATA_LINK_BATCH</a></span><span class="symbol">);</span>
 
460
<span class="normal">operation </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataBatchable.html#gdata-batchable-create-operation">gdata_batchable_create_operation</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_BATCHABLE</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">),</span><span class="normal"> </span><span class="function"><a href="GDataLink.html#gdata-link-get-uri">gdata_link_get_uri</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">batch_link</span><span class="symbol">));</span>
 
461
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">feed</span><span class="symbol">);</span>
 
462
 
 
463
<span class="function"><a href="GDataBatchOperation.html#gdata-batch-operation-add-query">gdata_batch_operation_add_query</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">,</span><span class="normal"> presentation_entry_id_to_query</span><span class="symbol">,</span><span class="normal"> GDATA_TYPE_DOCUMENTS_PRESENTATION</span><span class="symbol">,</span>
 
464
<span class="normal">                                 </span><span class="symbol">(</span><span class="normal"><a href="GDataBatchOperation.html#GDataBatchOperationCallback">GDataBatchOperationCallback</a></span><span class="symbol">)</span><span class="normal"> batch_query_cb</span><span class="symbol">,</span><span class="normal"> user_data</span><span class="symbol">);</span>
 
465
<span class="function"><a href="GDataBatchOperation.html#gdata-batch-operation-add-insertion">gdata_batch_operation_add_insertion</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">,</span><span class="normal"> new_entry</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="GDataBatchOperation.html#GDataBatchOperationCallback">GDataBatchOperationCallback</a></span><span class="symbol">)</span><span class="normal"> batch_insertion_cb</span><span class="symbol">,</span><span class="normal"> user_data</span><span class="symbol">);</span>
 
466
<span class="function"><a href="GDataBatchOperation.html#gdata-batch-operation-add-update">gdata_batch_operation_add_update</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">,</span><span class="normal"> old_entry</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="GDataBatchOperation.html#GDataBatchOperationCallback">GDataBatchOperationCallback</a></span><span class="symbol">)</span><span class="normal"> batch_update_cb</span><span class="symbol">,</span><span class="normal"> user_data</span><span class="symbol">);</span>
 
467
<span class="function"><a href="GDataBatchOperation.html#gdata-batch-operation-add-deletion">gdata_batch_operation_add_deletion</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">,</span><span class="normal"> entry_to_delete</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="GDataBatchOperation.html#GDataBatchOperationCallback">GDataBatchOperationCallback</a></span><span class="symbol">)</span><span class="normal"> batch_deletion_cb</span><span class="symbol">,</span><span class="normal"> user_data</span><span class="symbol">);</span>
 
468
 
 
469
<span class="comment">/* Run the batch operation and handle the results in the various callbacks */</span>
 
470
<span class="function">gdata_test_batch_operation_run</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
 
471
 
 
472
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">operation</span><span class="symbol">);</span>
 
473
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
 
474
 
 
475
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
 
476
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error running batch operation: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
477
<span class="normal">    </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
 
478
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
479
<span class="cbracket">}</span>
 
480
 
 
481
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
 
482
<span class="function">batch_query_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">guint</span><span class="normal"> operation_id</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataBatchOperationType</span><span class="normal"> operation_type</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataEntry</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">entry</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
 
483
<span class="cbracket">{</span>
 
484
<span class="normal">    </span><span class="comment">/* operation_type == GDATA_BATCH_OPERATION_QUERY */</span>
 
485
<span class="normal">    </span><span class="comment">/* Reference and do something with the returned entry. */</span>
 
486
<span class="cbracket">}</span>
 
487
 
 
488
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
 
489
<span class="function">batch_insertion_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">guint</span><span class="normal"> operation_id</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataBatchOperationType</span><span class="normal"> operation_type</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataEntry</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">entry</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
 
490
<span class="cbracket">{</span>
 
491
<span class="normal">    </span><span class="comment">/* operation_type == GDATA_BATCH_OPERATION_INSERTION */</span>
 
492
<span class="normal">    </span><span class="comment">/* Reference and do something with the returned entry. */</span>
 
493
<span class="cbracket">}</span>
 
494
 
 
495
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
 
496
<span class="function">batch_update_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">guint</span><span class="normal"> operation_id</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataBatchOperationType</span><span class="normal"> operation_type</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataEntry</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">entry</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
 
497
<span class="cbracket">{</span>
 
498
<span class="normal">    </span><span class="comment">/* operation_type == GDATA_BATCH_OPERATION_UPDATE */</span>
 
499
<span class="normal">    </span><span class="comment">/* Reference and do something with the returned entry. */</span>
 
500
<span class="cbracket">}</span>
 
501
 
 
502
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
 
503
<span class="function">batch_deletion_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">guint</span><span class="normal"> operation_id</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataBatchOperationType</span><span class="normal"> operation_type</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GDataEntry</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">entry</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
 
504
<span class="cbracket">{</span>
 
505
<span class="normal">    </span><span class="comment">/* operation_type == GDATA_BATCH_OPERATION_DELETION, entry == NULL */</span>
 
506
<span class="cbracket">}</span></pre></td>
 
507
      </tr>
 
508
    </tbody>
 
509
  </table>
 
510
</div>
 
511
 
 
512
</div>
 
513
<p><br class="example-break">
 
514
</p>
136
515
</div>
137
516
<div class="refsect1">
138
517
<a name="GDataDocumentsService.details"></a><h2>Details</h2>
178
557
<hr>
179
558
<div class="refsect2">
180
559
<a name="gdata-documents-service-new"></a><h3>gdata_documents_service_new ()</h3>
181
 
<pre class="programlisting"><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="returnvalue">GDataDocumentsService</span></a> * gdata_documents_service_new     (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>);</pre>
 
560
<pre class="programlisting"><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="returnvalue">GDataDocumentsService</span></a> * gdata_documents_service_new     (<em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>);</pre>
182
561
<p>
183
562
Creates a new <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>. The <em class="parameter"><code>client_id</code></em> must be unique for your application, and as registered with Google.
184
563
</p>
191
570
</tr>
192
571
<tr>
193
572
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
194
 
<td>a new <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
 
573
<td>a new <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
195
574
</td>
196
575
</tr>
197
576
</tbody>
204
583
<pre class="programlisting"><a class="link" href="GDataDocumentsFeed.html" title="GDataDocumentsFeed"><span class="returnvalue">GDataDocumentsFeed</span></a> * gdata_documents_service_query_documents
205
584
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
206
585
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> *query</code></em>,
207
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
586
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
208
587
                                                         <em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
209
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
210
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
588
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
 
589
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
211
590
<p>
212
591
Queries the service to return a list of documents matching the given <em class="parameter"><code>query</code></em>. Note that <em class="parameter"><code>query</code></em> has to be a <a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a>, rather than just
213
592
a <a class="link" href="GDataQuery.html" title="GDataQuery"><span class="type">GDataQuery</span></a>, as it uses the folder ID specified in <a class="link" href="GDataDocumentsQuery.html#GDataDocumentsQuery--folder-id" title='The "folder-id" property'><span class="type">"folder-id"</span></a>.
225
604
</tr>
226
605
<tr>
227
606
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
228
 
<td>a <a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> with the query parameters, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
607
<td>a <a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> with the query parameters, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
229
608
</td>
230
609
</tr>
231
610
<tr>
232
611
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
233
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
612
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
234
613
</td>
235
614
</tr>
236
615
<tr>
237
616
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
238
 
<td>a <a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> to call when an entry is loaded, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 
617
<td>a <a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> to call when an entry is loaded, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
239
618
</td>
240
619
</tr>
241
620
<tr>
245
624
</tr>
246
625
<tr>
247
626
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
248
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
627
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
249
628
</td>
250
629
</tr>
251
630
<tr>
252
631
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
253
 
<td>a <a class="link" href="GDataDocumentsFeed.html" title="GDataDocumentsFeed"><span class="type">GDataDocumentsFeed</span></a> of query results; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
632
<td>a <a class="link" href="GDataDocumentsFeed.html" title="GDataDocumentsFeed"><span class="type">GDataDocumentsFeed</span></a> of query results; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
254
633
</td>
255
634
</tr>
256
635
</tbody>
263
642
<pre class="programlisting"><span class="returnvalue">void</span>                gdata_documents_service_query_documents_async
264
643
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
265
644
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> *query</code></em>,
266
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
645
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
267
646
                                                         <em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
268
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
269
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
270
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
647
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
 
648
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
649
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
271
650
<p>
272
651
Queries the service to return a list of documents matching the given <em class="parameter"><code>query</code></em>. <em class="parameter"><code>self</code></em> and
273
652
<em class="parameter"><code>query</code></em> are both reffed when this function is called, so can safely be unreffed after this function returns.
286
665
</tr>
287
666
<tr>
288
667
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
289
 
<td>a <a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> with the query parameters, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
668
<td>a <a class="link" href="GDataDocumentsQuery.html" title="GDataDocumentsQuery"><span class="type">GDataDocumentsQuery</span></a> with the query parameters, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
290
669
</td>
291
670
</tr>
292
671
<tr>
293
672
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
294
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
673
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
295
674
</td>
296
675
</tr>
297
676
<tr>
298
677
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
299
 
<td>a <a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> to call when an entry is loaded, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
678
<td>a <a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> to call when an entry is loaded, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
300
679
</td>
301
680
</tr>
302
681
<tr>
305
684
</tr>
306
685
<tr>
307
686
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
308
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when authentication is finished</td>
 
687
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when authentication is finished</td>
309
688
</tr>
310
689
<tr>
311
690
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
319
698
<hr>
320
699
<div class="refsect2">
321
700
<a name="gdata-documents-service-upload-document"></a><h3>gdata_documents_service_upload_document ()</h3>
322
 
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_upload_document
 
701
<pre class="programlisting"><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="returnvalue">GDataUploadStream</span></a> * gdata_documents_service_upload_document
323
702
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
324
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
325
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *document_file</code></em>,
 
703
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> *document</code></em>,
 
704
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
 
705
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
326
706
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
327
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
328
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
329
 
<p>
330
 
Uploads a document to Google Documents, using the properties from <em class="parameter"><code>document</code></em> and the document file pointed to by <em class="parameter"><code>document_file</code></em>.
331
 
</p>
332
 
<p>
333
 
If <em class="parameter"><code>document</code></em> is <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, only the document file will be uploaded. The new document entry will be named after the document file's name,
334
 
and will have default metadata.
335
 
</p>
336
 
<p>
337
 
If <em class="parameter"><code>document_file</code></em> is <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, only the document metadata will be uploaded. A blank document file will be created with the name
338
 
<code class="literal">new document</code> and the specified metadata. <em class="parameter"><code>document</code></em> and <em class="parameter"><code>document_file</code></em> cannot both be <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, but can both have values.
339
 
</p>
340
 
<p>
341
 
The updated <em class="parameter"><code>document_entry</code></em> will be returned on success, containing updated metadata.
342
 
</p>
343
 
<p>
344
 
If there is a problem reading <em class="parameter"><code>document_file</code></em>, an error from <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html#g-file-load-contents"><code class="function">g_file_load_contents()</code></a> or <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html#g-file-query-info"><code class="function">g_file_query_info()</code></a> will be returned. Other errors from
345
 
<a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for other exceptional conditions, as determined by the server.
 
707
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
708
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
709
<p>
 
710
Uploads a document to Google Documents, using the properties from <em class="parameter"><code>document</code></em> and the document data written to the resulting <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>. If
 
711
the document data does not need to be provided at the moment, just the metadata, use <a class="link" href="GDataService.html#gdata-service-insert-entry" title="gdata_service_insert_entry ()"><code class="function">gdata_service_insert_entry()</code></a> instead (e.g. in the case of
 
712
creating a new, empty file to be edited at a later date).
 
713
</p>
 
714
<p>
 
715
If <em class="parameter"><code>document</code></em> is <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, only the document data will be uploaded. The new document entry will be named using <em class="parameter"><code>slug</code></em>, and will have default metadata.
 
716
</p>
 
717
<p>
 
718
The stream returned by this function should be written to using the standard <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> methods, asychronously or synchronously. Once the stream
 
719
is closed (using <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#g-output-stream-close"><code class="function">g_output_stream_close()</code></a>), <a class="link" href="GDataDocumentsService.html#gdata-documents-service-finish-upload" title="gdata_documents_service_finish_upload ()"><code class="function">gdata_documents_service_finish_upload()</code></a> should be called on it to parse and return the updated
 
720
<a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> for the document. This must be done, as <em class="parameter"><code>document</code></em> isn't updated in-place.
 
721
</p>
 
722
<p>
 
723
In order to cancel the upload, a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> passed in to <em class="parameter"><code>cancellable</code></em> must be cancelled using <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html#g-cancellable-cancel"><code class="function">g_cancellable_cancel()</code></a>. Cancelling the individual
 
724
<a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> operations on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will not cancel the entire upload; merely the write or close operation in question. See the
 
725
<a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title='The "cancellable" property'><span class="type">"cancellable"</span></a> for more details.
 
726
</p>
 
727
<p>
 
728
Any upload errors will be thrown by the stream methods, and may come from the <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> domain.
346
729
</p>
347
730
<div class="variablelist"><table border="0">
348
731
<col align="left" valign="top">
354
737
</tr>
355
738
<tr>
356
739
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
357
 
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to insert, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
358
 
</td>
359
 
</tr>
360
 
<tr>
361
 
<td><p><span class="term"><em class="parameter"><code>document_file</code></em> :</span></p></td>
362
 
<td>the document to upload, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
363
 
</td>
 
740
<td>the <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> to insert, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
741
</td>
 
742
</tr>
 
743
<tr>
 
744
<td><p><span class="term"><em class="parameter"><code>slug</code></em> :</span></p></td>
 
745
<td>the filename to give to the uploaded document</td>
 
746
</tr>
 
747
<tr>
 
748
<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
 
749
<td>the content type of the uploaded data</td>
364
750
</tr>
365
751
<tr>
366
752
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
367
 
<td>the folder to which the document should be uploaded, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
753
<td>the folder to which the document should be uploaded, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
368
754
</td>
369
755
</tr>
370
756
<tr>
371
757
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
372
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
758
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> for the entire upload stream, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
373
759
</td>
374
760
</tr>
375
761
<tr>
376
762
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
377
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
763
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
378
764
</td>
379
765
</tr>
380
766
<tr>
381
767
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
382
 
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
768
<td>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> to write the document data to, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
383
769
</td>
384
770
</tr>
385
771
</tbody>
386
772
</table></div>
387
 
<p class="since">Since 0.4.0</p>
 
773
<p class="since">Since 0.8.0</p>
388
774
</div>
389
775
<hr>
390
776
<div class="refsect2">
391
777
<a name="gdata-documents-service-update-document"></a><h3>gdata_documents_service_update_document ()</h3>
392
 
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_update_document
 
778
<pre class="programlisting"><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="returnvalue">GDataUploadStream</span></a> * gdata_documents_service_update_document
393
779
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
394
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
395
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *document_file</code></em>,
396
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
397
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
398
 
<p>
399
 
Update the document using the properties from <em class="parameter"><code>document</code></em> and the document file pointed to by <em class="parameter"><code>document_file</code></em>. If the document file does not
400
 
need to be changed, <em class="parameter"><code>document_file</code></em> can be <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
401
 
</p>
402
 
<p>
403
 
If there is a problem reading <em class="parameter"><code>document_file</code></em>, an error from <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html#g-file-load-contents"><code class="function">g_file_load_contents()</code></a> or <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html#g-file-query-info"><code class="function">g_file_query_info()</code></a> will be returned. Other errors from
404
 
<a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for other exceptional conditions, as determined by the server.
405
 
</p>
406
 
<p>
407
 
For more details, see <a class="link" href="GDataService.html#gdata-service-insert-entry" title="gdata_service_insert_entry ()"><code class="function">gdata_service_insert_entry()</code></a>.
 
780
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> *document</code></em>,
 
781
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
 
782
                                                         <em class="parameter"><code>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
 
783
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
784
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
785
<p>
 
786
Update the document using the properties from <em class="parameter"><code>document</code></em> and the document data written to the resulting <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>. If the document data does
 
787
not need to be changed, just the metadata, use <a class="link" href="GDataService.html#gdata-service-update-entry" title="gdata_service_update_entry ()"><code class="function">gdata_service_update_entry()</code></a> instead.
 
788
</p>
 
789
<p>
 
790
The stream returned by this function should be written to using the standard <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> methods, asychronously or synchronously. Once the stream
 
791
is closed (using <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#g-output-stream-close"><code class="function">g_output_stream_close()</code></a>), <a class="link" href="GDataDocumentsService.html#gdata-documents-service-finish-upload" title="gdata_documents_service_finish_upload ()"><code class="function">gdata_documents_service_finish_upload()</code></a> should be called on it to parse and return the updated
 
792
<a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> for the document. This must be done, as <em class="parameter"><code>document</code></em> isn't updated in-place.
 
793
</p>
 
794
<p>
 
795
In order to cancel the update, a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> passed in to <em class="parameter"><code>cancellable</code></em> must be cancelled using <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html#g-cancellable-cancel"><code class="function">g_cancellable_cancel()</code></a>. Cancelling the individual
 
796
<a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> operations on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will not cancel the entire update; merely the write or close operation in question. See the
 
797
<a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title='The "cancellable" property'><span class="type">"cancellable"</span></a> for more details.
 
798
</p>
 
799
<p>
 
800
Any upload errors will be thrown by the stream methods, and may come from the <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> domain.
 
801
</p>
 
802
<p>
 
803
For more information, see <a class="link" href="GDataService.html#gdata-service-update-entry" title="gdata_service_update_entry ()"><code class="function">gdata_service_update_entry()</code></a>.
408
804
</p>
409
805
<div class="variablelist"><table border="0">
410
806
<col align="left" valign="top">
416
812
</tr>
417
813
<tr>
418
814
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
419
 
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to update</td>
420
 
</tr>
421
 
<tr>
422
 
<td><p><span class="term"><em class="parameter"><code>document_file</code></em> :</span></p></td>
423
 
<td>the local document file containing the new data, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
424
 
</td>
 
815
<td>the <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> to update</td>
 
816
</tr>
 
817
<tr>
 
818
<td><p><span class="term"><em class="parameter"><code>slug</code></em> :</span></p></td>
 
819
<td>the filename to give to the uploaded document</td>
 
820
</tr>
 
821
<tr>
 
822
<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
 
823
<td>the content type of the uploaded data</td>
425
824
</tr>
426
825
<tr>
427
826
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
428
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
429
 
</td>
430
 
</tr>
431
 
<tr>
432
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
433
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
434
 
</td>
435
 
</tr>
436
 
<tr>
437
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
438
 
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
439
 
</td>
440
 
</tr>
441
 
</tbody>
442
 
</table></div>
443
 
<p class="since">Since 0.4.0</p>
444
 
</div>
445
 
<hr>
446
 
<div class="refsect2">
447
 
<a name="gdata-documents-service-move-document-to-folder"></a><h3>gdata_documents_service_move_document_to_folder ()</h3>
448
 
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_move_document_to_folder
449
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
450
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
 
827
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> for the entire upload stream, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
828
</td>
 
829
</tr>
 
830
<tr>
 
831
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
832
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
833
</td>
 
834
</tr>
 
835
<tr>
 
836
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
837
<td>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> to write the document data to; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
838
</td>
 
839
</tr>
 
840
</tbody>
 
841
</table></div>
 
842
<p class="since">Since 0.8.0</p>
 
843
</div>
 
844
<hr>
 
845
<div class="refsect2">
 
846
<a name="gdata-documents-service-finish-upload"></a><h3>gdata_documents_service_finish_upload ()</h3>
 
847
<pre class="programlisting"><a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="returnvalue">GDataDocumentsDocument</span></a> * gdata_documents_service_finish_upload
 
848
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
849
                                                         <em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *upload_stream</code></em>,
 
850
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
851
<p>
 
852
Finish off a document upload or update operation started by <a class="link" href="GDataDocumentsService.html#gdata-documents-service-upload-document" title="gdata_documents_service_upload_document ()"><code class="function">gdata_documents_service_upload_document()</code></a> or <a class="link" href="GDataDocumentsService.html#gdata-documents-service-update-document" title="gdata_documents_service_update_document ()"><code class="function">gdata_documents_service_update_document()</code></a>,
 
853
parsing the result and returning the new or updated <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a>.
 
854
</p>
 
855
<p>
 
856
If an error occurred during the upload or update operation, it will have been returned during the operation (e.g. by <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#g-output-stream-splice"><code class="function">g_output_stream_splice()</code></a> or one
 
857
of the other stream methods). In such a case, <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned but <em class="parameter"><code>error</code></em> will remain unset. <em class="parameter"><code>error</code></em> is only set in the case that the server
 
858
indicates that the operation was successful, but an error is encountered in parsing the result sent by the server.
 
859
</p>
 
860
<p>
 
861
In the case that no <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> was passed (to <a class="link" href="GDataDocumentsService.html#gdata-documents-service-upload-document" title="gdata_documents_service_upload_document ()"><code class="function">gdata_documents_service_upload_document()</code></a> or <a class="link" href="GDataDocumentsService.html#gdata-documents-service-update-document" title="gdata_documents_service_update_document ()"><code class="function">gdata_documents_service_update_document()</code></a>)
 
862
when starting the operation, <a class="link" href="GDataDocumentsService.html#GDATA-DOCUMENTS-SERVICE-ERROR-INVALID-CONTENT-TYPE:CAPS"><code class="literal">GDATA_DOCUMENTS_SERVICE_ERROR_INVALID_CONTENT_TYPE</code></a> will be thrown in <em class="parameter"><code>error</code></em> if the content type of the uploaded data
 
863
could not be mapped to a document type with which to interpret the response from the server.
 
864
</p>
 
865
<div class="variablelist"><table border="0">
 
866
<col align="left" valign="top">
 
867
<tbody>
 
868
<tr>
 
869
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
870
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
871
</td>
 
872
</tr>
 
873
<tr>
 
874
<td><p><span class="term"><em class="parameter"><code>upload_stream</code></em> :</span></p></td>
 
875
<td>the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> from the operation</td>
 
876
</tr>
 
877
<tr>
 
878
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
879
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
880
</td>
 
881
</tr>
 
882
<tr>
 
883
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
884
<td>the new or updated <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
885
</td>
 
886
</tr>
 
887
</tbody>
 
888
</table></div>
 
889
<p class="since">Since 0.8.0</p>
 
890
</div>
 
891
<hr>
 
892
<div class="refsect2">
 
893
<a name="gdata-documents-service-add-entry-to-folder"></a><h3>gdata_documents_service_add_entry_to_folder ()</h3>
 
894
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_add_entry_to_folder
 
895
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
896
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
451
897
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
452
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
453
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
898
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
899
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
454
900
<p>
455
 
Move the given <em class="parameter"><code>document</code></em> to the specified <em class="parameter"><code>folder</code></em>. If the document is already in another folder, it will be added to
456
 
the new folder, but will also remain in any previous folders.
 
901
Add the given <em class="parameter"><code>entry</code></em> to the specified <em class="parameter"><code>folder</code></em>, and return an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> for <em class="parameter"><code>entry</code></em>. If the <em class="parameter"><code>entry</code></em> is already in another folder, it
 
902
will be added to the new folder, but will also remain  in its other folders. Note that <em class="parameter"><code>entry</code></em> can be either a <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> or a
 
903
<a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a>.
457
904
</p>
458
905
<p>
459
 
Errors from <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for other exceptional conditions, as determined by the server.
 
906
Errors from <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for exceptional conditions, as determined by the server.
460
907
</p>
461
908
<div class="variablelist"><table border="0">
462
909
<col align="left" valign="top">
467
914
</td>
468
915
</tr>
469
916
<tr>
470
 
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
917
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
471
918
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to move</td>
472
919
</tr>
473
920
<tr>
474
921
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
475
 
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> to move <em class="parameter"><code>document</code></em> into</td>
476
 
</tr>
477
 
<tr>
478
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
479
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
480
 
</td>
481
 
</tr>
482
 
<tr>
483
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
484
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
485
 
</td>
486
 
</tr>
487
 
<tr>
488
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
489
 
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
490
 
</td>
491
 
</tr>
492
 
</tbody>
493
 
</table></div>
494
 
<p class="since">Since 0.4.0</p>
495
 
</div>
496
 
<hr>
497
 
<div class="refsect2">
498
 
<a name="gdata-documents-service-remove-document-from-folder"></a><h3>gdata_documents_service_remove_document_from_folder ()</h3>
499
 
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_remove_document_from_folder
500
 
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
501
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *document</code></em>,
502
 
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
503
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
504
 
                                                         <em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
505
 
<p>
506
 
Remove the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> <em class="parameter"><code>document</code></em> from the GDataDocumentsFolder <em class="parameter"><code>folder</code></em>, and updates the document entry <em class="parameter"><code>document</code></em>.
507
 
</p>
508
 
<p>
509
 
Errors from <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for other exceptional conditions, as determined by the server.
510
 
</p>
511
 
<div class="variablelist"><table border="0">
512
 
<col align="left" valign="top">
513
 
<tbody>
514
 
<tr>
515
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
516
 
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
517
 
</td>
518
 
</tr>
519
 
<tr>
520
 
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
922
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> to move <em class="parameter"><code>entry</code></em> into</td>
 
923
</tr>
 
924
<tr>
 
925
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
926
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
927
</td>
 
928
</tr>
 
929
<tr>
 
930
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
931
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
932
</td>
 
933
</tr>
 
934
<tr>
 
935
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
936
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
937
</td>
 
938
</tr>
 
939
</tbody>
 
940
</table></div>
 
941
<p class="since">Since 0.8.0</p>
 
942
</div>
 
943
<hr>
 
944
<div class="refsect2">
 
945
<a name="gdata-documents-service-add-entry-to-folder-async"></a><h3>gdata_documents_service_add_entry_to_folder_async ()</h3>
 
946
<pre class="programlisting"><span class="returnvalue">void</span>                gdata_documents_service_add_entry_to_folder_async
 
947
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
948
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
949
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
950
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
951
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
952
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
953
<p>
 
954
Add the given <em class="parameter"><code>entry</code></em> to the specified <em class="parameter"><code>folder</code></em>. <em class="parameter"><code>self</code></em>, <em class="parameter"><code>entry</code></em> and <em class="parameter"><code>folder</code></em> are all reffed when this function is called, so can safely be unreffed
 
955
after this function returns.
 
956
</p>
 
957
<p>
 
958
For more details, see <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder" title="gdata_documents_service_add_entry_to_folder ()"><code class="function">gdata_documents_service_add_entry_to_folder()</code></a>, which is the synchronous version of this function.
 
959
</p>
 
960
<p>
 
961
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can then call <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder-finish" title="gdata_documents_service_add_entry_to_folder_finish ()"><code class="function">gdata_documents_service_add_entry_to_folder_finish()</code></a> to get the results
 
962
of the operation.
 
963
</p>
 
964
<div class="variablelist"><table border="0">
 
965
<col align="left" valign="top">
 
966
<tbody>
 
967
<tr>
 
968
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
969
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
970
</td>
 
971
</tr>
 
972
<tr>
 
973
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
974
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to add to <em class="parameter"><code>folder</code></em>
 
975
</td>
 
976
</tr>
 
977
<tr>
 
978
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
 
979
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> to add <em class="parameter"><code>entry</code></em> to</td>
 
980
</tr>
 
981
<tr>
 
982
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
983
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
984
</td>
 
985
</tr>
 
986
<tr>
 
987
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
988
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the operation is finished, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
989
</td>
 
990
</tr>
 
991
<tr>
 
992
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
993
<td>data to pass to the <em class="parameter"><code>callback</code></em> function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
994
</td>
 
995
</tr>
 
996
</tbody>
 
997
</table></div>
 
998
<p class="since">Since 0.8.0</p>
 
999
</div>
 
1000
<hr>
 
1001
<div class="refsect2">
 
1002
<a name="gdata-documents-service-add-entry-to-folder-finish"></a><h3>gdata_documents_service_add_entry_to_folder_finish ()</h3>
 
1003
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_add_entry_to_folder_finish
 
1004
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
1005
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *async_result</code></em>,
 
1006
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
1007
<p>
 
1008
Finish an asynchronous operation to add a <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to a folder started with <a class="link" href="GDataDocumentsService.html#gdata-documents-service-add-entry-to-folder-async" title="gdata_documents_service_add_entry_to_folder_async ()"><code class="function">gdata_documents_service_add_entry_to_folder_async()</code></a>.
 
1009
</p>
 
1010
<div class="variablelist"><table border="0">
 
1011
<col align="left" valign="top">
 
1012
<tbody>
 
1013
<tr>
 
1014
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1015
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
1016
</td>
 
1017
</tr>
 
1018
<tr>
 
1019
<td><p><span class="term"><em class="parameter"><code>async_result</code></em> :</span></p></td>
 
1020
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
1021
</td>
 
1022
</tr>
 
1023
<tr>
 
1024
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1025
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1026
</td>
 
1027
</tr>
 
1028
<tr>
 
1029
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1030
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1031
</td>
 
1032
</tr>
 
1033
</tbody>
 
1034
</table></div>
 
1035
<p class="since">Since 0.8.0</p>
 
1036
</div>
 
1037
<hr>
 
1038
<div class="refsect2">
 
1039
<a name="gdata-documents-service-remove-entry-from-folder"></a><h3>gdata_documents_service_remove_entry_from_folder ()</h3>
 
1040
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_remove_entry_from_folder
 
1041
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
1042
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
1043
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
1044
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
1045
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
1046
<p>
 
1047
Remove the given <em class="parameter"><code>entry</code></em> from <em class="parameter"><code>folder</code></em>, and return an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> for <em class="parameter"><code>entry</code></em>. <em class="parameter"><code>entry</code></em> will remain a member of any other folders it's
 
1048
currently in. Note that <em class="parameter"><code>entry</code></em> can be either a <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> or a <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a>.
 
1049
</p>
 
1050
<p>
 
1051
Errors from <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> can be returned for exceptional conditions, as determined by the server.
 
1052
</p>
 
1053
<div class="variablelist"><table border="0">
 
1054
<col align="left" valign="top">
 
1055
<tbody>
 
1056
<tr>
 
1057
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1058
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
1059
</td>
 
1060
</tr>
 
1061
<tr>
 
1062
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
521
1063
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to remove</td>
522
1064
</tr>
523
1065
<tr>
524
1066
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
525
 
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> from which we should remove <em class="parameter"><code>document</code></em>
526
 
</td>
527
 
</tr>
528
 
<tr>
529
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
530
 
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
531
 
</td>
532
 
</tr>
533
 
<tr>
534
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
535
 
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
536
 
</td>
537
 
</tr>
538
 
<tr>
539
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
540
 
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
541
 
</td>
542
 
</tr>
543
 
</tbody>
544
 
</table></div>
545
 
<p class="since">Since 0.4.0</p>
 
1067
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> from which we should remove <em class="parameter"><code>entry</code></em>
 
1068
</td>
 
1069
</tr>
 
1070
<tr>
 
1071
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1072
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1073
</td>
 
1074
</tr>
 
1075
<tr>
 
1076
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1077
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1078
</td>
 
1079
</tr>
 
1080
<tr>
 
1081
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1082
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1083
</td>
 
1084
</tr>
 
1085
</tbody>
 
1086
</table></div>
 
1087
<p class="since">Since 0.8.0</p>
 
1088
</div>
 
1089
<hr>
 
1090
<div class="refsect2">
 
1091
<a name="gdata-documents-service-remove-entry-from-folder-async"></a><h3>gdata_documents_service_remove_entry_from_folder_async ()</h3>
 
1092
<pre class="programlisting"><span class="returnvalue">void</span>                gdata_documents_service_remove_entry_from_folder_async
 
1093
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
1094
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> *entry</code></em>,
 
1095
                                                         <em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>,
 
1096
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
1097
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
1098
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
1099
<p>
 
1100
Remove the given <em class="parameter"><code>entry</code></em> from the specified <em class="parameter"><code>folder</code></em>. <em class="parameter"><code>self</code></em>, <em class="parameter"><code>entry</code></em> and <em class="parameter"><code>folder</code></em> are all reffed when this function is called, so can safely be unreffed
 
1101
after this function returns.
 
1102
</p>
 
1103
<p>
 
1104
For more details, see <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder" title="gdata_documents_service_remove_entry_from_folder ()"><code class="function">gdata_documents_service_remove_entry_from_folder()</code></a>, which is the synchronous version of this function.
 
1105
</p>
 
1106
<p>
 
1107
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can then call <a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder-finish" title="gdata_documents_service_remove_entry_from_folder_finish ()"><code class="function">gdata_documents_service_remove_entry_from_folder_finish()</code></a> to get the
 
1108
results of the operation.
 
1109
</p>
 
1110
<div class="variablelist"><table border="0">
 
1111
<col align="left" valign="top">
 
1112
<tbody>
 
1113
<tr>
 
1114
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1115
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
1116
</td>
 
1117
</tr>
 
1118
<tr>
 
1119
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
1120
<td>the <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to remove from <em class="parameter"><code>folder</code></em>
 
1121
</td>
 
1122
</tr>
 
1123
<tr>
 
1124
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
 
1125
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> to remove <em class="parameter"><code>entry</code></em> from</td>
 
1126
</tr>
 
1127
<tr>
 
1128
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1129
<td>optional <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1130
</td>
 
1131
</tr>
 
1132
<tr>
 
1133
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1134
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the operation is finished, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1135
</td>
 
1136
</tr>
 
1137
<tr>
 
1138
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1139
<td>data to pass to the <em class="parameter"><code>callback</code></em> function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
1140
</td>
 
1141
</tr>
 
1142
</tbody>
 
1143
</table></div>
 
1144
<p class="since">Since 0.8.0</p>
 
1145
</div>
 
1146
<hr>
 
1147
<div class="refsect2">
 
1148
<a name="gdata-documents-service-remove-entry-from-folder-finish"></a><h3>gdata_documents_service_remove_entry_from_folder_finish ()</h3>
 
1149
<pre class="programlisting"><a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="returnvalue">GDataDocumentsEntry</span></a> * gdata_documents_service_remove_entry_from_folder_finish
 
1150
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *self</code></em>,
 
1151
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *async_result</code></em>,
 
1152
                                                         <em class="parameter"><code><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
1153
<p>
 
1154
Finish an asynchronous operation to remove a <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> from a folder started with
 
1155
<a class="link" href="GDataDocumentsService.html#gdata-documents-service-remove-entry-from-folder-async" title="gdata_documents_service_remove_entry_from_folder_async ()"><code class="function">gdata_documents_service_remove_entry_from_folder_async()</code></a>.
 
1156
</p>
 
1157
<div class="variablelist"><table border="0">
 
1158
<col align="left" valign="top">
 
1159
<tbody>
 
1160
<tr>
 
1161
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1162
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
 
1163
</td>
 
1164
</tr>
 
1165
<tr>
 
1166
<td><p><span class="term"><em class="parameter"><code>async_result</code></em> :</span></p></td>
 
1167
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
1168
</td>
 
1169
</tr>
 
1170
<tr>
 
1171
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1172
<td>a <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
1173
</td>
 
1174
</tr>
 
1175
<tr>
 
1176
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1177
<td>an updated <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1178
</td>
 
1179
</tr>
 
1180
</tbody>
 
1181
</table></div>
 
1182
<p class="since">Since 0.8.0</p>
546
1183
</div>
547
1184
<hr>
548
1185
<div class="refsect2">
549
1186
<a name="gdata-documents-service-get-upload-uri"></a><h3>gdata_documents_service_get_upload_uri ()</h3>
550
 
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gdata_documents_service_get_upload_uri
 
1187
<pre class="programlisting"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gdata_documents_service_get_upload_uri
551
1188
                                                        (<em class="parameter"><code><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> *folder</code></em>);</pre>
552
1189
<p>
553
1190
Gets the upload URI for documents for the service.
554
1191
</p>
555
1192
<p>
556
 
If <em class="parameter"><code>folder</code></em> is <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the URI will be the one to upload documents to the "root" folder.
 
1193
If <em class="parameter"><code>folder</code></em> is <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the URI will be the one to upload documents to the "root" folder.
557
1194
</p>
558
1195
<div class="variablelist"><table border="0">
559
1196
<col align="left" valign="top">
560
1197
<tbody>
561
1198
<tr>
562
1199
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
563
 
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> into which to upload the document, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1200
<td>the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> into which to upload the document, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
564
1201
</td>
565
1202
</tr>
566
1203
<tr>
567
1204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
568
 
<td>the URI permitting the upload of documents to <em class="parameter"><code>folder</code></em>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; free with <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
 
1205
<td>the URI permitting the upload of documents to <em class="parameter"><code>folder</code></em>, or <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; free with <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
569
1206
</td>
570
1207
</tr>
571
1208
</tbody>