com.flickr4java.flickr.photosets

Class PhotosetsInterface

java.lang.Object

com.flickr4java.flickr.photosets.PhotosetsInterface

public class PhotosetsInterface
extends java.lang.Object

Interface for working with photosets.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METHOD_ADD_PHOTO
static java.lang.String	METHOD_CREATE
static java.lang.String	METHOD_DELETE
static java.lang.String	METHOD_EDIT_META
static java.lang.String	METHOD_EDIT_PHOTOS
static java.lang.String	METHOD_GET_CONTEXT
static java.lang.String	METHOD_GET_INFO
static java.lang.String	METHOD_GET_LIST
static java.lang.String	METHOD_GET_PHOTOS
static java.lang.String	METHOD_ORDER_SETS
static java.lang.String	METHOD_REMOVE_PHOTO
static java.lang.String	METHOD_REMOVE_PHOTOS
static java.lang.String	METHOD_REORDER_PHOTOS
static java.lang.String	METHOD_SET_PRIMARY_PHOTO

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addPhoto(java.lang.String photosetId, java.lang.String photoId) Add a photo to the end of the photoset.
Photoset	create(java.lang.String title, java.lang.String description, java.lang.String primaryPhotoId) Create a new photoset.
void	delete(java.lang.String photosetId) Delete the specified photoset.
void	editMeta(java.lang.String photosetId, java.lang.String title, java.lang.String description) Modify the meta-data for a photoset.
void	editPhotos(java.lang.String photosetId, java.lang.String primaryPhotoId, java.lang.String[] photoIds) Edit which photos are in the photoset.
PhotoContext	getContext(java.lang.String photoId, java.lang.String photosetId) Get a photo's context in the specified photo set.
Photoset	getInfo(java.lang.String photosetId) Get the information for a specified photoset.
Photosets	getList(java.lang.String userId) Deprecated.
Photosets	getList(java.lang.String userId, int perPage, int page) Get a list of all photosets for the specified user.
PhotoList<Photo>	getPhotos(java.lang.String photosetId, int perPage, int page) Convenience method.
PhotoList<Photo>	getPhotos(java.lang.String photosetId, java.util.Set<java.lang.String> extras, int privacy_filter, int perPage, int page) Get a collection of Photo objects for the specified Photoset.
int	getPhotosetCount(java.lang.String userId) Convenience method.
void	orderSets(java.lang.String[] photosetIds) Set the order in which sets are returned for the user.
void	removePhoto(java.lang.String photosetId, java.lang.String photoId) Remove a photo from the set.
void	removePhotos(java.lang.String photosetId, java.lang.String photoIds) Remove a photo from the set.
void	reorderPhotos(java.lang.String photosetId, java.lang.String photoIds) Remove a photo from the set.
void	setPrimaryPhoto(java.lang.String photosetId, java.lang.String photoId) Remove a photo from the set.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ADD_PHOTO

public static final java.lang.String METHOD_ADD_PHOTO

See Also:

Constant Field Values

METHOD_CREATE

public static final java.lang.String METHOD_CREATE

See Also:

Constant Field Values

METHOD_DELETE

public static final java.lang.String METHOD_DELETE

See Also:

Constant Field Values

METHOD_EDIT_META

public static final java.lang.String METHOD_EDIT_META

See Also:

Constant Field Values

METHOD_EDIT_PHOTOS

public static final java.lang.String METHOD_EDIT_PHOTOS

See Also:

Constant Field Values

METHOD_GET_CONTEXT

public static final java.lang.String METHOD_GET_CONTEXT

See Also:

Constant Field Values

METHOD_GET_INFO

public static final java.lang.String METHOD_GET_INFO

See Also:

Constant Field Values

METHOD_GET_LIST

public static final java.lang.String METHOD_GET_LIST

See Also:

Constant Field Values

METHOD_GET_PHOTOS

public static final java.lang.String METHOD_GET_PHOTOS

See Also:

Constant Field Values

METHOD_ORDER_SETS

public static final java.lang.String METHOD_ORDER_SETS

See Also:

Constant Field Values

METHOD_REMOVE_PHOTO

public static final java.lang.String METHOD_REMOVE_PHOTO

See Also:

Constant Field Values

METHOD_REMOVE_PHOTOS

public static final java.lang.String METHOD_REMOVE_PHOTOS

See Also:

Constant Field Values

METHOD_REORDER_PHOTOS

public static final java.lang.String METHOD_REORDER_PHOTOS

See Also:

Constant Field Values

METHOD_SET_PRIMARY_PHOTO

public static final java.lang.String METHOD_SET_PRIMARY_PHOTO

See Also:

Constant Field Values

Constructor Detail

PhotosetsInterface

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

Method Detail

addPhoto

public void addPhoto(java.lang.String photosetId,
            java.lang.String photoId)
              throws FlickrException

Add a photo to the end of the photoset.

Note: requires authentication with the new authentication API with 'write' permission.

Parameters:

photosetId - The photoset ID

photoId - The photo ID

Throws:

FlickrException

create

public Photoset create(java.lang.String title,
              java.lang.String description,
              java.lang.String primaryPhotoId)
                throws FlickrException

Create a new photoset.

Parameters:

title - The photoset title

description - The photoset description

primaryPhotoId - The primary photo id

Returns:

The new Photset

Throws:

FlickrException

delete

public void delete(java.lang.String photosetId)
            throws FlickrException

Delete the specified photoset.

Parameters:

photosetId - The photoset ID

Throws:

FlickrException

editMeta

public void editMeta(java.lang.String photosetId,
            java.lang.String title,
            java.lang.String description)
              throws FlickrException

Modify the meta-data for a photoset.

Parameters:

photosetId - The photoset ID

title - A new title

description - A new description (can be null)

Throws:

FlickrException

editPhotos

public void editPhotos(java.lang.String photosetId,
              java.lang.String primaryPhotoId,
              java.lang.String[] photoIds)
                throws FlickrException

Edit which photos are in the photoset.

Parameters:

photosetId - The photoset ID

primaryPhotoId - The primary photo Id

photoIds - The photo IDs for the photos in the set

Throws:

FlickrException

getContext

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

Get a photo's context in the specified photo set. This method does not require authentication.

Parameters:

photoId - The photo ID

photosetId - The photoset ID

Returns:

The PhotoContext

Throws:

FlickrException

getInfo

public Photoset getInfo(java.lang.String photosetId)
                 throws FlickrException

Get the information for a specified photoset. This method does not require authentication.

Parameters:

photosetId - The photoset ID

Returns:

The Photoset

Throws:

FlickrException

getList

@Deprecated
public Photosets getList(java.lang.String userId)
                  throws FlickrException

Deprecated.

Get a list of all photosets for the specified user. This method does not require authentication. But to get a Photoset into the list, that contains just private photos, the call needs to be authenticated.

Parameters:

userId - The User id

Returns:

The Photosets collection

Throws:

FlickrException

getList

public Photosets getList(java.lang.String userId,
                int perPage,
                int page)
                  throws FlickrException

Get a list of all photosets for the specified user. This method does not require authentication. But to get a Photoset into the list, that contains just private photos, the call needs to be authenticated.

Parameters:

userId - The User id

perPage - The number of photosets per page

page - The page offset

Returns:

The Photosets collection

Throws:

FlickrException

getPhotosetCount

public int getPhotosetCount(java.lang.String userId)
                     throws FlickrException

Convenience method. Get the total number of sets belonging to a user

Parameters:

userId - The User id

Returns:

int The number of photosets

Throws:

FlickrException

getPhotos

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

Get a collection of Photo objects for the specified Photoset. This method does not require authentication.

Parameters:

photosetId - The photoset ID

extras - Set of extra-fields

privacy_filter - filter value for authenticated calls

perPage - The number of photos per page

page - The page offset

Returns:

PhotoList The Collection of Photo objects

Throws:

FlickrException

See Also:

Extras, Flickr.PRIVACY_LEVEL_NO_FILTER, Flickr.PRIVACY_LEVEL_PUBLIC, Flickr.PRIVACY_LEVEL_FRIENDS, Flickr.PRIVACY_LEVEL_FRIENDS_FAMILY, Flickr.PRIVACY_LEVEL_FAMILY, Flickr.PRIVACY_LEVEL_FRIENDS

getPhotos

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

Convenience method. Calls getPhotos() with Extras.MIN_EXTRAS and Flickr.PRIVACY_LEVEL_NO_FILTER. This method does not require authentication.

Parameters:

photosetId - The photoset ID

perPage - The number of photos per page

page - The page offset

Returns:

PhotoList The Collection of Photo objects

Throws:

FlickrException

See Also:

Extras, Flickr.PRIVACY_LEVEL_NO_FILTER, Flickr.PRIVACY_LEVEL_PUBLIC, Flickr.PRIVACY_LEVEL_FRIENDS, Flickr.PRIVACY_LEVEL_FRIENDS_FAMILY, Flickr.PRIVACY_LEVEL_FAMILY, Flickr.PRIVACY_LEVEL_FRIENDS

orderSets

public void orderSets(java.lang.String[] photosetIds)
               throws FlickrException

Set the order in which sets are returned for the user. This method requires authentication with 'write' permission.

Parameters:

photosetIds - An array of Ids

Throws:

FlickrException

removePhoto

public void removePhoto(java.lang.String photosetId,
               java.lang.String photoId)
                 throws FlickrException

Remove a photo from the set.

Parameters:

photosetId - The photoset ID

photoId - The photo ID

Throws:

FlickrException

removePhotos

public void removePhotos(java.lang.String photosetId,
                java.lang.String photoIds)
                  throws FlickrException

Remove a photo from the set.

Parameters:

photosetId - The photoset ID

photoIds - The ID's of the photos, in CVS format

Throws:

FlickrException

reorderPhotos

public void reorderPhotos(java.lang.String photosetId,
                 java.lang.String photoIds)
                   throws FlickrException

Remove a photo from the set.

Parameters:

photosetId - The photoset ID

photoIds - The ID's of the photos, in CSV format, in the order they need to be in.

Throws:

FlickrException

setPrimaryPhoto

public void setPrimaryPhoto(java.lang.String photosetId,
                   java.lang.String photoId)
                     throws FlickrException

Remove a photo from the set.

Parameters:

photosetId - The photoset ID

photoId - The photo ID that is being added

Throws:

FlickrException