.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "XML::Atom::Client 3pm"
.TH XML::Atom::Client 3pm "2011-09-27" "perl v5.12.4" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
XML::Atom::Client \- A client for the Atom API
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    use XML::Atom::Client;
\&    use XML::Atom::Entry;
\&    my $api = XML::Atom::Client\->new;
\&    $api\->username(\*(AqMelody\*(Aq);
\&    $api\->password(\*(AqNelson\*(Aq);
\&
\&    my $entry = XML::Atom::Entry\->new;
\&    $entry\->title(\*(AqNew Post\*(Aq);
\&    $entry\->content(\*(AqContent of my post.\*(Aq);
\&    my $EditURI = $api\->createEntry($PostURI, $entry);
\&
\&    my $feed = $api\->getFeed($FeedURI);
\&    my @entries = $feed\->entries;
\&
\&    my $entry = $api\->getEntry($EditURI);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIXML::Atom::Client\fR implements a client for the Atom \s-1API\s0 described at
\&\fIhttp://bitworking.org/projects/atom/draft\-gregorio\-09.html\fR, with the
authentication scheme described at
\&\fIhttp://www.intertwingly.net/wiki/pie/DifferentlyAbledClients\fR.
.PP
\&\fB\s-1NOTE:\s0\fR the \s-1API\s0, and particularly the authentication scheme, are still
in flux.
.SH "USAGE"
.IX Header "USAGE"
.SS "XML::Atom::Client\->new(%param)"
.IX Subsection "XML::Atom::Client->new(%param)"
.ie n .SS "$api\->use_soap([ 0 | 1 ])"
.el .SS "\f(CW$api\fP\->use_soap([ 0 | 1 ])"
.IX Subsection "$api->use_soap([ 0 | 1 ])"
\&\fIXML::Atom::Client\fR supports both the \s-1REST\s0 and SOAP-wrapper versions of the
Atom \s-1API\s0. By default, the \s-1REST\s0 version of the \s-1API\s0 will be used, but you can
turn on the \s-1SOAP\s0 wrapper\*(--for example, if you need to connect to a server
that supports only the \s-1SOAP\s0 wrapper\*(--by calling \fIuse_soap\fR with a value of
\&\f(CW1\fR:
.PP
.Vb 1
\&    $api\->use_soap(1);
.Ve
.PP
If called without arguments, returns the current value of the flag.
.ie n .SS "$api\->username([ $username ])"
.el .SS "\f(CW$api\fP\->username([ \f(CW$username\fP ])"
.IX Subsection "$api->username([ $username ])"
If called with an argument, sets the username for login to \fI\f(CI$username\fI\fR.
.PP
Returns the current username that will be used when logging in to the
Atom server.
.ie n .SS "$api\->password([ $password ])"
.el .SS "\f(CW$api\fP\->password([ \f(CW$password\fP ])"
.IX Subsection "$api->password([ $password ])"
If called with an argument, sets the password for login to \fI\f(CI$password\fI\fR.
.PP
Returns the current password that will be used when logging in to the
Atom server.
.ie n .SS "$api\->createEntry($PostURI, $entry)"
.el .SS "\f(CW$api\fP\->createEntry($PostURI, \f(CW$entry\fP)"
.IX Subsection "$api->createEntry($PostURI, $entry)"
Creates a new entry.
.PP
\&\fI\f(CI$entry\fI\fR must be an \fIXML::Atom::Entry\fR object.
.ie n .SS "$api\->getEntry($EditURI)"
.el .SS "\f(CW$api\fP\->getEntry($EditURI)"
.IX Subsection "$api->getEntry($EditURI)"
Retrieves the entry with the given \s-1URL\s0 \fI\f(CI$EditURI\fI\fR.
.PP
Returns an \fIXML::Atom::Entry\fR object.
.ie n .SS "$api\->updateEntry($EditURI, $entry)"
.el .SS "\f(CW$api\fP\->updateEntry($EditURI, \f(CW$entry\fP)"
.IX Subsection "$api->updateEntry($EditURI, $entry)"
Updates the entry at \s-1URL\s0 \fI\f(CI$EditURI\fI\fR with the entry \fI\f(CI$entry\fI\fR, which must be
an \fIXML::Atom::Entry\fR object.
.PP
Returns true on success, false otherwise.
.ie n .SS "$api\->deleteEntry($EditURI)"
.el .SS "\f(CW$api\fP\->deleteEntry($EditURI)"
.IX Subsection "$api->deleteEntry($EditURI)"
Deletes the entry at \s-1URL\s0 \fI\f(CI$EditURI\fI\fR.
.ie n .SS "$api\->getFeed($FeedURI)"
.el .SS "\f(CW$api\fP\->getFeed($FeedURI)"
.IX Subsection "$api->getFeed($FeedURI)"
Retrieves the feed at \fI\f(CI$FeedURI\fI\fR.
.PP
Returns an \fIXML::Atom::Feed\fR object representing the feed returned
from the server.
.SS "\s-1ERROR\s0 \s-1HANDLING\s0"
.IX Subsection "ERROR HANDLING"
Methods return \f(CW\*(C`undef\*(C'\fR on error, and the error message can be retrieved
using the \fIerrstr\fR method.
.SH "AUTHOR & COPYRIGHT"
.IX Header "AUTHOR & COPYRIGHT"
Please see the \fIXML::Atom\fR manpage for author, copyright, and license
information.