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_id        (GDataPicasaWebAlbum *self);
    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_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);
    GList *             gdata_picasaweb_album_get_contents  (GDataPicasaWebAlbum *self);
    GList *             gdata_picasaweb_album_get_thumbnails
                                                            (GDataPicasaWebAlbum *self);
    void                gdata_picasaweb_album_get_coordinates
                                                            (GDataPicasaWebAlbum *self,
                                                             gdouble *latitude,
                                                             gdouble *longitude);
    void                gdata_picasaweb_album_set_coordinates
                                                            (GDataPicasaWebAlbum *self,
                                                             gdouble latitude,
                                                             gdouble longitude);

## Object Hierarchy

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

## Properties

      "album-id"                 gchar*                : Read / Write / Construct Only
      "bytes-used"               glong                 : Read
      "comment-count"            guint                 : Read
      "edited"                   GDataTimeVal*         : Read
      "is-commenting-enabled"    gboolean              : Read / Write
      "latitude"                 gdouble               : Read / Write
      "location"                 gchar*                : Read / Write
      "longitude"                gdouble               : Read / Write
      "nickname"                 gchar*                : Read
      "num-photos"               guint                 : Read
      "num-photos-remaining"     guint                 : Read
      "tags"                     gchar*                : Read / Write
      "timestamp"                GDataTimeVal*         : 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` is the ID which would be returned by `gdata_entry_get_id()`, not `gdata_picasaweb_album_get_id()`.

If `id` is not `NULL` and can't be parsed to extract an album ID, `NULL` will be returned.

`id` : | the album's entry ID, or `NULL`. [allow-none]
Returns : | a new GDataPicasaWebAlbum, or `NULL`; unref with `g_object_unref()`

Since 0.4.0

### gdata_picasaweb_album_get_id ()

    const gchar *       gdata_picasaweb_album_get_id        (GDataPicasaWebAlbum *self);

Gets the "album-id" property.

`self` : | a GDataPicasaWebAlbum
Returns : | the album's ID

Since 0.6.4

### 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. [out caller-allocates]

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, or `NULL`. [allow-none]

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. [out caller-allocates]

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`. [allow-none]

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`. [allow-none]

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. [element-type GData.MediaContent][transfer none]

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`. [element-type GData.MediaThumbnail][transfer none]

Since 0.4.0

### gdata_picasaweb_album_get_coordinates ()

    void                gdata_picasaweb_album_get_coordinates
                                                            (GDataPicasaWebAlbum *self,
                                                             gdouble *latitude,
                                                             gdouble *longitude);

Gets the "latitude" and "longitude" properties, setting the out parameters to them. If either latitude or longitude is `NULL`, that parameter will not be set. If the coordinates are unset, `latitude` and `longitude` will be set to `G_MAXDOUBLE`.

`self` : | a GDataPicasaWebAlbum
`latitude` : | return location for the latitude, or `NULL`. [out caller-allocates][allow-none]
`longitude` : | return location for the longitude, or `NULL`. [out caller-allocates][allow-none]

Since 0.5.0

### gdata_picasaweb_album_set_coordinates ()

    void                gdata_picasaweb_album_set_coordinates
                                                            (GDataPicasaWebAlbum *self,
                                                             gdouble latitude,
                                                             gdouble longitude);

Sets the "latitude" and "longitude" properties to `latitude` and `longitude` respectively.

`self` : | a GDataPicasaWebAlbum
`latitude` : | the album's new latitude coordinate, or `G_MAXDOUBLE`
`longitude` : | the album's new longitude coordinate, or `G_MAXDOUBLE`

Since 0.5.0

## Property Details

### The `"album-id"` property

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

The ID of the album. This is a substring of the ID returned by `gdata_entry_get_id()` for GDataPicasaWebAlbums; for example, if `gdata_entry_get_id()` returned "http://picasaweb.google.com/data/entry/user/libgdata.picasaweb/albumid/5328889949261497249" for a particular GDataPicasaWebAlbum, the "album-id" property would be "5328889949261497249".

For more information, see the gphoto specification.

Default value: NULL

Since 0.6.4

### 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 `"edited"` property

      "edited"                   GDataTimeVal*         : Read

The time this album was last edited. If the album has not been edited yet, the content indicates the time it was created.

For more information, see the Atom Publishing Protocol specification.

Since 0.4.0

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

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

Whether commenting is enabled for this album.

Default value: FALSE

### The `"latitude"` property

      "latitude"                 gdouble               : Read / Write

The location as a latitude coordinate associated with this album. Valid latitudes range from `-90.0` to `90.0` inclusive.

For more information, see the GeoRSS specification.

Allowed values: [-90,90]

Default value: 0

Since 0.5.0

### The `"location"` property

      "location"                 gchar*                : Read / Write

The user-specified location associated with the album. A place name.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"longitude"` property

      "longitude"                gdouble               : Read / Write

The location as a longitude coordinate associated with this album. Valid longitudes range from `-180.0` to `180.0` inclusive.

For more information, see the GeoRSS specification.

Allowed values: [-180,180]

Default value: 0

Since 0.5.0

### The `"nickname"` property

      "nickname"                 gchar*                : Read

The user's nickname. This is a user-specified value that should be used when referring to the user by name.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### 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"                GDataTimeVal*         : Read / Write

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

For more information, see the gphoto specification.

Since 0.4.0

### The `"user"` property

      "user"                     gchar*                : Read

The username of the album owner.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"visibility"` property

      "visibility"               GDataPicasaWebVisibility  : Read / Write

The visibility (or access rights) of the album.

For more information, see the gphoto specification.

Default value: GDATA_PICASAWEB_PUBLIC

Since 0.4.0