Larry Leszczynski > WebService-ScormCloud-0.03 > WebService::ScormCloud::Service::Upload

Download:
WebService-ScormCloud-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

WebService::ScormCloud::Service::Upload - ScormCloud API "upload" namespace

VERSION ^

Version 0.03

SYNOPSIS ^

    use WebService::ScormCloud;

    my $ScormCloud = WebService::ScormCloud->new(
                        app_id      => '12345678',
                        secret_key  => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
    );

    my $token = $ScormCloud->getUploadToken;

    my $remote_filename = $ScormCloud->uploadFile($file, $token);

    my $progress = $ScormCloud->getUploadProgress($token);

    my $uploaded_files = $ScormCloud->listFiles;

DESCRIPTION ^

This module defines WebService::ScormCloud API methods in the "upload" namespace. See WebService::ScormCloud for more info.

METHODS ^

getUploadToken

Get and return an upload token to be used with a file upload.

getUploadProgress ( token )

Given an upload token, get progress info for the corresponding upload.

uploadFile ( file [ , token ] )

Upload a file. Will generate an upload token is none is supplied.

Returns the generated destination path on the remote filesystem.

listFiles

Return a list of files that have been uploaded using the given AppID.

deleteFiles ( file )

Delete a file that was uploaded.

Note: This method only handles one file at a time even though the API service can accept multiple files for deletion in a single request.

SEE ALSO ^

WebService::ScormCloud

AUTHOR ^

Larry Leszczynski, <larryl at cpan.org>

BUGS ^

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

Patches more than welcome, especially via GitHub: https://github.com/larryl/ScormCloud

SUPPORT ^

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

    perldoc WebService::ScormCloud::Service::Upload

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2010 Larry Leszczynski.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: