Permalink
Browse files

POD only: Added GitHub info

  • Loading branch information...
larryl committed Apr 4, 2011
1 parent e00bd83 commit 52cb54bc90d72ca45c0f4f4313c16563b28f9f97
@@ -75,7 +75,7 @@ called post-construction as object set/get methods.
=over 4
-=item app_id
+=item B<app_id>
B<Required.> An application ID generated for your login at
L<http://cloud.scorm.com/>.
@@ -88,7 +88,7 @@ has 'app_id' => (
isa => 'Str',
);
-=item secret_key
+=item B<secret_key>
B<Required.> A secret key that corresponds to the application ID,
used for hashing parameters in the API request URLs. Generated at
@@ -102,7 +102,7 @@ has 'secret_key' => (
isa => 'Str',
);
-=item service_url
+=item B<service_url>
The API service URL. Defaults to "http://cloud.scorm.com/api".
@@ -116,7 +116,7 @@ has 'service_url' => (
default => 'http://cloud.scorm.com/api',
);
-=item last_error_data
+=item B<last_error_data>
Returns a listref representing the raw response data for the
error(s) returned by the most recent ScormCloud service API call.
@@ -142,7 +142,7 @@ has 'last_error_data' => (
default => sub { return [] },
);
-=item last_error_msg
+=item B<last_error_msg>
Return a error message representing the error(s) returned by the
most recent ScormCloud service API call.
@@ -174,7 +174,7 @@ sub last_error_msg
return join("\n", @msg);
}
-=item lwp_user_agent
+=item B<lwp_user_agent>
Set the user agent string used in API requests. Defaults to "MyApp/1.0".
@@ -188,7 +188,7 @@ has 'lwp_user_agent' => (
default => 'MyApp/1.0',
);
-=item top_level_namespace
+=item B<top_level_namespace>
Top-level namespace for API methods. Defaults to "rustici".
@@ -201,7 +201,7 @@ has 'top_level_namespace' => (
default => 'rustici',
);
-=item dump_request_url
+=item B<dump_request_url>
Set to true to dump request URLs to STDOUT. Default is false.
@@ -213,7 +213,7 @@ has 'dump_request_url' => (
default => 0,
);
-=item dump_response_xml
+=item B<dump_response_xml>
Set to true to dump raw response XML to STDOUT. Default is false.
@@ -225,7 +225,7 @@ has 'dump_response_xml' => (
default => 0,
);
-=item dump_response_data
+=item B<dump_response_data>
Set to true to dump data from parsed response XML to STDOUT.
Default is false.
@@ -240,7 +240,7 @@ has 'dump_response_data' => (
default => 0,
);
-=item dump_api_results
+=item B<dump_api_results>
Set to true to dump results grabbed from response data by each API
call. Default is false.
@@ -255,7 +255,7 @@ has 'dump_api_results' => (
default => 0,
);
-=item die_on_bad_response
+=item B<die_on_bad_response>
Set to true to die if the API response data is malformed or invalid
for the given API method being called (mainly useful for testing).
@@ -307,6 +307,9 @@ L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -317,6 +320,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -232,17 +232,17 @@ Input arguments are:
=over 4
-=item params
+=item B<params>
A hashref of API request params. At minimum must include "method".
-=item callback
+=item B<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.
-=item args
+=item B<args>
An optional hashref of arguments to modify the request.
@@ -298,6 +298,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -308,6 +311,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -98,7 +98,7 @@ to filter the returned list of registrations:
=over 4
-=item filter
+=item B<filter>
A regular expression for matching the course ID
@@ -165,6 +165,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -175,6 +178,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -122,6 +122,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -132,6 +135,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -48,35 +48,35 @@ Required arguments are:
=over 4
-=item course_id
+=item B<course_id>
-=item registration_id
+=item B<registration_id>
-=item first_name
+=item B<first_name>
-=item last_name
+=item B<last_name>
-=item learner_id
+=item B<learner_id>
=back
Valid options include:
=over 4
-=item email
+=item B<email>
-=item postbackurl
+=item B<postbackurl>
-=item authtype
+=item B<authtype>
-=item urlname
+=item B<urlname>
-=item urlpass
+=item B<urlpass>
-=item resultsformat
+=item B<resultsformat>
-=item disableTracking
+=item B<disableTracking>
=back
@@ -184,11 +184,11 @@ to filter the returned list of registrations:
=over 4
-=item filter
+=item B<filter>
A regular expression for matching the registration ID
-=item coursefilter
+=item B<coursefilter>
A regular expression for matching the course ID
@@ -315,15 +315,15 @@ Valid options include:
=over 4
-=item cssurl
+=item B<cssurl>
-=item learnerTags
+=item B<learnerTags>
-=item courseTags
+=item B<courseTags>
-=item registrationTags
+=item B<registrationTags>
-=item disableTracking
+=item B<disableTracking>
=back
@@ -416,6 +416,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -426,6 +429,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -87,6 +87,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -97,6 +100,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -200,6 +200,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -210,6 +213,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>
@@ -77,6 +77,9 @@ Please report any bugs or feature requests to C<bug-scormcloud at rt.cpan.org>,
the web interface at L<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:
+L<https://github.com/larryl/ScormCloud>
+
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
@@ -87,6 +90,10 @@ You can also look for information at:
=over 4
+=item * GitHub
+
+L<https://github.com/larryl/ScormCloud>
+
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-ScormCloud>

0 comments on commit 52cb54b

Please sign in to comment.