com.flickr4java.flickr.favorites

Class FavoritesInterface

java.lang.Object

com.flickr4java.flickr.favorites.FavoritesInterface

public class FavoritesInterface
extends java.lang.Object

Interface for working with Flickr favorites.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METHOD_ADD
static java.lang.String	METHOD_GET_CONTEXT
static java.lang.String	METHOD_GET_LIST
static java.lang.String	METHOD_GET_PUBLIC_LIST
static java.lang.String	METHOD_REMOVE

Constructor Summary

Constructors

Constructor and Description
FavoritesInterface(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) Add a photo to the user's favorites.
PhotoContext	getContext(java.lang.String photoId, java.lang.String userId) Returns next and previous favorites for a photo in a user's favorites
PhotoList<Photo>	getList(java.lang.String userId, int perPage, int page, java.util.Set<java.lang.String> extras) Get the collection of favorites for the calling user or the specified user ID.
PhotoList<Photo>	getPublicList(java.lang.String userId, int perPage, int page, java.util.Set<java.lang.String> extras) Get the specified user IDs public contacts.
void	remove(java.lang.String photoId) Remove the specified photo from the user's favorites.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ADD

public static final java.lang.String METHOD_ADD

See Also:

Constant Field Values

METHOD_GET_LIST

public static final java.lang.String METHOD_GET_LIST

See Also:

Constant Field Values

METHOD_GET_PUBLIC_LIST

public static final java.lang.String METHOD_GET_PUBLIC_LIST

See Also:

Constant Field Values

METHOD_REMOVE

public static final java.lang.String METHOD_REMOVE

See Also:

Constant Field Values

METHOD_GET_CONTEXT

public static final java.lang.String METHOD_GET_CONTEXT

See Also:

Constant Field Values

Constructor Detail

FavoritesInterface

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

Method Detail

add

public void add(java.lang.String photoId)
         throws FlickrException

Add a photo to the user's favorites.

Parameters:

photoId - The photo ID

Throws:

FlickrException

getList

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

Get the collection of favorites for the calling user or the specified user ID.

Parameters:

userId - The optional user ID. Null value will be ignored.

perPage - The optional per page value. Values <= 0 will be ignored.

page - The page to view. Values <= 0 will be ignored.

extras - a Set Strings representing extra parameters to send

Returns:

The Collection of Photo objects

Throws:

FlickrException

See Also:

Extras

getPublicList

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

Get the specified user IDs public contacts. This method does not require authentication.

Parameters:

userId - The user ID

perPage - The optional per page value. Values <= 0 will be ignored.

page - The optional page to view. Values <= 0 will be ignored

extras - A Set of extra parameters to send

Returns:

A Collection of Photo objects

Throws:

FlickrException

See Also:

Extras

remove

public void remove(java.lang.String photoId)
            throws FlickrException

Remove the specified photo from the user's favorites.

Parameters:

photoId - The photo id

Throws:

FlickrException

getContext

public PhotoContext getContext(java.lang.String photoId,
                      java.lang.String userId)
                        throws FlickrException

Returns next and previous favorites for a photo in a user's favorites

Parameters:

photoId - The photo id

userId - The user's ID

Throws:

FlickrException

See Also:

flickr.favorites.getContext