CFlickr.photosets
Component PhotosetsInterface

AbstractInterface
  |
  +--photosets.PhotosetsInterface

Method Summary
public boolean	addPhoto(string photoset_id, string photo_id) Add a photo to the end of an existing photoset.
public Photoset	create(string title, [string description], string primary_photo_id) Create a new photoset for the calling user.
public void	delete(string photoset_id) Delete a photoset.
public void	editMeta(string photoset_id, string title, [string description]) Modify the meta-data for a photoset.
public void	editPhotos(string photoset_id, string primary_photo_id, string photo_ids) Modify the photos in a photoset. Use this method to add, remove and re-order photos.
public PhotoContext	getContext(string photo_id, string photoset_id) Returns next and previous photos for a photo in a set.
public Photoset	getInfo(string photoset_id) Gets information about a photoset.
public array	getList([string user_id]) Returns the photosets belonging to the specified user.
public Photoset	getPhotos(string photoset_id, [string extras], [numeric privacy_filter], [numeric per_page], [numeric page]) Get the list of photos in a set.
public boolean	orderSets(string photoset_ids) Set the order of photosets for the calling user.
public boolean	removePhoto(string photoset_id, string photo_id) Remove a photo from a photoset.

Methods inherited from AbstractInterface

init

 

Method Detail

addPhoto

public boolean addPhoto(string photoset_id, string photo_id)

Add a photo to the end of an existing photoset.

Parameters:

string photoset_id (Required) - The id of the photoset to add a photo to.

string photo_id (Required) - The id of the photo to add to the set.

create

public CFlickr.photosets.Photoset create(string title, [string description], string primary_photo_id)

Create a new photoset for the calling user.

Parameters:

string title (Required) - A title for the photoset.

string description (Optional) - A description of the photoset. May contain limited html.

string primary_photo_id (Required) - The id of the photo to represent this set. The photo must belong to the calling user.

delete

public void delete(string photoset_id)

Delete a photoset.

Parameters:

string photoset_id (Required) - The id of the photoset to delete. It must be owned by the calling user.

editMeta

public void editMeta(string photoset_id, string title, [string description])

Modify the meta-data for a photoset.

Parameters:

string photoset_id (Required) - The id of the photoset to modify.

string title (Required) - The new title for the photoset.

string description (Optional) - A description of the photoset. May contain limited html.

editPhotos

public void editPhotos(string photoset_id, string primary_photo_id, string photo_ids)

Modify the photos in a photoset. Use this method to add, remove and re-order photos.

Parameters:

string photoset_id (Required) - The id of the photoset to modify.

string primary_photo_id (Required) - The id of the photo to use as the 'primary' photo for the set. This id must also be passed along in photo_ids list argument.

string photo_ids (Required) - A comma-delimited list of photo ids to include in the set. They will appear in the set in the order sent. This list must contain the primary photo id. All photos must belong to the owner of the set. This list of photos replaces the existing list. Call flickr.photosets.addPhoto to append a photo to a set.

getContext

public CFlickr.photos.PhotoContext getContext(string photo_id, string photoset_id)

Returns next and previous photos for a photo in a set.

Parameters:

string photo_id (Required) - The id of the photo to fetch the context for.

string photoset_id (Required) - The id of the photoset for which to fetch the photo's context.

getInfo

public CFlickr.photosets.Photoset getInfo(string photoset_id)

Gets information about a photoset.

Parameters:

string photoset_id (Required) - The ID of the photoset to fetch information for.

getList

public array getList([string user_id])

Returns the photosets belonging to the specified user.

Parameters:

string user_id (Optional) - The NSID of the user to get a photoset list for. If none is specified, the calling user is assumed.

getPhotos

public CFlickr.photosets.Photoset getPhotos(string photoset_id, [string extras], [numeric privacy_filter], [numeric per_page], [numeric page])

Get the list of photos in a set.

Parameters:

string photoset_id (Required) - The id of the photoset to return the photos for.

string extras (Optional) - A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo.

numeric privacy_filter (Optional)

numeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 500. The maximum allowed value is 500.

numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1.

orderSets

public boolean orderSets(string photoset_ids)

Set the order of photosets for the calling user.

Parameters:

string photoset_ids (Required) - A comma delimited list of photoset IDs, ordered with the set to show first, first in the list. Any set IDs not given in the list will be set to appear at the end of the list, ordered by their IDs

removePhoto

public boolean removePhoto(string photoset_id, string photo_id)

Remove a photo from a photoset.

Parameters:

string photoset_id (Required) - The id of the photoset to remove a photo from.

string photo_id (Required) - The id of the photo to remove from the set.