GDataPicasaWebAlbum

## GDataPicasaWebAlbum GDataPicasaWebAlbum — GData PicasaWeb album object |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

    #include <gdata/services/picasaweb/gdata-picasaweb-album.h>

                        GDataPicasaWebAlbum;
                        GDataPicasaWebAlbumClass;
    enum                GDataPicasaWebVisibility;
    GDataPicasaWebAlbum * gdata_picasaweb_album_new         (const gchar *id);
    const gchar *       gdata_picasaweb_album_get_user      (GDataPicasaWebAlbum *self);
    const gchar *       gdata_picasaweb_album_get_nickname  (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_get_edited    (GDataPicasaWebAlbum *self,
                                                             GTimeVal *edited);
    const gchar *       gdata_picasaweb_album_get_name      (GDataPicasaWebAlbum *self);
    const gchar *       gdata_picasaweb_album_get_location  (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_set_location  (GDataPicasaWebAlbum *self,
                                                             const gchar *location);
    GDataPicasaWebVisibility  gdata_picasaweb_album_get_visibility
                                                            (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_set_visibility
                                                            (GDataPicasaWebAlbum *self,
                                                             GDataPicasaWebVisibility visibility);
    void                gdata_picasaweb_album_get_timestamp (GDataPicasaWebAlbum *self,
                                                             GTimeVal *timestamp);
    void                gdata_picasaweb_album_set_timestamp (GDataPicasaWebAlbum *self,
                                                             GTimeVal *timestamp);
    guint               gdata_picasaweb_album_get_num_photos
                                                            (GDataPicasaWebAlbum *self);
    guint               gdata_picasaweb_album_get_num_photos_remaining
                                                            (GDataPicasaWebAlbum *self);
    glong               gdata_picasaweb_album_get_bytes_used
                                                            (GDataPicasaWebAlbum *self);
    gboolean            gdata_picasaweb_album_is_commenting_enabled
                                                            (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_set_is_commenting_enabled
                                                            (GDataPicasaWebAlbum *self,
                                                             gboolean is_commenting_enabled);
    guint               gdata_picasaweb_album_get_comment_count
                                                            (GDataPicasaWebAlbum *self);
    const gchar *       gdata_picasaweb_album_get_tags      (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_set_tags      (GDataPicasaWebAlbum *self,
                                                             const gchar *tags);
    const gchar *       gdata_picasaweb_album_get_description
                                                            (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_set_description
                                                            (GDataPicasaWebAlbum *self,
                                                             const gchar *description);
    GList *             gdata_picasaweb_album_get_contents  (GDataPicasaWebAlbum *self);
    GList *             gdata_picasaweb_album_get_thumbnails
                                                            (GDataPicasaWebAlbum *self);

## Object Hierarchy

      GObject
       +----GDataParsable
             +----GDataEntry
                   +----GDataPicasaWebAlbum

## Properties

      "bytes-used"               glong                 : Read
      "comment-count"            guint                 : Read
      "description"              gchar*                : Read / Write
      "edited"                   GTimeVal*             : Read
      "is-commenting-enabled"    gboolean              : Read / Write
      "location"                 gchar*                : Read / Write
      "name"                     gchar*                : Read
      "nickname"                 gchar*                : Read
      "num-photos"               guint                 : Read
      "num-photos-remaining"     guint                 : Read
      "tags"                     gchar*                : Read / Write
      "timestamp"                GTimeVal*             : Read / Write
      "user"                     gchar*                : Read
      "visibility"               GDataPicasaWebVisibility  : Read / Write

## Description

GDataPicasaWebAlbum is a subclass of GDataEntry to represent an album from Google PicasaWeb.

For more details of Google PicasaWeb's GData API, see the online documentation.

## Details

### GDataPicasaWebAlbum

    typedef struct _GDataPicasaWebAlbum GDataPicasaWebAlbum;

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

Since 0.4.0

### GDataPicasaWebAlbumClass

    typedef struct {
    } GDataPicasaWebAlbumClass;

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

Since 0.4.0

### enum GDataPicasaWebVisibility

    typedef enum {
    	GDATA_PICASAWEB_PUBLIC = 1,
    	GDATA_PICASAWEB_PRIVATE
    } GDataPicasaWebVisibility;

Visibility statuses available for albums on PicasaWeb. For more information, see the online documentation.

`GDATA_PICASAWEB_PUBLIC` | the album is visible to everyone, regardless of whether they're authenticated
`GDATA_PICASAWEB_PRIVATE` | the album is visible only to authenticated users in a whitelist

Since 0.4.0

### gdata_picasaweb_album_new ()

    GDataPicasaWebAlbum * gdata_picasaweb_album_new         (const gchar *id);

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

`id` : | the album's ID, or `NULL`
Returns : | a new GDataPicasaWebAlbum; unref with `g_object_unref()`

Since 0.4.0

### gdata_picasaweb_album_get_user ()

    const gchar *       gdata_picasaweb_album_get_user      (GDataPicasaWebAlbum *self);

Gets the "user" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album owner's username

Since 0.4.0

### gdata_picasaweb_album_get_nickname ()

    const gchar *       gdata_picasaweb_album_get_nickname  (GDataPicasaWebAlbum *self);

Gets the "nickname" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album owner's nickname

Since 0.4.0

### gdata_picasaweb_album_get_edited ()

    void                gdata_picasaweb_album_get_edited    (GDataPicasaWebAlbum *self,
                                                             GTimeVal *edited);

Gets the "edited" property and puts it in `edited`. If the property is unset, both fields in the GTimeVal will be set to `0`.

`self` : | a GDataPicasaWebAlbum
`edited` : | a GTimeVal

Since 0.4.0

### gdata_picasaweb_album_get_name ()

    const gchar *       gdata_picasaweb_album_get_name      (GDataPicasaWebAlbum *self);

Gets the "name" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album's name, as usable in URIs, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_get_location ()

    const gchar *       gdata_picasaweb_album_get_location  (GDataPicasaWebAlbum *self);

Gets the "location" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album's location, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_set_location ()

    void                gdata_picasaweb_album_set_location  (GDataPicasaWebAlbum *self,
                                                             const gchar *location);

Sets the "location" property to `location`.

Set `location` to `NULL` to unset the property.

`self` : | a GDataPicasaWebAlbum
`location` : | the new album location

Since 0.4.0

### gdata_picasaweb_album_get_visibility ()

    GDataPicasaWebVisibility  gdata_picasaweb_album_get_visibility
                                                            (GDataPicasaWebAlbum *self);

Gets the "visibility" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album's visibility level

Since 0.4.0

### gdata_picasaweb_album_set_visibility ()

    void                gdata_picasaweb_album_set_visibility
                                                            (GDataPicasaWebAlbum *self,
                                                             GDataPicasaWebVisibility visibility);

Sets the "visibility" property to `visibility`.

`self` : | a GDataPicasaWebAlbum
`visibility` : | the new album visibility level

Since 0.4.0

### gdata_picasaweb_album_get_timestamp ()

    void                gdata_picasaweb_album_get_timestamp (GDataPicasaWebAlbum *self,
                                                             GTimeVal *timestamp);

Gets the "timestamp" property and puts it in `timestamp`. If the property is unset, both fields in the GTimeVal will be set to `0`.

`self` : | a GDataPicasaWebAlbum
`timestamp` : | a GTimeVal

Since 0.4.0

### gdata_picasaweb_album_set_timestamp ()

    void                gdata_picasaweb_album_set_timestamp (GDataPicasaWebAlbum *self,
                                                             GTimeVal *timestamp);

Sets the "timestamp" property from values supplied by `timestamp`.

Set `timestamp` to `NULL` to unset the property.

`self` : | a GDataPicasaWebAlbum
`timestamp` : | a GTimeVal, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_get_num_photos ()

    guint               gdata_picasaweb_album_get_num_photos
                                                            (GDataPicasaWebAlbum *self);

Gets the "num-photos" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the number of photos currently in the album

Since 0.4.0

### gdata_picasaweb_album_get_num_photos_remaining ()

    guint               gdata_picasaweb_album_get_num_photos_remaining
                                                            (GDataPicasaWebAlbum *self);

Gets the "num-photos-remaining" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the number of photos that can still be uploaded to the album

Since 0.4.0

### gdata_picasaweb_album_get_bytes_used ()

    glong               gdata_picasaweb_album_get_bytes_used
                                                            (GDataPicasaWebAlbum *self);

Gets the "bytes-used" property. It will return `-1` if the current authenticated user is not the owner of the album.

`self` : | a GDataPicasaWebAlbum
Returns : | the number of bytes used by the album and its contents, or `-1`

Since 0.4.0

### gdata_picasaweb_album_is_commenting_enabled ()

    gboolean            gdata_picasaweb_album_is_commenting_enabled
                                                            (GDataPicasaWebAlbum *self);

Gets the "is-commenting-enabled" property.

`self` : | a GDataPicasaWebAlbum
Returns : | `TRUE` if commenting is enabled for the album, `FALSE` otherwise

Since 0.4.0

### gdata_picasaweb_album_set_is_commenting_enabled ()

    void                gdata_picasaweb_album_set_is_commenting_enabled
                                                            (GDataPicasaWebAlbum *self,
                                                             gboolean is_commenting_enabled);

Sets the "is-commenting-enabled" property to `is_commenting_enabled`.

`self` : | a GDataPicasaWebAlbum
`is_commenting_enabled` : | `TRUE` if commenting should be enabled for the album, `FALSE` otherwise

Since 0.4.0

### gdata_picasaweb_album_get_comment_count ()

    guint               gdata_picasaweb_album_get_comment_count
                                                            (GDataPicasaWebAlbum *self);

Gets the "comment-count" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the number of comments on the album

Since 0.4.0

### gdata_picasaweb_album_get_tags ()

    const gchar *       gdata_picasaweb_album_get_tags      (GDataPicasaWebAlbum *self);

Gets the "tags" property.

`self` : | a GDataPicasaWebAlbum
Returns : | a comma-separated list of tags associated with all the photos in the album, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_set_tags ()

    void                gdata_picasaweb_album_set_tags      (GDataPicasaWebAlbum *self,
                                                             const gchar *tags);

Sets the "tags" property to `tags`.

Set `tags` to `NULL` to unset the album's tag list.

`self` : | a GDataPicasaWebAlbum
`tags` : | the new comma-separated list of tags, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_get_description ()

    const gchar *       gdata_picasaweb_album_get_description
                                                            (GDataPicasaWebAlbum *self);

Gets the "description" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album's long text description, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_set_description ()

    void                gdata_picasaweb_album_set_description
                                                            (GDataPicasaWebAlbum *self,
                                                             const gchar *description);

Sets the "description" property to the new description, `description`.

Set `description` to `NULL` to unset the album's description.

`self` : | a GDataPicasaWebAlbum
`description` : | the album's new description, or `NULL`

Since 0.4.0

### gdata_picasaweb_album_get_contents ()

    GList *             gdata_picasaweb_album_get_contents  (GDataPicasaWebAlbum *self);

Returns a list of media content, such as the cover image for the album.

`self` : | a GDataPicasaWebAlbum
Returns : | a GList of GDataMediaContent items

Since 0.4.0

### gdata_picasaweb_album_get_thumbnails ()

    GList *             gdata_picasaweb_album_get_thumbnails
                                                            (GDataPicasaWebAlbum *self);

Returns a list of thumbnails, often at different sizes, for this album.

`self` : | a GDataPicasaWebAlbum
Returns : | a GList of GDataMediaThumbnails, or `NULL`

Since 0.4.0

## Property Details

### The `"bytes-used"` property

      "bytes-used"               glong                 : Read

The number of bytes consumed by this album and its contents. Note that this is only set if the authenticated user is the owner of the album; it's otherwise `-1`.

For more information, see the gphoto specification.

Allowed values: >= -1

Default value: -1

Since 0.4.0

### The `"comment-count"` property

      "comment-count"            guint                 : Read

The number of comments on the album.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0

### The `"description"` property

      "description"              gchar*                : Read / Write

Description of the album.

For more information, see the Media RSS specification.

Default value: NULL

Since 0.4.0

### The `"edited"` property

      "edited"                   GTimeVal*             : Read

The time this album was last edited.

### The `"is-commenting-enabled"` property

      "is-commenting-enabled"    gboolean              : Read / Write

Whether commenting is enabled for this album.

Default value: FALSE

### The `"location"` property

      "location"                 gchar*                : Read / Write

The user-specified location associated with the album.

Default value: NULL

### The `"name"` property

      "name"                     gchar*                : Read

The name of the album.

Default value: NULL

### The `"nickname"` property

      "nickname"                 gchar*                : Read

The user's nickname.

Default value: NULL

### The `"num-photos"` property

      "num-photos"               guint                 : Read

The number of photos and videos in the album.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0

### The `"num-photos-remaining"` property

      "num-photos-remaining"     guint                 : Read

The number of photos and videos that can still be uploaded to this album. This doesn't account for quota, just a hardcoded maximum number per album set by Google.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0

### The `"tags"` property

      "tags"                     gchar*                : Read / Write

A comma-separated list of tags associated with the album; all the tags associated with the individual photos in the album.

For more information, see the Media RSS specification.

Default value: NULL

Since 0.4.0

### The `"timestamp"` property

      "timestamp"                GTimeVal*             : Read / Write

The timestamp of when the album occurred, settable by the user.

### The `"user"` property

      "user"                     gchar*                : Read

The username of the album owner.

Default value: NULL

### The `"visibility"` property

      "visibility"               GDataPicasaWebVisibility  : Read / Write

The visibility (or access rights) of the album.

Default value: GDATA_PICASAWEB_PUBLIC