public interface

UserData

implements GphotoData
com.google.gdata.data.photos.UserData
Known Indirect Subclasses

Class Overview

An interface for the user data objects. This is implemented by both UserEntry and UserFeed, which allows the use of a common interface when handling items of the User kind.

Summary

Constants
String KIND The unqualified kind for a user.
String USER_KIND The fully qualified kind term for users.
Fields
public static final Category USER_CATEGORY A category object for users.
Public Methods
abstract Integer getMaxPhotos()
The number of photos a user can have in a single album.
abstract String getNickname()
The nickname of the user.
abstract Long getQuotaLimit()
The quota limit of the user.
abstract Long getQuotaUsed()
The quota in bytes that the user has used.
abstract String getThumbnail()
A url to the user's portrait.
abstract String getUsername()
The username of the user.
abstract void setMaxPhotos(Integer max)
Set the maximum number of photos the user is allowed.
abstract void setNickname(String nickname)
Set the nickname of the user this data represents.
abstract void setQuotaLimit(Long quota)
Set the quota limit for the user this data represents.
abstract void setQuotaUsed(Long quota)
Set the used quota for the user.
abstract void setThumbnail(String thumbnail)
Set the thumbnail for the user portrait.
abstract void setUsername(String username)
Set the username for the user this data represents.
[Expand]
Inherited Methods
From interface com.google.gdata.data.photos.Extensible
From interface com.google.gdata.data.photos.GphotoData

Constants

public static final String KIND

The unqualified kind for a user.

Constant Value: "user"

public static final String USER_KIND

The fully qualified kind term for users.

Constant Value: "http://schemas.google.com/photos/2007#user"

Fields

public static final Category USER_CATEGORY

A category object for users. All user objects will have this set.

Public Methods

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getThumbnail ()

A url to the user's portrait.

Returns
  • the thumbnail for the user this data represents.

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.