com.flickr4java.flickr.galleries

Class GalleriesInterface

java.lang.Object

com.flickr4java.flickr.galleries.GalleriesInterface

public class GalleriesInterface
extends java.lang.Object

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_EDIT_META
static java.lang.String	METHOD_EDIT_PHOTO
static java.lang.String	METHOD_EDIT_PHOTOS
static java.lang.String	METHOD_GET_INFO
static java.lang.String	METHOD_GET_LIST
static java.lang.String	METHOD_GET_LIST_FOR_PHOTO
static java.lang.String	METHOD_GET_PHOTOS

Constructor Summary

Constructors

Constructor and Description
GalleriesInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI) Construct a GalleriesInterface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPhoto(java.lang.String strGalleryId, java.lang.String photoId, java.lang.String strComment)
Gallery	create(java.lang.String strTitle, java.lang.String strDescription, java.lang.String primaryPhotoId)
void	editMeta(java.lang.String strGalleryId, java.lang.String strTitle, java.lang.String strDescription)
void	editPhoto(java.lang.String strGalleryId, java.lang.String strPhotoId, java.lang.String strComment)
void	editPhotos(java.lang.String strGalleryId, java.lang.String strPrimaryPhotoId, java.lang.String strPhotoIds)
Gallery	getInfo(java.lang.String strGalleryId)
java.util.List<Gallery>	getList(java.lang.String userId, int perPage, int page) Return the list of galleries created by a user.
PhotoList<Photo>	getListForPhoto(java.lang.String photoId, int perPage, int page) This method does not require authentication.
PhotoList<Photo>	getPhotos(java.lang.String galleryId, java.util.Set<java.lang.String> extras, int perPage, int page) Get the photos for the specified gallery This method does not require authentication.

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_EDIT_META

public static final java.lang.String METHOD_EDIT_META

See Also:

Constant Field Values

METHOD_EDIT_PHOTO

public static final java.lang.String METHOD_EDIT_PHOTO

See Also:

Constant Field Values

METHOD_EDIT_PHOTOS

public static final java.lang.String METHOD_EDIT_PHOTOS

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_LIST_FOR_PHOTO

public static final java.lang.String METHOD_GET_LIST_FOR_PHOTO

See Also:

Constant Field Values

METHOD_GET_PHOTOS

public static final java.lang.String METHOD_GET_PHOTOS

See Also:

Constant Field Values

Constructor Detail

GalleriesInterface

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

Construct a GalleriesInterface.

Parameters:

apiKey - The API key

transportAPI - The Transport interface

Method Detail

getList

public java.util.List<Gallery> getList(java.lang.String userId,
                              int perPage,
                              int page)
                                throws FlickrException

Return the list of galleries created by a user. Sorted from newest to oldest.

Parameters:

userId - The user you want to check for

perPage - Number of galleries per page

page - The page number

Returns:

gallery

Throws:

FlickrException

See Also:

flickr.galleries.getList

addPhoto

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

Throws:

FlickrException

editMeta

public void editMeta(java.lang.String strGalleryId,
            java.lang.String strTitle,
            java.lang.String strDescription)
              throws FlickrException

Throws:

FlickrException

editPhoto

public void editPhoto(java.lang.String strGalleryId,
             java.lang.String strPhotoId,
             java.lang.String strComment)
               throws FlickrException

Throws:

FlickrException

editPhotos

public void editPhotos(java.lang.String strGalleryId,
              java.lang.String strPrimaryPhotoId,
              java.lang.String strPhotoIds)
                throws FlickrException

Throws:

FlickrException

getInfo

public Gallery getInfo(java.lang.String strGalleryId)
                throws FlickrException

Throws:

FlickrException

create

public Gallery create(java.lang.String strTitle,
             java.lang.String strDescription,
             java.lang.String primaryPhotoId)
               throws FlickrException

Parameters:

strTitle -

strDescription -

primaryPhotoId -

Throws:

FlickrException

getPhotos

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

Get the photos for the specified gallery This method does not require authentication.

Parameters:

galleryId - The group ID

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

perPage - The number of photos per page (0 to ignore)

page - The page offset (0 to ignore)

Returns:

A Collection of Photo objects

Throws:

FlickrException

getListForPhoto

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

This method does not require authentication.

Parameters:

photoId - The photo ID

perPage - The number of photos per page (0 to ignore)

page - The page offset (0 to ignore)

Returns:

A Collection of Photo objects

Throws:

FlickrException