Aaron Straup Cope > Net-Flickr-API-1.7 > Net::Flickr::API

Download:
Net-Flickr-API-1.7.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 1.7   Source  

NAME ^

Net::Flickr::API - base API class for Net::Flickr::* libraries

SYNOPSIS ^

 package Net::Flickr::RDF;
 use base qw (Net::Flickr::API);

DESCRIPTION ^

Base API class for Net::Flickr::* libraries

Net::Flickr::API is a wrapper for Flickr::API that provides support for throttling API calls (per second), retries if the API is disabled and marshalling of API responses into XML::LibXML or XML::XPath objects.

OPTIONS ^

Options are passed to Net::Flickr::Backup using a Config::Simple object or a valid Config::Simple config file. Options are grouped by "block".

flick

reporting

PACKAGE METHODS ^

__PACKAGE__->new($cfg)

Where $cfg is either a valid Config::Simple object or the path to a file that can be parsed by Config::Simple.

Returns a Net::Flickr::API object.

OBJECT METHODS ^

$obj->api_call(\%args)

Valid args are :

If the method encounters any errors calling the API, receives an API error or can not parse the response it will log an error event, via the log method, and return undef.

Otherwise it will return a XML::LibXML::Document object (if XML::LibXML is installed) or a XML::XPath object.

$obj->get_auth()

Return an XML node element containing the Flickr auth token information for the current object.

Returns undef if no token information is present.

$obj->get_auth_nsid()

Return the Flickr NSID of the user associated with the Flickr auth token information for the current object.

Returns undef if no token information is present.

$obj->upload(\%args)

This is a helper method that simply wraps calls to the Flickr::Upload upload method. All the arguments are the same. For complete documentation please consult:

http://search.cpan.org/dist/Flickr-Upload/Upload.pm#upload

(Note: There's no need to pass an auth_token argument as the wrapper will take care of for you.)

Returns a photo ID (or a ticket ID if the call is asynchronous) on success or false if there was a problem.

$obj->log()

Returns a Log::Dispatch object.

VERSION ^

1.7

DATE ^

$Date: 2009/08/02 17:16:12 $

AUTHOR ^

Aaron Straup Cope <ascope@cpan.org>

SEE ALSO ^

Config::Simple

Flickr::API

XML::XPath

XML::LibXML

BUGS ^

Please report all bugs via http://rt.cpan.org/

LICENSE ^

Copyright (c) 2005-2008 Aaron Straup Cope. All Rights Reserved.

This is free software. You may redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: