com
Index

com. kelvinluck. flickr. FlickrResponseListener

Class to define a listener for responses from the FlickrAPI.

Subclass this class or override the methods you are interested in and use Flickr.addListener...  The methods as they exist in this class just output debugging information and exist kind of like an interface to specify the callbacks from Flickr.callMethod and the variables available to them.

This code is licensed under a Creative Commons License.  http://creativecommons.org/licenses/by-nc-sa/2.0/

See Also

Flickr

Flickr.callMethod

http://www.flickr.com/services/api/

Version

0.3.0

Author

Kelvin Luck < kelvin at kelvinluck dot com >

Project Website

http://kelvinluck.com- /projects- /flashr-a-flickr-api-wrapper-for-flash

Summary
com. kelvinluck. flickr. FlickrResponseListener
Class to define a listener for responses from the FlickrAPI.
supressOutput
Used internally to control whether info messages are logged.
setSuppressOutput
Use if you don’t want this instance to log it’s messages.
onAuthGetFrob
Called when there is a successful response from a call to flickr.auth.getFrob
onAuthCheckToken
Called when there is a successful response from a call to flickr.auth.getToken or flickr.auth.checkToken.
onContactsGetList
Called when there is a response from a call to flickr.contacts.getList.
onContactsGetPublicList
Called when there is a response from a call to flickr.contacts.getPublicList.
onFavoritesAdd
Called when there is a response from a call to flickr.favorites.add.
onFavoritesGetList
Called when there is a response from a call to flickr.favorites.getList.
onFavoritesGetPublicList
Called when there is a response from a call to flickr.favorites.getPublicList.
onFavoritesRemove
Called when there is a response from a call to flickr.favorites.remove.
onGroupsPoolsAdd
Called when there is a response from a call to flickr.groups.pools.add
onGroupsPoolsGetContext
Called when there is a response from a call to flickr.groups.pools.getContext
onGroupsPoolsGetGroups
Called when there is a response from a call to flickr.groups.pools.getGroups
onGroupsPoolsGetPhotos
Called when there is a response from a call to flickr.groups.pools.getPhotos
onGroupsPoolsRemove
Called when there is a response from a call to flickr.groups.pools.remove
onPeopleFindByEmail
Called when there is a response from a call to flickr.people.findByEmail.
onPeopleFindByUsername
Called when there is a response from a call to flickr.people.findByUsername.
onPeopleGetInfo
Called when there is a response from a call to flickr.people.getInfo.
onPeopleGetPublicGroups
Called when there is a response from a call to flickr.people.getPublicGroups.
onPeopleGetPublicPhotos
Called when there is a response from a call to flickr.people.getPublicPhotos.
onPeopleGetUploadStatus
Called when there is a response from a call to flickr.people.getUploadStatus.
onPhotosAddTags
Called when there is a response from a call to flickr.photos.addTags.
onPhotosGetAllContexts
Called when there is a response from a call to flickr.people.getAllContexts.
onPhotosGetContactsPhotos
Called when there is a response from a call to flickr.people.getContactsPhotos.
onPhotosGetContactsPublicPhotos
Called when there is a response from a call to flickr.people.getContactsPhotos.
onPhotosGetContext
Called when there is a response from a call to flickr.people.getContext.
onPhotosGetCounts
Called when there is a response from a call to flickr.people.getCounts.
onPhotosGetExif
Called when there is a response from a call to flickr.people.getExif.
onPhotosGetInfo
Called when there is a response from a call to flickr.people.getInfo.
onPhotosGetNotInSet
Called when there is a response from a call to flickr.people.getPhotosNotInSet.
onPhotosGetPerms
Called when there is a response from a call to flickr.people.getPerms.
onPhotosGetRecent
Called when there is a response from a call to flickr.people.getRecent.
onPhotosGetSizes
Called when there is a response from a call to flickr.people.getSizes.
onPhotosGetUntagged
Called when there is a response from a call to flickr.people.getUntagged.
onPhotosRemoveTag
Called when there is a response from a call to flickr.people.removeTag.
onPhotosSearch
Called when there is a response from a call to flickr.people.search.
onPhotosSetDates
Called when there is a response from a call to flickr.people.setDates.
onPhotosSetMeta
Called when there is a response from a call to flickr.people.setMeta.
onPhotosSetPerms
Called when there is a response from a call to flickr.people.setPerms.
onPhotosSetTags
Called when there is a response from a call to flickr.people.setTags.
onPhotosetsAddPhoto
Called when there is a response from a call to flickr.photosets.addPhoto
onPhotosetsCreate
Called when there is a response from a call to flickr.photosets.create
onPhotosetsDelete
Called when there is a response from a call to flickr.photosets.delete
onPhotosetsEditMeta
Called when there is a response from a call to flickr.photosets.editMeta
onPhotosetsEditPhotos
Called when there is a response from a call to flickr.photosets.editPhotos
onPhotosetsGetContext
Called when there is a response from a call to flickr.photosets.getContext
onPhotosetsGetInfo
Called when there is a response from a call to flickr.photosets.getInfo
onPhotosetsGetList
Called when there is a response from a call to flickr.photosets.getList
onPhotosetsGetPhotos
Called when there is a response from a call to flickr.photosets.getPhotos
onPhotosetsOrderSets
Called when there is a response from a call to flickr.photosets.orderSets
onPhotosetsRemovePhoto
Called when there is a response from a call to flickr.photosets.removePhoto
onTagsGetListPhoto
Called when there is a response from a call to flickr.tags.tagsGetListPhoto.
onTagsGetListUser
Called when there is a response from a call to flickr.tags.getListUser.
onTagsGetListUserPopular
Called when there is a response from a call to flickr.tags.getListUserPopular.
onTagsGetRelated
Called when there is a response from a call to flickr.tags.tagsGetRelated.
onTestEcho
Called when there is a response from a call to flickr.test.echo.
onTestLogin
Called when there is a response from a call to flickr.test.login
onError
Called when the Flickr API returns an error code..
onAPIResponse
Internal function which deals with a response from a Flickr API call and forwards any relevant arguments to the relevant function.

supressOutput

private var supressOutput: Boolean

Used internally to control whether info messages are logged.

See Also

setSuppressOutput

setSuppressOutput

function setSuppressOutput(supressOutput: Boolean):Void

Use if you don’t want this instance to log it’s messages.

You may want to do this if you have multipule FlickrResponseListeners in one movie (e.g. one for auth stuff and one for other calls) or in a production environment.

See Also

supressOutput

onAuthGetFrob

public function onAuthGetFrob(frob)

Called when there is a successful response from a call to flickr.auth.getFrob

Note that you only need to use this and Flickr.authGetFrob if you have opted not to use Flickr.authLogin for some reason.

Parameters

froba frob to be used during authentication.

See Also

Flickr.authLogin

Flickr.authGetFrob

http://flickr.com- /services- /api- /flickr.auth.getFrob.html

onAuthCheckToken

public function onAuthCheckToken(token)

Called when there is a successful response from a call to flickr.auth.getToken or flickr.auth.checkToken.

The token is returned so that you can save it so that you can authenticate against flickr at a later date without prompting the user again.

Parameters

tokenthe auth token.

See Also

Flickr.authLogin

Flickr.authCheckToken

http://www.flickr.com- /services- /api- /flickr.auth.getToken.html

http://www.flickr.com- /services- /api- /flickr.auth.checkToken.html

onContactsGetList

function onContactsGetList(user: Person,
filter: String)

Called when there is a response from a call to flickr.contacts.getList.  Override this method in your application if you want to do something with the response to this call.

Parameters

contactsThe Person whose contacts you collected.  Use Person.getPublicContacts to see their contacts.
filterThe filter that was used on the call to Flickr.contactsGetList or undefined if no filter was used.

See Also

Flickr.contactsGetList

http://flickr.com- /services- /api- /flickr.contacts.getList.html

onContactsGetPublicList

function onContactsGetPublicList(user: Person)

Called when there is a response from a call to flickr.contacts.getPublicList.  Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person object whose contacts you got.  Use Person.getPublicContacts to retrieve the list of contacts.

See Also

Flickr.contactsGetPublicList

Person.getPublicContacts

http://flickr.com- /services- /api- /flickr.contacts.getPublicList.html

onFavoritesAdd

function onFavoritesAdd(photo: Photo)

Called when there is a response from a call to flickr.favorites.add.  Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe photo which has just been successfully added to the auth’duser’s favorites.

See Also

Flickr.favoritesAdd

http://www.flickr.com- /services- /api- /flickr.favorites.add.html

onFavoritesGetList

function onFavoritesGetList(user: Person)

Called when there is a response from a call to flickr.favorites.getList.  Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person whose favourites we got.  You see get their favorites using Person.getFavorites.

See Also

Flickr.favoritesGetList

Person.getFavorites

http://www.flickr.com- /services- /api- /flickr.favorites.getList.html

onFavoritesGetPublicList

function onFavoritesGetPublicList(user: Person)

Called when there is a response from a call to flickr.favorites.getPublicList.  Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person whose favourites we got.  You can get their favorites using Person.getFavorites.

See Also

Flickr.favoritesGetPublicList

Person.getFavorites

http://www.flickr.com- /services- /api- /flickr.favorites.getPublicList.html

onFavoritesRemove

function onFavoritesRemove(photo: Photo)

Called when there is a response from a call to flickr.favorites.remove.  Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe photo which has just been successfully removed from the auth’d user’s favorites.

See Also

Flickr.favoritesRemove

http://www.flickr.com- /services- /api- /flickr.favorites.remove.html

onGroupsPoolsAdd

function onGroupsPoolsAdd(photo: Photo,
group: Group)

Called when there is a response from a call to flickr.groups.pools.add

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo you have just added to a Group.
groupThe Group you have just added the Photo to.

See Also

Flickr.groupsPoolsAdd

http://flickr.com- /services- /api- /flickr.groups.pools.add.html

onGroupsPoolsGetContext

function onGroupsPoolsGetContext(photo: Photo,
group: Group)

Called when there is a response from a call to flickr.groups.pools.getContext

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo you have just got the context for.
groupThe Group you have just got the context in

See Also

Flickr.groupsPoolsGetContext

Photo.contextGroupPools

http://flickr.com- /services- /api- /flickr.groups.pools.getContext.html

onGroupsPoolsGetGroups

function onGroupsPoolsGetGroups(user: Person)

Called when there is a response from a call to flickr.groups.pools.getGroups

Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person you have just got the Groups for.

See Also

Flickr.groupsPoolsGetGroups

Person.getGroups

http://flickr.com- /services- /api- /flickr.groups.pools.getGroups.html

onGroupsPoolsGetPhotos

function onGroupsPoolsGetPhotos(group: Group)

Called when there is a response from a call to flickr.groups.pools.getPhotos

Override this method in your application if you want to do something with the response to this call.

Parameters

groupThe Group you have just got the Photos for.

See Also

Flickr.groupsPoolsGetPhotos

Group.getPhotos

http://flickr.com- /services- /api- /flickr.groups.pools.getPhotos.html

onGroupsPoolsRemove

function onGroupsPoolsRemove(photo: Photo,
group: Group)

Called when there is a response from a call to flickr.groups.pools.remove

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo you have just added to a Group.
groupThe Group you have just added the Photo to.

See Also

Flickr.groupsPoolsAdd

http://flickr.com- /services- /api- /flickr.groups.pools.remove.html

onPeopleFindByEmail

function onPeopleFindByEmail(person: Person)

Called when there is a response from a call to flickr.people.findByEmail.

Override this method in your application if you want to do something with the response to this call.

Parameters

personA Person object containing information about the person you found.

See Also

Flickr.peopleFindByEmail

http://flickr.com- /services- /api- /flickr.people.findByEmail.html

onPeopleFindByUsername

function onPeopleFindByUsername(person: Person)

Called when there is a response from a call to flickr.people.findByUsername.

Override this method in your application if you want to do something with the response to this call.

Parameters

personA Person object containing information about the person you found

See Also

Flickr.peopleFindByUsername

http://flickr.com- /services- /api- /flickr.people.findByUsername.html

onPeopleGetInfo

function onPeopleGetInfo(person: Person)

Called when there is a response from a call to flickr.people.getInfo.

Override this method in your application if you want to do something with the response to this call.

Parameters

personA Person object containing information about the person you found (nsid, isAdmin, isPro, username, realname, location, photosFirstDateTaken, photosFirstDate and numPhotos).

See Also

Flickr.peopleGetInfo

http://flickr.com- /services- /api- /flickr.people.getInfo.html

onPeopleGetPublicGroups

function onPeopleGetPublicGroups(person: Person)

Called when there is a response from a call to flickr.people.getPublicGroups.

Override this method in your application if you want to do something with the response to this call.

Parameters

personA Person object representing the person whose groups you wanted info on

See Also

Flickr.peopleGetPublicGroups

Person.getGroups

http://flickr.com- /services- /api- /flickr.people.getPublicGroups.html

onPeopleGetPublicPhotos

function onPeopleGetPublicPhotos(person: Person)

Called when there is a response from a call to flickr.people.getPublicPhotos.

Override this method in your application if you want to do something with the response to this call.

Parameters

personThe Person whose public photos you have got.

See Also

Flickr.peopleGetPublicPhotos

Person._photos

http://flickr.com- /services- /api- /flickr.people.getPublicPhotos.html

onPeopleGetUploadStatus

function onPeopleGetUploadStatus(person: Person)

Called when there is a response from a call to flickr.people.getUploadStatus.

Override this method in your application if you want to do something with the response to this call.

Parameters

personThe Person whose upload status you have got (e.g. the currently auth’d user).

See Also

Flickr.peopleGetUploadStatus

Person.bandwidthMax

Person.bandwidthUsed

Person.filesizeMax

http://flickr.com- /services- /api- /flickr.people.getUploadStatus.html

onPhotosAddTags

function onPhotosAddTags(photo: Photo,
tags: String)

Called when there is a response from a call to flickr.photos.addTags.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo that the tags were added to.
tagsThe tags that were added.

See Also

Flickr.photosAddTags

http://www.flickr.com- /services- /api- /flickr.photos.addTags.html

onPhotosGetAllContexts

function onPhotosGetAllContexts(photo: Photo)

Called when there is a response from a call to flickr.people.getAllContexts.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose contexts you have just got

See Also

Photo.getPhotosets

<Photo.getGroupPools> TODO: implement this!

http://flickr.com- /services- /api- /flickr.photos.getAllContexts.html

onPhotosGetContactsPhotos

function onPhotosGetContactsPhotos(photos: Array)

Called when there is a response from a call to flickr.people.getContactsPhotos.

Override this method in your application if you want to do something with the response to this call.

Note that Flickr.getFlickr().authUser will point to the auth’d user and any contacts that photos were found for whill have been added to that Persons contact list.

Parameters

photosAn array of Photo objects - one for each photo by a contact of the calling user

See Also

Flickr.photosGetContactsPhotos

http://flickr.com- /services- /api- /flickr.photos.getContactsPhotos.html

onPhotosGetContactsPublicPhotos

function onPhotosGetContactsPublicPhotos(person: Person,
photos: Array)

Called when there is a response from a call to flickr.people.getContactsPhotos.

Override this method in your application if you want to do something with the response to this call.

Parameters

personThe Person whose contacts public photos you requested
photosAn array of Photo objects - one for each photo by a contact of the calling user

See Also

Flickr.photosGetContactsPublicPhotos

http://flickr.com- /services- /api- /flickr.photos.getContactsPublicPhotos.html

onPhotosGetContext

function onPhotosGetContext(photo: Photo)

Called when there is a response from a call to flickr.people.getContext.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo we were getting the context for.  The values of context* will be set in it and will point to the relevant other Photo objects

See Also

Flickr.photosGetContext

http://flickr.com- /services- /api- /flickr.photos.getContext.html

onPhotosGetCounts

function onPhotosGetCounts(counts: Array)

Called when there is a response from a call to flickr.people.getCounts.

Override this method in your application if you want to do something with the response to this call.

Parameters

countsAn array containing objects for each date range getCounts was called on Each object contains the following attributes: count, fromdate and todate

See Also

Flickr.photosGetCounts

http://www.flickr.com- /services- /api- /flickr.photos.getCounts.html

onPhotosGetExif

function onPhotosGetExif(photo: Photo)

Called when there is a response from a call to flickr.people.getExif.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoA Photo containing all the information loaded from flickr.com

See Also

Flickr.photosGetExif

http://www.flickr.com- /services- /api- /flickr.photos.getExif.html

onPhotosGetInfo

function onPhotosGetInfo(photo: Photo)

Called when there is a response from a call to flickr.people.getInfo.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoA Photo containing all the information loaded from flickr.com

See Also

Flickr.photosGetInfo

http://www.flickr.com- /services- /api- /flickr.photos.getInfo.html

onPhotosGetNotInSet

function onPhotosGetNotInSet(photos: Array)

Called when there is a response from a call to flickr.people.getPhotosNotInSet.

Override this method in your application if you want to do something with the response to this call.

Parameters

photosAn Array of Photo’s.

See Also

Flickr.photosGetNotInSet

http://www.flickr.com- /services- /api- /flickr.photos.getNotInSet.html

onPhotosGetPerms

function onPhotosGetPerms(photo: Array)

Called when there is a response from a call to flickr.people.getPerms.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo that you just got permissions for.

TODO

Need to actually do something with the permissions that were returned.  At the moment they are ignored as I need to figure out how to store permissions which are a combination of Person and Photo - and so can’t just be stored on a Photo.

See Also

Flickr.photosGetPerms

http://www.flickr.com- /services- /api- /flickr.photos.getPerms.html

onPhotosGetRecent

function onPhotosGetRecent(photos: Array)

Called when there is a response from a call to flickr.people.getRecent.

Override this method in your application if you want to do something with the response to this call.

Parameters

photosAn Array of Photo’s.

See Also

Flickr.photosGetNotInSet

http://www.flickr.com- /services- /api- /flickr.photos.getRecent.html

onPhotosGetSizes

function onPhotosGetSizes(photo: Photo)

Called when there is a response from a call to flickr.people.getSizes.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose sizes you got.

See Also

Flickr.photosGetSizes

Photo._sizes

PhotoSize

http://www.flickr.com- /services- /api- /flickr.photos.getSizes.html

onPhotosGetUntagged

function onPhotosGetUntagged(photos: Array)

Called when there is a response from a call to flickr.people.getUntagged.

Override this method in your application if you want to do something with the response to this call.

Parameters

photosAn Array of Photo’s.

See Also

Flickr.photosGetUntagged

http://www.flickr.com- /services- /api- /flickr.photos.getUntagged.html

onPhotosRemoveTag

function onPhotosRemoveTag(tagId: Number)

Called when there is a response from a call to flickr.people.removeTag.

Override this method in your application if you want to do something with the response to this call.

Note that Flickr.getFlickr().authUser will point to the auth’d user who is obviously the person who removed the Tag if you are interested in that.

Parameters

tagIdThe ID of the Tag that was removed.  This identifies a Tag and a Photo it was associated with...

See Also

Flickr.photosRemoveTag

http://www.flickr.com- /services- /api- /flickr.photos.removeTag.html

onPhotosSearch

function onPhotosSearch(photos: Array)

Called when there is a response from a call to flickr.people.search.

Override this method in your application if you want to do something with the response to this call.

Parameters

photosAn Array of Photo’s.

See Also

Flickr.photosSearch

http://www.flickr.com- /services- /api- /flickr.photos.search.html

onPhotosSetDates

function onPhotosSetDates(photo: Photo)

Called when there is a response from a call to flickr.people.setDates.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose dates have just been updated,

See Also

Flickr.photosSetDates

http://www.flickr.com- /services- /api- /flickr.photos.setDates.html

onPhotosSetMeta

function onPhotosSetMeta(photo: Photo)

Called when there is a response from a call to flickr.people.setMeta.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose meta info has just been updated,

See Also

Flickr.photosSetMeta

http://www.flickr.com- /services- /api- /flickr.photos.setMeta.html

onPhotosSetPerms

function onPhotosSetPerms(photo: Photo)

Called when there is a response from a call to flickr.people.setPerms.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose permissions info has just been updated,

See Also

Flickr.photosSetMeta

http://www.flickr.com- /services- /api- /flickr.photos.setPerms.html

onPhotosSetTags

function onPhotosSetTags(photo: Photo)

Called when there is a response from a call to flickr.people.setTags.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose tags have just been updated,

See Also

Flickr.photosSetTags

http://www.flickr.com- /services- /api- /flickr.photos.setTags.html

onPhotosetsAddPhoto

function onPhotosetsAddPhoto(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.addPhoto

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe photoset the photo was added to.  The added photo will be the last one in <photoset.photos>

See Also

Flickr.photosetsAddPhoto

http://www.flickr.com- /services- /api- /flickr.photosets.addPhoto.html

onPhotosetsCreate

function onPhotosetsCreate(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.create

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe newly created Photoset

See Also

Flickr.photosetsCreate

http://www.flickr.com- /services- /api- /flickr.photosets.create.html

onPhotosetsDelete

function onPhotosetsDelete(photosetId: Number)

Called when there is a response from a call to flickr.photosets.delete

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetIdThe id of the deleted photoset

See Also

Flickr.photosetsDelete

http://www.flickr.com- /services- /api- /flickr.photosets.delete.html

onPhotosetsEditMeta

function onPhotosetsEditMeta(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.editMeta

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe Photoset that you have just updated the meta info for...

See Also

Flickr.photosetsEditMeta

http://www.flickr.com- /services- /api- /flickr.photosets.editMeta.html

onPhotosetsEditPhotos

function onPhotosetsEditPhotos(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.editPhotos

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe Photoset that you have just updated the photos for...

See Also

Flickr.photosetsEditPhotos

http://www.flickr.com- /services- /api- /flickr.photosets.editPhotos.html

onPhotosetsGetContext

function onPhotosetsGetContext(photo: Photo,
photoset: Photoset)

Called when there is a response from a call to flickr.photosets.getContext

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo that you have just got the context of.
photosetThe Photoset you got the context in.

See Also

Flickr.photosetsGetContext

Photo.contextPhotosets

http://www.flickr.com- /services- /api- /flickr.photosets.getContext.html

onPhotosetsGetInfo

function onPhotosetsGetInfo(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.getInfo

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe Photoset that you have just got info for...

See Also

Flickr.photosetsEditPhotos

http://www.flickr.com- /services- /api- /flickr.photosets.getInfo.html

onPhotosetsGetList

function onPhotosetsGetList(user: Person)

Called when there is a response from a call to flickr.photosets.getList

Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person whose Photosets you have just retrieved.

See Also

Flickr.photosetsGetList

Person.getPhotosets

http://www.flickr.com- /services- /api- /flickr.photosets.getList.html

onPhotosetsGetPhotos

function onPhotosetsGetPhotos(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.getPhotos

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe Photoset whose Photos you have just retrieved.

See Also

Flickr.photosetsGetPhotos

Photoset.getPhotos

http://www.flickr.com- /services- /api- /flickr.photosets.getPhotos.html

onPhotosetsOrderSets

function onPhotosetsOrderSets(user: Person)

Called when there is a response from a call to flickr.photosets.orderSets

Override this method in your application if you want to do something with the response to this call.

Parameters

userThe Person whose Photos you have just ordered (i.e. you!)

See Also

<Flickr.photosetsOrderSets>

Person.getPhotosets

http://www.flickr.com- /services- /api- /flickr.photosets.orderSets.html

onPhotosetsRemovePhoto

function onPhotosetsRemovePhoto(photoset: Photoset)

Called when there is a response from a call to flickr.photosets.removePhoto

Override this method in your application if you want to do something with the response to this call.

Parameters

photosetThe Photoset you have just removed a Photo from

See Also

Flickr.photosetsRemovePhoto

http://www.flickr.com- /services- /api- /flickr.photosets.removePhoto.html

onTagsGetListPhoto

function onTagsGetListPhoto(photo: Photo)

Called when there is a response from a call to flickr.tags.tagsGetListPhoto.

Override this method in your application if you want to do something with the response to this call.

Parameters

photoThe Photo whose tags are being returned.  Use Photo.getTags to get at the tags themselves...

See Also

Flickr.tagsGetListPhoto

Photo.getTags

http://www.flickr.com- /services- /api- /flickr.tags.getListPhoto.html

onTagsGetListUser

function onTagsGetListUser(person: Person)

Called when there is a response from a call to flickr.tags.getListUser.

Override this method in your application if you want to do something with the response to this call.

Parameters

personThe Person whose tags are being returned.

See Also

Flickr.tagsGetListUser

http://www.flickr.com- /services- /api- /flickr.tags.getListUser.html

onTagsGetListUserPopular

function onTagsGetListUserPopular(person: Person)

Called when there is a response from a call to flickr.tags.getListUserPopular.

Override this method in your application if you want to do something with the response to this call.

Parameters

personThe Person whose tags are being returned.

See Also

Flickr.tagsGetListUserPopular

http://www.flickr.com- /services- /api- /flickr.tags.getListUserPopular.html

onTagsGetRelated

function onTagsGetRelated(sourceTag: Tag)

Called when there is a response from a call to flickr.tags.tagsGetRelated.

Override this method in your application if you want to do something with the response to this call.

Parameters

sourceTagThe tag you were getting related tags for - look in it’s relatedTags Object.

See Also

Flickr.tagsGetRelated

Tag.relatedTags

http://www.flickr.com- /services- /api- /flickr.tags.getRelated.html

onTestEcho

function onTestEcho(params: Object)

Called when there is a response from a call to flickr.test.echo.

Override this method in your application if you want to do something with the response to this call.

Parameters

paramsAn object with containing all the echo’d variables.

See Also

Flickr.testEcho

http://www.flickr.com- /services- /api- /flickr.test.echo.html

onTestLogin

function onTestLogin(user: Person)

Called when there is a response from a call to flickr.test.login

Override this method in your application if you want to do something with the response to this call.

Parameters

userA reference to the logged in user

See Also

Flickr.testLogin

http://www.flickr.com- /services- /api- /flickr.test.login.html

onError

function onError(errorCode: Number,
errorDescription: String,
method: String)

Called when the Flickr API returns an error code..

Override this method in your application so that it deals with the error.

Parameters

errorCodeThe code of this error.
errorDescriptionA description of this error.
methodThe Flickr API method that was called when this error occured.

onAPIResponse

function onAPIResponse(eventObject: Object)

Internal function which deals with a response from a Flickr API call and forwards any relevant arguments to the relevant function.

You shouldn’t need to override this function.

Parameters

eventObjectAn object containing all the relevant information about the API call
[Copyright Kelvin Luck - http://creativecommons.org/licenses/by-nc-sa/2.0/ ].  Generated by Natural Docs.
private var supressOutput: Boolean
Used internally to control whether info messages are logged.
function setSuppressOutput(supressOutput: Boolean):Void
Use if you don’t want this instance to log it’s messages.
public function onAuthGetFrob(frob)
Called when there is a successful response from a call to flickr.auth.getFrob
public function onAuthCheckToken(token)
Called when there is a successful response from a call to flickr.auth.getToken or flickr.auth.checkToken.
function onContactsGetList(user: Person,
filter: String)
Called when there is a response from a call to flickr.contacts.getList.
function onContactsGetPublicList(user: Person)
Called when there is a response from a call to flickr.contacts.getPublicList.
function onFavoritesAdd(photo: Photo)
Called when there is a response from a call to flickr.favorites.add.
function onFavoritesGetList(user: Person)
Called when there is a response from a call to flickr.favorites.getList.
function onFavoritesGetPublicList(user: Person)
Called when there is a response from a call to flickr.favorites.getPublicList.
function onFavoritesRemove(photo: Photo)
Called when there is a response from a call to flickr.favorites.remove.
function onGroupsPoolsAdd(photo: Photo,
group: Group)
Called when there is a response from a call to flickr.groups.pools.add
function onGroupsPoolsGetContext(photo: Photo,
group: Group)
Called when there is a response from a call to flickr.groups.pools.getContext
function onGroupsPoolsGetGroups(user: Person)
Called when there is a response from a call to flickr.groups.pools.getGroups
function onGroupsPoolsGetPhotos(group: Group)
Called when there is a response from a call to flickr.groups.pools.getPhotos
function onGroupsPoolsRemove(photo: Photo,
group: Group)
Called when there is a response from a call to flickr.groups.pools.remove
function onPeopleFindByEmail(person: Person)
Called when there is a response from a call to flickr.people.findByEmail.
function onPeopleFindByUsername(person: Person)
Called when there is a response from a call to flickr.people.findByUsername.
function onPeopleGetInfo(person: Person)
Called when there is a response from a call to flickr.people.getInfo.
function onPeopleGetPublicGroups(person: Person)
Called when there is a response from a call to flickr.people.getPublicGroups.
function onPeopleGetPublicPhotos(person: Person)
Called when there is a response from a call to flickr.people.getPublicPhotos.
function onPeopleGetUploadStatus(person: Person)
Called when there is a response from a call to flickr.people.getUploadStatus.
function onPhotosAddTags(photo: Photo,
tags: String)
Called when there is a response from a call to flickr.photos.addTags.
function onPhotosGetAllContexts(photo: Photo)
Called when there is a response from a call to flickr.people.getAllContexts.
function onPhotosGetContactsPhotos(photos: Array)
Called when there is a response from a call to flickr.people.getContactsPhotos.
function onPhotosGetContactsPublicPhotos(person: Person,
photos: Array)
Called when there is a response from a call to flickr.people.getContactsPhotos.
function onPhotosGetContext(photo: Photo)
Called when there is a response from a call to flickr.people.getContext.
function onPhotosGetCounts(counts: Array)
Called when there is a response from a call to flickr.people.getCounts.
function onPhotosGetExif(photo: Photo)
Called when there is a response from a call to flickr.people.getExif.
function onPhotosGetInfo(photo: Photo)
Called when there is a response from a call to flickr.people.getInfo.
function onPhotosGetNotInSet(photos: Array)
Called when there is a response from a call to flickr.people.getPhotosNotInSet.
function onPhotosGetPerms(photo: Array)
Called when there is a response from a call to flickr.people.getPerms.
function onPhotosGetRecent(photos: Array)
Called when there is a response from a call to flickr.people.getRecent.
function onPhotosGetSizes(photo: Photo)
Called when there is a response from a call to flickr.people.getSizes.
function onPhotosGetUntagged(photos: Array)
Called when there is a response from a call to flickr.people.getUntagged.
function onPhotosRemoveTag(tagId: Number)
Called when there is a response from a call to flickr.people.removeTag.
function onPhotosSearch(photos: Array)
Called when there is a response from a call to flickr.people.search.
function onPhotosSetDates(photo: Photo)
Called when there is a response from a call to flickr.people.setDates.
function onPhotosSetMeta(photo: Photo)
Called when there is a response from a call to flickr.people.setMeta.
function onPhotosSetPerms(photo: Photo)
Called when there is a response from a call to flickr.people.setPerms.
function onPhotosSetTags(photo: Photo)
Called when there is a response from a call to flickr.people.setTags.
function onPhotosetsAddPhoto(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.addPhoto
function onPhotosetsCreate(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.create
function onPhotosetsDelete(photosetId: Number)
Called when there is a response from a call to flickr.photosets.delete
function onPhotosetsEditMeta(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.editMeta
function onPhotosetsEditPhotos(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.editPhotos
function onPhotosetsGetContext(photo: Photo,
photoset: Photoset)
Called when there is a response from a call to flickr.photosets.getContext
function onPhotosetsGetInfo(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.getInfo
function onPhotosetsGetList(user: Person)
Called when there is a response from a call to flickr.photosets.getList
function onPhotosetsGetPhotos(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.getPhotos
function onPhotosetsOrderSets(user: Person)
Called when there is a response from a call to flickr.photosets.orderSets
function onPhotosetsRemovePhoto(photoset: Photoset)
Called when there is a response from a call to flickr.photosets.removePhoto
function onTagsGetListPhoto(photo: Photo)
Called when there is a response from a call to flickr.tags.tagsGetListPhoto.
function onTagsGetListUser(person: Person)
Called when there is a response from a call to flickr.tags.getListUser.
function onTagsGetListUserPopular(person: Person)
Called when there is a response from a call to flickr.tags.getListUserPopular.
function onTagsGetRelated(sourceTag: Tag)
Called when there is a response from a call to flickr.tags.tagsGetRelated.
function onTestEcho(params: Object)
Called when there is a response from a call to flickr.test.echo.
function onTestLogin(user: Person)
Called when there is a response from a call to flickr.test.login
function onError(errorCode: Number,
errorDescription: String,
method: String)
Called when the Flickr API returns an error code..
function onAPIResponse(eventObject: Object)
Internal function which deals with a response from a Flickr API call and forwards any relevant arguments to the relevant function.
public function callMethod(method: String,
additionalArguments: Object,
requiresSigning: Boolean):Void
Used to call a method on the flickr API.
Class to provide an interface to the Flickr API
public function authGetFrob(authIsLoggingIn: Boolean)
Calls flickr.auth.getFrob to get a frob to be used during authentication.
public function authLogin(perms: String)
Pops open a login window so that the user can authenticate with the flickr.com website.
public function authCheckToken(authToken: String)
Calls flickr.auth.checkToken to get the credentials attached to an authentication token.
Class to describe a person from Flickr.
function getPublicContacts():Object
Gets a list of the public contacts that this user has (if addPublicContact has been called for this user.
public function contactsGetList(filter: String)
Calls flickr.contacts.getList to get a list of contacts for the calling user.
public function contactsGetPublicList(nsid: String)
Calls flickr.contacts.getPublicList to get a list of contacts a user.
public function favoritesAdd(photoId: Number)
Calls flickr.favorites.add to add a photo to a user’s favorites list.
function getFavorites():Object
Gets a list of the favorite Photo’s that this user has.
public function favoritesGetList(userId: String,
extras: String,
perPage: Number,
page: Number)
Calls flickr.favorites.getList to get a list of the user’s favorite photos.
public function favoritesGetPublicList(userId: String,
extras: String,
perPage: Number,
page: Number)
Calls flickr.favorites.getPublicList to get a list of favorite public photos for the given user.
public function favoritesRemove(photoId: Number)
Calls flickr.favorites.remove to remove a photo from a user’s favorites list.
Class to describe a photo from Flickr.
Class to describe a group from Flickr.
function groupsPoolsAdd(photoId: Number,
groupId: String)
Add a photo to a group’s pool.
function groupsPoolsGetContext(photoId: Number,
groupId: String)
Gets next and previous photos for a photo in a group pool.
Stores information about this Photos context in given Groups
function groupsPoolsGetGroups()
Gets a list of groups to which you can add photos.
function getGroups():Array
Returns this Person’s _groups Array.
function groupsPoolsGetPhotos(groupId: String,
tags: String,
extras: String,
perPage: Number,
page: Number)
Gets a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).
function getPhotos():Array
Get’s this Groups _pool
function peopleFindByEmail(email: String)
Calls flickr.people.findByEmail to get a user’s NSID, given their email address.
function peopleFindByUsername(username: String)
Calls flickr.people.findByUsername to get a user’s NSID, given their username.
function peopleGetInfo(nsid: String)
Calls flickr.people.getInfo to get information about a user.
function peopleGetPublicGroups(nsid: String)
Calls flickr.people.getPublicGroups to get the list of public groups a user is a member of.
function peopleGetPublicPhotos(nsid: String,
extras: String,
perPage: Number,
page: Number)
Calls flickr.people.getPublicPhotos to get a list of public photos for the given user.
private var _photos: Array
An Array containing references to all of this Person’s photos.
function peopleGetUploadStatus()
Calls flickr.people.getUploadStatus to get information for the calling user related to photo uploads.
public var bandwidthMax: Number
The bandwidth this user has available, in bytes per month.
public var bandwidthUsed: Number
The bandwidth this user has used this month, in bytes.
public var filesizeMax: Number
The maximum size per file that this user can upload, in bytes.
function photosAddTags (photoId: Number,
tags: String)
Calls flickr.photos.addTags to add tags to a given photo.
function getPhotosets():Array
This Photos _photosets Array.
function photosGetContactsPhotos (count: Number,
justFriends: Number,
singlePhoto: Number,
includeSelf: Number)
Calls flickr.photos.getContactsPhotos to fetch a list of recent photos from the calling users’ contacts.
function photosGetContactsPublicPhotos (nsid: String,
count: Number,
justFriends: Boolean,
singlePhoto: Boolean,
includeSelf: Boolean)
Calls flickr.photos.getContactsPublicPhotos to fetch a list of recent public photos from a users’ contacts.
function photosGetContext (photoId: Number)
Calls flickr.photos.getContext to return next and previous photos for a photo in a photostream.
function photosGetCounts (dates: String,
takenDates: String)
Calls flickr.photos.getCounts to get a list of photo counts for the given date ranges for the calling user.
function photosGetExif (photoId: Number,
secret: String)
Calls flickr.photos.getExif to return a list of EXIF/TIFF/GPS tags for a given photo.
function photosGetInfo (photoId: Number,
secret: String)
Calls flickr.photos.getInfo to get information about a photo..
function photosGetNotInSet (extras: String,
perPage: Number,
page: Number)
Calls flickr.photos.getNotInSet to get a list of your photos that are not part of any sets.
function photosGetPerms (photoId: Number)
Calls flickr.photos.getPerms to get permissions for a photo.
function photosGetSizes (photoId: Number)
Calls flickr.photos.getRecent to get the available sizes for a photo.
private var _sizes: Array
The PhotoSizes that are associated with this photo.
Class to describe the size of a Photo from Flickr.
function photosGetUntagged (extras: String,
perPage: Number,
page: Number)
Calls flickr.photos.getUntagged to get a list of your photos with no tags.
Class to describe a tag on a photo on flickr.com
function photosRemoveTag (tagId: Number)
Calls flickr.photos.removeTag to remove a tag from a photo.
function photosSearch (params)
Calls flickr.photos.search to get a list of photos matching some criteria.
function photosSetDates (photoId: Number,
datePosted: Date,
dateTaken: Date,
dateTakenGran: Number)
Calls flickr.photos.setDates to set one or both of the dates for a photo..
function photosSetMeta (photoId: Number,
title: String,
description: String)
Calls flickr.photos.setMeta to set the meta information for a photo.
function photosSetTags (photoId: Number,
tags: String)
Calls flickr.photos.setTags to set the tags for a photo.
function photosetsAddPhoto(photosetId: Number,
photoId: Number)
Add a photo to the end of an existing photoset.
Describes a Photoset on flickr.com
function photosetsCreate(title: String,
description: String,
primaryPhotoId: Number)
Create a new photoset for the calling user.
function photosetsDelete(photosetId: Number)
Delete a photoset.
function photosetsEditMeta(photosetId: Number,
title: String,
description: String)
Modify the meta-data for a photoset.
function photosetsEditPhotos(photosetId: Number,
primaryPhotoId: Number,
photoIds: Array)
Modify the photos in a photoset.
function photosetsGetContext(photoId: Number,
photosetId: Number)
Returns next and previous photos for a photo in a set.
var contextPhotosets: Object
Stores information about this Photos context in given Photosets
function photosetsGetList(userId: String)
Gets the photosets belonging to the specified user.
function getPhotosets():Array
Returns this Person’s _photosets Array.
function photosetsGetPhotos(photosetId: Number)
Get the list of photos in a set.
function getPhotos():Array
Get’s this Photosets photos
function photosetsRemovePhoto(photosetId: Number,
photoId: Number)
Remove a photo from a photoset.
function getTags():Object
Returns an object containing all the tags’s that are associated with this Photo.
public function tagsGetListPhoto(photoId: Number)
Calls flickr.tags.getListPhoto to get the tag list for a given photo.
public function tagsGetListUser(userId: String)
Calls flickr.tags.getListUser to get the tag list for a given user (or the currently logged in user).
public function tagsGetListUserPopular(userId: String,
count: Number)
Calls flickr.tags.getListUserPopular to get the popular tags for a given user (or the currently logged in user).
public function tagsGetRelated(tag: String)
Calls flickr.tags.getRelated to get a list of tags ‘related’ to the given tag, based on clustered usage analysis.
public var relatedTags: Object
An object containing a list of tags that are related to this one, based on clustered usage analysis.
public function testEcho()
Calls flickr.test.echo - forwards any arguments on to the Flickr API
public function testLogin()
Calls flickr.test.login - A testing method which checks if the caller is logged in then returns their username.