com.aetrion.flickr.people
Class PeopleInterface

java.lang.Object
  extended by com.aetrion.flickr.people.PeopleInterface

public class PeopleInterface
extends java.lang.Object

Interface for finding Flickr users.

Version:
$Id: PeopleInterface.java,v 1.26 2009/07/11 20:30:27 x-mago Exp $
Author:
Anthony Eden

Field Summary
static java.lang.String METHOD_FIND_BY_EMAIL
           
static java.lang.String METHOD_FIND_BY_USERNAME
           
static java.lang.String METHOD_GET_INFO
           
static java.lang.String METHOD_GET_ONLINE_LIST
           
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
PeopleInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)
           
 
Method Summary
 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.
 User getInfo(java.lang.String userId)
          Get info about the specified user.
 java.util.Collection getPublicGroups(java.lang.String userId)
          Get a collection of public groups for the user.
 PhotoList getPublicPhotos(java.lang.String userId, int perPage, int page)
           
 PhotoList getPublicPhotos(java.lang.String userId, java.util.Set 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
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 java.io.IOException,
                        org.xml.sax.SAXException,
                        FlickrException
Find the user by their email address. This method does not require authentication.

Parameters:
email - The email address
Returns:
The User
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

findByUsername

public User findByUsername(java.lang.String username)
                    throws java.io.IOException,
                           org.xml.sax.SAXException,
                           FlickrException
Find a User by the username. This method does not require authentication.

Parameters:
username - The username
Returns:
The User object
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getInfo

public User getInfo(java.lang.String userId)
             throws java.io.IOException,
                    org.xml.sax.SAXException,
                    FlickrException
Get info about the specified user. This method does not require authentication.

Parameters:
userId - The user ID
Returns:
The User object
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getPublicGroups

public java.util.Collection getPublicGroups(java.lang.String userId)
                                     throws java.io.IOException,
                                            org.xml.sax.SAXException,
                                            FlickrException
Get a collection of public groups for the user. This method does not require authentication.

Parameters:
userId - The user ID
Returns:
The public groups
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getPublicPhotos

public PhotoList getPublicPhotos(java.lang.String userId,
                                 int perPage,
                                 int page)
                          throws java.io.IOException,
                                 org.xml.sax.SAXException,
                                 FlickrException
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getPublicPhotos

public PhotoList getPublicPhotos(java.lang.String userId,
                                 java.util.Set extras,
                                 int perPage,
                                 int page)
                          throws java.io.IOException,
                                 org.xml.sax.SAXException,
                                 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:
java.io.IOException
org.xml.sax.SAXException
FlickrException
See Also:
Extras

getUploadStatus

public User getUploadStatus()
                     throws java.io.IOException,
                            org.xml.sax.SAXException,
                            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:
java.io.IOException
org.xml.sax.SAXException
FlickrException


Copyright (C) 2005-2008 Aetrion LLC. All Rights Reserved.