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

Contains the methods for the PhotoSets 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 Notes "method group" class
PhotoSets
  
addPhoto(photoset_id:String, photo_id:String):void
Add a photo to the end of an existing photoset.
PhotoSets
  
create(title:String, description:String, primary_photo_id:String):void
Create a new photoset for the calling user.
PhotoSets
  
deleteSet(photoset_id:String):void
Delete a photoset.
PhotoSets
  
editMeta(photoset_id:String, title:String, description:String = ""):void
Modify the meta-data for a photoset.
PhotoSets
  
editPhotos(photoset_id:String, primary_photo_id:String, photo_ids:Array):void
Modify the photos in a photoset.
PhotoSets
  
getContext(photo_id:String, photoset_id:String):void
Returns next and previous photos for a photo in a set.
PhotoSets
  
getInfo(photoset_id:String):void
Returns next and previous photos for a photo in a set.
PhotoSets
  
getList(user_id:String = ""):void
Returns the photosets belonging to the specified user.
PhotoSets
  
getPhotos(photoset_id:String):void
Get the list of photos in a set.
PhotoSets
  
orderSets(photoset_ids:Array):void
Set the order of photosets for the calling user.
PhotoSets
  
removePhoto(photoset_id:String, photo_id:String):void
Remove a photo from a photoset.
PhotoSets
Events
 EventSummaryDefined by
   Broadcast as a result of the addPhoto 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 PhotoSets
   Broadcast as a result of the create 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 PhotoSet instance When success is false, contains an "error" FlickrError instance PhotoSets
   Broadcast as a result of the deleteSet 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 PhotoSets
   Broadcast as a result of the editMeta 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 PhotoSets
   Broadcast as a result of the editPhotos 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 PhotoSets
   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 Photo instances.PhotoSets
   Broadcast as a result of the getInfo 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 PhotoSet instance When success is false, contains an "error" FlickrError instance PhotoSets
   Broadcast as a result of the getList 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 PhotoSet instnaces When success is false, contains an "error" FlickrError instance PhotoSets
   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 PhotoSet instance When success is false, contains an "error" FlickrError instance PhotoSets
   Broadcast as a result of the orderSets 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 PhotoSets
   Broadcast as a result of the removePhoto 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 PhotoSets
Constructor detail
PhotoSets()constructor
public function PhotoSets(service:FlickrService)

Construct a new Notes "method group" class

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

Add a photo to the end of an existing photoset. This method requires authentication with WRITE permission.

Parameters
photoset_id:String — The id of the photoset to add a photo to.
 
photo_id:String — The id of the photo to add to the set.

See also

create()method 
public function create(title:String, description:String, primary_photo_id:String):void

Create a new photoset for the calling user. This method requires authentication with WRITE permission.

Parameters
title:String — A title for the photoset.
 
description:String — (Optional) A description of the photoset. May contain limited html.
 
primary_photo_id:String — The id of the photo to represent this set. The photo must belong to the calling user.

See also

deleteSet()method 
public function deleteSet(photoset_id:String):void

Delete a photoset. This method requires authentication with WRITE permission.

Parameters
photoset_id:String — The id of the photoset to delete. It must be owned by the calling user.

See also

editMeta()method 
public function editMeta(photoset_id:String, title:String, description:String = ""):void

Modify the meta-data for a photoset. This method requires authentication with WRITE permission.

Parameters
photoset_id:String — The id of the photoset to modify.
 
title:String — The new title for the photoset.
 
description:String (default = "") — (Optional) A description of the photoset. May contain limited html.

See also

editPhotos()method 
public function editPhotos(photoset_id:String, primary_photo_id:String, photo_ids:Array):void

Modify the photos in a photoset. Use this method to add, remove and re-order photos. This method requires authentication with WRITE permission.

Parameters
photoset_id:String — The id of the photoset to modify. The photoset must belong to the calling user.
 
primary_photo_id:String — 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.
 
photo_ids:Array — An array of photo ids (number or string) 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.

See also

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

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

Parameters
photo_id:String — The id of the photo to fetch the context for.
 
photoset_id:String — The id of the photoset for which to fetch the photo's context.

See also

getInfo()method 
public function getInfo(photoset_id:String):void

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

Parameters
photoset_id:String — The ID of the photoset to fetch information for.

See also

getList()method 
public function getList(user_id:String = ""):void

Returns the photosets belonging to the specified user.

Parameters
user_id:String (default = "") — The NSID of the user to get a photoset list for. If none is specified, the calling user is assumed.

See also

getPhotos()method 
public function getPhotos(photoset_id:String):void

Get the list of photos in a set.

Parameters
photoset_id:String — The id of the photoset to return the photos for.

See also

orderSets()method 
public function orderSets(photoset_ids:Array):void

Set the order of photosets for the calling user. This method requires authentication with WRITE permission.

Parameters
photoset_ids:Array — An array of photoset IDs (number or string), 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.

See also

removePhoto()method 
public function removePhoto(photoset_id:String, photo_id:String):void

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

Parameters
photoset_id:String — The id of the photoset to remove a photo from.
 
photo_id:String — The id of the photo to remove from the set.

See also

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

Broadcast as a result of the addPhoto 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

addPhoto
com.adobe.service.flickr.FlickrError
photosetsCreateevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the create 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 PhotoSet instance When success is false, contains an "error" FlickrError instance

See also

create
com.adobe.service.flickr.FlickrError
photosetsDeleteevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the deleteSet 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

deleteSet
com.adobe.service.flickr.FlickrError
photosetsEditMetaevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the editMeta 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

editMeta
com.adobe.service.flickr.FlickrError
photosetsEditPhotosevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the editPhotos 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

editPhotos
com.adobe.service.flickr.FlickrError
photosetsGetContextevent  
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 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
photosetsGetInfoevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the getInfo 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 PhotoSet instance When success is false, contains an "error" FlickrError instance

See also

getInfo
com.adobe.service.flickr.FlickrError
photosetsGetListevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the getList 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 PhotoSet instnaces When success is false, contains an "error" FlickrError instance

See also

getList
com.adobe.service.flickr.FlickrError
photosetsGetPhotosevent  
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 PhotoSet instance When success is false, contains an "error" FlickrError instance

See also

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

Broadcast as a result of the orderSets 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

orderSets
com.adobe.service.flickr.FlickrError
photosetsRemovePhotoevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

Broadcast as a result of the removePhoto 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

removePhoto
com.adobe.service.flickr.FlickrError