![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/gdata-entry.h> GDataEntry; GDataEntryClass; GDataEntry * (*GDataEntryParserFunc) (xmlDoc *doc, xmlNode *node, GError **error); GDataEntry * gdata_entry_new (void); GDataEntry * gdata_entry_new_from_xml (const gchar *xml, gint length, GError **error); const gchar * gdata_entry_get_title (GDataEntry *self); void gdata_entry_set_title (GDataEntry *self, const gchar *title); const gchar * gdata_entry_get_id (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); void gdata_entry_add_link (GDataEntry *self, GDataLink *link); GDataLink * gdata_entry_lookup_link (GDataEntry *self, const gchar *rel); gboolean gdata_entry_is_inserted (GDataEntry *self); gchar * gdata_entry_get_xml (GDataEntry *self);
"content" gchar* : Read / Write "id" gchar* : Read "is-inserted" gboolean : Read "published" GTimeVal* : Read "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 { GObjectClass parent; void (*get_xml) (GDataEntry *self, GString *xml_string); const gchar *(*get_namespaces) (GDataEntry *self); } GDataEntryClass;
The class structure for the GDataEntry type.
the parent class | |
a function to build an XML representation of the GDataEntry in its current state, appending it to the provided GString | |
a function to return a string containing the namespace declarations used by the entry when represented in XML form |
GDataEntry * (*GDataEntryParserFunc) (xmlDoc *doc, xmlNode *node, GError **error);
Callback function for operations which parse feeds, which should produce a new GDataEntry from the provided entry XML.
It can return any error, but GDataParserError errors are most likely and most expected.
|
the XML document |
|
the XML node for an element; the <entry> element
|
|
a GError, or NULL
|
Returns : |
a new GDataEntry, or NULL
|
GDataEntry * gdata_entry_new (void);
Creates a new GDataEntry with default properties.
Returns : |
a new GDataEntry |
GDataEntry * gdata_entry_new_from_xml (const gchar *xml, gint length, GError **error);
Creates a new GDataEntry from the provided xml
.
If length
is -1, xml
will be assumed to be nul-terminated.
If an error occurs during parsing, a suitable error from GDataParserError will be returned.
|
the XML for just the entry, with full namespace declarations |
|
the length of xml , or -1
|
|
a GError, or NULL
|
Returns : |
a new GDataEntry, or NULL
|
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 |
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_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.
|
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.
|
a GDataEntry |
|
a GDataCategory to add |
void gdata_entry_add_link (GDataEntry *self, GDataLink *link);
Adds link
to the list of links in the given GDataEntry.
|
a GDataEntry |
|
a GDataLink to add |
GDataLink * gdata_entry_lookup_link (GDataEntry *self, const gchar *rel);
Looks up a link by rel
value from the list of links in the entry.
|
a GDataEntry |
|
the value of the rel attribute of the desired link
|
Returns : |
a GDataLink, or NULL if one was not found
|
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
|
gchar * gdata_entry_get_xml (GDataEntry *self);
Builds an XML representation of the GDataEntry in its current state, such that it could be inserted on the server.
The XML is guaranteed to have all its namespaces declared properly in a self-contained fashion. The root element is
guaranteed to be <entry>
.
|
a GDataEntry |
Returns : |
the entry's XML; free with g_free()
|