CFlickr.groups.pools
Component PoolsInterface

AbstractInterface
  |
  +--groups.pools.PoolsInterface

Method Summary
public boolean	add(string photo_id, string group_id) Add a photo to a group's pool.
public PhotoContext	getContext(string photo_id, string group_id) Returns next and previous photos for a photo in a group pool.
public GroupList	getGroups([numeric page], [numeric per_page]) Returns a list of groups to which you can add photos.
public PhotoList	getPhotos(string group_id, [string tags], [string user_id], [string extras], [numeric per_page], [numeric page]) Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).
public boolean	remove(string photo_id, string group_id) Remove a photo from a group pool.

Methods inherited from AbstractInterface

init

 

Method Detail

add

public boolean add(string photo_id, string group_id)

Add a photo to a group's pool.

Parameters:

string photo_id (Required) - The id of the photo to add to the group pool. The photo must belong to the calling user.

string group_id (Required) - The NSID of the group who's pool the photo is to be added to.

getContext

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

Returns next and previous photos for a photo in a group pool.

Parameters:

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

string group_id (Required) - The nsid of the group who's pool to fetch the photo's context for.

getGroups

public CFlickr.groups.GroupList getGroups([numeric page], [numeric per_page])

Returns a list of groups to which you can add photos.

Parameters:

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

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

getPhotos

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

Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).

Parameters:

string group_id (Required) - The id of the group who's pool you which to get the photo list for

string tags (Optional) - A tag to filter the pool with. At the moment only one tag at a time is supported

string user_id (Optional) - The nsid of a user. Specifiying this parameter will retrieve for you only those photos that the user has contributed to the group pool

string extras (Optional) - List, any of: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update

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, string group_id)

Remove a photo from a group pool.

Parameters:

string photo_id (Required) - The id of the photo to remove from the group pool. The photo must either be owned by the calling user of the calling user must be an administrator of the group.

string group_id (Required) - The NSID of the group who's pool the photo is to removed from.