David Warring > Elive-StandardV3 > Elive::StandardV3

Download:
Elive-StandardV3-0.01_4.tar.gz

Dependencies

Annotate this POD

Module Version: 0.01_4   Source  

NAME ^

Elive::StandardV3 - Perl bindings for the Elluminate Live Standard Bridge (V3)

VERSION ^

Version 0.01_4

DESCRIPTION ^

Elluminate Live! (c) is software for virtual online classrooms. It is suitable for meetings, demonstrations web conferences, seminars and general training and support.

Elive-StandardV3 is a set of Perl bindings and entity definitions for the Elluminate Standard Bridge V3 SOAP services ('standardv3' adapter).

This is an alternative to the Command Toolkit, as supported by the Elive::Entity classess ('default' adapter).

EXAMPLE ^

    use Elive::StandardV3;
    use Elive::StandardV3::Session;
    use Elive::Util;

    my $connection = Elive::StandardV3->connect(
                                'http://myserver/mysite',
                                'some_user' => 'some_pass' );

    # Sessions must start and end on the quarter hour.

    my $session_start = Elive::Util::next_quarter_hour();
    my $session_end = Elive::Util::next_quarter_hour( $session_start );

    my %session_data = (
        sessionName   => 'My Demo Session',
        creatorId     => $connection->user,
        startTime     => $session_start . '000',
        endTime       => $session_end . '000',
        openChair     => 1,
        mustBeSupervised => 0,
        permissionsOn => 1,
        nonChairList  => [qw(alice bob)],
        groupingList  => [qw(mechanics sewing)],
    );

    my $session = Elive::StandardV3::Session->insert(\%session_data);

    my $url = $session->session_url( userId => 'bob', displayName => 'Robert');
    print "bob's session link is: $url\n";

DESCRIPTION ^

Implements Elluminate Live! Standard Bridge V3 API bindings

** DEVELOPER RELEASE - UNDER CONSTRUCTION **

METHODS ^

data_classes

returns a list of all implemented entity classes

connect

     use Elive::StandardV3;
     use Elive::StandardV3::Connection;

     #
     # Setup the default connection
     Elive::StandardV3->connect('http://myServer.com/test1', 'user1', 'pass1');
     my $c1 = Elive::StandardV3->connection;
     #
     # Setup a secondary connection
     my $c2 = Elive::StandardV3::Connection->connect('http://user2:pass2@myServer.com/test2');

Connects to an Elluminate server instance. Dies if the connection could not be established. If, for example, the SOAP connection or authentication failed.

See also Elive::StandardV3::Connection.

connection

     $e1 = Elive::StandardV3->connection
         or warn 'no elive connection active';

Returns the default Elive connection handle.

update

Abstract method to commit outstanding object updates to the server.

    $obj->{foo} = 'Foo';  # change foo attribute directly
    $foo->update;         # save

    $obj->bar('Bar');     # change bar via its accessor
    $obj->update;         # save

Updates may also be passed as parameters.

   # change and save foo and bar. All in one go.
    $obj->update({foo => 'Foo', bar => 'Bar'});

insert

Abstract method to create new entity instances on the server:

    my $multimedia = Elive::StandardV3::Multimedia->insert(
             {
                    filename => 'demo.wav',
                    creatorId =>  'bob',
                    content => $content,
             },
         );

list

Abstract selection method. Most commands allow a ranging expression to narrow the selection. This is passed in using the filter option. For example:

    my $bobs_sessions = Elive::StandardV3::Session->list({userId => 'bob'});

delete

Abstract method to delete entities:

    $multimedia->delete;

SEE ALSO ^

Elive::StandardV3::Connection Elive::StandardV3::Multimedia Elive::StandardV3::Session Elive::StandardV3::SessionAttendance Elive::StandardV3::SessionTelephony Elive::StandardV3::Presentation Elive::StandardV3::SchedulingManager Elive::StandardV3::ServerConfiguration Elive::StandardV3::ServerVersion Elive::StandardV3::Recording

AUTHOR ^

David Warring, <david.warring at gmail.com>

BUGS ^

Please report any bugs or feature requests to bug-elive-StandardV3 at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Elive-StandardV3. 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 Elive::StandardV3

You can also look for information at:

SEE ALSO ^

Standard Integration API Guide for ELM.pdf - this contains essential background information and a full description of the available commands.

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2012 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.

syntax highlighting: