com. kelvinluck. flickr. Flickr

Class to provide an interface to the Flickr API

This class in combination with FlickrResponseListener provides a convienient way to interact with the Flickr API from AS 2. The implementation should abstract away any processing of XML and allow for type checking in the functions you override in FlickrResponseListener. The idea is to make flash code which interacts with the Flickr API quicker and easier to write.

This is still very alpha so feedback is greatfully received :)

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

Usage

Very simple usage example -- in the real world you would either subclass FlickrResponseListener to add functionality you required or override the method you were interested in.

import com.kelvinluck.flickr.Flickr;
import com.kelvinluck.flickr.FlickrResponseListener;

var _flickr:Flickr = Flickr.getFlickr();
_flickrResponseListener = new FlickrResponseListener();
_flickr.apiKey = "***";
_flickr.testEcho("one", 2, "free");

This example shows how you would override the method you were interested in:

import com.kelvinluck.flickr.Flickr;
import com.kelvinluck.flickr.FlickrResponseListener;

var _flickr:Flickr = Flickr.getFlickr();
_flickrResponseListener = new FlickrResponseListener();
_flickrResponseListener.onTestEcho = function(params:Object) {
      // do stuff
}
_flickr.apiKey = "***";
_flickr.testEcho("one", 2, "free");

Version

0.1.0

Author

Kelvin Luck < kelvin at kelvinluck dot com >

Summary

com. kelvinluck. flickr. Flickr	Class to provide an interface to the Flickr API
Variables
_flickr
apiKey	Your Flickr API Key.
_apiKey
REST_ENDPOINT	The place for all API calls to connect to.
_REST_ENDPOINT
awaitingResponse
_restXML
_calledMethod
_additionalArgs
_email
_password
STATUS_BUSY	The API is already waiting for the response to a method call so cannot make another call
STATUS_BUSY_DESCRIPTION
STATUS_ERROR_CONNECTING	Could not connect to the server (e.g.
STATUS_ERROR_CONNECTING_DESCRIPTION
STATUS_INVALID_XML	The XML returned by the server wasn’t in a <rsp /> tag.
STATUS_INVALID_XML_DESCRIPTION
STATUS_USER_NOT_LOGGED_IN	The user wasn’t logged in and tried to access a method that requires authentication (returned from flickr.com)
STATUS_INVALID_API_KEY	The API key sent to flickr was invalid (returned from flickr.com)
STATUS_OK	There was no errors and valid XML was returned.
PERM_NOBODY	A constant representing permissions for nobody.
PERM_FRIENDS	A constant representing permissions for friends and family.
PERM_CONTACTS	A constant representing permissions for contacts.
PERM_EVERYBODY	A constant representing permissions for everybody.
Properties
email	The email address to use when accessing methods that require user authentication.
password	The password to use when accessing methods that require user authentication.
Functions
Flickr	Constructor - as this class implements the Singleton pattern do not call directly but rather access through Flickr.getFlickr.
contactsGetList	Calls flickr.contacts.getList to get a list of contacts for the calling user.
contactsGetPublicList	Calls flickr.contacts.getPublicList to get a list of contacts a user.
favoritesAdd	Calls flickr.favorites.add to add a photo to a user’s favorites list.
favoritesGetList	Calls flickr.favorites.getList to get a list of the user’s favorite photos.
favoritesGetPublicList	Calls flickr.favorites.getPublicList to get a list of favorite public photos for the given user.
favoritesRemove	Calls flickr.favorites.remove to remove a photo from a user’s favorites list.
peopleFindByEmail	Calls flickr.people.findByEmail to get a user’s NSID, given their email address.
peopleFindByUsername	Calls flickr.people.findByUsername to get a user’s NSID, given their username.
peopleGetInfo	Calls flickr.people.getInfo to get information about a user.
peopleGetOnlineList	Calls flickr.people.getOnlineList to get a list of all online users.
peopleGetPublicGroups	Calls flickr.people.getPublicGroups to get the list of public groups a user is a member of.
peopleGetPublicPhotos	Calls flickr.people.getPublicPhotos to get a list of public photos for the given user.
photosAddTags	Calls flickr.photos.addTags to add tags to a given photo.
photosGetContactsPhotos	Calls flickr.photos.getContactsPhotos to fetch a list of recent photos from the calling users’ contacts.
photosGetContactsPublicPhotos	Calls flickr.photos.getContactsPublicPhotos to fetch a list of recent public photos from a users’ contacts.
photosGetContext	Calls flickr.photos.getContext to return next and previous photos for a photo in a photostream.
photosGetCounts	Calls flickr.photos.getCounts to get a list of photo counts for the given date ranges for the calling user.
photosGetExif	Calls flickr.photos.getExif to return a list of EXIF/TIFF/GPS tags for a given photo.
photosGetInfo	Calls flickr.photos.getInfo to get information about a photo..
photosGetNotInSet	Calls flickr.photos.getNotInSet to get a list of your photos that are not part of any sets.
photosGetPerms	Calls flickr.photos.getPerms to get permissions for a photo.
photosGetRecent	Calls flickr.photos.getRecent to get a list of the latest public photos uploaded to flickr.
photosGetSizes	Calls flickr.photos.getRecent to get the available sizes for a photo.
photosGetUntagged	Calls flickr.photos.getUntagged to get a list of your photos with no tags.
photosRemoveTag	Calls flickr.photos.removeTag to remove a tag from a photo.
photosSearch	Calls flickr.photos.search to get a list of photos matching some criteria.
photosSetDates	Calls flickr.photos.setDates to set one or both of the dates for a photo..
photosSetMeta	Calls flickr.photos.setMeta to set the meta information for a photo.
photosSetPerms	Calls flickr.photos.setPerms to set permissions for a photo..
photosSetTags	Calls flickr.photos.setTags to set the tags for a photo.
tagsGetListPhoto	Calls flickr.tags.getListPhoto to get the tag list for a given photo.
tagsGetListUser	Calls flickr.tags.getListUser to get the tag list for a given user (or the currently logged in user).
tagsGetListUserPopular	Calls flickr.tags.getListUserPopular to get the popular tags for a given user (or the currently logged in user).
tagsGetRelated	Calls flickr.tags.getRelated to get a list of tags ‘related’ to the given tag, based on clustered usage analysis.
testEcho	Calls flickr.test.echo - forwards any arguments on to the Flickr API
testLogin	Calls flickr.test.login - A testing method which checks if the caller is logged in then returns their username.
callMethod	Used to call a method on the flickr API.
onAPIResponse	Called internally on recepit of a response from a request to the REST_ENDPOINT.
Properties
REST_ENDPOINT
REST_ENDPOINT
apiKey
Functions
_parsePhotoXML	Private internal function used to avoid duplicate code to parse “the standard photo list xml”
getFlickr	Returns a reference to the Flickr instance - if none exists yet then creates one and returns a reference to that.
toString
dispatchEvent
addEventListener
removeEventListener

photosGetCounts

function photosGetCounts ( dates: String,
takenDates: String,
email: String,
password: String )

Calls flickr.photos.getCounts to get a list of photo counts for the given date ranges for the calling user.

Parameters

dates	A comma delimited list of unix timestamps denoting the periods to return counts for. They should be specified smallest first. [Optional: if not present then takenDates used instead.
takenDates	A comma delimited list of mysql datetimes denoting the periods to return counts for. They should be specified smallest first. [Optional: if not present then dates used instead.
email	The email address of the user whose photos you want to count [Optional: default=<email>]
password	The password of the user whose photos you want to count [Optional: default=<password>]

Note

The dates parameter is passed as UNIX Timestamps while the takenDates parameter is passed as MySQL Timestamps (e.g. 2005-03-21).
If you want to pass takenDates then pass “” (empty string) or undefined as the value of dates.

TODO

Should we change this method to accept Arrays of Date Objects rather than comma delimited Strings? Then we could sort it making order unimportant and could abstract away the fact that Flickr stores dates uploaded and dates taken in different formats. Maybe it would be better if the methods first two arguments were dates (an Array of Date Objects) and type (Flickr.DATES_UPLOADED or Flickr.DATES_TAKEN)?

photosSearch

function photosSearch ( params )

Calls flickr.photos.search to get a list of photos matching some criteria.

You pass an object with one or many of the following attributes...

Attributes

user_id	The NSID of the user who’s photo to search. If this parameter isn’t passed then everybody’s public photos will be searched.
tags	A comma-delimited list of tags. Photos with one or more of the tags listed will be returned.
tagMode	Either ‘any’ for an OR combination of tags, or ‘all’ for an AND combination. Defaults to ‘any’ if not specified.
text	A free text search. Photos who’s title, description or tags contain the text will be returned.
min_upload_date	Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a UNIX timestamp.
max_upload_date	Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a UNIX timestamp.
min_taken_date	Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a MySQL datetime.
max_taken_date	Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a MySQL datetime.
license	The license id for photos.
extras	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 of photos to return per page. If this argument is ommited, it defaults to 100. The maximum allowed value is 500.
page	The page of results to return. If this argument is ommited, it defaults to 1.
sort	The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, date-taken-asc and date-taken-desc

TODO

Should probably change it to accept dates as Date Objects... Then you wouldn’t have to worry about what type of date flickr expects for the different arguments.

com. kelvinluck. flickr. Flickr

Usage

See Also

Version

Author

Variables

_flickr

apiKey

_apiKey

REST_ENDPOINT

_REST_ENDPOINT

awaitingResponse

_restXML

_calledMethod

_additionalArgs

_email

_password

STATUS_BUSY

STATUS_BUSY_DESCRIPTION

STATUS_ERROR_CONNECTING

STATUS_ERROR_CONNECTING_DESCRIPTION

STATUS_INVALID_XML

STATUS_INVALID_XML_DESCRIPTION

STATUS_USER_NOT_LOGGED_IN

STATUS_INVALID_API_KEY

STATUS_OK

PERM_NOBODY

See Also

PERM_FRIENDS

See Also

PERM_CONTACTS

See Also

PERM_EVERYBODY

See Also

Properties

email

password

Functions

Flickr

contactsGetList

See Also

contactsGetPublicList

Parameters

See Also

favoritesAdd

TODO

Parameters

See Also

favoritesGetList

Parameters

See Also

favoritesGetPublicList

Parameters

See Also

favoritesRemove

TODO

Parameters

See Also

peopleFindByEmail

Parameters

See Also

peopleFindByUsername

Parameters

See Also

peopleGetInfo

Parameters

See Also

peopleGetOnlineList

See Also

peopleGetPublicGroups

Parameters

See Also

peopleGetPublicPhotos

Parameters

See Also

photosAddTags

Parameters

See Also

photosGetContactsPhotos

Parameters