GDataEntry

GDataEntry — GData entry object

Stability Level

Unstable, unless otherwise indicated

Synopsis

#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);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataEntry
               +----GDataAccessRule
               +----GDataCalendarCalendar
               +----GDataCalendarEvent
               +----GDataContactsContact
               +----GDataDocumentsEntry
               +----GDataPicasaWebAlbum
               +----GDataPicasaWebFile
               +----GDataPicasaWebUser
               +----GDataYouTubeVideo

Known Derived Interfaces

GDataEntry is required by GDataAccessHandler.

Properties

  "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

Description

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.

Details

GDataEntry

typedef struct _GDataEntry GDataEntry;

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


GDataEntryClass

typedef struct {
} GDataEntryClass;

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


gdata_entry_new ()

GDataEntry *        gdata_entry_new                     (const gchar *id);

Creates a new GDataEntry with the given ID and default properties.

id :

the entry's ID, or NULL

Returns :

a new GDataEntry; unref with g_object_unref()

gdata_entry_get_title ()

const gchar *       gdata_entry_get_title               (GDataEntry *self);

Returns the title of the entry.

self :

a GDataEntry

Returns :

the entry's title

gdata_entry_set_title ()

void                gdata_entry_set_title               (GDataEntry *self,
                                                         const gchar *title);

Sets the title of the entry.

self :

a GDataEntry

title :

the new entry title, or NULL

gdata_entry_get_summary ()

const gchar *       gdata_entry_get_summary             (GDataEntry *self);

Returns the summary of the entry.

self :

a GDataEntry

Returns :

the entry's summary, or NULL

Since 0.4.0


gdata_entry_set_summary ()

void                gdata_entry_set_summary             (GDataEntry *self,
                                                         const gchar *summary);

Sets the summary of the entry.

self :

a GDataEntry

summary :

the new entry summary, or NULL

Since 0.4.0


gdata_entry_get_id ()

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.

self :

a GDataEntry

Returns :

the entry's ID

gdata_entry_get_etag ()

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.

self :

a GDataEntry

Returns :

the entry's ETag

Since 0.2.0


gdata_entry_get_content ()

const gchar *       gdata_entry_get_content             (GDataEntry *self);

Returns the textual content in this entry.

self :

a GDataEntry

Returns :

the entry's content, or NULL

gdata_entry_set_content ()

void                gdata_entry_set_content             (GDataEntry *self,
                                                         const gchar *content);

Sets the entry's content to content.

self :

a GDataEntry

content :

the new content for the entry

gdata_entry_get_published ()

void                gdata_entry_get_published           (GDataEntry *self,
                                                         GTimeVal *published);

Puts the time the entry was originally published into published.

self :

a GDataEntry

published :

a GTimeVal

gdata_entry_get_updated ()

void                gdata_entry_get_updated             (GDataEntry *self,
                                                         GTimeVal *updated);

Puts the time the entry was last updated into updated.

self :

a GDataEntry

updated :

a GTimeVal

gdata_entry_add_author ()

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.

self :

a GDataEntry

author :

a GDataAuthor to add

gdata_entry_add_category ()

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.

self :

a GDataEntry

category :

a GDataCategory to add

gdata_entry_get_categories ()

GList *             gdata_entry_get_categories          (GDataEntry *self);

Gets a list of the GDataCategorys containing this entry.

self :

a GDataEntry

Returns :

a GList of GDataCategorys

Since 0.2.0


gdata_entry_add_link ()

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.

self :

a GDataEntry

link :

a GDataLink to add

gdata_entry_look_up_link ()

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().

self :

a GDataEntry

rel :

the value of the rel attribute of the desired link

Returns :

a GDataLink, or NULL if one was not found

Since 0.1.1


gdata_entry_look_up_links ()

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.

self :

a GDataEntry

rel :

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


gdata_entry_is_inserted ()

gboolean            gdata_entry_is_inserted             (GDataEntry *self);

Returns whether the entry is marked as having been inserted on (uploaded to) the server already.

self :

a GDataEntry

Returns :

TRUE if the entry has been inserted already, FALSE otherwise

gdata_entry_get_rights ()

const gchar *       gdata_entry_get_rights              (GDataEntry *self);

Returns the rights pertaining to the entry, or NULL if not set.

self :

a GDataEntry

Returns :

the entry's rights information

Since 0.5.0


gdata_entry_set_rights ()

void                gdata_entry_set_rights              (GDataEntry *self,
                                                         const gchar *rights);

Sets the rights for this entry.

self :

a GDataEntry

rights :

the new rights, or NULL

Since 0.5.0

Property Details

The "content" property

  "content"                  gchar*                : Read / Write

The content of the entry.

For more information, see the Atom specification.

Default value: NULL


The "etag" property

  "etag"                     gchar*                : Read / Write / Construct Only

An identifier for a particular version of the entry. This changes every time the entry on the server changes, and can be used for conditional retrieval and locking.

For more information, see the GData specification.

Default value: NULL

Since 0.2.0


The "id" property

  "id"                       gchar*                : Read / Write / Construct Only

A permanent, universally unique identifier for the entry, in IRI form.

For more information, see the Atom specification.

Default value: NULL


The "is-inserted" property

  "is-inserted"              gboolean              : Read

Whether the entry has been inserted on the server. This is FALSE for entries which have just been created using gdata_entry_new() and TRUE for entries returned from the server by queries. It is set to TRUE when an entry is inserted using gdata_service_insert_entry().

Default value: FALSE


The "published" property

  "published"                GTimeVal*             : Read

The date and time the entry was first published or made available.

For more information, see the Atom specification.


The "rights" property

  "rights"                   gchar*                : Read / Write

The ownership rights pertaining to the entry.

For more information, see the Atom specification.

Default value: NULL

Since 0.5.0


The "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


The "title" property

  "title"                    gchar*                : Read / Write

A human-readable title for the entry.

For more information, see the Atom specification.

Default value: NULL


The "updated" property

  "updated"                  GTimeVal*             : Read

The date and time the entry was most recently updated in a significant way.

For more information, see the Atom specification.