com.flickr4java.flickr.people

Class PeopleInterface

java.lang.Object

com.flickr4java.flickr.people.PeopleInterface

public class PeopleInterface
extends java.lang.Object

Interface for finding Flickr users.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METHOD_FIND_BY_EMAIL
static java.lang.String	METHOD_FIND_BY_USERNAME
static java.lang.String	METHOD_GET_GROUPS
static java.lang.String	METHOD_GET_INFO
static java.lang.String	METHOD_GET_ONLINE_LIST
static java.lang.String	METHOD_GET_PHOTOS
static java.lang.String	METHOD_GET_PHOTOS_OF
static java.lang.String	METHOD_GET_PUBLIC_GROUPS
static java.lang.String	METHOD_GET_PUBLIC_PHOTOS
static java.lang.String	METHOD_GET_UPLOAD_STATUS

Constructor Summary

Constructors

Constructor and Description
PeopleInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String photoId, java.lang.String userId, java.awt.Rectangle bounds) Add the given person to the photo.
void	delete(java.lang.String photoId, java.lang.String userId) Delete the person from the photo
void	deleteCoords(java.lang.String photoId, java.lang.String userId) Delete the co-ordinates that the user is shown in
void	editCoords(java.lang.String photoId, java.lang.String userId, java.awt.Rectangle bounds) Edit the co-ordinates that the user shows in
User	findByEmail(java.lang.String email) Find the user by their email address.
User	findByUsername(java.lang.String username) Find a User by the username.
GroupList<Group>	getGroups(java.lang.String userId)
User	getInfo(java.lang.String userId) Get info about the specified user.
UserList<User>	getList(java.lang.String photoId)
PhotoList<Photo>	getPhotos(java.lang.String userId, java.lang.String safeSearch, java.util.Date minUploadDate, java.util.Date maxUploadDate, java.util.Date minTakenDate, java.util.Date maxTakenDate, java.lang.String contentType, java.lang.String privacyFilter, java.util.Set<java.lang.String> extras, int perPage, int page)
PhotoList<Photo>	getPhotosOf(java.lang.String userId, java.lang.String ownerId, java.util.Set<java.lang.String> extras, int perPage, int page)
java.util.Collection<Group>	getPublicGroups(java.lang.String userId) Get a collection of public groups for the user.
PhotoList<Photo>	getPublicPhotos(java.lang.String userId, int perPage, int page)
PhotoList<Photo>	getPublicPhotos(java.lang.String userId, java.util.Set<java.lang.String> extras, int perPage, int page) Get a collection of public photos for the specified user ID.
User	getUploadStatus() Get upload status for the currently authenticated user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METHOD_FIND_BY_EMAIL

public static final java.lang.String METHOD_FIND_BY_EMAIL

See Also:

Constant Field Values

METHOD_FIND_BY_USERNAME

public static final java.lang.String METHOD_FIND_BY_USERNAME

See Also:

Constant Field Values

METHOD_GET_INFO

public static final java.lang.String METHOD_GET_INFO

See Also:

Constant Field Values

METHOD_GET_ONLINE_LIST

public static final java.lang.String METHOD_GET_ONLINE_LIST

See Also:

Constant Field Values

METHOD_GET_PUBLIC_GROUPS

public static final java.lang.String METHOD_GET_PUBLIC_GROUPS

See Also:

Constant Field Values

METHOD_GET_PUBLIC_PHOTOS

public static final java.lang.String METHOD_GET_PUBLIC_PHOTOS

See Also:

Constant Field Values

METHOD_GET_UPLOAD_STATUS

public static final java.lang.String METHOD_GET_UPLOAD_STATUS

See Also:

Constant Field Values

METHOD_GET_PHOTOS

public static final java.lang.String METHOD_GET_PHOTOS

See Also:

Constant Field Values

METHOD_GET_PHOTOS_OF

public static final java.lang.String METHOD_GET_PHOTOS_OF

See Also:

Constant Field Values

METHOD_GET_GROUPS

public static final java.lang.String METHOD_GET_GROUPS

See Also:

Constant Field Values

Constructor Detail

PeopleInterface

public PeopleInterface(java.lang.String apiKey,
               java.lang.String sharedSecret,
               Transport transportAPI)

Method Detail

findByEmail

public User findByEmail(java.lang.String email)
                 throws FlickrException

Find the user by their email address. This method does not require authentication.

Parameters:

email - The email address

Returns:

The User

Throws:

FlickrException

findByUsername

public User findByUsername(java.lang.String username)
                    throws FlickrException

Find a User by the username. This method does not require authentication.

Parameters:

username - The username

Returns:

The User object

Throws:

FlickrException

getInfo

public User getInfo(java.lang.String userId)
             throws FlickrException

Get info about the specified user. This method does not require authentication.

Parameters:

userId - The user ID

Returns:

The User object

Throws:

FlickrException

getPublicGroups

public java.util.Collection<Group> getPublicGroups(java.lang.String userId)
                                            throws FlickrException

Get a collection of public groups for the user. The groups will contain only the members nsid, name, admin and eighteenplus. If you want the whole group-information, you have to call GroupsInterface.getInfo(String). This method does not require authentication.

Parameters:

userId - The user ID

Returns:

The public groups

Throws:

FlickrException

getPublicPhotos

public PhotoList<Photo> getPublicPhotos(java.lang.String userId,
                               int perPage,
                               int page)
                                 throws FlickrException

Throws:

FlickrException

getPublicPhotos

public PhotoList<Photo> getPublicPhotos(java.lang.String userId,
                               java.util.Set<java.lang.String> extras,
                               int perPage,
                               int page)
                                 throws FlickrException

Get a collection of public photos for the specified user ID. This method does not require authentication.

Parameters:

userId - The User ID

extras - Set of extra-attributes to include (may be null)

perPage - The number of photos per page

page - The page offset

Returns:

The PhotoList collection

Throws:

FlickrException

See Also:

Extras

getUploadStatus

public User getUploadStatus()
                     throws FlickrException

Get upload status for the currently authenticated user. Requires authentication with 'read' permission using the new authentication API.

Returns:

A User object with upload status data fields filled

Throws:

FlickrException

getPhotos

public PhotoList<Photo> getPhotos(java.lang.String userId,
                         java.lang.String safeSearch,
                         java.util.Date minUploadDate,
                         java.util.Date maxUploadDate,
                         java.util.Date minTakenDate,
                         java.util.Date maxTakenDate,
                         java.lang.String contentType,
                         java.lang.String privacyFilter,
                         java.util.Set<java.lang.String> extras,
                         int perPage,
                         int page)
                           throws FlickrException

Throws:

FlickrException

getPhotosOf

public PhotoList<Photo> getPhotosOf(java.lang.String userId,
                           java.lang.String ownerId,
                           java.util.Set<java.lang.String> extras,
                           int perPage,
                           int page)
                             throws FlickrException

Throws:

FlickrException

add

public void add(java.lang.String photoId,
       java.lang.String userId,
       java.awt.Rectangle bounds)
         throws FlickrException

Add the given person to the photo. Optionally, send in co-ordinates

Parameters:

photoId -

userId -

bounds -

Throws:

FlickrException

delete

public void delete(java.lang.String photoId,
          java.lang.String userId)
            throws FlickrException

Delete the person from the photo

Parameters:

photoId -

userId -

Throws:

FlickrException

deleteCoords

public void deleteCoords(java.lang.String photoId,
                java.lang.String userId)
                  throws FlickrException

Delete the co-ordinates that the user is shown in

Parameters:

photoId -

userId -

Throws:

FlickrException

editCoords

public void editCoords(java.lang.String photoId,
              java.lang.String userId,
              java.awt.Rectangle bounds)
                throws FlickrException

Edit the co-ordinates that the user shows in

Parameters:

photoId -

userId -

bounds -

Throws:

FlickrException

getList

public UserList<User> getList(java.lang.String photoId)
                       throws FlickrException

Parameters:

photoId -

Throws:

FlickrException

getGroups

public GroupList<Group> getGroups(java.lang.String userId)
                           throws FlickrException

Parameters:

userId -

Throws:

FlickrException