NAME

Bb::Collaborate::V3::Session::Telephony - Session Telephony instance class

DESCRIPTION

This class is used to setup telephony information for an existing session

PROPERTIES

sessionId (Int)

The identifier of the session.

telephonyType (Str)

The type of telephony to configure.

thirdParty - You are using 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 - Telephony is disabled for this session.

chairPhone (Str)

The phone number for the session chair (also known as a session moderator) when the session is running.

chairPIN (Str)

The PIN for the chairPhone.

nonChairPhone (Str)

The phone number used by the session non-chair users (also known as a session participants). The information is for display purposes only in the session (so participants know what telephone number and PIN to use to connect to the teleconference).

nonChairPIN (Str)

The PIN for the nonChairPhone.

isPhone (Bool)

Used to indicate if the sessionSIPPhone field should be validated as a Session Initiation Protocol (SIP) or phone number.

sessionSIPPhone (Str)

The Session Initiation Protocol (SIP) or phone number used by the session. Sometimes referred to as the session bridge or teleconference bridge. For accepted phone number and SIP formats, see Notes About Session Telephony Validation on page 67.

sessionPIN (Str)

The PIN for the sessionSIPPhone.

METHODS

update

    my $session_telephony = $session->telephony;

    my %telephony_data = (
        chairPhone => '(03) 5999 1234',
        chairPIN   => '6342',
        nonChairPhone => '(03) 5999 2234',
        nonChairPIN   => '7722',
        isPhone => '1',
        sessionSIPPhone => '(03) 6999 2222',
        sessionPIN => '1234',
        );

    $session_telephony->update(\%telephony_data);

Updates a session's telephony characteristics.