-
-
28 Apr 2021 20:40:29 UTC
- Distribution: XML-Atom
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (5)
- Testers (88 / 0 / 0)
- Kwalitee
Bus factor: 3- 65.53% Coverage
- License: perl_5
- Perl: v5.8.1
- Activity
24 month- Tools
- Download (57.73KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 17 contributors- Benjamin Trott, Tatsuhiko Miyagawa
-
Andreas Marienborg
-
Benjamin Trott
-
Christian Walde
-
Dave Cross
-
David Steinbrunner
-
emasaka
-
Florian Schlichting
-
Jonathan "Duke" Leto
-
Martin Atkins
-
root
-
Simon Wistow
-
tokuhirom
-
Tomas Doran
-
tzccinct
-
Vince Veselosky
-
Yann Kerherve
NAME
XML::Atom::Client - A client for the Atom API
SYNOPSIS
use XML::Atom::Client; use XML::Atom::Entry; my $api = XML::Atom::Client->new; $api->username('Melody'); $api->password('Nelson'); my $entry = XML::Atom::Entry->new; $entry->title('New Post'); $entry->content('Content of my post.'); my $EditURI = $api->createEntry($PostURI, $entry); my $feed = $api->getFeed($FeedURI); my @entries = $feed->entries; my $entry = $api->getEntry($EditURI);
DESCRIPTION
XML::Atom::Client implements a client for the Atom API described at http://bitworking.org/projects/atom/draft-gregorio-09.html, with the authentication scheme described at http://www.intertwingly.net/wiki/pie/DifferentlyAbledClients.
NOTE: the API, and particularly the authentication scheme, are still in flux.
USAGE
XML::Atom::Client->new(%param)
$api->use_soap([ 0 | 1 ])
XML::Atom::Client supports both the REST and SOAP-wrapper versions of the Atom API. By default, the REST version of the API will be used, but you can turn on the SOAP wrapper--for example, if you need to connect to a server that supports only the SOAP wrapper--by calling use_soap with a value of
1
:$api->use_soap(1);
If called without arguments, returns the current value of the flag.
$api->username([ $username ])
If called with an argument, sets the username for login to $username.
Returns the current username that will be used when logging in to the Atom server.
$api->password([ $password ])
If called with an argument, sets the password for login to $password.
Returns the current password that will be used when logging in to the Atom server.
$api->createEntry($PostURI, $entry)
Creates a new entry.
$entry must be an XML::Atom::Entry object.
$api->getEntry($EditURI)
Retrieves the entry with the given URL $EditURI.
Returns an XML::Atom::Entry object.
$api->updateEntry($EditURI, $entry)
Updates the entry at URL $EditURI with the entry $entry, which must be an XML::Atom::Entry object.
Returns true on success, false otherwise.
$api->deleteEntry($EditURI)
Deletes the entry at URL $EditURI.
$api->getFeed($FeedURI)
Retrieves the feed at $FeedURI.
Returns an XML::Atom::Feed object representing the feed returned from the server.
ERROR HANDLING
Methods return
undef
on error, and the error message can be retrieved using the errstr method.AUTHOR & COPYRIGHT
Please see the XML::Atom manpage for author, copyright, and license information.
Module Install Instructions
To install XML::Atom, copy and paste the appropriate command in to your terminal.
cpanm XML::Atom
perl -MCPAN -e shell install XML::Atom
For more information on module installation, please visit the detailed CPAN module installation guide.