Johan Vromans > SugarSync-API-0.06 > SugarSync::API

Download:
SugarSync-API-0.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.06   Source  

NAME ^

SugarSync::API - Basic API to SugarSync cloud file sharing.

SYNOPSIS ^

    use SugarSync::API;
    my $sushi = SugarSync::API->new( $username, $password );
    $sushi->get_userinfo;
    say "My SugarSync nickname is ", $sushi->{nickname};

Data structures are discussed in SugarSync::API::Data.

METHODS ^

new [ username, password ]

Create a new API object.

If you pass a username and password, the object will be authorized. Otherwise, an explicit call to the method get_auth is required.

get_auth( username, password )

Get the authorization token for subsequent calls and stores it internally to be used with other method calls.

Returns the authorization token.

get_userinfo

Retrieves the user info, e.g., quota, shared folders and so on.

get_receivedShares

Returns the data for the shared folders.

get_receivedShare( $share )

Retrieves detailed information for a shared folder.

get_files( $folder )

Retrieves the files data for a folder.

get_collections( $folder )

Retrieves the collections data for a folder.

get_url_data( $url )

Retrieves the raw data for a given url.

Handles basic errors, like 401 (authentication token expired) and temporary server failures.

get_url_xml( $url, $dump )

Retrieves the XML data for a given url and returns it as a Perl structure.

Optionally, dumps (using Data::Dumper) the structure to STDERR.

SugarSync::API::Data

AUTHOR ^

Johan Vromans, <jv at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-sugarsync-api at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SugarSync-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc SugarSync::API
    perldoc SugarSync::API::Data

You can also look for information at:

ACKNOWLEDGEMENTS ^

Thanks to Mark Willis for producing a non-functional php module.

COPYRIGHT & LICENSE ^

Copyright 2011 Johan Vromans, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: