![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Known Derived Interfaces | Properties |
#include <gdata/gdata-entry.h> GDataEntry; GDataEntryClass; GDataEntry * gdata_entry_new (const gchar *id); const gchar * gdata_entry_get_title (GDataEntry *self); void gdata_entry_set_title (GDataEntry *self, const gchar *title); const gchar * gdata_entry_get_summary (GDataEntry *self); void gdata_entry_set_summary (GDataEntry *self, const gchar *summary); const gchar * gdata_entry_get_id (GDataEntry *self); const gchar * gdata_entry_get_etag (GDataEntry *self); const gchar * gdata_entry_get_content (GDataEntry *self); void gdata_entry_set_content (GDataEntry *self, const gchar *content); void gdata_entry_get_published (GDataEntry *self, GTimeVal *published); void gdata_entry_get_updated (GDataEntry *self, GTimeVal *updated); void gdata_entry_add_author (GDataEntry *self, GDataAuthor *author); void gdata_entry_add_category (GDataEntry *self, GDataCategory *category); GList * gdata_entry_get_categories (GDataEntry *self); void gdata_entry_add_link (GDataEntry *self, GDataLink *link); GDataLink * gdata_entry_look_up_link (GDataEntry *self, const gchar *rel); GList * gdata_entry_look_up_links (GDataEntry *self, const gchar *rel); gboolean gdata_entry_is_inserted (GDataEntry *self); const gchar * gdata_entry_get_rights (GDataEntry *self); void gdata_entry_set_rights (GDataEntry *self, const gchar *rights);
GObject +----GDataParsable +----GDataEntry +----GDataAccessRule +----GDataYouTubeVideo +----GDataPicasaWebFile +----GDataPicasaWebAlbum +----GDataDocumentsEntry +----GDataContactsContact +----GDataCalendarEvent +----GDataCalendarCalendar
"content" gchar* : Read / Write "etag" gchar* : Read / Write / Construct Only "id" gchar* : Read / Write / Construct Only "is-inserted" gboolean : Read "published" GTimeVal* : Read "rights" gchar* : Read / Write "summary" gchar* : Read / Write "title" gchar* : Read / Write "updated" GTimeVal* : Read
GDataEntry represents a single object on the online service, such as a playlist, video or calendar event. It is a snapshot of the state of that object at the time of querying the service, so modifications made to a GDataEntry will not be automatically or magically propagated to the server.
typedef struct _GDataEntry GDataEntry;
All the fields in the GDataEntry structure are private and should never be accessed directly.
typedef struct { } GDataEntryClass;
All the fields in the GDataEntryClass structure are private and should never be accessed directly.
GDataEntry * gdata_entry_new (const gchar *id);
Creates a new GDataEntry with the given ID and default properties.
|
the entry's ID, or NULL
|
Returns : |
a new GDataEntry; unref with g_object_unref()
|
const gchar * gdata_entry_get_title (GDataEntry *self);
Returns the title of the entry.
|
a GDataEntry |
Returns : |
the entry's title |
void gdata_entry_set_title (GDataEntry *self, const gchar *title);
Sets the title of the entry.
|
a GDataEntry |
|
the new entry title, or NULL
|
const gchar * gdata_entry_get_summary (GDataEntry *self);
Returns the summary of the entry.
|
a GDataEntry |
Returns : |
the entry's summary, or NULL
|
Since 0.4.0
void gdata_entry_set_summary (GDataEntry *self, const gchar *summary);
Sets the summary of the entry.
|
a GDataEntry |
|
the new entry summary, or NULL
|
Since 0.4.0
const gchar * gdata_entry_get_id (GDataEntry *self);
Returns the URN ID of the entry; a unique and permanent identifier for the object the entry represents.
|
a GDataEntry |
Returns : |
the entry's ID |
const gchar * gdata_entry_get_etag (GDataEntry *self);
Returns the ETag of the entry; a unique identifier for each version of the entry. For more information, see the online documentation.
|
a GDataEntry |
Returns : |
the entry's ETag |
Since 0.2.0
const gchar * gdata_entry_get_content (GDataEntry *self);
Returns the textual content in this entry.
|
a GDataEntry |
Returns : |
the entry's content, or NULL
|
void gdata_entry_set_content (GDataEntry *self, const gchar *content);
Sets the entry's content to content
.
|
a GDataEntry |
|
the new content for the entry |
void gdata_entry_get_published (GDataEntry *self, GTimeVal *published);
Puts the time the entry was originally published into published
.
|
a GDataEntry |
|
a GTimeVal |
void gdata_entry_get_updated (GDataEntry *self, GTimeVal *updated);
Puts the time the entry was last updated into updated
.
|
a GDataEntry |
|
a GTimeVal |
void gdata_entry_add_author (GDataEntry *self, GDataAuthor *author);
Adds author
to the list of authors in the given GDataEntry and increments its reference count.
Duplicate authors will not be added to the list.
|
a GDataEntry |
|
a GDataAuthor to add |
void gdata_entry_add_category (GDataEntry *self, GDataCategory *category);
Adds category
to the list of categories in the given GDataEntry, and increments its reference count.
Duplicate categories will not be added to the list.
|
a GDataEntry |
|
a GDataCategory to add |
GList * gdata_entry_get_categories (GDataEntry *self);
Gets a list of the GDataCategorys containing this entry.
|
a GDataEntry |
Returns : |
a GList of GDataCategorys |
Since 0.2.0
void gdata_entry_add_link (GDataEntry *self, GDataLink *link);
Adds link
to the list of links in the given GDataEntry and increments its reference count.
Duplicate links will not be added to the list.
|
a GDataEntry |
|
a GDataLink to add |
GDataLink * gdata_entry_look_up_link (GDataEntry *self, const gchar *rel);
Looks up a link by relation type from the list of links in the entry. If the link has one of the standard Atom relation types,
use one of the defined rel
values, instead of a static string. e.g. GDATA_LINK_EDIT
or GDATA_LINK_SELF
.
In the rare event of requiring a list of links with the same rel
value, use gdata_entry_look_up_links()
.
|
a GDataEntry |
|
the value of the rel attribute of the desired link
|
Returns : |
a GDataLink, or NULL if one was not found
|
Since 0.1.1
GList * gdata_entry_look_up_links (GDataEntry *self, const gchar *rel);
Looks up a list of links by relation type from the list of links in the entry. If the links have one of the standard Atom
relation types, use one of the defined rel
values, instead of a static string. e.g. GDATA_LINK_EDIT
or GDATA_LINK_SELF
.
If you will only use the first link found, consider calling gdata_entry_look_up_link()
instead.
|
a GDataEntry |
|
the value of the rel attribute of the desired links
|
Returns : |
a GList of GDataLinks, or NULL if none were found; free the list with g_list_free()
|
Since 0.4.0
gboolean gdata_entry_is_inserted (GDataEntry *self);
Returns whether the entry is marked as having been inserted on (uploaded to) the server already.
|
a GDataEntry |
Returns : |
TRUE if the entry has been inserted already, FALSE otherwise
|
const gchar * gdata_entry_get_rights (GDataEntry *self);
Returns the rights pertaining to the entry, or NULL
if not set.
|
a GDataEntry |
Returns : |
the entry's rights information |
Since 0.5.0
"content"
property"content" gchar* : Read / Write
The textual content of this entry.
Default value: NULL
"etag"
property"etag" gchar* : Read / Write / Construct Only
The ETag for this entry.
Default value: NULL
"id"
property"id" gchar* : Read / Write / Construct Only
The ID for this entry.
Default value: NULL
"is-inserted"
property"is-inserted" gboolean : Read
Whether the entry has been inserted on the server.
Default value: FALSE
"rights"
property"rights" gchar* : Read / Write
The ownership rights pertaining to this entry.
For more information, see the Atom specification.
Default value: NULL
Since 0.5.0
"summary"
property"summary" gchar* : Read / Write
A short summary, abstract, or excerpt of the entry.
For more information, see the Atom specification.
Default value: NULL
Since 0.4.0