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

Contains the methods for the Notes 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
Notes
  
add(photo_id:String, note_rect:Rectangle, note_text:String):void
Add a note to a photo.
Notes
  
deleteNote(note_id:String):void
Delete a note from a photo.
Notes
  
edit(note_id:String, note_rect:Rectangle, note_text:String):void
Edit a note on a photo.
Notes
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, a PhotoNote instnace When success is false, contains an "error" FlickrError instance Notes
   Broadcast as a result of the deleteNote 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 Notes
   Broadcast as a result of the edit 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 Notes
Constructor detail
Notes()constructor
public function Notes(service:FlickrService)

Construct a new Notes "method group" class

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

Add a note to a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages. This method requires authentication with WRITE permission.

Parameters
photo_id:String — The id of the photo to add a note to
 
note_rect:Rectangle — The Rectangle bounding box (x, y, width, height) for the note
 
note_text:String — The description of the note

See also

deleteNote()method 
public function deleteNote(note_id:String):void

Delete a note from a photo. This method requires authentication with WRITE permission.

Parameters
note_id:String — The id of the note to delete

See also

edit()method 
public function edit(note_id:String, note_rect:Rectangle, note_text:String):void

Edit a note on a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages. This method requires authentication with WRITE permission.

Parameters
note_id:String — The id of the note to edit
 
note_rect:Rectangle — The Rectangle bounding box (x, y, width, height) for the note
 
note_text:String — The description of the note

See also

Event detail
photosNotesAddevent 
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, a PhotoNote instnace When success is false, contains an "error" FlickrError instance

See also

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

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

deleteNote
com.adobe.service.flickr.FlickrError
photosNotesEditevent  
Event object type: com.adobe.webapis.flickr.events.FlickrResultEvent

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

edit
com.adobe.service.flickr.FlickrError