GDataAuthor

GDataAuthor — Atom author element

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/atom/gdata-author.h>

                    GDataAuthor;
                    GDataAuthorClass;
GDataAuthor *       gdata_author_new                    (const gchar *name,
                                                         const gchar *uri,
                                                         const gchar *email_address);
gint                gdata_author_compare                (const GDataAuthor *a,
                                                         const GDataAuthor *b);
const gchar *       gdata_author_get_name               (GDataAuthor *self);
void                gdata_author_set_name               (GDataAuthor *self,
                                                         const gchar *name);
const gchar *       gdata_author_get_uri                (GDataAuthor *self);
void                gdata_author_set_uri                (GDataAuthor *self,
                                                         const gchar *uri);
const gchar *       gdata_author_get_email_address      (GDataAuthor *self);
void                gdata_author_set_email_address      (GDataAuthor *self,
                                                         const gchar *email_address);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataAuthor

Properties

  "email-address"            gchar*                : Read / Write
  "name"                     gchar*                : Read / Write
  "uri"                      gchar*                : Read / Write

Description

GDataAuthor represents a "author" element from the Atom specification.

Details

GDataAuthor

typedef struct _GDataAuthor GDataAuthor;

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


GDataAuthorClass

typedef struct {
} GDataAuthorClass;

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

Since 0.4.0


gdata_author_new ()

GDataAuthor *       gdata_author_new                    (const gchar *name,
                                                         const gchar *uri,
                                                         const gchar *email_address);

Creates a new GDataAuthor. More information is available in the Atom specification.

name :

the author's name

uri :

an IRI describing the author, or NULL. [allow-none]

email_address :

the author's e-mail address, or NULL. [allow-none]

Returns :

a new GDataAuthor, or NULL; unref with g_object_unref()

gdata_author_compare ()

gint                gdata_author_compare                (const GDataAuthor *a,
                                                         const GDataAuthor *b);

Compares the two authors in a strcmp() fashion. NULL values are handled gracefully, with 0 returned if both a and b are NULL, -1 if a is NULL and 1 if b is NULL.

The comparison of non-NULL values is done on the basis of the name property of the GDataAuthors.

a :

a GDataAuthor, or NULL

b :

another GDataAuthor, or NULL

Returns :

0 if a equals b, -1 or 1 as appropriate otherwise

Since 0.4.0


gdata_author_get_name ()

const gchar *       gdata_author_get_name               (GDataAuthor *self);

Gets the "name" property.

self :

a GDataAuthor

Returns :

the author's name

Since 0.4.0


gdata_author_set_name ()

void                gdata_author_set_name               (GDataAuthor *self,
                                                         const gchar *name);

Sets the "name" property to name.

self :

a GDataAuthor

name :

the new name for the author

Since 0.4.0


gdata_author_get_uri ()

const gchar *       gdata_author_get_uri                (GDataAuthor *self);

Gets the "uri" property.

self :

a GDataAuthor

Returns :

the author's URI, or NULL

Since 0.4.0


gdata_author_set_uri ()

void                gdata_author_set_uri                (GDataAuthor *self,
                                                         const gchar *uri);

Sets the "uri" property to uri.

Set uri to NULL to unset the property in the author.

self :

a GDataAuthor

uri :

the new URI for the author, or NULL. [allow-none]

Since 0.4.0


gdata_author_get_email_address ()

const gchar *       gdata_author_get_email_address      (GDataAuthor *self);

Gets the "email-address" property.

self :

a GDataAuthor

Returns :

the author's e-mail address, or NULL

Since 0.4.0


gdata_author_set_email_address ()

void                gdata_author_set_email_address      (GDataAuthor *self,
                                                         const gchar *email_address);

Sets the "email-address" property to email_address.

Set email_address to NULL to unset the property in the author.

self :

a GDataAuthor

email_address :

the new e-mail address for the author, or NULL. [allow-none]

Since 0.4.0

Property Details

The "email-address" property

  "email-address"            gchar*                : Read / Write

An e-mail address associated with the person.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0


The "name" property

  "name"                     gchar*                : Read / Write

A human-readable name for the person.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0


The "uri" property

  "uri"                      gchar*                : Read / Write

An IRI associated with the person.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0