local-lib5/man/man3/XML::Atom::Client.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "XML::Atom::Client 3"
 127 .TH XML::Atom::Client 3 "2009-04-24" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 XML::Atom::Client \- A client for the Atom API
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 5
 137 \&    use XML::Atom::Client;
 138 \&    use XML::Atom::Entry;
 139 \&    my $api = XML::Atom::Client\->new;
 140 \&    $api\->username(\*(AqMelody\*(Aq);
 141 \&    $api\->password(\*(AqNelson\*(Aq);
 142 \&
 143 \&    my $entry = XML::Atom::Entry\->new;
 144 \&    $entry\->title(\*(AqNew Post\*(Aq);
 145 \&    $entry\->content(\*(AqContent of my post.\*(Aq);
 146 \&    my $EditURI = $api\->createEntry($PostURI, $entry);
 147 \&
 148 \&    my $feed = $api\->getFeed($FeedURI);
 149 \&    my @entries = $feed\->entries;
 150 \&
 151 \&    my $entry = $api\->getEntry($EditURI);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fIXML::Atom::Client\fR implements a client for the Atom \s-1API\s0 described at
 156 \&\fIhttp://bitworking.org/projects/atom/draft\-gregorio\-09.html\fR, with the
 157 authentication scheme described at
 158 \&\fIhttp://www.intertwingly.net/wiki/pie/DifferentlyAbledClients\fR.
 159 .PP
 160 \&\fB\s-1NOTE:\s0\fR the \s-1API\s0, and particularly the authentication scheme, are still
 161 in flux.
 162 .SH "USAGE"
 163 .IX Header "USAGE"
 164 .SS "XML::Atom::Client\->new(%param)"
 165 .IX Subsection "XML::Atom::Client->new(%param)"
 166 .ie n .SS "$api\->use_soap([ 0 | 1 ])"
 167 .el .SS "\f(CW$api\fP\->use_soap([ 0 | 1 ])"
 168 .IX Subsection "$api->use_soap([ 0 | 1 ])"
 169 \&\fIXML::Atom::Client\fR supports both the \s-1REST\s0 and SOAP-wrapper versions of the
 170 Atom \s-1API\s0. By default, the \s-1REST\s0 version of the \s-1API\s0 will be used, but you can
 171 turn on the \s-1SOAP\s0 wrapper\*(--for example, if you need to connect to a server
 172 that supports only the \s-1SOAP\s0 wrapper\*(--by calling \fIuse_soap\fR with a value of
 173 \&\f(CW1\fR:
 174 .PP
 175 .Vb 1
 176 \&    $api\->use_soap(1);
 177 .Ve
 178 .PP
 179 If called without arguments, returns the current value of the flag.
 180 .ie n .SS "$api\->username([ $username ])"
 181 .el .SS "\f(CW$api\fP\->username([ \f(CW$username\fP ])"
 182 .IX Subsection "$api->username([ $username ])"
 183 If called with an argument, sets the username for login to \fI\f(CI$username\fI\fR.
 184 .PP
 185 Returns the current username that will be used when logging in to the
 186 Atom server.
 187 .ie n .SS "$api\->password([ $password ])"
 188 .el .SS "\f(CW$api\fP\->password([ \f(CW$password\fP ])"
 189 .IX Subsection "$api->password([ $password ])"
 190 If called with an argument, sets the password for login to \fI\f(CI$password\fI\fR.
 191 .PP
 192 Returns the current password that will be used when logging in to the
 193 Atom server.
 194 .ie n .SS "$api\->createEntry($PostURI, $entry)"
 195 .el .SS "\f(CW$api\fP\->createEntry($PostURI, \f(CW$entry\fP)"
 196 .IX Subsection "$api->createEntry($PostURI, $entry)"
 197 Creates a new entry.
 198 .PP
 199 \&\fI\f(CI$entry\fI\fR must be an \fIXML::Atom::Entry\fR object.
 200 .ie n .SS "$api\->getEntry($EditURI)"
 201 .el .SS "\f(CW$api\fP\->getEntry($EditURI)"
 202 .IX Subsection "$api->getEntry($EditURI)"
 203 Retrieves the entry with the given \s-1URL\s0 \fI\f(CI$EditURI\fI\fR.
 204 .PP
 205 Returns an \fIXML::Atom::Entry\fR object.
 206 .ie n .SS "$api\->updateEntry($EditURI, $entry)"
 207 .el .SS "\f(CW$api\fP\->updateEntry($EditURI, \f(CW$entry\fP)"
 208 .IX Subsection "$api->updateEntry($EditURI, $entry)"
 209 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
 210 an \fIXML::Atom::Entry\fR object.
 211 .PP
 212 Returns true on success, false otherwise.
 213 .ie n .SS "$api\->deleteEntry($EditURI)"
 214 .el .SS "\f(CW$api\fP\->deleteEntry($EditURI)"
 215 .IX Subsection "$api->deleteEntry($EditURI)"
 216 Deletes the entry at \s-1URL\s0 \fI\f(CI$EditURI\fI\fR.
 217 .ie n .SS "$api\->getFeed($FeedURI)"
 218 .el .SS "\f(CW$api\fP\->getFeed($FeedURI)"
 219 .IX Subsection "$api->getFeed($FeedURI)"
 220 Retrieves the feed at \fI\f(CI$FeedURI\fI\fR.
 221 .PP
 222 Returns an \fIXML::Atom::Feed\fR object representing the feed returned
 223 from the server.
 224 .SS "\s-1ERROR\s0 \s-1HANDLING\s0"
 225 .IX Subsection "ERROR HANDLING"
 226 Methods return \f(CW\*(C`undef\*(C'\fR on error, and the error message can be retrieved
 227 using the \fIerrstr\fR method.
 228 .SH "AUTHOR & COPYRIGHT"
 229 .IX Header "AUTHOR & COPYRIGHT"
 230 Please see the \fIXML::Atom\fR manpage for author, copyright, and license
 231 information.