GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  XML::ATOM::CLIENT (3)

.ds Aq ’

NAME

XML::Atom::Client - A client for the Atom API

CONTENTS

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.

<B>NOTE:B> the API, and particularly the authentication scheme, are still in flux.

USAGE

    XML::Atom::Client->new(%param)

CW$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.

CW$api->username([ CW$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.

CW$api->password([ CW$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.

CW$api->createEntry($PostURI, CW$entry)

Creates a new entry.

$entry must be an XML::Atom::Entry object.

CW$api->getEntry($EditURI)

Retrieves the entry with the given URL $EditURI.

Returns an XML::Atom::Entry object.

CW$api->updateEntry($EditURI, CW$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.

CW$api->deleteEntry($EditURI)

Deletes the entry at URL $EditURI.

CW$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.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 XML::ATOM::CLIENT (3) 2011-06-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.