Packagecom.adobe.webapis.flickr.methodgroups
Classpublic class Pools

Contains the methods for the Pools method group in the Flickr API. Even though the events are listed here, they're really broadcast from the FlickrService instance itself to make using the service easier.



Public Methods
 MethodDefined by
  
Construct a new Pools "method group" class
Pools
  
add(photo_id:String, group_id:String):void
Add a photo to a group's pool.
Pools
  
getContext(photo_id:String, group_id:String):void
Returns next and previous photos for a photo in a group pool.
Pools
  
getGroups():void
Returns a list of groups to which you can add photos.
Pools
  
getPhotos(group_id:String, tags:String = "", extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).
Pools
  
remove(photo_id:String, group_id:String):void
Remove a photo from a group pool.
Pools
Events
 EventSummaryDefined by
   Broadcast as a result of the add method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance Pools
   Broadcast as a result of the getContext method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an array of length 2 of Photo instances.Pools
   Broadcast as a result of the getGroups method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Group instances When success is false, contains an "error" FlickrError instance Pools
   Broadcast as a result of the getPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance Pools
   Broadcast as a result of the remove method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance Pools
Constructor detail
Pools()constructor
public function Pools(service:FlickrService)

Construct a new Pools "method group" class

Parameters
service:FlickrService — The FlickrService this method group is associated with.
Method detail
add()method
public function add(photo_id:String, group_id:String):void

Add a photo to a group's pool. This method requires authentication with WRITE permission.

Parameters
photo_id:String — The id of the photo to add to the group pool. The photo must belong to the calling user.
 
group_id:String — The NSID of the group who's pool the photo is to be added to.

See also

getContext()method 
public function getContext(photo_id:String, group_id:String):void

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

Parameters
photo_id:String — The id of the photo to fetch the context for.
 
group_id:String — The NSID of the group who's pool to fetch the photo's context for.

See also

getGroups()method 
public function getGroups():void

Returns a list of groups to which you can add photos. This method requires authentication with READ permission.

See also

getPhotos()method 
public function getPhotos(group_id:String, tags:String = "", extras:String = "", per_page:Number = 100, page:Number = 1):void

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
group_id:String — The id of the group who's pool you which to get the photo list for.
 
tags:String (default = "") — (Optional) A tag to filter the pool with. At the moment only one tag at a time is supported.
 
extras:String (default = "") — (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.
 
per_page:Number (default = 100) — (Optional) Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
 
page:Number (default = 1) — (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

See also

remove()method 
public function remove(photo_id:String, group_id:String):void

Remove a photo from a group pool. This method requires authentication with WRITE permission.

Parameters
photo_id:String — 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.
 
group_id:String — The NSID of the group who's pool the photo is to be removed from.

See also

Event detail
groupsPoolsAddevent 
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the add method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance

See also

add
com.adobe.service.flickr.FlickrError
groupsPoolsGetContextevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the getContext method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an array of length 2 of Photo instances. The first element is the previous photo, the second element is the next photo. When success is false, contains an "error" FlickrError instance

See also

getContext
com.adobe.service.flickr.FlickrError
groupsPoolsGetGroupsevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the getGroups method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Group instances When success is false, contains an "error" FlickrError instance

See also

getGroups
com.adobe.service.flickr.FlickrError
groupsPoolsGetPhotosevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the getPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance

See also

getPhotos
com.adobe.service.flickr.FlickrError
groupsPoolsRemoveevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the remove method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance

See also

remove
com.adobe.service.flickr.FlickrError