![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
#include <gdata/services/documents/gdata-documents-entry.h> #define GDATA_DOCUMENTS_ACCESS_ROLE_OWNER #define GDATA_DOCUMENTS_ACCESS_ROLE_WRITER #define GDATA_DOCUMENTS_ACCESS_ROLE_READER GDataDocumentsEntry; GDataDocumentsEntryClass; gchar * gdata_documents_entry_get_path (GDataDocumentsEntry *self
); const gchar * gdata_documents_entry_get_document_id (GDataDocumentsEntry *self
); gint64 gdata_documents_entry_get_edited (GDataDocumentsEntry *self
); GDataAuthor * gdata_documents_entry_get_last_modified_by (GDataDocumentsEntry *self
); gint64 gdata_documents_entry_get_last_viewed (GDataDocumentsEntry *self
); 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
);
GObject +----GDataParsable +----GDataEntry +----GDataDocumentsEntry +----GDataDocumentsDocument +----GDataDocumentsFolder
"document-id" gchar* : Read "edited" gint64 : Read "is-deleted" gboolean : Read / Write "last-modified-by" GDataAuthor* : Read "last-viewed" gint64 : Read "writers-can-invite" gboolean : Read / Write
GDataDocumentsEntry is a subclass of GDataEntry to represent a Google Documents entry, which is then further subclassed to give specific document types.
GDataDocumentsEntry implements GDataAccessHandler, meaning the access rules to it can be modified using that interface. As well as the
access roles defined for the base GDataAccessRule (e.g. GDATA_ACCESS_ROLE_NONE
), GDataDocumentsEntry has its own, such as
GDATA_DOCUMENTS_ACCESS_ROLE_OWNER
and GDATA_DOCUMENTS_ACCESS_ROLE_READER
.
For more details of Google Documents' GData API, see the online documentation.
#define GDATA_DOCUMENTS_ACCESS_ROLE_OWNER "owner"
The users specified by the GDataAccessRule have full owner access to the document. This allows them to modify the access rules and delete the document, amongst other things.
Since 0.7.0
#define GDATA_DOCUMENTS_ACCESS_ROLE_WRITER "writer"
The users specified by the GDataAccessRule have write access to the document. They cannot modify the access rules or delete the document.
Since 0.7.0
#define GDATA_DOCUMENTS_ACCESS_ROLE_READER "reader"
The users specified by the GDataAccessRule have read-only access to the document.
Since 0.7.0
typedef struct _GDataDocumentsEntry GDataDocumentsEntry;
All the fields in the GDataDocumentsEntry structure are private and should never be accessed directly.
Since 0.4.0
typedef struct { } GDataDocumentsEntryClass;
All the fields in the GDataDocumentsEntryClass structure are private and should never be accessed directly.
Since 0.4.0
gchar * gdata_documents_entry_get_path (GDataDocumentsEntry *self
);
Builds a path for the GDataDocumentsEntry, starting from a root node and traversing the folders containing the document, then ending with the document's ID.
An example path would be: /folder_id1/folder_id2/document_id
.
Note: the path is based on the entry/document IDs of the folders ("id") and document ("document-id"), and not the entries' human-readable names ("title").
|
a GDataDocumentsEntry |
Returns : |
the folder hierarchy path containing the document, or NULL ; free with g_free()
|
Since 0.4.0
const gchar * gdata_documents_entry_get_document_id
(GDataDocumentsEntry *self
);
Gets the "document-id" property.
|
a GDataDocumentsEntry |
Returns : |
the document's document ID |
Since 0.4.0
gint64 gdata_documents_entry_get_edited (GDataDocumentsEntry *self
);
Gets the "edited" property. If the property is unset, -1
will be returned.
|
a GDataDocumentsEntry |
Returns : |
the UNIX timestamp for the time the document was last edited, or -1
|
Since 0.4.0
GDataAuthor * gdata_documents_entry_get_last_modified_by
(GDataDocumentsEntry *self
);
Gets the "last-modified-by" property.
|
a GDataDocumentsEntry |
Returns : |
the author who last modified the document. [transfer none] |
Since 0.4.0
gint64 gdata_documents_entry_get_last_viewed
(GDataDocumentsEntry *self
);
Gets the "last-viewed" property. If the property is unset, -1
will be returned.
|
a GDataDocumentsEntry |
Returns : |
the UNIX timestamp for the time the document was last viewed, or -1
|
Since 0.4.0
gboolean gdata_documents_entry_writers_can_invite
(GDataDocumentsEntry *self
);
Gets the "writers-can-invite" property.
|
a GDataDocumentsEntry |
Returns : |
TRUE if writers can invite other people to edit the document, FALSE otherwise |
Since 0.4.0
void gdata_documents_entry_set_writers_can_invite (GDataDocumentsEntry *self
,gboolean writers_can_invite
);
Sets the "writers-can-invite" property to writers_can_invite
.
|
a GDataDocumentsEntry |
|
TRUE if writers can invite other people to edit the document, FALSE otherwise |
Since 0.4.0
gboolean gdata_documents_entry_is_deleted (GDataDocumentsEntry *self
);
Gets the "is-deleted" property.
|
a GDataDocumentsEntry |
Returns : |
TRUE if the document has been deleted, FALSE otherwise |
Since 0.5.0
"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
"edited"
property"edited" gint64 : 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.
Allowed values: >= -1
Default value: -1
Since 0.4.0
"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
"last-modified-by"
property"last-modified-by" GDataAuthor* : Read
Indicates the author of the last modification.
Since 0.4.0
"last-viewed"
property"last-viewed" gint64 : Read
The last time the document was viewed.
Allowed values: >= -1
Default value: -1
Since 0.4.0
"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