NAME
Bb::Collaborate::Ultra - Perl bindings for Blackboard Ultra virtual classroms
VERSION
Version 0.00.00_3
DESCRIPTION
Blackboard Collaborate Ultira is software for virtual web classrooms. It is suitable for meetings, demonstrations web conferences, seminars, general training and support.
Bb-Ultra is a set of Perl bindings and entity definitions for the Collaborate REST services. These can be used to administer classrooms, including sessions, users and recordings.
Bb::Collaborate::Ultra is an abstract base class for various resource classess (e.g. Bb::Collaborate::Ultra::Session) and contains both builder and inherited methods from implementing these classes.
METHODS
new
Creates a new object.
post
Saves a newly created object on the server.
put
Updates an existing object
get
Fetches one or more objects from the server.
del
Deletes an object from the server
find_or_create
Attempts a get on the object. If that fails, createas an new object on the server.
path
Computes a RESTful resource path for the object.
parent
Returns any parent class for the object. May be used to compute the path.
changed
Returns a list of fields that have been updated since the object was last saved via a `put`, or `post`, or fetched via a `get`.
connection
Returns the connection associated with the object. Will be set if the object has been fetched via a `get`, added via a `store` or updated via a `put`.
Internal METHODS
query_params
__PACKAGE__->query_params(
name => 'Str',
extId => 'Str',
);This is used to specify any aditional layload fields that may be passed as query parameters, or returned along with object data.
freeze
Serializes an object to JSON., with data conversion.
- Dates are converted from numeric unix timestamps to date-strings
- Booleans are converted from numeric (0, 1) to 'true', or 'false'.
- Nested objects are recursively serialized.
thaw
The reverse of `freeze`. Deserializes JSON data to objects, with conversion of dates, boolean values or nested objects.
construct
Constructs a new object from server data.
load_schema
Constructs the object class from JSON schema data
LICENSE AND COPYRIGHT
Copyright 2016 David Warring.
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.