public class

UserFeed

extends GphotoFeed<F extends GphotoFeed>
implements AtomData UserData
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.Source
         ↳ com.google.gdata.data.BaseFeed<F extends com.google.gdata.data.BaseFeed, E extends com.google.gdata.data.BaseEntry>
           ↳ com.google.gdata.data.media.MediaFeed<F extends com.google.gdata.data.BaseFeed, E extends com.google.gdata.data.BaseEntry>
             ↳ com.google.gdata.data.photos.GphotoFeed<F extends com.google.gdata.data.photos.GphotoFeed>
               ↳ com.google.gdata.data.photos.UserFeed

Class Overview

Feed for a User in our google photos api. This feed represents a user as the container for other objects. A User feed contains entries of AlbumEntry or TagEntry kind. The user feed itself also contains all of the metadata available as part of a UserData object.

Summary

[Expand]
Inherited Constants
From interface com.google.gdata.data.photos.UserData
Fields
private final UserData delegate
[Expand]
Inherited Fields
From class com.google.gdata.data.photos.GphotoFeed
From class com.google.gdata.data.BaseFeed
From class com.google.gdata.data.Source
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From interface com.google.gdata.data.photos.UserData
Public Constructors
UserFeed()
Constructs a new empty user feed.
UserFeed(BaseFeed<?, ?> sourceFeed)
Constructs a new user feed from a shallow copy of the data in the source feed.
Public Methods
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.

The implementation of this method for BaseFeed will declare any extensions associated with the contained entry type.

List<AlbumEntry> getAlbumEntries()
Get a list of entries of the AlbumEntry kind.
Integer getMaxPhotos()
The number of photos a user can have in a single album.
String getNickname()
The nickname of the user.
Long getQuotaLimit()
The quota limit of the user.
Long getQuotaUsed()
The quota in bytes that the user has used.
List<TagEntry> getTagEntries()
Get a list of entries of the TagEntry kind.
String getThumbnail()
A url to the user's portrait.
String getUsername()
The username of the user.
void setMaxPhotos(Integer max)
Set the maximum number of photos the user is allowed.
void setNickname(String nickname)
Set the nickname of the user this data represents.
void setQuotaLimit(Long quota)
Set the quota limit for the user this data represents.
void setQuotaUsed(Long quota)
Set the used quota for the user.
void setThumbnail(String thumbnail)
Set the thumbnail for the user portrait.
void setUsername(String username)
Set the username for the user this data represents.
[Expand]
Inherited Methods
From class com.google.gdata.data.photos.GphotoFeed
From class com.google.gdata.data.media.MediaFeed
From class com.google.gdata.data.BaseFeed
From class com.google.gdata.data.Source
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.IFeed
From interface com.google.gdata.data.Kind.Adaptable
From interface com.google.gdata.data.Kind.Adaptor
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.UserData

Fields

private final UserData delegate

Public Constructors

public UserFeed ()

Constructs a new empty user feed.

public UserFeed (BaseFeed<?, ?> sourceFeed)

Constructs a new user feed from a shallow copy of the data in the source feed. This is used to get the correct entry type based on the category of the entry.

Parameters
sourceFeed

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

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.

The implementation of this method for BaseFeed will declare any extensions associated with the contained entry type.

Parameters
extProfile The ExtensionProfile to initialize.

public List<AlbumEntry> getAlbumEntries ()

Get a list of entries of the AlbumEntry kind.

public Integer getMaxPhotos ()

The number of photos a user can have in a single album. Calculated on the server.

Returns
  • the maximum number of photos the user can have in an album.

public String getNickname ()

The nickname of the user. This is the display name of the user, defined by editing the user information through the UI.

Returns
  • the nickname of the user this data represents.

public Long getQuotaLimit ()

The quota limit of the user. Set on the server, only modifiable by purchasing more storage through the UI.

Returns
  • the quota limit for the user in bytes.

public Long getQuotaUsed ()

The quota in bytes that the user has used. This is calculated on the server.

Returns
  • the quota used for this user in bytes.

public List<TagEntry> getTagEntries ()

Get a list of entries of the TagEntry kind.

public String getThumbnail ()

A url to the user's portrait.

Returns
  • the thumbnail for the user this data represents.

public String getUsername ()

The username of the user. The username is the user's current persona, and is not a valid email address but is instead a unique name of the user on the server.

Returns
  • the username of the user this data represents.

public void setMaxPhotos (Integer max)

Set the maximum number of photos the user is allowed. Used by the server to set the field, has no effect on the client.

Parameters
max The number of photos the user is allowed.

public void setNickname (String nickname)

Set the nickname of the user this data represents. Used on the server to set the field of the entry or feed, this will have no effect on the client.

Parameters
nickname The nickname of the user.

public void setQuotaLimit (Long quota)

Set the quota limit for the user this data represents. Used by the server to set the field in the response, has no effect on the client.

Parameters
quota The quota in bytes for the user.

public void setQuotaUsed (Long quota)

Set the used quota for the user. Has no effect on the client.

Parameters
quota The quota usage in bytes for this user.

public void setThumbnail (String thumbnail)

Set the thumbnail for the user portrait. This is used on the server and does not yet have the effect of changing the portrait when set on the client.

Parameters
thumbnail The url to the user portrait image.

public void setUsername (String username)

Set the username for the user this data represents. This is used by the server and setting it on the client will have no effect.

Parameters
username The username of the user.