| java.lang.Object | ||||||
| ↳ | com.google.gdata.data.AbstractExtension | |||||
| ↳ | com.google.gdata.data.ExtensionPoint | |||||
| ↳ | com.google.gdata.data.BaseEntry<E extends com.google.gdata.data.BaseEntry> | |||||
| ↳ | com.google.gdata.data.media.MediaEntry<E extends com.google.gdata.data.BaseEntry<E>> | |||||
| ↳ | com.google.gdata.data.photos.GphotoEntry<E extends com.google.gdata.data.photos.GphotoEntry<E>> | |||||
| ↳ | com.google.gdata.data.photos.AlbumEntry | |||||
Entry for album kinds, contains album metadata.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | KIND | Album kind term value. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.google.gdata.data.photos.AlbumData
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CATEGORY | Album kind category. | ||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.google.gdata.data.photos.GphotoEntry
| |||||||||||
From class
com.google.gdata.data.BaseEntry
| |||||||||||
From class
com.google.gdata.data.ExtensionPoint
| |||||||||||
From class
com.google.gdata.data.AbstractExtension
| |||||||||||
From interface
com.google.gdata.data.photos.AlbumData
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Default mutable constructor.
| |||||||||||
Constructs a new instance by doing a shallow copy of data from an existing
BaseEntry instance. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Clears the bounding box and removes the extension point.
| |||||||||||
Clears the point data and removes the extension point.
| |||||||||||
Declares the set of expected Extension types for an ExtensionPoint within
the target extension profile.
| |||||||||||
The access level of the album, either private, protected, or public.
| |||||||||||
Returns the access level for the album.
| |||||||||||
The number of bytes that are used by photos in this album.
| |||||||||||
Returns the number of bytes used by this album.
| |||||||||||
The number of comments on the album.
| |||||||||||
Returns the number of comments on this album.
| |||||||||||
Whether or not commenting is allowed on this album.
| |||||||||||
Returns the comments enabled field, which is true if comments are enabled
for this album.
| |||||||||||
The date the album was taken.
| |||||||||||
Returns the user date of the album.
| |||||||||||
Retrieve the album feed and associated entries.
| |||||||||||
Gets the bounding box of this entity.
| |||||||||||
Gets the geo-location of the entity.
| |||||||||||
Returns the geolocation as a geo:point.
| |||||||||||
Returns the geo bounding box as a georss:box.
| |||||||||||
Returns the geolocation as a georss:point.
| |||||||||||
Returns the geolocation as a georss:where.
| |||||||||||
Returns the geo bounding box as a gml:Envelope.
| |||||||||||
Returns the geolocation as a gml:point.
| |||||||||||
The location of the album is a string representing where the photos in
the album where taken.
| |||||||||||
Returns the textual location of the album.
| |||||||||||
Retrieve the list of media:category elements inside the media:group on
this element.
| |||||||||||
Retrieve the list of media:content elements inside the media:group on
this element.
| |||||||||||
Retrieve the list of media:credit elements inside the media:group on
this element.
| |||||||||||
Returns the mediarss group for media metadata.
| |||||||||||
Retrieve the list of media:keywords elements inside the media:group on
this element.
| |||||||||||
Retrieve the list of media:thumbnail elements inside the media:group on
this element.
| |||||||||||
The name of the album is its canonicalized title.
| |||||||||||
Returns the canonical name of the album.
| |||||||||||
The nickname of the user who owns the album.
| |||||||||||
Returns the nickname of the owner of the album.
| |||||||||||
The number of spaces for photos that are available in the album.
| |||||||||||
Returns the number of photos that can be uploaded to this album.
| |||||||||||
The number of photos that are contained in this album.
| |||||||||||
Returns the number of photos that have been uploaded to this album.
| |||||||||||
The username of the owner of the album.
| |||||||||||
Returns the username of the owner of the album.
| |||||||||||
Returns whether it has the access level for the album.
| |||||||||||
Returns whether it has the number of bytes used by this album.
| |||||||||||
Returns whether it has the number of comments on this album.
| |||||||||||
Returns whether it has the comments enabled field, which is true if
comments are enabled for this album.
| |||||||||||
Returns whether it has the user date of the album.
| |||||||||||
Returns whether it has the geolocation as a geo:point.
| |||||||||||
Returns whether it has the geo bounding box as a georss:box.
| |||||||||||
Returns whether it has the geolocation as a georss:point.
| |||||||||||
Returns whether it has the geolocation as a georss:where.
| |||||||||||
Returns whether it has the geo bounding box as a gml:Envelope.
| |||||||||||
Returns whether it has the geolocation as a gml:point.
| |||||||||||
Returns whether it has the textual location of the album.
| |||||||||||
Returns whether it has the mediarss group for media metadata.
| |||||||||||
Returns whether it has the canonical name of the album.
| |||||||||||
Returns whether it has the nickname of the owner of the album.
| |||||||||||
Returns whether it has the number of photos that can be uploaded to this
album.
| |||||||||||
Returns whether it has the number of photos that have been uploaded to this
album.
| |||||||||||
Returns whether it has the username of the owner of the album.
| |||||||||||
Set the access for the album this data object represents.
| |||||||||||
Sets the access level for the album.
| |||||||||||
Set the number of bytes used in the album this data object represents.
| |||||||||||
Sets the number of bytes used by this album.
| |||||||||||
Set the number of comments on the album.
| |||||||||||
Sets the number of comments on this album.
| |||||||||||
Set the whether comments are enabled in the album.
| |||||||||||
Sets the comments enabled field, which is true if comments are enabled for
this album.
| |||||||||||
Set the date of the album.
| |||||||||||
Sets the user date of the album.
| |||||||||||
Sets the bounding box based on two
Point objects. | |||||||||||
Sets the bounding box for this entity based on a
Box extension. | |||||||||||
Sets the geo-location of the entity based on the lat and long coordinates
passed in.
| |||||||||||
Sets the geo-location of the entity based on the Point extension.
| |||||||||||
Sets the geolocation as a geo:point.
| |||||||||||
Sets the geo bounding box as a georss:box.
| |||||||||||
Sets the geolocation as a georss:point.
| |||||||||||
Sets the geolocation as a georss:where.
| |||||||||||
Sets the geo bounding box as a gml:Envelope.
| |||||||||||
Sets the geolocation as a gml:point.
| |||||||||||
Set the media keywords on this element to the given keywords.
| |||||||||||
Set the location string for where the photos in the album were taken.
| |||||||||||
Sets the textual location of the album.
| |||||||||||
Sets the mediarss group for media metadata.
| |||||||||||
Set the canonical name of the album.
| |||||||||||
Sets the canonical name of the album.
| |||||||||||
Set the nickname for the owner of the album this data object represents.
| |||||||||||
Sets the nickname of the owner of the album.
| |||||||||||
Set the number of photos remaining that can be uploaded to this album.
| |||||||||||
Sets the number of photos that can be uploaded to this album.
| |||||||||||
Set the number of photos used on the album this data object represents.
| |||||||||||
Sets the number of photos that have been uploaded to this album.
| |||||||||||
Set the username for the owner of the album this data object represents.
| |||||||||||
Sets the username of the owner of the album.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Checks the attributes to see if there are any problems.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.google.gdata.data.photos.GphotoEntry
| |||||||||||
From class
com.google.gdata.data.media.MediaEntry
| |||||||||||
From class
com.google.gdata.data.BaseEntry
| |||||||||||
From class
com.google.gdata.data.ExtensionPoint
| |||||||||||
From class
com.google.gdata.data.AbstractExtension
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
com.google.gdata.data.Extension
| |||||||||||
From interface
com.google.gdata.data.IAtom
| |||||||||||
From interface
com.google.gdata.data.IEntry
| |||||||||||
From interface
com.google.gdata.data.Kind.Adaptable
| |||||||||||
From interface
com.google.gdata.data.Kind.Adaptor
| |||||||||||
From interface
com.google.gdata.data.geo.BoxData
| |||||||||||
From interface
com.google.gdata.data.geo.PointData
| |||||||||||
From interface
com.google.gdata.data.media.IMediaEntry
| |||||||||||
From interface
com.google.gdata.data.photos.AlbumData
| |||||||||||
From interface
com.google.gdata.data.photos.AtomData
| |||||||||||
From interface
com.google.gdata.data.photos.Extensible
| |||||||||||
From interface
com.google.gdata.data.photos.GphotoData
| |||||||||||
From interface
com.google.gdata.data.photos.MediaData
| |||||||||||
Album kind term value.
Default mutable constructor.
Constructs a new instance by doing a shallow copy of data from an existing
BaseEntry instance.
| sourceEntry | Source entry |
|---|
Clears the bounding box and removes the extension point.
Clears the point data and removes the extension point.
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.
| extProfile | The ExtensionProfile to initialize. |
|---|
The access level of the album, either private, protected, or public. This may be null when the access level of the album is not known.
Returns the access level for the album.
The number of bytes that are used by photos in this album. Useful to see how much space each album is taking up of the user's quota. This method is calculated by the server so it should be considered read-only by the client.
Returns the number of bytes used by this album.
The number of comments on the album. This is calculated based on the comments stored on the server.
Returns the number of comments on this album.
Whether or not commenting is allowed on this album. If set to true then comments may be added to the album, if set to false then no comments can be made on photos in this album.
Returns the comments enabled field, which is true if comments are enabled for this album.
The date the album was taken. Date ranges are not currently allowed. This is typically set to the date the earliest photo in the album was taken.
Returns the user date of the album.
Retrieve the album feed and associated entries. The kinds parameter is a
list of the associated entries to return. For example
AlbumFeed albumAndPhotos = albumEntry.getFeed(PhotoData.KIND,
TagData.KIND); If no kind parameters are passed, the default of
KIND will be used.
| kinds | The kinds of entries to retrieve, or empty to use the default. |
|---|
| IOException | |
|---|---|
| ServiceException |
Gets the bounding box of this entity.
Gets the geo-location of the entity.
Returns the geolocation as a geo:point.
Returns the geo bounding box as a georss:box.
Returns the geolocation as a georss:point.
Returns the geolocation as a georss:where.
Returns the geo bounding box as a gml:Envelope.
Returns the geolocation as a gml:point.
The location of the album is a string representing where the photos in the album where taken.
Returns the textual location of the album.
Retrieve the list of media:category elements inside the media:group on this element. If either the media:group or media:category elements are missing then an empty list will be returned.
Retrieve the list of media:content elements inside the media:group on this element. If either the media:group or media:content elements are missing then an empty list will be returned.
Retrieve the list of media:credit elements inside the media:group on this element. If either the media:group or media:credit elements are missing then an empty list will be returned.
Returns the mediarss group for media metadata.
Retrieve the list of media:keywords elements inside the media:group on
this element. If either the media:group or media:keywords elements are
missing then null will be returned.
null.
Retrieve the list of media:thumbnail elements inside the media:group on this element. If either the media:group or media:thumbnail elements are missing then an empty list will be returned.
The name of the album is its canonicalized title. This is the name that can be used in urls to access the album by name rather than by id.
Returns the canonical name of the album.
The nickname of the user who owns the album. This is provided to make it easier to display ownership information about albums. This is a read only field calculated by the server based on the owner of the album.
Returns the nickname of the owner of the album.
The number of spaces for photos that are available in the album. This should be treated as a read only field as it is calculated on the server. Once 0 photos are left no more photos can be uploaded to this album until photos have been deleted.
Returns the number of photos that can be uploaded to this album.
The number of photos that are contained in this album. This should be treated as a read only field, it is calculated on the server.
Returns the number of photos that have been uploaded to this album.
The username of the owner of the album. This username can be used to query for the gallery of the owner of the album, for example.
Returns the username of the owner of the album.
Returns whether it has the access level for the album.
Returns whether it has the number of bytes used by this album.
Returns whether it has the number of comments on this album.
Returns whether it has the comments enabled field, which is true if comments are enabled for this album.
Returns whether it has the user date of the album.
Returns whether it has the geolocation as a geo:point.
Returns whether it has the geo bounding box as a georss:box.
Returns whether it has the geolocation as a georss:point.
Returns whether it has the geolocation as a georss:where.
Returns whether it has the geo bounding box as a gml:Envelope.
Returns whether it has the geolocation as a gml:point.
Returns whether it has the textual location of the album.
Returns whether it has the mediarss group for media metadata.
Returns whether it has the canonical name of the album.
Returns whether it has the nickname of the owner of the album.
Returns whether it has the number of photos that can be uploaded to this album.
Returns whether it has the number of photos that have been uploaded to this album.
Returns whether it has the username of the owner of the album.
Set the access for the album this data object represents. Valid values are "private" or "public". Anything other than "public" will be set as "private", which is the default.
| access | The access level of the album. |
|---|
Sets the access level for the album.
| accessExt | Access level for the album or null to reset
|
|---|
Set the number of bytes used in the album this data object represents. This method is used by the server, setting this on the client will have no effect.
| bytesUsed | The number of bytes used. |
|---|
Sets the number of bytes used by this album.
| bytesUsedExt | Number of bytes used by this album or null
to reset
|
|---|
Set the number of comments on the album. Used by the server, this has no effect on the client.
| commentCount | The number of comments on the album. |
|---|
Sets the number of comments on this album.
| commentCountExt | Number of comments on this album or
null to reset
|
|---|
Set the whether comments are enabled in the album. This will change the setting on the server if set by the owner of the album and updated.
| commentsEnabled | True if comments are enabled in the album. |
|---|
Sets the comments enabled field, which is true if comments are enabled for this album.
| commentsEnabledExt | Comments enabled field, which is true if comments
are enabled for this album or null to reset
|
|---|
Set the date of the album. Dates that are too early will be truncated by the server, where too early currently means anything before 1970.
| date | The date the album represents. |
|---|
Sets the user date of the album.
| dateExt | User date of the album or null to reset
|
|---|
Sets the bounding box based on two Point objects. If there is an
existing Box on this object, the new points will be copied into the
existing box rather than creating a new box.
| lowerLeft | The lower left coordinate of the box. |
|---|---|
| upperRight | The upper right coordinate of the box. |
Sets the bounding box for this entity based on a Box extension. If
there is an existing Box on this object, the new box will have its points
copied into the existing box rather than using the passed-in box.
| boundingBox | The box that bounds this entity. |
|---|
Sets the geo-location of the entity based on the lat and long coordinates passed in. This will create a new Point object if none exists, otherwise it will copy the new coordinates into the existing object.
| lat | The latitude coordinate, between -90 and 90 degrees. |
|---|---|
| lon | The longitude coordinate, between -180 and 180 degrees. |
Sets the geo-location of the entity based on the Point extension. This will use the passed in extension as the geo location if none already exists, otherwise it will copy the given point's data into the existing point object.
| point | A point containing the latitude and longitude coordinates. |
|---|
Sets the geolocation as a geo:point.
| geoPoint | Geolocation as a geo:point or null to reset
|
|---|
Sets the geo bounding box as a georss:box.
| geoRssBox | Geo bounding box as a georss:box or null to
reset
|
|---|
Sets the geolocation as a georss:point.
| geoRssPoint | Geolocation as a georss:point or null to
reset
|
|---|
Sets the geolocation as a georss:where.
| geoRssWhere | Geolocation as a georss:where or null to
reset
|
|---|
Sets the geo bounding box as a gml:Envelope.
| gmlEnvelope | Geo bounding box as a gml:Envelope or null
to reset
|
|---|
Sets the geolocation as a gml:point.
| gmlPoint | Geolocation as a gml:point or null to reset
|
|---|
Set the media keywords on this element to the given keywords. Will create the media:group element as needed.
| keywords |
|---|
Set the location string for where the photos in the album were taken. This string may be geocoded by the server to provide coordinates based on the location.
| location | The location of the album. |
|---|
Sets the textual location of the album.
| locationExt | Textual location of the album or null to
reset
|
|---|
Sets the mediarss group for media metadata.
| mediaGroup | Mediarss group for media metadata or null to
reset
|
|---|
Set the canonical name of the album. This is used on the server.
If you wish to change the title of the album you should instead use
setTitle(com.google.gdata.data.TextConstruct).
| name | The canonical name of the album. |
|---|
Sets the canonical name of the album.
| nameExt | Canonical name of the album or null to reset
|
|---|
Set the nickname for the owner of the album this data object represents. This is used by the server and has no effect on the client.
| nickname | The nickname of the owner. |
|---|
Sets the nickname of the owner of the album.
| nicknameExt | Nickname of the owner of the album or null
to reset
|
|---|
Set the number of photos remaining that can be uploaded to this album. This is used by the server, changing this value on the client will have no effect.
| photosLeft | The number of photos left. |
|---|
Sets the number of photos that can be uploaded to this album.
| photosLeftExt | Number of photos that can be uploaded to this album or
null to reset
|
|---|
Set the number of photos used on the album this data object represents. This is used by the server, changing this value on the client will have no effect.
| photosUsed | The number of photos used. |
|---|
Sets the number of photos that have been uploaded to this album.
| photosUsedExt | Number of photos that have been uploaded to this album
or null to reset
|
|---|
Set the username for the owner of the album this data object represents. This is used by the server, setting it on the client will have no effect. We currently do not support moving albums between users.
| username | The username of the owner. |
|---|
Sets the username of the owner of the album.
| usernameExt | Username of the owner of the album or null
to reset
|
|---|
Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.