GData.PicasaWebAlbum¶

Subclasses:: None

Methods¶

Inherited:: GData.Entry (24), GData.Parsable (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (id)
	`get_bytes_used` ()
	`get_comment_count` ()
	`get_contents` ()
	`get_coordinates` ()
	`get_edited` ()
	`get_id` ()
	`get_location` ()
	`get_nickname` ()
	`get_num_photos` ()
	`get_num_photos_remaining` ()
	`get_tags` ()
	`get_thumbnails` ()
	`get_timestamp` ()
	`get_user` ()
	`get_visibility` ()
	`is_commenting_enabled` ()
	`set_coordinates` (latitude, longitude)
	`set_is_commenting_enabled` (is_commenting_enabled)
	`set_location` (location)
	`set_tags` (tags)
	`set_timestamp` (timestamp)
	`set_visibility` (visibility)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7)

Properties¶

Inherited:: GData.Entry (10), GData.Parsable (1)

Name	Type	Flags	Short Description
`album-id`	`str`	r/w/co	The ID of the album.
`bytes-used`		r	The number of bytes consumed by this album and its contents.
`comment-count`	`int`	r	The number of comments on the album.
`edited`	`int`	r	The time this album was last edited.
`is-commenting-enabled`	`bool`	r/w	Whether commenting is enabled for this album.
`latitude`	`float`	r/w	The location as a latitude coordinate associated with this album.
`location`	`str`	r/w	The user-specified location associated with the album.
`longitude`	`float`	r/w	The location as a longitude coordinate associated with this album.
`nickname`	`str`	r	The user’s nickname.
`num-photos`	`int`	r	The number of photos and videos in the album.
`num-photos-remaining`	`int`	r	The number of files spaces still free for uploads.
`tags`	[`str`]	r/w	A `None`-terminated array of tags associated with the album
`timestamp`	`int`	r/w	The timestamp of when the album occurred, settable by the user.
`user`	`str`	r	The username of the album owner.
`visibility`	`GData.PicasaWebVisibility`	r/w	The visibility (or access rights) of the album.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Entry`	r

Class Details¶

class GData.PicasaWebAlbum(**kwargs)¶

Bases:: GData.Entry
Abstract:: No
Structure:: GData.PicasaWebAlbumClass

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

New in version 0.4.0.

classmethod new(id)¶

Parameters:: id (str or None) – the album’s entry ID, or None
Returns:: a new GData.PicasaWebAlbum, or None; unref with GObject.Object.unref()
Return type:: GData.PicasaWebAlbum

Creates a new GData.PicasaWebAlbum with the given ID and default properties. id is the ID which would be returned by GData.Entry.get_id(), not GData.PicasaWebAlbum.get_id().

If id is not None and can’t be parsed to extract an album ID, None will be returned.

New in version 0.4.0.

get_bytes_used()¶

Returns:: the number of bytes used by the album and its contents, or -1
Return type:: int

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

New in version 0.4.0.

get_comment_count()¶

Returns:: the number of comments on the album
Return type:: int

Gets the GData.PicasaWebAlbum :comment-count property.

New in version 0.4.0.

get_contents()¶

Returns:: a GLib.List of GData.MediaContent items
Return type:: [GData.MediaContent]

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

New in version 0.4.0.

get_coordinates()¶

Returns:

latitude:: return location for the latitude, or None
longitude:: return location for the longitude, or None

Return type:

(latitude: float, longitude: float)

Gets the GData.PicasaWebAlbum :latitude and GData.PicasaWebAlbum :longitude properties, setting the out parameters to them. If either latitude or longitude is None, that parameter will not be set. If the coordinates are unset, latitude and longitude will be set to GObject.G_MAXDOUBLE.

New in version 0.5.0.

get_edited()¶

Returns:: the UNIX timestamp for the time the album was last edited, or -1
Return type:: int

Gets the GData.PicasaWebAlbum :edited property. If the property is unset, -1 will be returned.

New in version 0.4.0.

get_id()¶

Returns:: the album’s ID
Return type:: str

Gets the GData.PicasaWebAlbum :album-id property.

New in version 0.7.0.

get_location()¶

Returns:: the album’s location, or None
Return type:: str

Gets the GData.PicasaWebAlbum :location property.

New in version 0.4.0.

get_nickname()¶

Returns:: the album owner’s nickname
Return type:: str

Gets the GData.PicasaWebAlbum :nickname property.

New in version 0.4.0.

get_num_photos()¶

Returns:: the number of photos currently in the album
Return type:: int

Gets the GData.PicasaWebAlbum :num-photos property.

New in version 0.4.0.

get_num_photos_remaining()¶

Returns:: the number of photos that can still be uploaded to the album
Return type:: int

Gets the GData.PicasaWebAlbum :num-photos-remaining property.

New in version 0.4.0.

get_tags()¶

Returns:: a None-terminated array of tags associated with all the photos in the album, or None
Return type:: [str]

Gets the GData.PicasaWebAlbum :tags property.

New in version 0.4.0.

get_thumbnails()¶

Returns:: a GLib.List of GData.MediaThumbnails, or None
Return type:: [GData.MediaThumbnail]

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

New in version 0.4.0.

get_timestamp()¶

Returns:: the UNIX timestamp for the timestamp property in milliseconds, or -1
Return type:: int

Gets the GData.PicasaWebAlbum :timestamp property. This value usually holds either the date that best corresponds to the album of photos, or to the day it was uploaded. It’s a UNIX timestamp in milliseconds (not seconds) since the epoch. If the property is unset, -1 will be returned.

New in version 0.4.0.

get_user()¶

Returns:: the album owner’s username
Return type:: str

Gets the GData.PicasaWebAlbum :user property.

New in version 0.4.0.

get_visibility()¶

Returns:: the album’s visibility level
Return type:: GData.PicasaWebVisibility

Gets the GData.PicasaWebAlbum :visibility property.

New in version 0.4.0.

is_commenting_enabled()¶

Returns:: True if commenting is enabled for the album, False otherwise
Return type:: bool

Gets the GData.PicasaWebAlbum :is-commenting-enabled property.

New in version 0.4.0.

set_coordinates(latitude, longitude)¶

Parameters:

latitude (float) – the album’s new latitude coordinate, or GObject.G_MAXDOUBLE
longitude (float) – the album’s new longitude coordinate, or GObject.G_MAXDOUBLE

Sets the GData.PicasaWebAlbum :latitude and GData.PicasaWebAlbum :longitude properties to latitude and longitude respectively.

New in version 0.5.0.

set_is_commenting_enabled(is_commenting_enabled)¶

Parameters:: is_commenting_enabled (bool) – True if commenting should be enabled for the album, False otherwise

Sets the GData.PicasaWebAlbum :is-commenting-enabled property to is_commenting_enabled.

New in version 0.4.0.

set_location(location)¶

Parameters:: location (str or None) – the new album location, or None

Sets the GData.PicasaWebAlbum :location property to location.

Set location to None to unset the property.

New in version 0.4.0.

set_tags(tags)¶

Parameters:: tags ([str] or None) – the new None-terminated array of tags, or None

Sets the GData.PicasaWebAlbum :tags property to tags.

Set tags to None to unset the album’s tag list.

New in version 0.4.0.

set_timestamp(timestamp)¶

Parameters:: timestamp (int) – a UNIX timestamp, or -1

Sets the GData.PicasaWebAlbum :timestamp property from timestamp. This should be a UNIX timestamp in milliseconds (not seconds) since the epoch.

Set timestamp to -1 to unset the property.

New in version 0.4.0.

set_visibility(visibility)¶

Parameters:: visibility (GData.PicasaWebVisibility) – the new album visibility level

Sets the GData.PicasaWebAlbum :visibility property to visibility.

New in version 0.4.0.

Property Details¶

GData.PicasaWebAlbum.props.album_id¶

Name:: album-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The ID of the album. This is a substring of the ID returned by GData.Entry.get_id() for GData.PicasaWebAlbums; for example, if GData.Entry.get_id() returned “http://picasaweb.google.com/data/entry/user/libgdata.picasaweb/albumid/5328889949261497249” for a particular GData.PicasaWebAlbum, the GData.PicasaWebAlbum :album-id property would be “5328889949261497249”.

For more information, see the gphoto specification.

New in version 0.7.0.

GData.PicasaWebAlbum.props.bytes_used¶

Name:: bytes-used
Type:
Default Value:: -1
Flags:: READABLE

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.

New in version 0.4.0.

GData.PicasaWebAlbum.props.comment_count¶

Name:: comment-count
Type:: int
Default Value:: 0
Flags:: READABLE

The number of comments on the album.

For more information, see the gphoto specification.

New in version 0.4.0.

GData.PicasaWebAlbum.props.edited¶

Name:: edited
Type:: int
Default Value:: -1
Flags:: READABLE

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.

New in version 0.4.0.

GData.PicasaWebAlbum.props.is_commenting_enabled¶

Name:: is-commenting-enabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether commenting is enabled for this album.

GData.PicasaWebAlbum.props.latitude¶

Name:: latitude
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

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.

New in version 0.5.0.

GData.PicasaWebAlbum.props.location¶

Name:: location
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

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

For more information, see the gphoto specification.

New in version 0.4.0.

GData.PicasaWebAlbum.props.longitude¶

Name:: longitude
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

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.

New in version 0.5.0.

GData.PicasaWebAlbum.props.nickname¶

Name:: nickname
Type:: str
Default Value:: None
Flags:: READABLE

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.

New in version 0.4.0.

GData.PicasaWebAlbum.props.num_photos¶

Name:: num-photos
Type:: int
Default Value:: 0
Flags:: READABLE

The number of photos and videos in the album.

For more information, see the gphoto specification.

New in version 0.4.0.

GData.PicasaWebAlbum.props.num_photos_remaining¶

Name:: num-photos-remaining
Type:: int
Default Value:: 0
Flags:: READABLE

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.

New in version 0.4.0.

GData.PicasaWebAlbum.props.tags¶

Name:: tags
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE

A None-terminated array 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.

New in version 0.4.0.

GData.PicasaWebAlbum.props.timestamp¶

Name:: timestamp
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The timestamp of when the album occurred, settable by the user. This a UNIX timestamp in milliseconds (not seconds) since the epoch.

For more information, see the gphoto specification.

New in version 0.4.0.

GData.PicasaWebAlbum.props.user¶

Name:: user
Type:: str
Default Value:: None
Flags:: READABLE

The username of the album owner.

For more information, see the gphoto specification.

New in version 0.4.0.

GData.PicasaWebAlbum.props.visibility¶

Name:: visibility
Type:: GData.PicasaWebVisibility
Default Value:: GData.PicasaWebVisibility.PRIVATE
Flags:: READABLE, WRITABLE

The visibility (or access rights) of the album.

For more information, see the gphoto specification.

New in version 0.4.0.