.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Flickr::API 3"
.TH Net::Flickr::API 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Net::Flickr::API \- base API class for Net::Flickr::* libraries
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& package Net::Flickr::RDF;
\& use base qw (Net::Flickr::API);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Base \s-1API\s0 class for Net::Flickr::* libraries
.PP
Net::Flickr::API is a wrapper for Flickr::API that provides support for throttling
\&\s-1API\s0 calls (per second), retries if the \s-1API\s0 is disabled and marshalling of \s-1API\s0 responses
into XML::LibXML or XML::XPath objects.
.SH "OPTIONS"
.IX Header "OPTIONS"
Options are passed to Net::Flickr::Backup using a Config::Simple object or
a valid Config::Simple config file. Options are grouped by \*(L"block\*(R".
.Sh "flick"
.IX Subsection "flick"
.IP "* \fBapi_key\fR" 4
.IX Item "api_key"
String. \fIrequired\fR
.Sp
A valid Flickr \s-1API\s0 key.
.IP "* \fBapi_secret\fR" 4
.IX Item "api_secret"
String. \fIrequired\fR
.Sp
A valid Flickr Auth \s-1API\s0 secret key.
.IP "* \fBauth_token\fR" 4
.IX Item "auth_token"
String. \fIrequired\fR
.Sp
A valid Flickr Auth \s-1API\s0 token.
.IP "* \fBapi_handler\fR" 4
.IX Item "api_handler"
String. \fIrequired\fR
.Sp
The \fBapi_handler\fR defines which XML/XPath handler to use to process \s-1API\s0 responses.
.RS 4
.IP "* \fBLibXML\fR" 4
.IX Item "LibXML"
Use XML::LibXML.
.IP "* \fBXPath\fR" 4
.IX Item "XPath"
Use XML::XPath.
.RE
.RS 4
.RE
.Sh "reporting"
.IX Subsection "reporting"
.IP "* \fBenabled\fR" 4
.IX Item "enabled"
Boolean.
.Sp
Default is false.
.IP "* \fBhandler\fR" 4
.IX Item "handler"
String.
.Sp
The default handler is \fBScreen\fR, as in \f(CW\*(C`Log::Dispatch::Screen\*(C'\fR
.IP "* \fBhandler_args\fR" 4
.IX Item "handler_args"
For example, the following :
.Sp
.Vb 1
\& reporting_handler_args=name:foobar;min_level=info
.Ve
.Sp
Would be converted as :
.Sp
.Vb 2
\& (name      => "foobar",
\&  min_level => "info");
.Ve
.Sp
The default \fBname\fR argument is \*(L"_\|_report\*(R". The default \fBmin_level\fR argument
is \*(L"info\*(R".
.SH "PACKAGE METHODS"
.IX Header "PACKAGE METHODS"
.Sh "_\|_PACKAGE_\|_\->new($cfg)"
.IX Subsection "__PACKAGE__->new($cfg)"
Where \fB$cfg\fR is either a valid \fIConfig::Simple\fR object or the path
to a file that can be parsed by \fIConfig::Simple\fR.
.PP
Returns a \fINet::Flickr::API\fR object.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.Sh "$obj\->api_call(\e%args)"
.IX Subsection "$obj->api_call(%args)"
Valid args are :
.IP "* \fBmethod\fR" 4
.IX Item "method"
A string containing the name of the Flickr \s-1API\s0 method you are
calling.
.IP "* \fBargs\fR" 4
.IX Item "args"
A hash ref containing the key value pairs you are passing to 
\&\fImethod\fR
.PP
If the method encounters any errors calling the \s-1API\s0, receives an \s-1API\s0 error
or can not parse the response it will log an error event, via the \fBlog\fR method,
and return undef.
.PP
Otherwise it will return a \fIXML::LibXML::Document\fR object (if XML::LibXML is
installed) or a \fIXML::XPath\fR object.
.Sh "$obj\->\fIget_auth()\fP"
.IX Subsection "$obj->get_auth()"
Return an \s-1XML\s0 \fInode\fR element containing the Flickr auth token information for
the current object.
.PP
Returns undef if no token information is present.
.Sh "$obj\->\fIget_auth_nsid()\fP"
.IX Subsection "$obj->get_auth_nsid()"
Return the Flickr \s-1NSID\s0 of the user associated with the Flickr auth token information
for the current object.
.PP
Returns undef if no token information is present.
.Sh "$obj\->\fIlog()\fP"
.IX Subsection "$obj->log()"
Returns a \fILog::Dispatch\fR object.
.SH "VERSION"
.IX Header "VERSION"
1.67
.SH "DATE"
.IX Header "DATE"
$Date: 2007/09/02 18:32:30 $
.SH "AUTHOR"
.IX Header "AUTHOR"
Aaron Straup Cope <ascope@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Simple
.PP
Flickr::API
.PP
XML::XPath
.PP
XML::LibXML
.SH "BUGS"
.IX Header "BUGS"
Please report all bugs via http://rt.cpan.org/
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2005\-2007 Aaron Straup Cope. All Rights Reserved.
.PP
This is free software. You may redistribute it and/or
modify it under the same terms as Perl itself.