|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jickr.User
public class User
Information on a User of Flickr.
Constructor Summary | |
---|---|
User(java.lang.String id)
Creates a new instance of User with the given ID. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Check for equality of two User objects. |
static User |
findByEmail(java.lang.String emailAddr)
Return a new User object that corresponds to the stated Email Address. |
static User |
findByID(java.lang.String id)
Return a new User object that corresponds to the stated user ID. |
static User |
findByURL(java.lang.String userURL)
Return a new User object that corresponds to the stated URL. |
static User |
findByUsername(java.lang.String username)
Return a new User object that corresponds to the stated username. |
static java.util.List<User> |
getContacts()
Get a list of users that are contacts for the authenticated user. |
java.util.List<Photo> |
getFavoritePhotos()
Get a list of all favorite photos for this user. |
java.lang.String |
getID()
Gets the value of User's ID, the flickr unique identifier used in most of their URLs. |
java.lang.String |
getLocation()
Get the location listed for this user in Flickr. |
int |
getPhotoCount()
Gets the number of photos the user owns. |
java.util.List<PhotoSet> |
getPhotoSets()
Get a list of the PhotoSets for this user. |
java.net.URL |
getPhotosURL()
Gets the URL for photos for this user. |
java.util.Map<java.lang.String,java.lang.Integer> |
getPopularTags(int count)
Get a list of the popular tags associated with this User's Photos, and how many times they are used. |
java.net.URL |
getProfileURL()
Gets the URL of the user profile. |
java.util.List<Photo> |
getPublicContactPhotos()
Get a list of all public photos for this user's contacts. |
java.util.List<Photo> |
getPublicContactPhotos(boolean justFriends,
int count)
Get a list of all public photos for this user's contacts. |
java.util.List<User> |
getPublicContacts()
Get a list of users who are listed as contacts for this User. |
java.util.List<Photo> |
getPublicFavoritePhotos()
Get a list of all public favorite photos for this user. |
java.util.List<Photo> |
getPublicPhotos()
Get a list of all public photos for this user. |
java.lang.String |
getRealName()
Get the real name. |
java.util.List<java.lang.String> |
getTags()
Get a list of all the tags associated with this User's Photos. |
java.lang.String |
getUserName()
Get the User Name |
int |
hashCode()
Create a hashcode for the User object, based on ID. |
boolean |
isPro()
Gets whether the User is registered with a Pro account. |
java.lang.String |
toString()
Return a String rendition of this object. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public User(java.lang.String id)
User.findByID(String)
findByID(String)
Method Detail |
---|
public static User findByUsername(java.lang.String username) throws FlickrException
username
- Username of the User. Must not be null.
FlickrException
- for almost anything, including not found errorspublic static User findByEmail(java.lang.String emailAddr) throws FlickrException
emailAddr
- Email address &qt;user@domain.com&qt;
FlickrException
- for almost anything, including not found errorspublic static User findByID(java.lang.String id)
Note: this call creates a new User object without querying Flickr, so there is no guarentee that this object is valid. Validity will be checked once other calls are made to request data. This was done for performance reasons in other parts of the API.
id
- Flickr specific identifier. Must not be null.
public static User findByURL(java.lang.String userURL) throws FlickrException
userURL
- Flickr URL for this user.
FlickrException
public java.lang.String getUserName() throws FlickrException
FlickrException
public java.lang.String getRealName() throws FlickrException
FlickrException
public java.lang.String getLocation() throws FlickrException
FlickrException
public java.net.URL getPhotosURL() throws FlickrException
FlickrException
public java.net.URL getProfileURL() throws FlickrException
FlickrException
public int getPhotoCount() throws FlickrException
FlickrException
public boolean isPro() throws FlickrException
FlickrException
- on any error.public java.lang.String getID()
public java.util.List<User> getPublicContacts() throws FlickrException
FlickrException
public static java.util.List<User> getContacts() throws FlickrException
FlickrException
- on any error, including not being authenticated.public java.util.List<Photo> getPublicPhotos() throws FlickrException
FlickrException
- in the event of any error.public java.util.List<Photo> getPublicFavoritePhotos() throws FlickrException
FlickrException
- in the event of any error.public java.util.List<Photo> getFavoritePhotos() throws FlickrException
FlickrException
- in the event of any error.public java.util.List<Photo> getPublicContactPhotos() throws FlickrException
FlickrException
- in the event of any error.public java.util.List<Photo> getPublicContactPhotos(boolean justFriends, int count) throws FlickrException
justFriends
- Return only friends' photos, or all contacts' photos.count
- How many photos to return - default is 10, max is 50.
FlickrException
- in the event of any error.public java.util.List<PhotoSet> getPhotoSets() throws FlickrException
FlickrException
- in the event of any errorpublic java.util.List<java.lang.String> getTags() throws FlickrException
FlickrException
- on any error.public java.util.Map<java.lang.String,java.lang.Integer> getPopularTags(int count) throws FlickrException
count
- The number of popular tags to return. Must be greater than 0.
FlickrException
- on any error.public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- - Object to compare.
public int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |