CFlickr.favorites
Component FavoritesInterface

AbstractInterface
  |
  +--favorites.FavoritesInterface

Method Summary
public boolean	add(string photo_id) Adds a photo to a user's favorites list.
public PhotoList	getList([string user_id], [string extras], [numeric per_page], [numeric page]) Returns a list of the user's favorite photos. Only photos which the calling user has permission to see are returned.
public PhotoList	getPublicList(string user_id, [string extras], [numeric per_page], [numeric page]) Returns a list of favorite public photos for the given user.
public boolean	remove(string photo_id) Removes a photo from a user's favorites list.

Methods inherited from AbstractInterface

init

 

Method Detail

add

public boolean add(string photo_id)

Adds a photo to a user's favorites list.

Parameters:

string photo_id (Required) - The id of the photo to add to the user's favorites.

getList

public CFlickr.photos.PhotoList getList([string user_id], [string extras], [numeric per_page], [numeric page])

Returns a list of the user's favorite photos. Only photos which the calling user has permission to see are returned.

Parameters:

string user_id (Optional) - The NSID of the user to fetch the favorites list for. If this argument is omitted, the favorites list for the calling user is returned.

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 per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

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

getPublicList

public CFlickr.photos.PhotoList getPublicList(string user_id, [string extras], [numeric per_page], [numeric page])

Returns a list of favorite public photos for the given user.

Parameters:

string user_id (Required) - The NSID of the user to fetch the favorites list for. If this argument is omitted, the favorites list for the calling user is returned.

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 per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

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

remove

public boolean remove(string photo_id)

Removes a photo from a user's favorites list.

Parameters:

string photo_id (Required) - The id of the photo to remove from the user's favorites.