GDataPicasaWebFile

## GDataPicasaWebFile GDataPicasaWebFile — GData PicasaWeb file object |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

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

                        GDataPicasaWebFile;
                        GDataPicasaWebFileClass;
    GDataPicasaWebFile * gdata_picasaweb_file_new           (const gchar *id);
    void                gdata_picasaweb_file_get_edited     (GDataPicasaWebFile *self,
                                                             GTimeVal *edited);
    const gchar *       gdata_picasaweb_file_get_version    (GDataPicasaWebFile *self);
    gdouble             gdata_picasaweb_file_get_position   (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_position   (GDataPicasaWebFile *self,
                                                             gdouble position);
    const gchar *       gdata_picasaweb_file_get_album_id   (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_album_id   (GDataPicasaWebFile *self,
                                                             const gchar *album_id);
    guint               gdata_picasaweb_file_get_width      (GDataPicasaWebFile *self);
    guint               gdata_picasaweb_file_get_height     (GDataPicasaWebFile *self);
    gsize               gdata_picasaweb_file_get_size       (GDataPicasaWebFile *self);
    const gchar *       gdata_picasaweb_file_get_client     (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_client     (GDataPicasaWebFile *self,
                                                             const gchar *client);
    const gchar *       gdata_picasaweb_file_get_checksum   (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_checksum   (GDataPicasaWebFile *self,
                                                             const gchar *checksum);
    void                gdata_picasaweb_file_get_timestamp  (GDataPicasaWebFile *self,
                                                             GTimeVal *timestamp);
    void                gdata_picasaweb_file_set_timestamp  (GDataPicasaWebFile *self,
                                                             GTimeVal *timestamp);
    gboolean            gdata_picasaweb_file_is_commenting_enabled
                                                            (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_is_commenting_enabled
                                                            (GDataPicasaWebFile *self,
                                                             gboolean is_commenting_enabled);
    guint               gdata_picasaweb_file_get_comment_count
                                                            (GDataPicasaWebFile *self);
    guint               gdata_picasaweb_file_get_rotation   (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_rotation   (GDataPicasaWebFile *self,
                                                             guint rotation);
    const gchar *       gdata_picasaweb_file_get_video_status
                                                            (GDataPicasaWebFile *self);
    const gchar *       gdata_picasaweb_file_get_tags       (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_tags       (GDataPicasaWebFile *self,
                                                             const gchar *tags);
    const gchar *       gdata_picasaweb_file_get_credit     (GDataPicasaWebFile *self);
    const gchar *       gdata_picasaweb_file_get_caption    (GDataPicasaWebFile *self);
    void                gdata_picasaweb_file_set_caption    (GDataPicasaWebFile *self,
                                                             const gchar *caption);
    GList *             gdata_picasaweb_file_get_contents   (GDataPicasaWebFile *self);
    GList *             gdata_picasaweb_file_get_thumbnails (GDataPicasaWebFile *self);

## Object Hierarchy

      GObject
       +----GDataParsable
             +----GDataEntry
                   +----GDataPicasaWebFile

## Properties

      "album-id"                 gchar*                : Read / Write
      "caption"                  gchar*                : Read / Write
      "checksum"                 gchar*                : Read / Write
      "client"                   gchar*                : Read / Write
      "comment-count"            guint                 : Read
      "credit"                   gchar*                : Read
      "edited"                   GTimeVal*             : Read
      "height"                   guint                 : Read
      "is-commenting-enabled"    gboolean              : Read / Write
      "position"                 gdouble               : Read / Write
      "rotation"                 guint                 : Read / Write
      "size"                     gulong                : Read
      "tags"                     gchar*                : Read / Write
      "timestamp"                GTimeVal*             : Read / Write
      "version"                  gchar*                : Read / Write / Construct Only
      "video-status"             gchar*                : Read
      "width"                    guint                 : Read

## Description

GDataPicasaWebFile is a subclass of GDataEntry to represent a file in an album on Google PicasaWeb.

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

## Details

### GDataPicasaWebFile

    typedef struct _GDataPicasaWebFile GDataPicasaWebFile;

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

Since 0.4.0

### GDataPicasaWebFileClass

    typedef struct {
    } GDataPicasaWebFileClass;

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

Since 0.4.0

### gdata_picasaweb_file_new ()

    GDataPicasaWebFile * gdata_picasaweb_file_new           (const gchar *id);

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

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

Since 0.4.0

### gdata_picasaweb_file_get_edited ()

    void                gdata_picasaweb_file_get_edited     (GDataPicasaWebFile *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 GDataPicasaWebFile
`edited` : | a GTimeVal

Since 0.4.0

### gdata_picasaweb_file_get_version ()

    const gchar *       gdata_picasaweb_file_get_version    (GDataPicasaWebFile *self);

Gets the "version" property.

`self` : | a GDataPicasaWebFile
Returns : | the file's version number, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_get_position ()

    gdouble             gdata_picasaweb_file_get_position   (GDataPicasaWebFile *self);

Gets the "position" property.

`self` : | a GDataPicasaWebFile
Returns : | the file's ordinal position in the album

Since 0.4.0

### gdata_picasaweb_file_set_position ()

    void                gdata_picasaweb_file_set_position   (GDataPicasaWebFile *self,
                                                             gdouble position);

Sets the "position" property.

`self` : | a GDataPicasaWebFile
`position` : | the file's new position in the album

Since 0.4.0

### gdata_picasaweb_file_get_album_id ()

    const gchar *       gdata_picasaweb_file_get_album_id   (GDataPicasaWebFile *self);

Gets the "album-id" property.

`self` : | a GDataPicasaWebFile
Returns : | the ID of the album containing the GDataPicasaWebFile

Since 0.4.0

### gdata_picasaweb_file_set_album_id ()

    void                gdata_picasaweb_file_set_album_id   (GDataPicasaWebFile *self,
                                                             const gchar *album_id);

Sets the "album-id" property, effectively moving the file to the album.

`self` : | a GDataPicasaWebFile
`album_id` : | the ID of the new album for this file

Since 0.4.0

### gdata_picasaweb_file_get_width ()

    guint               gdata_picasaweb_file_get_width      (GDataPicasaWebFile *self);

Gets the "width" property.

`self` : | a GDataPicasaWebFile
Returns : | the width of the image or video, in pixels

Since 0.4.0

### gdata_picasaweb_file_get_height ()

    guint               gdata_picasaweb_file_get_height     (GDataPicasaWebFile *self);

Gets the "height" property.

`self` : | a GDataPicasaWebFile
Returns : | the height of the image or video, in pixels

Since 0.4.0

### gdata_picasaweb_file_get_size ()

    gsize               gdata_picasaweb_file_get_size       (GDataPicasaWebFile *self);

Gets the "size" property.

`self` : | a GDataPicasaWebFile
Returns : | the size of the file, in bytes

Since 0.4.0

### gdata_picasaweb_file_get_client ()

    const gchar *       gdata_picasaweb_file_get_client     (GDataPicasaWebFile *self);

Gets the "client" property.

`self` : | a GDataPicasaWebFile
Returns : | the name of the software which created the photo, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_set_client ()

    void                gdata_picasaweb_file_set_client     (GDataPicasaWebFile *self,
                                                             const gchar *client);

Sets the "client" property to `client`.

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

`self` : | a GDataPicasaWebFile
`client` : | the name of the software which created or modified the photo, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_get_checksum ()

    const gchar *       gdata_picasaweb_file_get_checksum   (GDataPicasaWebFile *self);

Gets the "checksum" property.

`self` : | a GDataPicasaWebFile
Returns : | the checksum assigned to this file, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_set_checksum ()

    void                gdata_picasaweb_file_set_checksum   (GDataPicasaWebFile *self,
                                                             const gchar *checksum);

Sets the "checksum" property to `checksum`.

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

`self` : | a GDataPicasaWebFile
`checksum` : | the new checksum for this file, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_get_timestamp ()

    void                gdata_picasaweb_file_get_timestamp  (GDataPicasaWebFile *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 GDataPicasaWebFile
`timestamp` : | a GTimeVal

Since 0.4.0

### gdata_picasaweb_file_set_timestamp ()

    void                gdata_picasaweb_file_set_timestamp  (GDataPicasaWebFile *self,
                                                             GTimeVal *timestamp);

Sets the "timestamp" property from values supplied by `timestamp`. If `timestamp` is `NULL`, the property will be unset.

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

Since 0.4.0

### gdata_picasaweb_file_is_commenting_enabled ()

    gboolean            gdata_picasaweb_file_is_commenting_enabled
                                                            (GDataPicasaWebFile *self);

Gets the "is-commenting-enabled" property.

`self` : | a GDataPicasaWebFile
Returns : | `TRUE` if commenting is enabled, `FALSE` otherwise

Since 0.4.0

### gdata_picasaweb_file_set_is_commenting_enabled ()

    void                gdata_picasaweb_file_set_is_commenting_enabled
                                                            (GDataPicasaWebFile *self,
                                                             gboolean is_commenting_enabled);

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

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

Since 0.4.0

### gdata_picasaweb_file_get_comment_count ()

    guint               gdata_picasaweb_file_get_comment_count
                                                            (GDataPicasaWebFile *self);

Gets the "comment-count" property.

`self` : | a GDataPicasaWebFile
Returns : | the number of comments on the file

Since 0.4.0

### gdata_picasaweb_file_get_rotation ()

    guint               gdata_picasaweb_file_get_rotation   (GDataPicasaWebFile *self);

Gets the "rotation" property.

`self` : | a GDataPicasaWebFile
Returns : | the image's rotation, in degrees

Since 0.4.0

### gdata_picasaweb_file_set_rotation ()

    void                gdata_picasaweb_file_set_rotation   (GDataPicasaWebFile *self,
                                                             guint rotation);

Sets the "rotation" property to `rotation`.

The rotation is absolute, rather than cumulative, through successive calls to `gdata_picasaweb_file_set_rotation()`, so calling it with 90° then 20° will result in a final rotation of 20°.

`self` : | a GDataPicasaWebFile
`rotation` : | the new rotation for the image, in degrees

Since 0.4.0

### gdata_picasaweb_file_get_video_status ()

    const gchar *       gdata_picasaweb_file_get_video_status
                                                            (GDataPicasaWebFile *self);

Gets the "video-status" property.

`self` : | a GDataPicasaWebFile
Returns : | the status of this video ("pending", "ready", "final" or "failed"), or `NULL`

Since 0.4.0

### gdata_picasaweb_file_get_tags ()

    const gchar *       gdata_picasaweb_file_get_tags       (GDataPicasaWebFile *self);

Gets the "tags" property.

`self` : | a GDataPicasaWebFile
Returns : | a comma-separated list of tags associated with the file, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_set_tags ()

    void                gdata_picasaweb_file_set_tags       (GDataPicasaWebFile *self,
                                                             const gchar *tags);

Sets the "tags" property to `tags`.

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

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

Since 0.4.0

### gdata_picasaweb_file_get_credit ()

    const gchar *       gdata_picasaweb_file_get_credit     (GDataPicasaWebFile *self);

Gets the "credit" property.

`self` : | a GDataPicasaWebFile
Returns : | the nickname of the user credited with this file

Since 0.4.0

### gdata_picasaweb_file_get_caption ()

    const gchar *       gdata_picasaweb_file_get_caption    (GDataPicasaWebFile *self);

Gets the "caption" property.

`self` : | a GDataPicasaWebFile
Returns : | the file's descriptive caption, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_set_caption ()

    void                gdata_picasaweb_file_set_caption    (GDataPicasaWebFile *self,
                                                             const gchar *caption);

Sets the "caption" property to `caption`.

Set `caption` to `NULL` to unset the file's caption.

`self` : | a GDataPicasaWebFile
`caption` : | the file's new caption, or `NULL`

Since 0.4.0

### gdata_picasaweb_file_get_contents ()

    GList *             gdata_picasaweb_file_get_contents   (GDataPicasaWebFile *self);

Returns a list of media content, e.g. the actual photo or video.

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

Since 0.4.0

### gdata_picasaweb_file_get_thumbnails ()

    GList *             gdata_picasaweb_file_get_thumbnails (GDataPicasaWebFile *self);

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

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

Since 0.4.0

## Property Details

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

      "album-id"                 gchar*                : Read / Write

The ID for the file's album.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"caption"` property

      "caption"                  gchar*                : Read / Write

The file's descriptive caption.

Default value: NULL

Since 0.4.0

### The `"checksum"` property

      "checksum"                 gchar*                : Read / Write

A checksum of the file, useful for duplicate detection.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"client"` property

      "client"                   gchar*                : Read / Write

The name of the software which created or last modified the file.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

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

      "comment-count"            guint                 : Read

The number of comments on the file.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0

### The `"credit"` property

      "credit"                   gchar*                : Read

The nickname of the user credited with this file.

For more information, see the Media RSS specification.

Default value: NULL

Since 0.4.0

### The `"edited"` property

      "edited"                   GTimeVal*             : Read

The time this file was last edited. If the file 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 `"height"` property

      "height"                   guint                 : Read

The height of the photo or video, in pixels.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0

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

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

Whether commenting is enabled for this file.

Default value: TRUE

Since 0.4.0

### The `"position"` property

      "position"                 gdouble               : Read / Write

The ordinal position of the file within the album. Lower values mean the file will be closer to the start of the album.

For more information, see the gphoto specification.

Allowed values: [0,G_MAXFLOAT]

Default value: 0

Since 0.4.0

### The `"rotation"` property

      "rotation"                 guint                 : Read / Write

The rotation of the photo, in degrees. This will only be non-zero for files which are pending rotation, and haven't yet been permanently modified. For files which have already been rotated, this will be `0`.

For more information, see the gphoto specification.

Allowed values: <= 359

Default value: 0

Since 0.4.0

### The `"size"` property

      "size"                     gulong                : Read

The size of the file, in bytes.

For more information, see the gphoto specification.

Since 0.4.0

### The `"tags"` property

      "tags"                     gchar*                : Read / Write

A comma-separated list of tags associated with the file.

For more information, see the Media RSS specification.

Default value: NULL

Since 0.4.0

### The `"timestamp"` property

      "timestamp"                GTimeVal*             : Read / Write

The time the file was purportedly taken.

For more information, see the gphoto specification.

Since 0.4.0

### The `"version"` property

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

The version number of the file. Version numbers are based on modification time, so they don't increment linearly.

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"video-status"` property

      "video-status"             gchar*                : Read

The status of the file, if it is a video.

Possible values include "pending", "ready", "final", and "failed".

For more information, see the gphoto specification.

Default value: NULL

Since 0.4.0

### The `"width"` property

      "width"                    guint                 : Read

The width of the photo or video, in pixels.

For more information, see the gphoto specification.

Default value: 0

Since 0.4.0