NAME

Bb::Collaborate::V3::Connection - Manage Collaborate SOAP V3 endpoint connections.

DESCRIPTION

This module handles logical connections to the .../webservice.event endpoint on the Collaborate server. This endpoint implements the Standard Bridge API.

connect

    my $con = Bb::Collaborate::V3::Connection->connect('https://xx-sas.bbcollab.com/site/external/adapter/default/v3',
                                                     'user1', 'pass1', debug => 1,
    );

    my $url = $con->url;   #  'https://xx-sas.bbcollab.com/site/external/adapter/default/v3.3/webservice.event'

Establishes a SOAP connection. Retrieves the server configuration, to verify connectivity, authentication and basic operation.

disconnect

Closes a connection and frees any resources related to the connection.

call

    my $som = $self->call( $cmd, %params );

Performs a Collaborate SOAP method call. Returns the response as a SOAP::SOM object.

soap

    my $soap_lite_obj = $connection->soap;

Returns the underlying SOAP::Lite object for the connection.

scheduling_manager

Returns the scheduling manager for this connection (see Bb::Collaborate::V3::SchedulingManager).

server_configuration

Returns the server configuration for this connection (see Bb::Collaborate::V3::Server::Configuration).

server_versions

Returns the server versions for this connection (see Bb::Collaborate::V3::Server::Version).

quota_limits

Returns a list of available quotas and current usages.

telephony_license

Returns the servers's telephony license, as a string. One of:

(*) thirdParty - You must use your own teleconference provider. You must manually configure the teleconference connection information.
(*) integrated - The teleconference service is provided by Blackboard Collaborate. Teleconference phone numbers and PINs are automatically generated during session creation and anyone in the session can initiate the connection between the session and the teleconference by simply dialing in to the teleconference.
(*) none - No teleconferencing is supported.

version

Equivalent to $self->server_versions->versionName.

url

Return the SOAP end-point URL.