GDataDocumentsEntry

GDataDocumentsEntry — GData document object abstract class

Stability Level

Unstable, unless otherwise indicated

Synopsis


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

                    GDataDocumentsEntry;
                    GDataDocumentsEntryClass;
gchar *             gdata_documents_entry_get_path      (GDataDocumentsEntry *self);
const gchar *       gdata_documents_entry_get_document_id
                                                        (GDataDocumentsEntry *self);
void                gdata_documents_entry_get_edited    (GDataDocumentsEntry *self,
                                                         GTimeVal *edited);
GDataAuthor *       gdata_documents_entry_get_last_modified_by
                                                        (GDataDocumentsEntry *self);
void                gdata_documents_entry_get_last_viewed
                                                        (GDataDocumentsEntry *self,
                                                         GTimeVal *last_viewed);
gboolean            gdata_documents_entry_writers_can_invite
                                                        (GDataDocumentsEntry *self);
void                gdata_documents_entry_set_writers_can_invite
                                                        (GDataDocumentsEntry *self,
                                                         gboolean writers_can_invite);
gboolean            gdata_documents_entry_is_deleted    (GDataDocumentsEntry *self);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataEntry
               +----GDataDocumentsEntry
                     +----GDataDocumentsText
                     +----GDataDocumentsSpreadsheet
                     +----GDataDocumentsPresentation
                     +----GDataDocumentsFolder

Implemented Interfaces

GDataDocumentsEntry implements GDataAccessHandler.

Properties

  "document-id"              gchar*                : Read
  "edited"                   GTimeVal*             : Read
  "is-deleted"               gboolean              : Read / Write
  "last-modified-by"         GDataAuthor*          : Read
  "last-viewed"              GTimeVal*             : Read
  "writers-can-invite"       gboolean              : Read / Write

Description

GDataDocumentsEntry is a subclass of GDataEntry to represent a Google Documents entry, which is then further subclassed to give specific document types.

For more details of Google Documents' GData API, see the online documentation.

Details

GDataDocumentsEntry

typedef struct _GDataDocumentsEntry GDataDocumentsEntry;

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

Since 0.4.0


GDataDocumentsEntryClass

typedef struct {
} GDataDocumentsEntryClass;

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

Since 0.4.0


gdata_documents_entry_get_path ()

gchar *             gdata_documents_entry_get_path      (GDataDocumentsEntry *self);

Gets the "path" property.

Note: the path is based on the entry ID, and not the entry human readable name ("title").

self :

a GDataDocumentsEntry

Returns :

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

Since 0.4.0


gdata_documents_entry_get_document_id ()

const gchar *       gdata_documents_entry_get_document_id
                                                        (GDataDocumentsEntry *self);

Gets the "document-id" property.

self :

a GDataDocumentsEntry

Returns :

the document's document ID

Since 0.4.0


gdata_documents_entry_get_edited ()

void                gdata_documents_entry_get_edited    (GDataDocumentsEntry *self,
                                                         GTimeVal *edited);

Gets the "edited" property and puts it in edited. If the property is unset, both fields in the GTimeVal will be set to 0.

self :

a GDataDocumentsEntry

edited :

a GTimeVal

Since 0.4.0


gdata_documents_entry_get_last_modified_by ()

GDataAuthor *       gdata_documents_entry_get_last_modified_by
                                                        (GDataDocumentsEntry *self);

Gets the "last-modified-by" property.

self :

a GDataDocumentsEntry

Returns :

the author who last modified the document

Since 0.4.0


gdata_documents_entry_get_last_viewed ()

void                gdata_documents_entry_get_last_viewed
                                                        (GDataDocumentsEntry *self,
                                                         GTimeVal *last_viewed);

Gets the "last-viewed" property and puts it in last_viewed. If the property is unset, both fields in the GTimeVal will be set to 0.

self :

a GDataDocumentsEntry

last_viewed :

a GTimeVal

Since 0.4.0


gdata_documents_entry_writers_can_invite ()

gboolean            gdata_documents_entry_writers_can_invite
                                                        (GDataDocumentsEntry *self);

Gets the "writers-can-invite" property.

self :

a GDataDocumentsEntry

Returns :

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

Since 0.4.0


gdata_documents_entry_set_writers_can_invite ()

void                gdata_documents_entry_set_writers_can_invite
                                                        (GDataDocumentsEntry *self,
                                                         gboolean writers_can_invite);

Sets the "writers-can-invite" property to writers_can_invite.

self :

a GDataDocumentsEntry

writers_can_invite :

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

Since 0.4.0


gdata_documents_entry_is_deleted ()

gboolean            gdata_documents_entry_is_deleted    (GDataDocumentsEntry *self);

Gets the "is-deleted" property.

self :

a GDataDocumentsEntry

Returns :

TRUE if the document has been deleted, FALSE otherwise

Since 0.5.0

Property Details

The "document-id" property

  "document-id"              gchar*                : Read

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

Default value: NULL

Since 0.4.0


The "edited" property

  "edited"                   GTimeVal*             : Read

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

For more information, see the Atom Publishing Protocol specification.

Since 0.4.0


The "is-deleted" property

  "is-deleted"               gboolean              : Read / Write

Indicates whether the document entry has been deleted (moved to the trash). Deleted documents will only appear in query results if the "show-deleted" property is TRUE.

Default value: FALSE

Since 0.5.0


The "last-modified-by" property

  "last-modified-by"         GDataAuthor*          : Read

Indicates the author of the last modification.

Since 0.4.0


The "last-viewed" property

  "last-viewed"              GTimeVal*             : Read

The last time the document was viewed.

Since 0.4.0


The "writers-can-invite" property

  "writers-can-invite"       gboolean              : Read / Write

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

Default value: FALSE

Since 0.4.0