Blame docs/reference/html/GDataDocumentsEntry.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>GDataDocumentsEntry: 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="GDataDocumentsUploadQuery.html" title="GDataDocumentsUploadQuery">
Packit 4b6dd7
<link rel="next" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument">
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
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsEntry

Packit 4b6dd7

GDataDocumentsEntry — GData document object abstract class

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
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_path ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_resource_id ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_document_id ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_edited ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthor *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_last_modified_by ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_last_viewed ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
goffset
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_quota_used ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
goffset
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_get_file_size ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_writers_can_invite ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_set_writers_can_invite ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_documents_entry_is_deleted ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
document-id
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
edited
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
file-size
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
is-deleted
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthor *
Packit 4b6dd7
last-modified-by
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
last-viewed
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gint64
Packit 4b6dd7
quota-used
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
resource-id
Packit 4b6dd7
Read
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
writers-can-invite
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
#define
Packit 4b6dd7
GDATA_DOCUMENTS_ACCESS_ROLE_OWNER
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
#define
Packit 4b6dd7
GDATA_DOCUMENTS_ACCESS_ROLE_WRITER
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
#define
Packit 4b6dd7
GDATA_DOCUMENTS_ACCESS_ROLE_READER
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsEntry
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataDocumentsEntryClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataParsable
Packit 4b6dd7
        ╰── GDataEntry
Packit 4b6dd7
            ╰── GDataDocumentsEntry
Packit 4b6dd7
                ├── GDataDocumentsDocument
Packit 4b6dd7
                ╰── GDataDocumentsFolder
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Implemented Interfaces

Packit 4b6dd7

Packit 4b6dd7
GDataDocumentsEntry implements
Packit 4b6dd7
 GDataAccessHandler.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

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

Description

Packit 4b6dd7

GDataDocumentsEntry is a subclass of GDataEntry to represent a Google Drive entry, which is then further subclassed

Packit 4b6dd7
to give specific document types.

Packit 4b6dd7

GDataDocumentsEntry implements GDataAccessHandler, meaning the access rules to it can be modified using that interface. As well as the

Packit 4b6dd7
access roles defined for the base GDataAccessRule (e.g. GDATA_ACCESS_ROLE_NONE), GDataDocumentsEntry has its own, such as
Packit 4b6dd7
GDATA_DOCUMENTS_ACCESS_ROLE_OWNER and GDATA_DOCUMENTS_ACCESS_ROLE_READER.

Packit 4b6dd7

Documents can (confusingly) be referenced by three different types of IDs: their entry ID, their resource ID and their document ID (untyped resource

Packit 4b6dd7
ID). Each is a substring of the previous ones (i.e. the entry ID contains the resource ID, which in turn contains the document ID). The resource ID
Packit 4b6dd7
and document ID should almost always be considered as internal, and thus entry IDs (“id”) should normally be used to uniquely identify
Packit 4b6dd7
documents. For more information, see “resource-id”.

Packit 4b6dd7

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

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

Example 32. Moving an Entry Between Folders

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
        
GDataDocumentsService *service;
Packit 4b6dd7
GDataDocumentsEntry *entry, *intermediate_entry, *updated_entry;
Packit 4b6dd7
GDataDocumentsFolder *old_folder, *new_folder;
Packit 4b6dd7
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service */
Packit 4b6dd7
service = create_documents_service ();
Packit 4b6dd7
Packit 4b6dd7
/* Get the entry, the folder it's being moved out of, and the folder it's being moved into. The entry can either be a document or
Packit 4b6dd7
 * another folder, allowing hierarchies of folders to be constructed. */
Packit 4b6dd7
entry = query_user_for_entry (service);
Packit 4b6dd7
old_folder = query_user_for_old_folder (service);
Packit 4b6dd7
new_folder = query_user_for_new_folder (service);
Packit 4b6dd7
Packit 4b6dd7
/* Add the entry to the new folder */
Packit 4b6dd7
intermediate_entry = gdata_documents_service_add_entry_to_folder (service, entry, new_folder, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (entry);
Packit 4b6dd7
g_object_unref (new_folder);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    g_error ("Error adding entry to new folder: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    g_object_unref (old_folder);
Packit 4b6dd7
    g_object_unref (service);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Remove the entry from the old folder */
Packit 4b6dd7
updated_entry = gdata_documents_service_remove_entry_from_folder (service, intermediate_entry, old_folder, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (intermediate_entry);
Packit 4b6dd7
g_object_unref (old_folder);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
if (error != NULL) {
Packit 4b6dd7
    /* Note that you might want to attempt to remove the intermediate_entry from the new_folder in this error case, so that
Packit 4b6dd7
     * the operation is aborted cleanly. */
Packit 4b6dd7
    g_error ("Error removing entry from previous folder: %s", error->message);
Packit 4b6dd7
    g_error_free (error);
Packit 4b6dd7
    return;
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/* Do something with the updated entry */
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (updated_entry);
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_entry_get_path ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_documents_entry_get_path (GDataDocumentsEntry *self);
Packit 4b6dd7

Builds a path for the GDataDocumentsEntry, starting from a root node and traversing the folders containing the document, then ending with the

Packit 4b6dd7
document's ID.

Packit 4b6dd7

An example path would be: /folder_id1/folder_id2/document_id.

Packit 4b6dd7

Note: the path is based on the entry/document IDs of the folders (“id”) and document (“document-id”),

Packit 4b6dd7
and not the entries' human-readable names (“title”).

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the folder hierarchy path containing the document, or NULL; free with g_free()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_resource_id ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_documents_entry_get_resource_id (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “resource-id” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the document's resource ID

Packit 4b6dd7
Packit 4b6dd7

Since: 0.11.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_document_id ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_documents_entry_get_document_id (GDataDocumentsEntry *self);
Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_document_id has been deprecated since version 0.11.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_documents_entry_get_resource_id() instead. See “document-id”.

Packit 4b6dd7
Packit 4b6dd7

Gets the “document-id” property. The

Packit 4b6dd7
online GData Documentation

refers to these as “untyped resource IDs”.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the document's document ID

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_edited ()

Packit 4b6dd7
gint64
Packit 4b6dd7
gdata_documents_entry_get_edited (GDataDocumentsEntry *self);
Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_edited has been deprecated since version 0.17.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_entry_get_updated() instead. See “edited”.

Packit 4b6dd7
Packit 4b6dd7

Gets the “edited” property. If the property is unset, -1 will be returned.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the UNIX timestamp for the time the document was last edited, or -1

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_last_modified_by ()

Packit 4b6dd7
GDataAuthor *
Packit 4b6dd7
gdata_documents_entry_get_last_modified_by
Packit 4b6dd7
                               (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “last-modified-by” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the author who last modified the document.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_last_viewed ()

Packit 4b6dd7
gint64
Packit 4b6dd7
gdata_documents_entry_get_last_viewed (GDataDocumentsEntry *self);
Packit 4b6dd7

gdata_documents_entry_get_last_viewed is deprecated and should not be used in newly-written code.

Packit 4b6dd7

Gets the “last-viewed” property. If the property is unset, -1 will be returned.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the UNIX timestamp for the time the document was last viewed, or -1

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_quota_used ()

Packit 4b6dd7
goffset
Packit 4b6dd7
gdata_documents_entry_get_quota_used (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “quota-used” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the number of quota bytes used by the document

Packit 4b6dd7
Packit 4b6dd7

Since: 0.13.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_get_file_size ()

Packit 4b6dd7
goffset
Packit 4b6dd7
gdata_documents_entry_get_file_size (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “file-size” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

the size of the document in bytes

Packit 4b6dd7
Packit 4b6dd7

Since: 0.17.7

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_writers_can_invite ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_documents_entry_writers_can_invite
Packit 4b6dd7
                               (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “writers-can-invite” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

TRUE if writers can invite other people to edit the document, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_set_writers_can_invite ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_documents_entry_set_writers_can_invite
Packit 4b6dd7
                               (GDataDocumentsEntry *self,
Packit 4b6dd7
                                gboolean writers_can_invite);
Packit 4b6dd7

Sets the “writers-can-invite” property to writers_can_invite

Packit 4b6dd7
.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

writers_can_invite

Packit 4b6dd7

TRUE if writers can invite other people to edit the document, FALSE otherwise

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

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_documents_entry_is_deleted ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_documents_entry_is_deleted (GDataDocumentsEntry *self);
Packit 4b6dd7

Gets the “is-deleted” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

self

Packit 4b6dd7

a GDataDocumentsEntry

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

Returns

Packit 4b6dd7

TRUE if the document has been deleted, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.5.0

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

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDATA_DOCUMENTS_ACCESS_ROLE_OWNER

Packit 4b6dd7
#define GDATA_DOCUMENTS_ACCESS_ROLE_OWNER "owner"
Packit 4b6dd7
Packit 4b6dd7

The users specified by the GDataAccessRule have full owner access to the document. This allows them to modify the access rules and delete

Packit 4b6dd7
the document, amongst other things.

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDATA_DOCUMENTS_ACCESS_ROLE_WRITER

Packit 4b6dd7
#define GDATA_DOCUMENTS_ACCESS_ROLE_WRITER "writer"
Packit 4b6dd7
Packit 4b6dd7

The users specified by the GDataAccessRule have write access to the document. They cannot modify the access rules or delete the document.

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDATA_DOCUMENTS_ACCESS_ROLE_READER

Packit 4b6dd7
#define GDATA_DOCUMENTS_ACCESS_ROLE_READER "reader"
Packit 4b6dd7
Packit 4b6dd7

The users specified by the GDataAccessRule have read-only access to the document.

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsEntry

Packit 4b6dd7
typedef struct _GDataDocumentsEntry GDataDocumentsEntry;
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsEntryClass

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

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

Packit 4b6dd7

Since: 0.4.0

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

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “document-id” property

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

The document ID of the document, which is different from its entry ID (GDataEntry:id). The

Packit 4b6dd7
online GData
Packit 4b6dd7
Documentation refers to these as “untyped resource IDs”.
Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsEntry:document-id has been deprecated since version 0.11.0 and should not be used in newly-written code.

Packit 4b6dd7

This a substring of the “resource-id”, which is more general and should be used instead.

Packit 4b6dd7
Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “edited” property

Packit 4b6dd7
  “edited”                   gint64
Packit 4b6dd7

The last time the document was edited. If the document has not been edited yet, the content indicates the time it was created.

Packit 4b6dd7
Packit 4b6dd7

GDataDocumentsEntry:edited has been deprecated since version 0.17.0 and should not be used in newly-written code.

Packit 4b6dd7

This is identical to “updated”.

Packit 4b6dd7
Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Allowed values: >= -1

Packit 4b6dd7

Default value: -1

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “file-size” property

Packit 4b6dd7
  “file-size”                gint64
Packit 4b6dd7

The size of the document. This is only set for non-document files.

Packit 4b6dd7
Standard formats, such as GDataDocumentsText,
Packit 4b6dd7
GDataDocumentsSpreadsheet and GDataDocumentsFolder are not binary
Packit 4b6dd7
data and so have no size. Measured in bytes.

Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Allowed values: >= 0

Packit 4b6dd7

Default value: 0

Packit 4b6dd7

Since: 0.17.7

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “is-deleted” property

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

Indicates whether the document entry has been deleted (moved to the trash). Deleted documents will only

Packit 4b6dd7
appear in query results if the “show-deleted” property is TRUE.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: FALSE

Packit 4b6dd7

Since: 0.5.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “last-modified-by” property

Packit 4b6dd7
  “last-modified-by”         GDataAuthor *
Packit 4b6dd7

Indicates the author of the last modification.

Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “last-viewed” property

Packit 4b6dd7
  “last-viewed”              gint64
Packit 4b6dd7

The last time the document was viewed.

Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Allowed values: >= -1

Packit 4b6dd7

Default value: -1

Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “quota-used” property

Packit 4b6dd7
  “quota-used”               gint64
Packit 4b6dd7

The amount of user quota the document is occupying. Currently, only arbitrary files consume file space quota (whereas standard document

Packit 4b6dd7
formats, such as GDataDocumentsText, GDataDocumentsSpreadsheet and GDataDocumentsFolder don't). Measured in bytes.

Packit 4b6dd7

This property will be 0 for documents which aren't consuming any quota.

Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Allowed values: >= 0

Packit 4b6dd7

Default value: 0

Packit 4b6dd7

Since: 0.13.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “resource-id” property

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

The resource ID of the document. This should not normally need to be used in client code, and is mostly for internal use. To uniquely

Packit 4b6dd7
identify a given document or folder, use its “id”.

Packit 4b6dd7

Resource IDs have the form:

Packit 4b6dd7
document|drawing|pdf|spreadsheet|presentation|folder:untyped resource ID; whereas
Packit 4b6dd7
entry IDs have the form:
Packit 4b6dd7
https://docs.google.com/feeds/id/resource ID in version 3 of the API.

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
Google Documents
Packit 4b6dd7
API reference.
Packit 4b6dd7

Flags: Read

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.11.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “writers-can-invite” property

Packit 4b6dd7
  “writers-can-invite”       gboolean
Packit 4b6dd7

Indicates whether the document entry writers can invite others to edit the document.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: FALSE

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>