Blame docs/reference/html/GDataDocumentsService.html

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

GDataDocumentsService

Packit 4b6dd7

GDataDocumentsService — GData Documents service object

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

Stability Level

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

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsService *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_new ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_primary_authorization_domain ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_spreadsheet_authorization_domain ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsMetadata *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_metadata ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_metadata_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsMetadata *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_metadata_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_query_documents ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_query_documents_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_upload_document ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_upload_document_resumable ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_update_document ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_update_document_resumable ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_finish_upload ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_copy_document ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_copy_document_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_copy_document_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_service_get_upload_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsServiceClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
enum
Packit 4b6dd7
GDataDocumentsServiceError
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataService
Packit 4b6dd7
        ╰── GDataDocumentsService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Implemented Interfaces

Packit 4b6dd7

Packit 4b6dd7
GDataDocumentsService implements
Packit 4b6dd7
 GDataBatchable.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

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

Description

Packit 4b6dd7

GDataDocumentsService is a subclass of GDataService for communicating with the GData API of Google Drive. It supports querying

Packit 4b6dd7
for, inserting, editing and deleting documents, as well as a folder hierarchy.
Packit 4b6dd7
The API is named ‘documents’ rather than ‘drive’ as it used to use the Google
Packit 4b6dd7
Documents API, which has since been deprecated.

Packit 4b6dd7

For more details of Google Drive's GData API, see the

Packit 4b6dd7
Packit 4b6dd7
online documentation.
Packit 4b6dd7

Fore more details about the spreadsheet downloads handling, see the

Packit 4b6dd7
Packit 4b6dd7
online explanation about the problem.
Packit 4b6dd7
Packit 4b6dd7

Example 27. Uploading a Document from Disk

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
42
Packit 4b6dd7
43
Packit 4b6dd7
44
Packit 4b6dd7
45
Packit 4b6dd7
46
Packit 4b6dd7
47
Packit 4b6dd7
48
Packit 4b6dd7
49
Packit 4b6dd7
50
Packit 4b6dd7
51
Packit 4b6dd7
52
Packit 4b6dd7
53
Packit 4b6dd7
54
Packit 4b6dd7
55
Packit 4b6dd7
56
Packit 4b6dd7
57
Packit 4b6dd7
58
Packit 4b6dd7
59
Packit 4b6dd7
60
Packit 4b6dd7
61
Packit 4b6dd7
62
Packit 4b6dd7
63
Packit 4b6dd7
64
Packit 4b6dd7
65
Packit 4b6dd7
66
Packit 4b6dd7
67
Packit 4b6dd7
68
Packit 4b6dd7
69
Packit 4b6dd7
70
Packit 4b6dd7
71
Packit 4b6dd7
72
Packit 4b6dd7
73
Packit 4b6dd7
74
Packit 4b6dd7
75
Packit 4b6dd7
76
Packit 4b6dd7
77
Packit 4b6dd7
78
Packit 4b6dd7
79
Packit 4b6dd7
80
Packit 4b6dd7
81
Packit 4b6dd7
82
Packit 4b6dd7
83
Packit 4b6dd7
84
Packit 4b6dd7
85
Packit 4b6dd7
86
Packit 4b6dd7
87
Packit 4b6dd7
88
Packit 4b6dd7
89
Packit 4b6dd7
90
Packit 4b6dd7
91
Packit 4b6dd7
92
Packit 4b6dd7
93
Packit 4b6dd7
94
Packit 4b6dd7
95
Packit 4b6dd7
        
GDataDocumentsService *service;
Packit 4b6dd7
GDataDocumentsDocument *document, *uploaded_document;
Packit 4b6dd7
GFile *document_file;
Packit 4b6dd7
GDataDocumentsFolder *destination_folder;
Packit 4b6dd7
GFileInfo *file_info;
Packit 4b6dd7
const gchar *slug, *content_type;
Packit 4b6dd7
GFileInputStream *file_stream;
Packit 4b6dd7
GDataUploadStream *upload_stream;
Packit 4b6dd7
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service */
Packit 4b6dd7
service = create_documents_service ();
Packit 4b6dd7
Packit 4b6dd7
/* Get the document file to upload and the folder to upload it into */
Packit 4b6dd7
document_file = g_file_new_for_path ("document.odt");
Packit 4b6dd7
destination_folder = query_user_for_destination_folder (service);
Packit 4b6dd7
Packit 4b6dd7
/* Get the file's display name and content type */
Packit 4b6dd7
file_info = g_file_query_info (document_file, G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME "," G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
Packit 4b6dd7
                               G_FILE_QUERY_INFO_NONE, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error getting document file information: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    g_object_unref (destination_folder);
Packit 4b6dd7
    g_object_unref (document_file);
Packit 4b6dd7
    g_object_unref (service);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
slug = g_file_info_get_display_name (file_info);
Packit 4b6dd7
content_type = g_file_info_get_content_type (file_info);
Packit 4b6dd7
Packit 4b6dd7
/* Get an input stream for the file */
Packit 4b6dd7
file_stream = g_file_read (document_file, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (document_file);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error getting document file stream: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    g_object_unref (file_info);
Packit 4b6dd7
    g_object_unref (destination_folder);
Packit 4b6dd7
    g_object_unref (service);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Create the document metadata to upload */
Packit 4b6dd7
document = gdata_documents_text_new (NULL);
Packit 4b6dd7
gdata_entry_set_title (GDATA_ENTRY (document), "Document Title");
Packit 4b6dd7
Packit 4b6dd7
/* Get an upload stream for the document */
Packit 4b6dd7
upload_stream = gdata_documents_service_upload_document (service, document, slug, content_type, destination_folder, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (document);
Packit 4b6dd7
g_object_unref (file_info);
Packit 4b6dd7
g_object_unref (destination_folder);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error getting upload stream: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    g_object_unref (file_stream);
Packit 4b6dd7
    g_object_unref (service);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Upload the document. This is a blocking operation, and should normally be done asynchronously. */
Packit 4b6dd7
g_output_stream_splice (G_OUTPUT_STREAM (upload_stream), G_INPUT_STREAM (file_stream),
Packit 4b6dd7
                        G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (file_stream);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error splicing streams: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    g_object_unref (upload_stream);
Packit 4b6dd7
    g_object_unref (service);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Finish off the upload by parsing the returned updated document metadata entry */
Packit 4b6dd7
uploaded_document = gdata_documents_service_finish_upload (service, upload_stream, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (upload_stream);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error uploading document: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Do something with the uploaded document */
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (uploaded_document);
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

The Drive service can be manipulated using batch operations, too. See the

Packit 4b6dd7
online documentation on batch
Packit 4b6dd7
operations for more information.
Packit 4b6dd7
Packit 4b6dd7

Example 28. Performing a Batch Operation on Documents

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
42
Packit 4b6dd7
43
Packit 4b6dd7
44
Packit 4b6dd7
45
Packit 4b6dd7
46
Packit 4b6dd7
47
Packit 4b6dd7
48
Packit 4b6dd7
49
Packit 4b6dd7
50
Packit 4b6dd7
51
Packit 4b6dd7
52
Packit 4b6dd7
53
Packit 4b6dd7
54
Packit 4b6dd7
55
Packit 4b6dd7
56
Packit 4b6dd7
57
Packit 4b6dd7
58
Packit 4b6dd7
59
Packit 4b6dd7
60
Packit 4b6dd7
        
GDataDocumentsService *service;
Packit 4b6dd7
GDataBatchOperation *operation;
Packit 4b6dd7
GDataFeed *feed;
Packit 4b6dd7
GDataLink *batch_link;
Packit 4b6dd7
GList *i;
Packit 4b6dd7
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service */
Packit 4b6dd7
service = create_documents_service ();
Packit 4b6dd7
Packit 4b6dd7
/* Create the batch operation; this requires that we have done a query first so that we can get the batch link */
Packit 4b6dd7
feed = do_some_query (service);
Packit 4b6dd7
batch_link = gdata_feed_look_up_link (feed, GDATA_LINK_BATCH);
Packit 4b6dd7
operation = gdata_batchable_create_operation (GDATA_BATCHABLE (service), gdata_link_get_uri (batch_link));
Packit 4b6dd7
g_object_unref (feed);
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_add_query (operation, presentation_entry_id_to_query, GDATA_TYPE_DOCUMENTS_PRESENTATION,
Packit 4b6dd7
                                 (GDataBatchOperationCallback) batch_query_cb, user_data);
Packit 4b6dd7
gdata_batch_operation_add_insertion (operation, new_entry, (GDataBatchOperationCallback) batch_insertion_cb, user_data);
Packit 4b6dd7
gdata_batch_operation_add_update (operation, old_entry, (GDataBatchOperationCallback) batch_update_cb, user_data);
Packit 4b6dd7
gdata_batch_operation_add_deletion (operation, entry_to_delete, (GDataBatchOperationCallback) batch_deletion_cb, user_data);
Packit 4b6dd7
Packit 4b6dd7
/* Run the batch operation and handle the results in the various callbacks */
Packit 4b6dd7
gdata_test_batch_operation_run (operation, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (operation);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error running batch operation: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
batch_query_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_type == GDATA_BATCH_OPERATION_QUERY */
Packit 4b6dd7
    /* Reference and do something with the returned entry. */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
batch_insertion_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_type == GDATA_BATCH_OPERATION_INSERTION */
Packit 4b6dd7
    /* Reference and do something with the returned entry. */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
batch_update_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_type == GDATA_BATCH_OPERATION_UPDATE */
Packit 4b6dd7
    /* Reference and do something with the returned entry. */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
batch_deletion_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_type == GDATA_BATCH_OPERATION_DELETION, entry == NULL */
Packit 4b6dd7
}
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Starred documents are denoted by being in the GDATA_CATEGORY_SCHEMA_LABELS_STARRED category of the GDATA_CATEGORY_SCHEMA_LABELS schema. Documents

Packit 4b6dd7
can be starred or unstarred simply by adding or removing this category from them and updating the document:

Packit 4b6dd7
Packit 4b6dd7

Example 29. Starring a Document

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
        
GDataDocumentsService *service;
Packit 4b6dd7
GDataDocumentsEntry *document, *updated_document;
Packit 4b6dd7
GDataCategory *starred_category;
Packit 4b6dd7
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service and retrieve the document to be starred */
Packit 4b6dd7
service = create_documents_service ();
Packit 4b6dd7
document = get_document_to_be_starred (service);
Packit 4b6dd7
Packit 4b6dd7
/* Add the “starred” category to the document */
Packit 4b6dd7
starred_category = gdata_category_new (GDATA_CATEGORY_SCHEMA_LABELS_STARRED, GDATA_CATEGORY_SCHEMA_LABELS, "starred");
Packit 4b6dd7
gdata_entry_add_category (GDATA_ENTRY (document), starred_category);
Packit 4b6dd7
g_object_unref (starred_category);
Packit 4b6dd7
Packit 4b6dd7
/* Propagate the updated document to the server */
Packit 4b6dd7
updated_document = GDATA_DOCUMENTS_ENTRY (gdata_service_update_entry (GDATA_SERVICE (service),
Packit 4b6dd7
                                                                      gdata_documents_service_get_primary_authorization_domain (),
Packit 4b6dd7
                                                                      GDATA_ENTRY (document), NULL, &error));
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (document);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error starring document: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Do something with the newly-starred document, like update it in the UI */
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (updated_document);
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_new ()

Packit 4b6dd7
GDataDocumentsService *
Packit 4b6dd7
gdata_documents_service_new (GDataAuthorizer *authorizer);
Packit 4b6dd7

Creates a new GDataDocumentsService using the given GDataAuthorizer. If authorizer

Packit 4b6dd7
 is NULL, all requests are made as an unauthenticated user.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

authorizer

Packit 4b6dd7

a GDataAuthorizer to authorize the service's requests, or NULL.

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

Returns

Packit 4b6dd7

a new GDataDocumentsService, or NULL; unref with g_object_unref()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_primary_authorization_domain ()

Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
gdata_documents_service_get_primary_authorization_domain
Packit 4b6dd7
                               (void);
Packit 4b6dd7

The primary GDataAuthorizationDomain for interacting with Google Documents. This will not normally need to be used, as it's used internally

Packit 4b6dd7
by the GDataDocumentsService methods. However, if using the plain GDataService methods to implement custom queries or requests which libgdata
Packit 4b6dd7
does not support natively, then this domain may be needed to authorize the requests.

Packit 4b6dd7

The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.

Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the service's authorization domain.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_spreadsheet_authorization_domain ()

Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
gdata_documents_service_get_spreadsheet_authorization_domain
Packit 4b6dd7
                               (void);
Packit 4b6dd7

The GDataAuthorizationDomain for interacting with spreadsheet data. This will not normally need to be used, as it's automatically used internally

Packit 4b6dd7
by the GDataDocumentsService methods. However, if using the plain GDataService methods to implement custom queries or requests which libgdata
Packit 4b6dd7
does not support natively, then this domain may be needed to authorize the requests which pertain to the Google Spreadsheets Data API, such as
Packit 4b6dd7
requests to download or upload spreadsheet documents.

Packit 4b6dd7

The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.

Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the service's authorization domain.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_metadata ()

Packit 4b6dd7
GDataDocumentsMetadata *
Packit 4b6dd7
gdata_documents_service_get_metadata (GDataDocumentsService *self,
Packit 4b6dd7
                                      GCancellable *cancellable,
Packit 4b6dd7
                                      GError **error);
Packit 4b6dd7

Gets a GDataDocumentsMetadata object containing metadata about the documents

Packit 4b6dd7
service itself, like how large the user quota is.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

the service's metadata object; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.17.9

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_metadata_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_service_get_metadata_async
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Gets a GDataDocumentsMetadata object containing metadata about the documents

Packit 4b6dd7
service itself, like how large the user quota is.

Packit 4b6dd7

For more details, see gdata_documents_service_get_metadata(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_documents_service_get_metadata_finish() to get the results
Packit 4b6dd7
of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished, or NULL

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

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.17.9

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_metadata_finish ()

Packit 4b6dd7
GDataDocumentsMetadata *
Packit 4b6dd7
gdata_documents_service_get_metadata_finish
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finish an asynchronous operation to get a GDataDocumentsMetadata started with gdata_documents_service_get_metadata_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

async_result

Packit 4b6dd7

a GAsyncResult

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

the service's metadata object; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.17.9

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_query_documents ()

Packit 4b6dd7
GDataDocumentsFeed *
Packit 4b6dd7
gdata_documents_service_query_documents
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsQuery *query,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                                gpointer progress_user_data,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Queries the service to return a list of documents matching the given query

Packit 4b6dd7
. Note that query
Packit 4b6dd7
 has to be a GDataDocumentsQuery, rather than just
Packit 4b6dd7
a GDataQuery, as it uses the folder ID specified in “folder-id”.

Packit 4b6dd7

For more details, see gdata_service_query().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

query

Packit 4b6dd7

a GDataDocumentsQuery with the query parameters, or NULL.

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

progress_callback

Packit 4b6dd7

a GDataQueryProgressCallback to call when an entry is loaded, or NULL.

Packit 4b6dd7
[allow-none][scope call][closure progress_user_data]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

a GDataDocumentsFeed of query results; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_query_documents_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_service_query_documents_async
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsQuery *query,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                                gpointer progress_user_data,
Packit 4b6dd7
                                GDestroyNotify destroy_progress_user_data,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Queries the service to return a list of documents matching the given query

Packit 4b6dd7
. self
Packit 4b6dd7
 and
Packit 4b6dd7
query
Packit 4b6dd7
 are both reffed when this function is called, so can safely be unreffed after this function returns.

Packit 4b6dd7

For more details, see gdata_documents_service_query_documents(), which is the synchronous version of this function,

Packit 4b6dd7
and gdata_service_query_async(), which is the base asynchronous query function.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

query

Packit 4b6dd7

a GDataDocumentsQuery with the query parameters, or NULL.

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

progress_callback

Packit 4b6dd7

a GDataQueryProgressCallback to call when an entry is loaded, or NULL.

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

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

destroy_progress_user_data

Packit 4b6dd7

the function to call when progress_callback

Packit 4b6dd7
will not be called any more, or NULL. This function will be
Packit 4b6dd7
called with progress_user_data
Packit 4b6dd7
as a parameter and can be used to free any memory allocated for it. 

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when authentication is finished

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

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.1

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_upload_document ()

Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
gdata_documents_service_upload_document
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsDocument *document,
Packit 4b6dd7
                                const gchar *slug,
Packit 4b6dd7
                                const gchar *content_type,
Packit 4b6dd7
                                GDataDocumentsFolder *folder,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Uploads a document to Google Documents, using the properties from document

Packit 4b6dd7
 and the document data written to the resulting GDataUploadStream. If
Packit 4b6dd7
the document data does not need to be provided at the moment, just the metadata, use gdata_service_insert_entry() instead (e.g. in the case of
Packit 4b6dd7
creating a new, empty file to be edited at a later date).

Packit 4b6dd7

This performs a non-resumable upload, unlike gdata_documents_service_upload_document(). This means that errors during transmission will cause the

Packit 4b6dd7
upload to fail, and the entire document will have to be re-uploaded. It is recommended that gdata_documents_service_upload_document_resumable()
Packit 4b6dd7
be used instead.

Packit 4b6dd7

If document

Packit 4b6dd7
 is NULL, only the document data will be uploaded. The new document entry will be named using slug
Packit 4b6dd7
, and will have default metadata.

Packit 4b6dd7

The stream returned by this function should be written to using the standard GOutputStream methods, asychronously or synchronously. Once the stream

Packit 4b6dd7
is closed (using g_output_stream_close()), gdata_documents_service_finish_upload() should be called on it to parse and return the updated
Packit 4b6dd7
GDataDocumentsDocument for the document. This must be done, as document
Packit 4b6dd7
 isn't updated in-place.

Packit 4b6dd7

In order to cancel the upload, a GCancellable passed in to cancellable

Packit 4b6dd7
 must be cancelled using g_cancellable_cancel(). Cancelling the individual
Packit 4b6dd7
GOutputStream operations on the GDataUploadStream will not cancel the entire upload; merely the write or close operation in question. See the
Packit 4b6dd7
“cancellable” for more details.

Packit 4b6dd7

Any upload errors will be thrown by the stream methods, and may come from the GDataServiceError domain.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

an authenticated GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to insert, or NULL.

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

slug

Packit 4b6dd7

the filename to give to the uploaded document

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

content_type

Packit 4b6dd7

the content type of the uploaded data

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

folder

Packit 4b6dd7

the folder to which the document should be uploaded, or NULL.

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

cancellable

Packit 4b6dd7

a GCancellable for the entire upload stream, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

a GDataUploadStream to write the document data to, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_upload_document_resumable ()

Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
gdata_documents_service_upload_document_resumable
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsDocument *document,
Packit 4b6dd7
                                const gchar *slug,
Packit 4b6dd7
                                const gchar *content_type,
Packit 4b6dd7
                                goffset content_length,
Packit 4b6dd7
                                GDataDocumentsUploadQuery *query,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Uploads a document to Google Documents, using the properties from document

Packit 4b6dd7
 and the document data written to the resulting GDataUploadStream. If
Packit 4b6dd7
the document data does not need to be provided at the moment, just the metadata, use gdata_service_insert_entry() instead (e.g. in the case of
Packit 4b6dd7
creating a new, empty file to be edited at a later date).

Packit 4b6dd7

Unlike gdata_documents_service_upload_document(), this method performs a

Packit 4b6dd7
resumable upload which allows for correction of
Packit 4b6dd7

transmission errors without re-uploading the entire file. Use of this method is preferred over gdata_documents_service_upload_document().

Packit 4b6dd7

If document

Packit 4b6dd7
 is NULL, only the document data will be uploaded. The new document entry will be named using slug
Packit 4b6dd7
, and will have default metadata.

Packit 4b6dd7

If non-NULL, the query

Packit 4b6dd7
 specifies parameters for the upload, such as a GDataDocumentsFolder to upload the document into; and whether to treat
Packit 4b6dd7
the document as an opaque file, or convert it to a standard format. If query
Packit 4b6dd7
 is NULL, the document will be uploaded into the root folder, and
Packit 4b6dd7
automatically converted to a standard format. No OCR or automatic language translation will be performed by default.

Packit 4b6dd7

If query

Packit 4b6dd7
 is non-NULL and “convert” is FALSE, document
Packit 4b6dd7
 must be an instance of GDataDocumentsDocument. Otherwise,
Packit 4b6dd7
document
Packit 4b6dd7
 must be a subclass of it, such as GDataDocumentsPresentation.

Packit 4b6dd7

The stream returned by this function should be written to using the standard GOutputStream methods, asychronously or synchronously. Once the stream

Packit 4b6dd7
is closed (using g_output_stream_close()), gdata_documents_service_finish_upload() should be called on it to parse and return the updated
Packit 4b6dd7
GDataDocumentsDocument for the document. This must be done, as document
Packit 4b6dd7
 isn't updated in-place.

Packit 4b6dd7

In order to cancel the upload, a GCancellable passed in to cancellable

Packit 4b6dd7
 must be cancelled using g_cancellable_cancel(). Cancelling the individual
Packit 4b6dd7
GOutputStream operations on the GDataUploadStream will not cancel the entire upload; merely the write or close operation in question. See the
Packit 4b6dd7
“cancellable” for more details.

Packit 4b6dd7

Any upload errors will be thrown by the stream methods, and may come from the GDataServiceError domain.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

an authenticated GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to insert, or NULL.

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

slug

Packit 4b6dd7

the filename to give to the uploaded document

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

content_type

Packit 4b6dd7

the content type of the uploaded data

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

content_length

Packit 4b6dd7

the size (in bytes) of the file being uploaded

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

query

Packit 4b6dd7

a query specifying parameters for the upload, or NULL.

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

cancellable

Packit 4b6dd7

a GCancellable for the entire upload stream, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

a GDataUploadStream to write the document data to, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_update_document ()

Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
gdata_documents_service_update_document
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsDocument *document,
Packit 4b6dd7
                                const gchar *slug,
Packit 4b6dd7
                                const gchar *content_type,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Update the document using the properties from document

Packit 4b6dd7
 and the document data written to the resulting GDataUploadStream. If the document data does
Packit 4b6dd7
not need to be changed, just the metadata, use gdata_service_update_entry() instead.

Packit 4b6dd7

This performs a non-resumable upload, unlike gdata_documents_service_update_document(). This means that errors during transmission will cause the

Packit 4b6dd7
upload to fail, and the entire document will have to be re-uploaded. It is recommended that gdata_documents_service_update_document_resumable()
Packit 4b6dd7
be used instead.

Packit 4b6dd7

The stream returned by this function should be written to using the standard GOutputStream methods, asychronously or synchronously. Once the stream

Packit 4b6dd7
is closed (using g_output_stream_close()), gdata_documents_service_finish_upload() should be called on it to parse and return the updated
Packit 4b6dd7
GDataDocumentsDocument for the document. This must be done, as document
Packit 4b6dd7
 isn't updated in-place.

Packit 4b6dd7

In order to cancel the update, a GCancellable passed in to cancellable

Packit 4b6dd7
 must be cancelled using g_cancellable_cancel(). Cancelling the individual
Packit 4b6dd7
GOutputStream operations on the GDataUploadStream will not cancel the entire update; merely the write or close operation in question. See the
Packit 4b6dd7
“cancellable” for more details.

Packit 4b6dd7

Any upload errors will be thrown by the stream methods, and may come from the GDataServiceError domain.

Packit 4b6dd7

For more information, see gdata_service_update_entry().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to update

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

slug

Packit 4b6dd7

the filename to give to the uploaded document

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

content_type

Packit 4b6dd7

the content type of the uploaded data

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

cancellable

Packit 4b6dd7

a GCancellable for the entire upload stream, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

a GDataUploadStream to write the document data to; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_update_document_resumable ()

Packit 4b6dd7
GDataUploadStream *
Packit 4b6dd7
gdata_documents_service_update_document_resumable
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsDocument *document,
Packit 4b6dd7
                                const gchar *slug,
Packit 4b6dd7
                                const gchar *content_type,
Packit 4b6dd7
                                goffset content_length,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Update the document using the properties from document

Packit 4b6dd7
 and the document data written to the resulting GDataUploadStream. If the document data does
Packit 4b6dd7
not need to be changed, just the metadata, use gdata_service_update_entry() instead.

Packit 4b6dd7

Unlike gdata_documents_service_update_document(), this method performs a

Packit 4b6dd7
resumable upload which allows for correction of
Packit 4b6dd7

transmission errors without re-uploading the entire file. Use of this method is preferred over gdata_documents_service_update_document().

Packit 4b6dd7

The stream returned by this function should be written to using the standard GOutputStream methods, asychronously or synchronously. Once the stream

Packit 4b6dd7
is closed (using g_output_stream_close()), gdata_documents_service_finish_upload() should be called on it to parse and return the updated
Packit 4b6dd7
GDataDocumentsDocument for the document. This must be done, as document
Packit 4b6dd7
 isn't updated in-place.

Packit 4b6dd7

In order to cancel the update, a GCancellable passed in to cancellable

Packit 4b6dd7
 must be cancelled using g_cancellable_cancel(). Cancelling the individual
Packit 4b6dd7
GOutputStream operations on the GDataUploadStream will not cancel the entire update; merely the write or close operation in question. See the
Packit 4b6dd7
“cancellable” for more details.

Packit 4b6dd7

Any upload errors will be thrown by the stream methods, and may come from the GDataServiceError domain.

Packit 4b6dd7

For more information, see gdata_service_update_entry().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to update

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

slug

Packit 4b6dd7

the filename to give to the uploaded document

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

content_type

Packit 4b6dd7

the content type of the uploaded data

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

content_length

Packit 4b6dd7

the size (in bytes) of the file being uploaded

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

cancellable

Packit 4b6dd7

a GCancellable for the entire upload stream, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

a GDataUploadStream to write the document data to; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_finish_upload ()

Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
gdata_documents_service_finish_upload (GDataDocumentsService *self,
Packit 4b6dd7
                                       GDataUploadStream *upload_stream,
Packit 4b6dd7
                                       GError **error);
Packit 4b6dd7

Finish off a document upload or update operation started by gdata_documents_service_upload_document() or gdata_documents_service_update_document(),

Packit 4b6dd7
parsing the result and returning the new or updated GDataDocumentsDocument.

Packit 4b6dd7

If an error occurred during the upload or update operation, it will have been returned during the operation (e.g. by g_output_stream_splice() or one

Packit 4b6dd7
of the other stream methods). In such a case, NULL will be returned but error
Packit 4b6dd7
 will remain unset. error
Packit 4b6dd7
 is only set in the case that the server
Packit 4b6dd7
indicates that the operation was successful, but an error is encountered in parsing the result sent by the server.

Packit 4b6dd7

In the case that no GDataDocumentsDocument was passed (to gdata_documents_service_upload_document() or gdata_documents_service_update_document())

Packit 4b6dd7
when starting the operation, GDATA_DOCUMENTS_SERVICE_ERROR_INVALID_CONTENT_TYPE will be thrown in error
Packit 4b6dd7
 if the content type of the uploaded data
Packit 4b6dd7
could not be mapped to a document type with which to interpret the response from the server.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

upload_stream

Packit 4b6dd7

the GDataUploadStream from the operation

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

the new or updated GDataDocumentsDocument, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_copy_document ()

Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
gdata_documents_service_copy_document (GDataDocumentsService *self,
Packit 4b6dd7
                                       GDataDocumentsDocument *document,
Packit 4b6dd7
                                       GCancellable *cancellable,
Packit 4b6dd7
                                       GError **error);
Packit 4b6dd7

Copy the given document

Packit 4b6dd7
, producing a duplicate document in the same folder and returning its GDataDocumentsDocument.

Packit 4b6dd7

Errors from GDataServiceError can be returned for exceptional conditions, as determined by the server.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

an authenticated GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to copy

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

the duplicate GDataDocumentsDocument, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.1

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_copy_document_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_service_copy_document_async
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsDocument *document,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Copy the given document

Packit 4b6dd7
, producing a duplicate document in the same folder and returning its GDataDocumentsDocument. self
Packit 4b6dd7
 and document
Packit 4b6dd7
 are
Packit 4b6dd7
both reffed when this function is called, so can safely be unreffed after this function returns.

Packit 4b6dd7

For more details, see gdata_documents_service_copy_document(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_documents_service_copy_document_finish() to get the results
Packit 4b6dd7
of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

document

Packit 4b6dd7

the GDataDocumentsDocument to copy

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished, or NULL

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

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.1

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_copy_document_finish ()

Packit 4b6dd7
GDataDocumentsDocument *
Packit 4b6dd7
gdata_documents_service_copy_document_finish
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finish an asynchronous operation to copy a GDataDocumentsDocument started with gdata_documents_service_copy_document_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

async_result

Packit 4b6dd7

a GAsyncResult

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

the duplicate GDataDocumentsDocument, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.1

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_add_entry_to_folder ()

Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsEntry *entry,
Packit 4b6dd7
                                GDataDocumentsFolder *folder,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Add the given entry

Packit 4b6dd7
 to the specified folder
Packit 4b6dd7
, and return an updated GDataDocumentsEntry for entry
Packit 4b6dd7
. If the entry
Packit 4b6dd7
 is already in another folder,
Packit 4b6dd7
a copy will be added to the new folder. The copy and original will have different IDs. Note that entry
Packit 4b6dd7
 can't be a GDataDocumentsFolder that
Packit 4b6dd7
already exists on the server. It can be a new GDataDocumentsFolder, or a GDataDocumentsDocument that is either new or already present on the
Packit 4b6dd7
server.

Packit 4b6dd7

Errors from GDataServiceError can be returned for exceptional conditions, as determined by the server.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

an authenticated GDataDocumentsService

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

entry

Packit 4b6dd7

the GDataDocumentsEntry to copy

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

folder

Packit 4b6dd7

the GDataDocumentsFolder to copy entry

Packit 4b6dd7
into

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

an updated GDataDocumentsEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_add_entry_to_folder_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder_async
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsEntry *entry,
Packit 4b6dd7
                                GDataDocumentsFolder *folder,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Add the given entry

Packit 4b6dd7
 to the specified folder
Packit 4b6dd7
. self
Packit 4b6dd7
, entry
Packit 4b6dd7
 and folder
Packit 4b6dd7
 are all reffed when this function is called, so can safely be unreffed
Packit 4b6dd7
after this function returns.

Packit 4b6dd7

For more details, see gdata_documents_service_add_entry_to_folder(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_documents_service_add_entry_to_folder_finish() to get the results
Packit 4b6dd7
of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

entry

Packit 4b6dd7

the GDataDocumentsEntry to add to folder

Packit 4b6dd7

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

folder

Packit 4b6dd7

the GDataDocumentsFolder to add entry

Packit 4b6dd7
to

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished, or NULL

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

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_add_entry_to_folder_finish ()

Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
gdata_documents_service_add_entry_to_folder_finish
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finish an asynchronous operation to add a GDataDocumentsEntry to a folder started with gdata_documents_service_add_entry_to_folder_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

async_result

Packit 4b6dd7

a GAsyncResult

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

an updated GDataDocumentsEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_remove_entry_from_folder ()

Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsEntry *entry,
Packit 4b6dd7
                                GDataDocumentsFolder *folder,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Remove the given entry

Packit 4b6dd7
 from folder
Packit 4b6dd7
, and return an updated GDataDocumentsEntry for entry
Packit 4b6dd7
. entry
Packit 4b6dd7
 will remain a member of any other folders it's
Packit 4b6dd7
currently in. Note that entry
Packit 4b6dd7
 can be either a GDataDocumentsDocument or a GDataDocumentsFolder.

Packit 4b6dd7

Errors from GDataServiceError can be returned for exceptional conditions, as determined by the server.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

entry

Packit 4b6dd7

the GDataDocumentsEntry to remove

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

folder

Packit 4b6dd7

the GDataDocumentsFolder from which we should remove entry

Packit 4b6dd7

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

an updated GDataDocumentsEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_remove_entry_from_folder_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder_async
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GDataDocumentsEntry *entry,
Packit 4b6dd7
                                GDataDocumentsFolder *folder,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Remove the given entry

Packit 4b6dd7
 from the specified folder
Packit 4b6dd7
. self
Packit 4b6dd7
, entry
Packit 4b6dd7
 and folder
Packit 4b6dd7
 are all reffed when this function is called, so can safely be unreffed
Packit 4b6dd7
after this function returns.

Packit 4b6dd7

For more details, see gdata_documents_service_remove_entry_from_folder(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_documents_service_remove_entry_from_folder_finish() to get the
Packit 4b6dd7
results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

entry

Packit 4b6dd7

the GDataDocumentsEntry to remove from folder

Packit 4b6dd7

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

folder

Packit 4b6dd7

the GDataDocumentsFolder to remove entry

Packit 4b6dd7
from

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

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished, or NULL

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

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_remove_entry_from_folder_finish ()

Packit 4b6dd7
GDataDocumentsEntry *
Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder_finish
Packit 4b6dd7
                               (GDataDocumentsService *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finish an asynchronous operation to remove a GDataDocumentsEntry from a folder started with

Packit 4b6dd7
gdata_documents_service_remove_entry_from_folder_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsService

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

async_result

Packit 4b6dd7

a GAsyncResult

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

error

Packit 4b6dd7

a GError, or NULL

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

Returns

Packit 4b6dd7

an updated GDataDocumentsEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.8.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_service_get_upload_uri ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_documents_service_get_upload_uri
Packit 4b6dd7
                               (GDataDocumentsFolder *folder);
Packit 4b6dd7

Gets the upload URI for documents for the service.

Packit 4b6dd7

If folder

Packit 4b6dd7
 is NULL, the URI will be the one to upload documents to the "root" folder.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

folder

Packit 4b6dd7

the GDataDocumentsFolder into which to upload the document, or NULL.

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

Returns

Packit 4b6dd7

the URI permitting the upload of documents to folder

Packit 4b6dd7
, or NULL; free with g_free()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.5.0

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

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsService

Packit 4b6dd7
typedef struct _GDataDocumentsService GDataDocumentsService;
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsServiceClass

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

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

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

enum GDataDocumentsServiceError

Packit 4b6dd7

Error codes for GDataDocumentsService operations.

Packit 4b6dd7
Packit 4b6dd7

Members

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

GDATA_DOCUMENTS_SERVICE_ERROR_INVALID_CONTENT_TYPE

Packit 4b6dd7
Packit 4b6dd7

the content type of a provided file was invalid

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

Since: 0.4.0

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

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