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

Download:
WebService-ScormCloud-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

WebService::ScormCloud::Service - ScormCloud API base class

VERSION ^

Version 0.03

SYNOPSIS ^

    use WebService::ScormCloud;

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

    print "Service is alive\n" if $ScormCloud->ping;

    print "Auth is valid\n"    if $ScormCloud->authPing;

DESCRIPTION ^

This module defines WebService::ScormCloud shared API methods. See WebService::ScormCloud for more info.

METHODS ^

request_uri ( params )

Returns a URI object that would be used to make a ScormCloud API request.

Note that you would not typically call this method directly - use the API methods defined in the "API CLASSES" instead.

The params hashref should contain all query params and values used in building the request query string. At minimum it must include a value for "method".

request ( params [ , args ] )

Make an API request:

    my $parsed_response_data =
      $ScormCloud->request(method => 'rustici.debug.authPing');

Note that you would not typically call this method directly - use the API methods defined in the "API CLASSES" instead.

process_request ( params, callback )

Make an API request, and return desired data out of the response.

Input arguments are:

params

A hashref of API request params. At minimum must include "method".

callback

A callback function that extracts and returns the desired data from the response data. The callback should expect a single argument "response" which is the parsed XML response data.

args

An optional hashref of arguments to modify the 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

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: