FlickrService

Kind of class:	public class
Package:	com.adobe.webapis.flickr
Inherits from:	URLLoaderBase
Classpath:	com.adobe.webapis.flickr.FlickrService
File last modified:	Monday, 03 July 2006, 15:44:36

► View source

▼ Hide source

/*
Adobe Systems Incorporated(r) Source Code License Agreement
Copyright(c) 2005 Adobe Systems Incorporated. All rights reserved.
    
Please read this Source Code License Agreement carefully before using
the source code.
    
Adobe Systems Incorporated grants to you a perpetual, worldwide, non-exclusive,
no-charge, royalty-free, irrevocable copyright license, to reproduce,
prepare derivative works of, publicly display, publicly perform, and
distribute this source code and such derivative works in source or
object code form without any attribution requirements.
    
The name "Adobe Systems Incorporated" must not be used to endorse or promote products
derived from the source code without prior written permission.
    
You agree to indemnify, hold harmless and defend Adobe Systems Incorporated from and
against any loss, damage, claims or lawsuits, including attorney's
fees that arise or result from your use or distribution of the source
code.
    
THIS SOURCE CODE IS PROVIDED "AS IS" AND "WITH ALL FAULTS", WITHOUT
ANY TECHNICAL SUPPORT OR ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ALSO, THERE IS NO WARRANTY OF
NON-INFRINGEMENT, TITLE OR QUIET ENJOYMENT. IN NO EVENT SHALL MACROMEDIA
OR ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOURCE CODE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.adobe.webapis.flickr {
    
    import com.adobe.webapis.flickr.flickrservice_internal;
    import com.adobe.crypto.MD5;
    import com.adobe.webapis.URLLoaderBase;
    import com.adobe.webapis.flickr.methodgroups.*;
    import flash.net.URLLoader;
    
    /**
     * The FlickrService class abstracts the Flickr API found
     * at http://www.flickr.com/services/api/
     */
    public class FlickrService extends URLLoaderBase {
        
        /**
         * The REST endpoint where we can talk with Flickr service
         */
        public static const END_POINT:String = "http://flickr.com/services/rest/?";
        
        /**
         * The endpoint where we go for authentication
         */
        public static const AUTH_END_POINT:String = "http://flickr.com/services/auth/?";
        
        /** 
         * Store the API key that gives developers access to the Flickr service 
         */
        private var _api_key:String;
        
        /**
         * The "shared secret" of your application for authentication
         */
        private var _secret:String;
        
        /**
         * The token identifying the user as logged in
         */
        private var _token:String;
        
        /**
         * One of the consants from the AuthPerm class corresponding
         * to the current permission the authenticated user has
         */
        private var _permission:String;
        
        /**
         * Private variable that we provide read-only access to
         */
        private var _auth:Auth;
        private var _blogs:Blogs;
        private var _contacts:Contacts;
        private var _favorites:Favorites;
        private var _groups:Groups;
        private var _people:People;
        private var _photos:Photos;
        private var _photosets:PhotoSets;
        private var _tags:Tags;
        private var _test:Test;
        private var _urls:Urls;
        
        public function FlickrService( api_key:String ) {
            _api_key = api_key;
            _permission = AuthPerm.NONE;
            _token = "";
            
            _auth = new Auth( this );
            _blogs = new Blogs( this );
            _contacts = new Contacts( this );
            _favorites = new Favorites( this );
            _groups = new Groups( this );
            _people = new People( this );
            _photos = new Photos( this );
            _photosets = new PhotoSets( this );
            _tags = new Tags( this );
            _test = new Test( this );
            _urls = new Urls( this );
            
        }
        
        /**
         * Returns the current API key in use for accessing the Flickr service.
         *  
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get api_key():String {
            return _api_key;    
        }
        
        /**
         * Sets the API key that should be used to access the Flickr service.
         *
         * @param value The API key to use against Flickr.com
         * @see http://www.flickr.com/services/api/misc.api_keys.html
         * @see http://www.flickr.com/services/api/registered_keys.gne
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function set api_key( value:String ):void {
            _api_key = value;    
        }
        
        /**
         * Returns the "shared secret" of the Application associated with
         * the API key for use in Authentication.
         * 
         * @see http://www.flickr.com/services/api/registered_keys.gne
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get secret():String {
            return _secret;    
        }
        
        /**
         * Sets the "shared secret" to that of an Application configured against
         * the API key for use in Authentication.
         *
         * @param value The "shared secret" of the Application to authenticate 
         *            against.
         * @see http://www.flickr.com/services/api/registered_keys.gne
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function set secret( value:String ):void {
            _secret = value;    
        }
        
        /**
         * Returns the token identifying the user as logged in
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get token():String {
            return _token;    
        }
        
        /**
         * Sets the token identifyin the user as logged in so that
         * the FlickrService API can sign the method calls correctly.
         *
         * @param value The authentication token
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function set token( value:String ):void {
            _token = value;    
        }
        
        /**
         * Returns the permission the application has for the
         * currently logged in user's account.
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get permission():String {
            return _permission;
        }
        
        /**
         * Sets the desired permission for the user's account requested
         * by the application.  During the login process, the user has
         * the ability to allow or deny the application the permission.
         *
         * @param value One of the consants from the AuthPerm class
         *            corresponding to the current permission the 
         *            authenticated user has
         * @see com.adobe.service.flickr.AuthPerm
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function set permission( value:String ):void {
            _permission = value;    
        }
        
        /**
         * Provide read-only access to the Auth method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get auth():Auth {
            return _auth;    
        }
        
        /**
         * Provide read-only access to the Blogs method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get blogs():Blogs {
            return _blogs;    
        }
        
        /**
         * Provide read-only access to the Contacts method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get contacts():Contacts {
            return _contacts;    
        }
        
        /**
         * Provide read-only access to the Favorites method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get favorites():Favorites {
            return _favorites;    
        }
        
        /**
         * Provide read-only access to the Groups method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get groups():Groups {
            return _groups;    
        }
        
        /**
         * Provide read-only access to the People method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get people():People {
            return _people;    
        }
        
        /**
         * Provide read-only access to the Photos method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get photos():Photos {
            return _photos;    
        }
        
        /**
         * Provide read-only access to the PhotoSets method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get photosets():PhotoSets {
            return _photosets;    
        }
        
        /**
         * Provide read-only access to the Tags method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get tags():Tags {
            return _tags;    
        }
        
        /**
         * Provide read-only access to the Test method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get test():Test {
            return _test;    
        }
        
        /**
         * Provide read-only access to the Urls method group in the Flickr API
         *
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function get urls():Urls {
            return _urls;    
        }
        
        /**
         * Returns the URL to use for authentication so the developer
         * doesn't have to build it by hand.
         *
         * @param frob The frob from flickr.auth.getFrob to authenticate with
         * @param permission The permission the user will have after successful
         *            login
         * @return The url to open a browser to to authenticate against
         * @langversion ActionScript 3.0
         * @playerversion Flash 8.5
         * @tiptext
         */
        public function getLoginURL( frob:String, permission:String ):String {
            
            var sig:String = secret;
            sig += "api_key" + api_key;
            sig += "frob" + frob;
            sig += "perms" + permission;
            
            var auth_url:String = AUTH_END_POINT;
            auth_url += "api_key=" + api_key;
            auth_url += "&frob=" + frob;
            auth_url += "&perms=" + permission;
            auth_url += "&api_sig=" + MD5.hash( sig );
                        
            return auth_url;
        }
        
        /**
         * Use our "internal" namespace to provide access to the URLLoader
         * from this class to the helper classes in the methodgroups package.
         * This keeps this method away from the public API since it is not meant
         * to be used by the public.
         */
        flickrservice_internal function get urlLoader():URLLoader {
            return getURLLoader();    
        }
        
    }
    
}

The FlickrService class abstracts the Flickr API found at http://www.flickr.com/services/api/

Summary

Constructor

FlickrService (api_key:String)

Class properties

END_POINT : String
- The REST endpoint where we can talk with Flickr service
AUTH_END_POINT : String
- The endpoint where we go for authentication

Instance properties

_api_key : String
- Store the API key that gives developers access to the Flickr service
_secret : String
- The "shared secret" of your application for authentication
_token : String
- The token identifying the user as logged in
_permission : String
- One of the consants from the AuthPerm class corresponding
_auth : Auth
- Private variable that we provide read-only access to
_blogs : Blogs
_contacts : Contacts
_favorites : Favorites
_groups : Groups
_people : People
_photos : Photos
_photosets : PhotoSets
_tags : Tags
_test : Test
_urls : Urls
api_key : String
- Returns the current API key in use for accessing the Flickr service.
secret : String
- Returns the "shared secret" of the Application associated with
token : String
- Returns the token identifying the user as logged in
permission : String
- Returns the permission the application has for the
auth : Auth
- Provide read-only access to the Auth method group in the Flickr API
blogs : Blogs
- Provide read-only access to the Blogs method group in the Flickr API
contacts : Contacts
- Provide read-only access to the Contacts method group in the Flickr API
favorites : Favorites
- Provide read-only access to the Favorites method group in the Flickr API
groups : Groups
- Provide read-only access to the Groups method group in the Flickr API
people : People
- Provide read-only access to the People method group in the Flickr API
photos : Photos
- Provide read-only access to the Photos method group in the Flickr API
photosets : PhotoSets
- Provide read-only access to the PhotoSets method group in the Flickr API
tags : Tags
- Provide read-only access to the Tags method group in the Flickr API
test : Test
- Provide read-only access to the Test method group in the Flickr API
urls : Urls
- Provide read-only access to the Urls method group in the Flickr API
urlLoader : URLLoader
- Use our "internal" namespace to provide access to the URLLoader;

Instance methods

getLoginURL (frob:String, permission:String) : String
- Returns the URL to use for authentication so the developer

Constructor

FlickrService

public function FlickrService (

api_key:String)

Class properties

AUTH_END_POINT

public static AUTH_END_POINT:String = "http://flickr.com/services/auth/?"

(read,write)

The endpoint where we go for authentication

END_POINT

public static END_POINT:String = "http://flickr.com/services/rest/?"

(read,write)

The REST endpoint where we can talk with Flickr service

Instance properties

_api_key

private _api_key:String

(read)

Store the API key that gives developers access to the Flickr service

_auth

private _auth:Auth

(read)

Private variable that we provide read-only access to

_blogs

private _blogs:Blogs

(read)

_contacts

private _contacts:Contacts

(read)

_favorites

private _favorites:Favorites

(read)

_groups

private _groups:Groups

(read)

_people

private _people:People

(read)

_permission

private _permission:String

(read)

One of the consants from the AuthPerm class corresponding to the current permission the authenticated user has

_photos

private _photos:Photos

(read)

_photosets

private _photosets:PhotoSets

(read)

_secret

private _secret:String

(read)

The "shared secret" of your application for authentication

_tags

private _tags:Tags

(read)

_test

private _test:Test

(read)

_token

private _token:String

(read)

The token identifying the user as logged in

_urls

private _urls:Urls

(read)

api_key

public api_key:String

(read,write)

Returns the current API key in use for accessing the Flickr service. @langversion ActionScript 3.0 @playerversion Flash 8.5 Sets the API key that should be used to access the Flickr service.

Parameters:

value:

The API key to use against Flickr.com

auth

public auth:Auth

(read)

Provide read-only access to the Auth method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

blogs

public blogs:Blogs

(read)

Provide read-only access to the Blogs method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

contacts

public contacts:Contacts

(read)

Provide read-only access to the Contacts method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

favorites

public favorites:Favorites

(read)

Provide read-only access to the Favorites method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

groups

public groups:Groups

(read)

Provide read-only access to the Groups method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

people

public people:People

(read)

Provide read-only access to the People method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

permission

public permission:String

(read,write)

Returns the permission the application has for the currently logged in user's account. @langversion ActionScript 3.0 @playerversion Flash 8.5 Sets the desired permission for the user's account requested by the application. During the login process, the user has the ability to allow or deny the application the permission.

Parameters:

value:

One of the consants from the AuthPerm class corresponding to the current permission the authenticated user has

photos

public photos:Photos

(read)

Provide read-only access to the Photos method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

photosets

public photosets:PhotoSets

(read)

Provide read-only access to the PhotoSets method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

secret

public secret:String

(read,write)

Returns the "shared secret" of the Application associated with the API key for use in Authentication. Sets the "shared secret" to that of an Application configured against the API key for use in Authentication.

Parameters:

value:

The "shared secret" of the Application to authenticate against.

test

public test:Test

(read)

Provide read-only access to the Test method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

token

public token:String

(read,write)

Returns the token identifying the user as logged in @langversion ActionScript 3.0 @playerversion Flash 8.5 Sets the token identifyin the user as logged in so that the FlickrService API can sign the method calls correctly.

Parameters:

value:

The authentication token @langversion ActionScript 3.0 @playerversion Flash 8.5

urlLoader

flickrservice_internal public urlLoader:URLLoader

(read)

Use our "internal" namespace to provide access to the URLLoader; from this class to the helper classes in the methodgroups package. This keeps this method away from the public API since it is not meant to be used by the public.

urls

public urls:Urls

(read)

Provide read-only access to the Urls method group in the Flickr API @langversion ActionScript 3.0 @playerversion Flash 8.5

Instance methods

getLoginURL

public function getLoginURL (

frob:String, permission:String) : String

Returns the URL to use for authentication so the developer doesn't have to build it by hand.

Parameters:

frob :

The frob from flickr.auth.getFrob to authenticate with

permission:

The permission the user will have after successful login

Returns:

The url to open a browser to to authenticate against @langversion ActionScript 3.0 @playerversion Flash 8.5