| 1 | package Bb::Collaborate::V3::Session; | ||||||||||||||||||||||||||||
| 2 | 6 | ▶ | use warnings; use strict; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 3 | 6 | ▶ | use Mouse; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 4 | |||||||||||||||||||||||||||||
| 5 | 6 | extends 'Bb::Collaborate::V3'; | |||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||
| 7 | 6 | ▶ | use Scalar::Util; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 8 | 6 | ▶ | use Carp; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 9 | |||||||||||||||||||||||||||||
| 10 | 6 | ▶ | use Elive::Util; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 11 | |||||||||||||||||||||||||||||
| 12 | 6 | ▶ | use Bb::Collaborate::V3::_List; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 13 | 6 | ▶ | use Bb::Collaborate::V3::Session::Attendance; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 14 | 6 | ▶ | use Bb::Collaborate::V3::Session::Telephony; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 15 | 6 | ▶ | use Bb::Collaborate::V3::Multimedia; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 16 | 6 | ▶ | use Bb::Collaborate::V3::Presentation; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 17 | 6 | ▶ | use Bb::Collaborate::V3::Recording; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 18 | |||||||||||||||||||||||||||||
| 19 | =head1 NAME | ||||||||||||||||||||||||||||
| 20 | |||||||||||||||||||||||||||||
| 21 | Bb::Collaborate::V3::Session - Collaborate session instance class | ||||||||||||||||||||||||||||
| 22 | |||||||||||||||||||||||||||||
| 23 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 24 | |||||||||||||||||||||||||||||
| 25 | This is the main entity class for sessions. | ||||||||||||||||||||||||||||
| 26 | |||||||||||||||||||||||||||||
| 27 | =cut | ||||||||||||||||||||||||||||
| 28 | |||||||||||||||||||||||||||||
| 29 | 6 | __PACKAGE__->entity_name('Session'); | |||||||||||||||||||||||||||
| 30 | |||||||||||||||||||||||||||||
| 31 | 6 | __PACKAGE__->params( | |||||||||||||||||||||||||||
| 32 | displayName => 'Str', | ||||||||||||||||||||||||||||
| 33 | userId => 'Str', | ||||||||||||||||||||||||||||
| 34 | groupingId => 'Str', | ||||||||||||||||||||||||||||
| 35 | presentationId => 'Int', | ||||||||||||||||||||||||||||
| 36 | multimediaId => 'Int', | ||||||||||||||||||||||||||||
| 37 | multimediaIds => 'Bb::Collaborate::V3::_List', | ||||||||||||||||||||||||||||
| 38 | recurrenceCount => 'Int', | ||||||||||||||||||||||||||||
| 39 | recurrenceDays => 'Int', | ||||||||||||||||||||||||||||
| 40 | apiCallbackUrl => 'Str', | ||||||||||||||||||||||||||||
| 41 | isChair => 'Bool', | ||||||||||||||||||||||||||||
| 42 | ); | ||||||||||||||||||||||||||||
| 43 | |||||||||||||||||||||||||||||
| 44 | # mostly to help elive_query | ||||||||||||||||||||||||||||
| 45 | 6 | __PACKAGE__->derivable( | |||||||||||||||||||||||||||
| 46 | attendance => 'attendance', | ||||||||||||||||||||||||||||
| 47 | multimedia => 'list_multimedia', | ||||||||||||||||||||||||||||
| 48 | presentation => 'list_presentation', | ||||||||||||||||||||||||||||
| 49 | recordings => 'list_recordings', | ||||||||||||||||||||||||||||
| 50 | telephony => 'telephony', | ||||||||||||||||||||||||||||
| 51 | ); | ||||||||||||||||||||||||||||
| 52 | |||||||||||||||||||||||||||||
| 53 | =head1 PROPERTIES | ||||||||||||||||||||||||||||
| 54 | |||||||||||||||||||||||||||||
| 55 | =head2 sessionId (Int) | ||||||||||||||||||||||||||||
| 56 | |||||||||||||||||||||||||||||
| 57 | Identifier of the session. | ||||||||||||||||||||||||||||
| 58 | |||||||||||||||||||||||||||||
| 59 | =cut | ||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||
| 61 | 6 | has 'sessionId' => (is => 'rw', isa => 'Int', required => 1); | |||||||||||||||||||||||||||
| 62 | 6 | __PACKAGE__->primary_key('sessionId'); | |||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||
| 64 | =head2 accessType (Int) | ||||||||||||||||||||||||||||
| 65 | |||||||||||||||||||||||||||||
| 66 | Session access type: | ||||||||||||||||||||||||||||
| 67 | |||||||||||||||||||||||||||||
| 68 | =over 4 | ||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||
| 70 | =item 1. I<Private> - Only the SAS Owner may join the session. Note: this type does not apply to ELM. If | ||||||||||||||||||||||||||||
| 71 | you set this to 1, the API will change it to 2. | ||||||||||||||||||||||||||||
| 72 | |||||||||||||||||||||||||||||
| 73 | =item 2. I<Restricted> - only users specified in the chair or non-chair lists (or guests invited with the email links) may join. | ||||||||||||||||||||||||||||
| 74 | |||||||||||||||||||||||||||||
| 75 | =item 3. I<Public> - All users within your login group may join. | ||||||||||||||||||||||||||||
| 76 | |||||||||||||||||||||||||||||
| 77 | =back | ||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||
| 79 | Notes: | ||||||||||||||||||||||||||||
| 80 | |||||||||||||||||||||||||||||
| 81 | =over 4 | ||||||||||||||||||||||||||||
| 82 | |||||||||||||||||||||||||||||
| 83 | =item * SAS Use of this parameter should be avoided as this controls | ||||||||||||||||||||||||||||
| 84 | SAS Native Mode session and recording access. The default value for | ||||||||||||||||||||||||||||
| 85 | this parameter is 2 (Restricted) and is appropriate for API use. | ||||||||||||||||||||||||||||
| 86 | |||||||||||||||||||||||||||||
| 87 | =item * ELM If you don't specify a value, the default is taken from the C<Restrict Session Access> setting in the Default Session Preferences, These preferences are available through the ELM user interface. For more information, see the online help available from the Collaborate Manager user interface. | ||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||
| 89 | =back | ||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||
| 91 | =cut | ||||||||||||||||||||||||||||
| 92 | |||||||||||||||||||||||||||||
| 93 | 6 | has 'accessType' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 94 | documentation => '1=private (n/a), 2=restricted, 3=public', | ||||||||||||||||||||||||||||
| 95 | ); | ||||||||||||||||||||||||||||
| 96 | |||||||||||||||||||||||||||||
| 97 | =head2 allowInSessionInvites (Bool) | ||||||||||||||||||||||||||||
| 98 | |||||||||||||||||||||||||||||
| 99 | This flag value controls whether or not the chair of this session can send invitations to join the session from within the session. | ||||||||||||||||||||||||||||
| 100 | |||||||||||||||||||||||||||||
| 101 | If you don't specify a value, the default is taken from the C<Allow in-Session | ||||||||||||||||||||||||||||
| 102 | invites> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 103 | |||||||||||||||||||||||||||||
| 104 | =cut | ||||||||||||||||||||||||||||
| 105 | |||||||||||||||||||||||||||||
| 106 | 6 | has 'allowInSessionInvites' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 107 | documentation => 'allow in-session invitations', | ||||||||||||||||||||||||||||
| 108 | ); | ||||||||||||||||||||||||||||
| 109 | |||||||||||||||||||||||||||||
| 110 | =head2 boundaryTime (Int) | ||||||||||||||||||||||||||||
| 111 | |||||||||||||||||||||||||||||
| 112 | Boundary time. (Defined as the period before the start of a session in which users can join the session. Used by chairs to preload content and by non-chairs who have never joined a Collabroate session before to download any files and configure their audio.) | ||||||||||||||||||||||||||||
| 113 | |||||||||||||||||||||||||||||
| 114 | Specified in minutes, to a maximum value of 1440 minutes (24 hours). | ||||||||||||||||||||||||||||
| 115 | If you don't specify a value, the default is taken from the C<Boudary Time> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 116 | |||||||||||||||||||||||||||||
| 117 | =cut | ||||||||||||||||||||||||||||
| 118 | |||||||||||||||||||||||||||||
| 119 | 6 | has 'boundaryTime' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 120 | documentation => 'boundary time minutes: 0, 15, 30...', | ||||||||||||||||||||||||||||
| 121 | ); | ||||||||||||||||||||||||||||
| 122 | |||||||||||||||||||||||||||||
| 123 | =head2 chairList (Str) | ||||||||||||||||||||||||||||
| 124 | |||||||||||||||||||||||||||||
| 125 | Array of user identifiers from your system that specifies which users may join the Collaborate session as chairpersons. | ||||||||||||||||||||||||||||
| 126 | |||||||||||||||||||||||||||||
| 127 | Each user identifier in the list may be 1 - 64 characters in length, and each identifier is case sensitive and can include UTF-8 characters. | ||||||||||||||||||||||||||||
| 128 | |||||||||||||||||||||||||||||
| 129 | A userId may not appear in both the chair and non-chair lists. | ||||||||||||||||||||||||||||
| 130 | |||||||||||||||||||||||||||||
| 131 | Note: See also the C<register_atttendee> method, which can be used to add a user to the chair or non-chair list when joining. | ||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||
| 133 | =cut | ||||||||||||||||||||||||||||
| 134 | |||||||||||||||||||||||||||||
| 135 | 6 | has 'chairList' => (is => 'rw', isa => 'Bb::Collaborate::V3::_List', coerce => 1, | |||||||||||||||||||||||||||
| 136 | documentation => 'list of chair-persons', | ||||||||||||||||||||||||||||
| 137 | ); | ||||||||||||||||||||||||||||
| 138 | |||||||||||||||||||||||||||||
| 139 | =head2 chairNotes (Str) | ||||||||||||||||||||||||||||
| 140 | |||||||||||||||||||||||||||||
| 141 | Text field that can be used to store notes specific to users with chair role. | ||||||||||||||||||||||||||||
| 142 | 1 to 2147483647 characters in length. | ||||||||||||||||||||||||||||
| 143 | |||||||||||||||||||||||||||||
| 144 | =cut | ||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||
| 146 | 6 | has 'chairNotes' => (is => 'rw', isa => 'Str', | |||||||||||||||||||||||||||
| 147 | documentation => 'chair notes', | ||||||||||||||||||||||||||||
| 148 | ); | ||||||||||||||||||||||||||||
| 149 | |||||||||||||||||||||||||||||
| 150 | =head2 creatorId (Str) | ||||||||||||||||||||||||||||
| 151 | |||||||||||||||||||||||||||||
| 152 | Identifier of the session creator as specified by you in your system. | ||||||||||||||||||||||||||||
| 153 | Case sensitive. 1 - 32 characters in length. Can include UTF-8 characters. | ||||||||||||||||||||||||||||
| 154 | |||||||||||||||||||||||||||||
| 155 | =cut | ||||||||||||||||||||||||||||
| 156 | |||||||||||||||||||||||||||||
| 157 | 6 | has 'creatorId' => (is => 'rw', isa => 'Str', required => 1, | |||||||||||||||||||||||||||
| 158 | documentation => 'creator user id', | ||||||||||||||||||||||||||||
| 159 | ); | ||||||||||||||||||||||||||||
| 160 | |||||||||||||||||||||||||||||
| 161 | =head2 endTime (HiResDate) | ||||||||||||||||||||||||||||
| 162 | |||||||||||||||||||||||||||||
| 163 | End date and time of the session in milliseconds. | ||||||||||||||||||||||||||||
| 164 | |||||||||||||||||||||||||||||
| 165 | =cut | ||||||||||||||||||||||||||||
| 166 | |||||||||||||||||||||||||||||
| 167 | 6 | has 'endTime' => (is => 'rw', isa => 'HiResDate', required => 1, | |||||||||||||||||||||||||||
| 168 | documentation => 'session end time'); | ||||||||||||||||||||||||||||
| 169 | |||||||||||||||||||||||||||||
| 170 | =head2 groupingList (Str) | ||||||||||||||||||||||||||||
| 171 | |||||||||||||||||||||||||||||
| 172 | Array of unique course identifiers from your system with which to associate this Collaborate session. | ||||||||||||||||||||||||||||
| 173 | |||||||||||||||||||||||||||||
| 174 | Each course identifier may be 1 - 32 characters in length, each identifier is case sensitive and can include UTF-8 characters. | ||||||||||||||||||||||||||||
| 175 | |||||||||||||||||||||||||||||
| 176 | =cut | ||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | 6 | has 'groupingList' => (is => 'rw', isa => 'Bb::Collaborate::V3::_List', coerce => 1, | |||||||||||||||||||||||||||
| 179 | documentation => 'list of courses etc (user defined)', | ||||||||||||||||||||||||||||
| 180 | ); | ||||||||||||||||||||||||||||
| 181 | |||||||||||||||||||||||||||||
| 182 | =head2 sessionName (Str) | ||||||||||||||||||||||||||||
| 183 | |||||||||||||||||||||||||||||
| 184 | The session name. This name will appear in the Collaborate session title | ||||||||||||||||||||||||||||
| 185 | bar. Case insensitive. 1 - 255 characters in length. Must begin with a letter | ||||||||||||||||||||||||||||
| 186 | or digit and may not contain C<E<lt>>, C<&>, '"', C<#>, or C<%>. | ||||||||||||||||||||||||||||
| 187 | |||||||||||||||||||||||||||||
| 188 | =cut | ||||||||||||||||||||||||||||
| 189 | |||||||||||||||||||||||||||||
| 190 | 6 | has 'sessionName' => (is => 'rw', isa => 'Str', required => 1, | |||||||||||||||||||||||||||
| 191 | documentation => 'session name', | ||||||||||||||||||||||||||||
| 192 | ); | ||||||||||||||||||||||||||||
| 193 | |||||||||||||||||||||||||||||
| 194 | =head2 hideParticipantNames (Bool) | ||||||||||||||||||||||||||||
| 195 | |||||||||||||||||||||||||||||
| 196 | This flag value controls whether or not the session participant names are hidden in any session recording that may be made. | ||||||||||||||||||||||||||||
| 197 | |||||||||||||||||||||||||||||
| 198 | If you don't specify a value, the default is taken from the C<Hide Names in | ||||||||||||||||||||||||||||
| 199 | Recordings> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 200 | |||||||||||||||||||||||||||||
| 201 | =cut | ||||||||||||||||||||||||||||
| 202 | |||||||||||||||||||||||||||||
| 203 | 6 | has 'hideParticipantNames' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 204 | documentation => 'Hide Participant Names', | ||||||||||||||||||||||||||||
| 205 | ); | ||||||||||||||||||||||||||||
| 206 | |||||||||||||||||||||||||||||
| 207 | =head2 maxCameras (Int) | ||||||||||||||||||||||||||||
| 208 | |||||||||||||||||||||||||||||
| 209 | Maximum number of simultaneous video cameras to be configured in the Collaborate session at session launch time. | ||||||||||||||||||||||||||||
| 210 | |||||||||||||||||||||||||||||
| 211 | For single server configurations, this value must be between 1 and C<maxAvailableCameras> (as returned from the L<Bb::Collaborate::V3::Server::Configuration> C<get()> method). | ||||||||||||||||||||||||||||
| 212 | |||||||||||||||||||||||||||||
| 213 | For multiple server configurations, this must be between 1 and versionMaxFilmersLimit for the version you are using (as returned from the L<Bb::Collaborate::V3::Server::Version> C<list()> method). | ||||||||||||||||||||||||||||
| 214 | |||||||||||||||||||||||||||||
| 215 | If you don't specify a value, the default is taken from the C<Max Cameras> | ||||||||||||||||||||||||||||
| 216 | setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 217 | |||||||||||||||||||||||||||||
| 218 | =cut | ||||||||||||||||||||||||||||
| 219 | |||||||||||||||||||||||||||||
| 220 | 6 | has 'maxCameras' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 221 | documentation => 'maximum simultaneous cameras' | ||||||||||||||||||||||||||||
| 222 | ); | ||||||||||||||||||||||||||||
| 223 | |||||||||||||||||||||||||||||
| 224 | =head2 maxTalkers (Int) | ||||||||||||||||||||||||||||
| 225 | |||||||||||||||||||||||||||||
| 226 | Maximum number of simultaneous talkers to be configured in the Collaborate session at session launch time. | ||||||||||||||||||||||||||||
| 227 | |||||||||||||||||||||||||||||
| 228 | For single server configurations, this value must be between 1 and C<maxAvailableTalkers> property (as returned from the L<Bb::Collaborate::V3::Server::Configuration> C<get()> method). | ||||||||||||||||||||||||||||
| 229 | |||||||||||||||||||||||||||||
| 230 | For multiple server configurations, this must be between 1 and C<versionMaxTalkersLimit> for the version you are using (as returned from the L<Bb::Collaborate::V3::Server::Version> C<get()> method). | ||||||||||||||||||||||||||||
| 231 | |||||||||||||||||||||||||||||
| 232 | If you don't specify a value, the default is taken from the C<Max Talkers> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 233 | |||||||||||||||||||||||||||||
| 234 | =cut | ||||||||||||||||||||||||||||
| 235 | |||||||||||||||||||||||||||||
| 236 | 6 | has 'maxTalkers' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 237 | documentation => 'maximum simultaenous talkers' | ||||||||||||||||||||||||||||
| 238 | ); | ||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||
| 240 | =head2 mustBeSupervised (Bool) | ||||||||||||||||||||||||||||
| 241 | |||||||||||||||||||||||||||||
| 242 | Permits chairpersons to view all private chat messages in the Collaborate session. | ||||||||||||||||||||||||||||
| 243 | |||||||||||||||||||||||||||||
| 244 | If you don't specify a value, the default is taken from the C<Session is | ||||||||||||||||||||||||||||
| 245 | supervised> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 246 | |||||||||||||||||||||||||||||
| 247 | =cut | ||||||||||||||||||||||||||||
| 248 | |||||||||||||||||||||||||||||
| 249 | 6 | has 'mustBeSupervised' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 250 | documentation => 'Session number be supervised', | ||||||||||||||||||||||||||||
| 251 | ); | ||||||||||||||||||||||||||||
| 252 | |||||||||||||||||||||||||||||
| 253 | =head2 nonChairList | ||||||||||||||||||||||||||||
| 254 | |||||||||||||||||||||||||||||
| 255 | Comma-separated list of user identifiers from your system that specifies which users may join the Collaborate session as non-chair participants. (That is assuming that openChair is set to false. If C<openChair> is set to true, then all users will be chairpersons.) | ||||||||||||||||||||||||||||
| 256 | |||||||||||||||||||||||||||||
| 257 | Each user identifier in the list may be 1 - 64 characters in length, and each identifier is case sensitive and can include UTF-8 characters. | ||||||||||||||||||||||||||||
| 258 | |||||||||||||||||||||||||||||
| 259 | A userId may not appear in both the chair and non-chair lists. | ||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||
| 261 | Note: See also the C<register_atttendee> method, which can be used to add a user to the chair or non-chair list when joining. | ||||||||||||||||||||||||||||
| 262 | |||||||||||||||||||||||||||||
| 263 | =cut | ||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||
| 265 | 6 | has 'nonChairList' => (is => 'rw', isa => 'Bb::Collaborate::V3::_List', coerce => 1, | |||||||||||||||||||||||||||
| 266 | documentation => 'list of participants', | ||||||||||||||||||||||||||||
| 267 | ); | ||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||
| 269 | =head2 nonChairNotes (Str) | ||||||||||||||||||||||||||||
| 270 | |||||||||||||||||||||||||||||
| 271 | Text field that can be used to store notes specific to non-chair participants. | ||||||||||||||||||||||||||||
| 272 | 1 to 2147483647 characters in length. | ||||||||||||||||||||||||||||
| 273 | |||||||||||||||||||||||||||||
| 274 | =cut | ||||||||||||||||||||||||||||
| 275 | |||||||||||||||||||||||||||||
| 276 | 6 | has 'nonChairNotes' => (is => 'rw', isa => 'Str', | |||||||||||||||||||||||||||
| 277 | documentation => 'non chair notes', | ||||||||||||||||||||||||||||
| 278 | ); | ||||||||||||||||||||||||||||
| 279 | |||||||||||||||||||||||||||||
| 280 | =head2 startTime (HiResDate) | ||||||||||||||||||||||||||||
| 281 | |||||||||||||||||||||||||||||
| 282 | Start date and time of the session in milliseconds. | ||||||||||||||||||||||||||||
| 283 | |||||||||||||||||||||||||||||
| 284 | This can be constructed by appending C<000> to a standard unix epoch date. | ||||||||||||||||||||||||||||
| 285 | |||||||||||||||||||||||||||||
| 286 | =cut | ||||||||||||||||||||||||||||
| 287 | |||||||||||||||||||||||||||||
| 288 | 6 | has 'startTime' => (is => 'rw', isa => 'HiResDate', required => 1, | |||||||||||||||||||||||||||
| 289 | documentation => 'session start time'); | ||||||||||||||||||||||||||||
| 290 | |||||||||||||||||||||||||||||
| 291 | =head2 openChair (Bool) | ||||||||||||||||||||||||||||
| 292 | |||||||||||||||||||||||||||||
| 293 | All users will join the session as a chairperson in the Collaborate session. | ||||||||||||||||||||||||||||
| 294 | |||||||||||||||||||||||||||||
| 295 | If you don't specify a value, the default is taken from the C<Permissions granted on enter> setting in the | ||||||||||||||||||||||||||||
| 296 | Meeting Defaults. | ||||||||||||||||||||||||||||
| 297 | |||||||||||||||||||||||||||||
| 298 | =cut | ||||||||||||||||||||||||||||
| 299 | |||||||||||||||||||||||||||||
| 300 | 6 | has 'openChair' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 301 | documentation => 'Let all users act as chairpersons', | ||||||||||||||||||||||||||||
| 302 | ); | ||||||||||||||||||||||||||||
| 303 | |||||||||||||||||||||||||||||
| 304 | =head2 permissionsOn (Bool) | ||||||||||||||||||||||||||||
| 305 | |||||||||||||||||||||||||||||
| 306 | All users who join the session as non-chairpersons are granted full permissions to session resources such as audio, whiteboard, etc. | ||||||||||||||||||||||||||||
| 307 | |||||||||||||||||||||||||||||
| 308 | If you don't specify a value, the default is taken from the C<Permissions granted on enter> setting in the | ||||||||||||||||||||||||||||
| 309 | Meeting Defaults. | ||||||||||||||||||||||||||||
| 310 | |||||||||||||||||||||||||||||
| 311 | =cut | ||||||||||||||||||||||||||||
| 312 | |||||||||||||||||||||||||||||
| 313 | 6 | has 'permissionsOn' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 314 | documentation => 'Whether all non chair participants are granted all permissions', | ||||||||||||||||||||||||||||
| 315 | ); | ||||||||||||||||||||||||||||
| 316 | |||||||||||||||||||||||||||||
| 317 | =head2 raiseHandOnEnter (Bool) | ||||||||||||||||||||||||||||
| 318 | |||||||||||||||||||||||||||||
| 319 | When users join the Collaborate session, they will automatically raise their hand (this is accompanied by an audible notification). | ||||||||||||||||||||||||||||
| 320 | |||||||||||||||||||||||||||||
| 321 | If you don't specify a value, the default is taken from the C<Raise hand on | ||||||||||||||||||||||||||||
| 322 | enter> setting in the Meeting Defaults. | ||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||
| 324 | =cut | ||||||||||||||||||||||||||||
| 325 | |||||||||||||||||||||||||||||
| 326 | 6 | has 'raiseHandOnEnter' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 327 | documentation => 'Whether users automaticially raise their hands as they join.', | ||||||||||||||||||||||||||||
| 328 | ); | ||||||||||||||||||||||||||||
| 329 | |||||||||||||||||||||||||||||
| 330 | =head2 recordingModeType (Int) | ||||||||||||||||||||||||||||
| 331 | |||||||||||||||||||||||||||||
| 332 | The mode of recording in the Collaborate session: | ||||||||||||||||||||||||||||
| 333 | |||||||||||||||||||||||||||||
| 334 | =over 4 | ||||||||||||||||||||||||||||
| 335 | |||||||||||||||||||||||||||||
| 336 | =item 1. (I<Manual>) - A chairperson must start the recording. | ||||||||||||||||||||||||||||
| 337 | |||||||||||||||||||||||||||||
| 338 | =item 2. (I<Automatic>) - The recording starts automatically when the session first starts. | ||||||||||||||||||||||||||||
| 339 | |||||||||||||||||||||||||||||
| 340 | =item 3. (I<Disabled>) - Recording is disabled. | ||||||||||||||||||||||||||||
| 341 | |||||||||||||||||||||||||||||
| 342 | =back | ||||||||||||||||||||||||||||
| 343 | |||||||||||||||||||||||||||||
| 344 | If you don't specify a value, the default is taken from the C<Mode> setting in the | ||||||||||||||||||||||||||||
| 345 | Meeting Defaults. | ||||||||||||||||||||||||||||
| 346 | |||||||||||||||||||||||||||||
| 347 | =cut | ||||||||||||||||||||||||||||
| 348 | |||||||||||||||||||||||||||||
| 349 | 6 | has 'recordingModeType' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 350 | documentation => 'Recording mode type: 1:manual, 2:automatic, 3:disabled', | ||||||||||||||||||||||||||||
| 351 | ); | ||||||||||||||||||||||||||||
| 352 | |||||||||||||||||||||||||||||
| 353 | =head2 reserveSeats (Int) | ||||||||||||||||||||||||||||
| 354 | |||||||||||||||||||||||||||||
| 355 | Number of seats reserved for this session. | ||||||||||||||||||||||||||||
| 356 | |||||||||||||||||||||||||||||
| 357 | If C<Must reserve seats> is enabled for your login group, this number will be | ||||||||||||||||||||||||||||
| 358 | removed from your purchased license limit for the duration of this session. | ||||||||||||||||||||||||||||
| 359 | |||||||||||||||||||||||||||||
| 360 | In addition, this number acts as a cap to the number of users that may join this session, regardless of the number of users in the user lists, or guests invited through the email facility. | ||||||||||||||||||||||||||||
| 361 | |||||||||||||||||||||||||||||
| 362 | If C<Must reserve seats> is disabled, then this parameter is ignored. | ||||||||||||||||||||||||||||
| 363 | Generally, this parameter is not used. | ||||||||||||||||||||||||||||
| 364 | |||||||||||||||||||||||||||||
| 365 | =cut | ||||||||||||||||||||||||||||
| 366 | |||||||||||||||||||||||||||||
| 367 | 6 | has 'reserveSeats' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 368 | documentation => 'Number of places to reserve on server', | ||||||||||||||||||||||||||||
| 369 | ); | ||||||||||||||||||||||||||||
| 370 | |||||||||||||||||||||||||||||
| 371 | =head2 secureSignOn (Bool) | ||||||||||||||||||||||||||||
| 372 | |||||||||||||||||||||||||||||
| 373 | The parameter used to indicate that a session created through the API | ||||||||||||||||||||||||||||
| 374 | should use the extended authentication provided by the secure sign-on | ||||||||||||||||||||||||||||
| 375 | functionality. | ||||||||||||||||||||||||||||
| 376 | |||||||||||||||||||||||||||||
| 377 | =cut | ||||||||||||||||||||||||||||
| 378 | |||||||||||||||||||||||||||||
| 379 | 6 | has 'secureSignOn' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 380 | documentation => 'N/A to ELM', | ||||||||||||||||||||||||||||
| 381 | ); | ||||||||||||||||||||||||||||
| 382 | |||||||||||||||||||||||||||||
| 383 | =head2 recordings (Bool) | ||||||||||||||||||||||||||||
| 384 | |||||||||||||||||||||||||||||
| 385 | Whether the session has any recordings. | ||||||||||||||||||||||||||||
| 386 | |||||||||||||||||||||||||||||
| 387 | =cut | ||||||||||||||||||||||||||||
| 388 | |||||||||||||||||||||||||||||
| 389 | 6 | has 'recordings' => (is => 'rw', isa => 'Bool', | |||||||||||||||||||||||||||
| 390 | documentation => 'Whether session has any recordings', | ||||||||||||||||||||||||||||
| 391 | ); | ||||||||||||||||||||||||||||
| 392 | |||||||||||||||||||||||||||||
| 393 | =head2 versionId (Int) | ||||||||||||||||||||||||||||
| 394 | |||||||||||||||||||||||||||||
| 395 | The version of Blackboard Collaborate to use for this session. Valid | ||||||||||||||||||||||||||||
| 396 | values are retrieved from the L<Bb::Collaborate::V3::Server::Versions> C<get()> or C<list()> methods. If this | ||||||||||||||||||||||||||||
| 397 | parameter is not supplied the session will use the 'default' version. | ||||||||||||||||||||||||||||
| 398 | |||||||||||||||||||||||||||||
| 399 | =cut | ||||||||||||||||||||||||||||
| 400 | |||||||||||||||||||||||||||||
| 401 | 6 | has 'versionId' => (is => 'rw', isa => 'Int', | |||||||||||||||||||||||||||
| 402 | documentation => 'Version Id (N/A to ELM)', | ||||||||||||||||||||||||||||
| 403 | ); | ||||||||||||||||||||||||||||
| 404 | |||||||||||||||||||||||||||||
| 405 | |||||||||||||||||||||||||||||
| 406 | =head1 METHODS | ||||||||||||||||||||||||||||
| 407 | |||||||||||||||||||||||||||||
| 408 | =cut | ||||||||||||||||||||||||||||
| 409 | |||||||||||||||||||||||||||||
| 410 | 0 | ▶ | sub _readback_check { | ||||||||||||||||||||||||||
|
Subroutine
_readback_check: not called CC=8 SCAR=42.8
| |||||||||||||||||||||||||||||
| 411 | 0 | my ($class, $_updates_ref, $rows, @args) = @_; | |||||||||||||||||||||||||||
| 412 | 0 | my %updates = %$_updates_ref; | |||||||||||||||||||||||||||
| 413 | |||||||||||||||||||||||||||||
| 414 | # | ||||||||||||||||||||||||||||
| 415 | # sessionName is a bit SHOUTY on SAS. Do case insensitive comparision | ||||||||||||||||||||||||||||
| 416 | # | ||||||||||||||||||||||||||||
| 417 | 0 | ▶ | if (my $sent = delete $updates{sessionName}) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 418 | 0 | for my $got (map {$_->{sessionName}} @$rows) { | |||||||||||||||||||||||||||
| 419 | # normalize strings | ||||||||||||||||||||||||||||
| 420 | 0 | for ($sent, $got) { | |||||||||||||||||||||||||||
| 421 | 0 | s/[^\w\s]//g; s/\s+/ /g; s/^\s+//; s/\s+$//; | |||||||||||||||||||||||||||
| 422 | 0 | $_ = uc($_); | |||||||||||||||||||||||||||
| 423 | } | ||||||||||||||||||||||||||||
| 424 | 0 | ▶ | die " Update consistancy check failed on sessionName, sent:$sent, read-back:$got" | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$got and $sent ne $got
MC/DC0%0/2
$got and $sent ne $got
$got
$sent ne $got
Truth table0%0/3
A and B
A= $gotB= $sent ne $got
| |||||||||||||||||||||||||||||
| 425 | if $got && ($sent ne $got); | ||||||||||||||||||||||||||||
| 426 | } | ||||||||||||||||||||||||||||
| 427 | } | ||||||||||||||||||||||||||||
| 428 | |||||||||||||||||||||||||||||
| 429 | # cop out of checking start and end times for recurring | ||||||||||||||||||||||||||||
| 430 | # sessions | ||||||||||||||||||||||||||||
| 431 | # | ||||||||||||||||||||||||||||
| 432 | 0 | ▶ | if ($rows && @$rows > 1) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$rows and @$rows > 1
MC/DC0%0/2
$rows and @$rows > 1
$rows
@$rows > 1
Truth table0%0/3
A and B
A= $rowsB= @$rows > 1
| |||||||||||||||||||||||||||||
| 433 | 0 | delete $updates{startTime}; | |||||||||||||||||||||||||||
| 434 | 0 | delete $updates{endTime}; | |||||||||||||||||||||||||||
| 435 | } | ||||||||||||||||||||||||||||
| 436 | |||||||||||||||||||||||||||||
| 437 | 0 | return $class->SUPER::_readback_check( \%updates, $rows, @args); | |||||||||||||||||||||||||||
| 438 | } | ||||||||||||||||||||||||||||
| 439 | |||||||||||||||||||||||||||||
| 440 | =head2 insert | ||||||||||||||||||||||||||||
| 441 | |||||||||||||||||||||||||||||
| 442 | use Bb::Collaborate::V3; | ||||||||||||||||||||||||||||
| 443 | use Bb::Collaborate::V3::Session; | ||||||||||||||||||||||||||||
| 444 | use Elive::Util; | ||||||||||||||||||||||||||||
| 445 | |||||||||||||||||||||||||||||
| 446 | my $connection = Bb::Collaborate::V3->connect( | ||||||||||||||||||||||||||||
| 447 | 'http://myserver/mysite', | ||||||||||||||||||||||||||||
| 448 | 'some_user' => 'some_pass' ); | ||||||||||||||||||||||||||||
| 449 | |||||||||||||||||||||||||||||
| 450 | # Sessions must start and end on the quarter hour. | ||||||||||||||||||||||||||||
| 451 | |||||||||||||||||||||||||||||
| 452 | my $session_start = Elive::Util::next_quarter_hour(); | ||||||||||||||||||||||||||||
| 453 | my $session_end = Elive::Util::next_quarter_hour( $session_start ); | ||||||||||||||||||||||||||||
| 454 | |||||||||||||||||||||||||||||
| 455 | my %session_data = ( | ||||||||||||||||||||||||||||
| 456 | sessionName => 'My Demo Session', | ||||||||||||||||||||||||||||
| 457 | creatorId => $connection->user, | ||||||||||||||||||||||||||||
| 458 | startTime => $session_start . '000', | ||||||||||||||||||||||||||||
| 459 | endTime => $session_end . '000', | ||||||||||||||||||||||||||||
| 460 | openChair => 1, | ||||||||||||||||||||||||||||
| 461 | mustBeSupervised => 0, | ||||||||||||||||||||||||||||
| 462 | permissionsOn => 1, | ||||||||||||||||||||||||||||
| 463 | nonChairList => [qw(alice bob)], | ||||||||||||||||||||||||||||
| 464 | groupingList => [qw(mechanics sewing)], | ||||||||||||||||||||||||||||
| 465 | ); | ||||||||||||||||||||||||||||
| 466 | |||||||||||||||||||||||||||||
| 467 | my $session = Bb::Collaborate::V3::Session->insert(\%session_data); | ||||||||||||||||||||||||||||
| 468 | |||||||||||||||||||||||||||||
| 469 | my $url = $session->session_url( userId => 'bob', displayName => 'Robert'); | ||||||||||||||||||||||||||||
| 470 | print "bob's session link is: $url\n"; | ||||||||||||||||||||||||||||
| 471 | |||||||||||||||||||||||||||||
| 472 | C<register_attendee> calls the C<UpdateSessionAttendees> request. This ensures that the | ||||||||||||||||||||||||||||
| 473 | user is registered on either the C<chairList> or C<nonChairList> and returns a url for | ||||||||||||||||||||||||||||
| 474 | joining the session. | ||||||||||||||||||||||||||||
| 475 | |||||||||||||||||||||||||||||
| 476 | my %late_comer = (userId => 'fred', displayName => 'Fred Nurk', isChair => 1); | ||||||||||||||||||||||||||||
| 477 | my $url2 = $session->register_attendee( \%late_comer ); | ||||||||||||||||||||||||||||
| 478 | |||||||||||||||||||||||||||||
| 479 | A series of sessions can be created using the C<recurrenceCount> and C<recurrenceDays> parameters. | ||||||||||||||||||||||||||||
| 480 | |||||||||||||||||||||||||||||
| 481 | # | ||||||||||||||||||||||||||||
| 482 | # create three weekly sessions | ||||||||||||||||||||||||||||
| 483 | # | ||||||||||||||||||||||||||||
| 484 | my @sessions = Bb::Collaborate::V3::Session->insert({ | ||||||||||||||||||||||||||||
| 485 | ..., | ||||||||||||||||||||||||||||
| 486 | recurrenceCount => 3, | ||||||||||||||||||||||||||||
| 487 | recurrenceDays => 7, | ||||||||||||||||||||||||||||
| 488 | }); | ||||||||||||||||||||||||||||
| 489 | =cut | ||||||||||||||||||||||||||||
| 490 | |||||||||||||||||||||||||||||
| 491 | =head2 update | ||||||||||||||||||||||||||||
| 492 | |||||||||||||||||||||||||||||
| 493 | $session->maxCameras(5); | ||||||||||||||||||||||||||||
| 494 | $session->hideParticipantNames(0); | ||||||||||||||||||||||||||||
| 495 | $session->update; | ||||||||||||||||||||||||||||
| 496 | |||||||||||||||||||||||||||||
| 497 | # | ||||||||||||||||||||||||||||
| 498 | # ...or... | ||||||||||||||||||||||||||||
| 499 | # | ||||||||||||||||||||||||||||
| 500 | $session->update({maxCameras => 5, hideParticipantNames => 0}); | ||||||||||||||||||||||||||||
| 501 | |||||||||||||||||||||||||||||
| 502 | Updates an existing session. | ||||||||||||||||||||||||||||
| 503 | |||||||||||||||||||||||||||||
| 504 | =cut | ||||||||||||||||||||||||||||
| 505 | |||||||||||||||||||||||||||||
| 506 | 0 | ▶ | sub update { | ||||||||||||||||||||||||||
|
Subroutine
update: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||
| 507 | 0 | my ($class, $data, %opt) = @_; | |||||||||||||||||||||||||||
| 508 | |||||||||||||||||||||||||||||
| 509 | 0 | ▶ | $opt{command} ||= 'Update'.$class->entity_name; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{"command"} ||= 'Update' . $class->entity_name
MC/DC0%0/1
$opt{"command"} ||= 'Update' . $class->entity_name
$opt{"command"}
Truth table0%0/2
A
A= $opt{"command"}
| |||||||||||||||||||||||||||||
| 510 | |||||||||||||||||||||||||||||
| 511 | 0 | return $class->SUPER::update($data, %opt); | |||||||||||||||||||||||||||
| 512 | } | ||||||||||||||||||||||||||||
| 513 | |||||||||||||||||||||||||||||
| 514 | =head2 retrieve | ||||||||||||||||||||||||||||
| 515 | |||||||||||||||||||||||||||||
| 516 | my $session = Bb::Collaborate::V3::Session->retrieve( $session_id ); | ||||||||||||||||||||||||||||
| 517 | |||||||||||||||||||||||||||||
| 518 | Retrieves a session. | ||||||||||||||||||||||||||||
| 519 | |||||||||||||||||||||||||||||
| 520 | =cut | ||||||||||||||||||||||||||||
| 521 | |||||||||||||||||||||||||||||
| 522 | =head2 list | ||||||||||||||||||||||||||||
| 523 | |||||||||||||||||||||||||||||
| 524 | # | ||||||||||||||||||||||||||||
| 525 | # perl code snippet to select sessions in group 'perl_tut_1' | ||||||||||||||||||||||||||||
| 526 | # created from yesterday onwards. | ||||||||||||||||||||||||||||
| 527 | # | ||||||||||||||||||||||||||||
| 528 | my $yesterday_dt = DateTime->today->subtract( days => 1 ); | ||||||||||||||||||||||||||||
| 529 | my $yesterday_msec = $yesterday_dt->epoch . '000'; | ||||||||||||||||||||||||||||
| 530 | |||||||||||||||||||||||||||||
| 531 | my $sessions | ||||||||||||||||||||||||||||
| 532 | = Bb::Collaborate::V3::Session->list(filter => { | ||||||||||||||||||||||||||||
| 533 | groupingId => 'perl_tut_1', | ||||||||||||||||||||||||||||
| 534 | startTime => $yesterday_msec, | ||||||||||||||||||||||||||||
| 535 | }); | ||||||||||||||||||||||||||||
| 536 | |||||||||||||||||||||||||||||
| 537 | foreach my $session (@$sessions) { | ||||||||||||||||||||||||||||
| 538 | |||||||||||||||||||||||||||||
| 539 | my $session_id = $session->sessionId; | ||||||||||||||||||||||||||||
| 540 | my $session_name = $session->sessionName; | ||||||||||||||||||||||||||||
| 541 | |||||||||||||||||||||||||||||
| 542 | print "found id=$session_id, name=$session_name\n"; | ||||||||||||||||||||||||||||
| 543 | |||||||||||||||||||||||||||||
| 544 | } | ||||||||||||||||||||||||||||
| 545 | |||||||||||||||||||||||||||||
| 546 | Returns an array of session objects. You may filter on: | ||||||||||||||||||||||||||||
| 547 | |||||||||||||||||||||||||||||
| 548 | =over 4 | ||||||||||||||||||||||||||||
| 549 | |||||||||||||||||||||||||||||
| 550 | =item C<userId> - Matched against C<chairList> and C<nonChairList> | ||||||||||||||||||||||||||||
| 551 | |||||||||||||||||||||||||||||
| 552 | =item C<groupingId> - An Element from the C<groupingList> | ||||||||||||||||||||||||||||
| 553 | |||||||||||||||||||||||||||||
| 554 | =item C<sessionId> - Session identifier | ||||||||||||||||||||||||||||
| 555 | |||||||||||||||||||||||||||||
| 556 | =item C<creatorId> - Session creator | ||||||||||||||||||||||||||||
| 557 | |||||||||||||||||||||||||||||
| 558 | =item C<startTime> - Start of the search date/time range in milliseconds. | ||||||||||||||||||||||||||||
| 559 | |||||||||||||||||||||||||||||
| 560 | =item C<endTime> - End of the search date/time range in milliseconds. | ||||||||||||||||||||||||||||
| 561 | |||||||||||||||||||||||||||||
| 562 | =item C<sessionName> - The session name | ||||||||||||||||||||||||||||
| 563 | |||||||||||||||||||||||||||||
| 564 | =cut | ||||||||||||||||||||||||||||
| 565 | |||||||||||||||||||||||||||||
| 566 | =back | ||||||||||||||||||||||||||||
| 567 | |||||||||||||||||||||||||||||
| 568 | =cut | ||||||||||||||||||||||||||||
| 569 | |||||||||||||||||||||||||||||
| 570 | 0 | ▶ | sub list { | ||||||||||||||||||||||||||
|
Subroutine
list: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||
| 571 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 572 | 0 | my %opt = @_; | |||||||||||||||||||||||||||
| 573 | |||||||||||||||||||||||||||||
| 574 | 0 | ▶ | unless ($opt{filter}) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 575 | 0 | warn "listing sessions over +/- 3 days (approx)\n"; | |||||||||||||||||||||||||||
| 576 | 0 | my $one_day = 24 * 60 * 60; | |||||||||||||||||||||||||||
| 577 | 0 | my $now = time; | |||||||||||||||||||||||||||
| 578 | $opt{filter} = { | ||||||||||||||||||||||||||||
| 579 | 0 | startTime => ($now - 3 * $one_day).'000', | |||||||||||||||||||||||||||
| 580 | endTime => ($now + 3 * $one_day).'000', | ||||||||||||||||||||||||||||
| 581 | }; | ||||||||||||||||||||||||||||
| 582 | } | ||||||||||||||||||||||||||||
| 583 | |||||||||||||||||||||||||||||
| 584 | 0 | return $self->SUPER::list( %opt ); | |||||||||||||||||||||||||||
| 585 | } | ||||||||||||||||||||||||||||
| 586 | |||||||||||||||||||||||||||||
| 587 | =head2 delete | ||||||||||||||||||||||||||||
| 588 | |||||||||||||||||||||||||||||
| 589 | $session->delete; | ||||||||||||||||||||||||||||
| 590 | |||||||||||||||||||||||||||||
| 591 | Deletes unwanted or completed sessions. | ||||||||||||||||||||||||||||
| 592 | |||||||||||||||||||||||||||||
| 593 | =cut | ||||||||||||||||||||||||||||
| 594 | |||||||||||||||||||||||||||||
| 595 | =head2 telephony | ||||||||||||||||||||||||||||
| 596 | |||||||||||||||||||||||||||||
| 597 | my $session_telephony = $session->telephony; | ||||||||||||||||||||||||||||
| 598 | $session_telephony->update({ | ||||||||||||||||||||||||||||
| 599 | chairPhone => '(03) 5999 1234', | ||||||||||||||||||||||||||||
| 600 | chairPIN => '6342', | ||||||||||||||||||||||||||||
| 601 | }); | ||||||||||||||||||||||||||||
| 602 | |||||||||||||||||||||||||||||
| 603 | Returns an L<Bb::Collaborate::V3::Session::Telephony> object for the given session. | ||||||||||||||||||||||||||||
| 604 | This can then be used to get or set the session's telephony characterisitics. | ||||||||||||||||||||||||||||
| 605 | |||||||||||||||||||||||||||||
| 606 | =cut | ||||||||||||||||||||||||||||
| 607 | |||||||||||||||||||||||||||||
| 608 | 0 | ▶ | sub telephony { | ||||||||||||||||||||||||||
|
Subroutine
telephony: not called CC=5 SCAR=34.0
Pod
documented
| |||||||||||||||||||||||||||||
| 609 | 0 | my ($class, %opt) = @_; | |||||||||||||||||||||||||||
| 610 | |||||||||||||||||||||||||||||
| 611 | 0 | my $session_id = delete $opt{sessionId}; | |||||||||||||||||||||||||||
| 612 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 613 | if Scalar::Util::blessed($class); | ||||||||||||||||||||||||||||
| 614 | |||||||||||||||||||||||||||||
| 615 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 616 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 617 | |||||||||||||||||||||||||||||
| 618 | 0 | return Bb::Collaborate::V3::Session::Telephony->retrieve($session_id, | |||||||||||||||||||||||||||
| 619 | reuse => 1, | ||||||||||||||||||||||||||||
| 620 | connection => $connection, | ||||||||||||||||||||||||||||
| 621 | %opt, | ||||||||||||||||||||||||||||
| 622 | ); | ||||||||||||||||||||||||||||
| 623 | } | ||||||||||||||||||||||||||||
| 624 | |||||||||||||||||||||||||||||
| 625 | =head2 set_presentation | ||||||||||||||||||||||||||||
| 626 | |||||||||||||||||||||||||||||
| 627 | $session->set_presentation($presentation); | ||||||||||||||||||||||||||||
| 628 | |||||||||||||||||||||||||||||
| 629 | Associates a seession with presentation content. | ||||||||||||||||||||||||||||
| 630 | |||||||||||||||||||||||||||||
| 631 | =cut | ||||||||||||||||||||||||||||
| 632 | |||||||||||||||||||||||||||||
| 633 | 0 | ▶ | sub set_presentation { | ||||||||||||||||||||||||||
|
Subroutine
set_presentation: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||
| 634 | 0 | my ($class, $presentation_id, %opt) = @_; | |||||||||||||||||||||||||||
| 635 | |||||||||||||||||||||||||||||
| 636 | 0 | my $session_id = delete $opt{sessionId}; | |||||||||||||||||||||||||||
| 637 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 638 | if Scalar::Util::blessed($class); | ||||||||||||||||||||||||||||
| 639 | |||||||||||||||||||||||||||||
| 640 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 641 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 642 | |||||||||||||||||||||||||||||
| 643 | 0 | my $params = $class->_freeze({ | |||||||||||||||||||||||||||
| 644 | sessionId => $session_id, | ||||||||||||||||||||||||||||
| 645 | presentationId => $presentation_id | ||||||||||||||||||||||||||||
| 646 | }); | ||||||||||||||||||||||||||||
| 647 | |||||||||||||||||||||||||||||
| 648 | 0 | ▶ | my $command = $opt{command} || 'SetSessionPresentation'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'SetSessionPresentation'
MC/DC0%0/1
$opt{'command'} || 'SetSessionPresentation'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 649 | |||||||||||||||||||||||||||||
| 650 | 0 | my $som = $connection->call($command => %$params); | |||||||||||||||||||||||||||
| 651 | |||||||||||||||||||||||||||||
| 652 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 653 | |||||||||||||||||||||||||||||
| 654 | 0 | ▶ | my $success = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 655 | |||||||||||||||||||||||||||||
| 656 | 0 | return $success; | |||||||||||||||||||||||||||
| 657 | } | ||||||||||||||||||||||||||||
| 658 | |||||||||||||||||||||||||||||
| 659 | =head2 set_multimedia | ||||||||||||||||||||||||||||
| 660 | |||||||||||||||||||||||||||||
| 661 | $session->set_multimedia([$multimedia_1, $multimedia_2]); | ||||||||||||||||||||||||||||
| 662 | |||||||||||||||||||||||||||||
| 663 | Associates a session with multimedia content. | ||||||||||||||||||||||||||||
| 664 | |||||||||||||||||||||||||||||
| 665 | =cut | ||||||||||||||||||||||||||||
| 666 | |||||||||||||||||||||||||||||
| 667 | 0 | ▶ | sub set_multimedia { | ||||||||||||||||||||||||||
|
Subroutine
set_multimedia: not called CC=11 SCAR=48.8
Pod
documented
| |||||||||||||||||||||||||||||
| 668 | 0 | my ($class, $multimedia_ids, %opt) = @_; | |||||||||||||||||||||||||||
| 669 | |||||||||||||||||||||||||||||
| 670 | 0 | my $session_id = delete $opt{sessionId}; | |||||||||||||||||||||||||||
| 671 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 672 | if Scalar::Util::blessed($class); | ||||||||||||||||||||||||||||
| 673 | |||||||||||||||||||||||||||||
| 674 | 0 | for ($multimedia_ids) { | |||||||||||||||||||||||||||
| 675 | 0 | ▶ | croak 'usage: $'.(ref($class)||$class).'->set_multimedia(\@multimedia_ids)' | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
ref $class || $class
MC/DC0%0/2
ref $class || $class
ref $class
$class
Truth table0%0/3
A || B
A= ref $classB= $class
| |||||||||||||||||||||||||||||
| 676 | unless defined; | ||||||||||||||||||||||||||||
| 677 | # | ||||||||||||||||||||||||||||
| 678 | # coerce a single value to an array | ||||||||||||||||||||||||||||
| 679 | # | ||||||||||||||||||||||||||||
| 680 | 0 | ▶ | $_ = [$_] | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 681 | if Elive::Util::_reftype($_) ne 'ARRAY'; | ||||||||||||||||||||||||||||
| 682 | } | ||||||||||||||||||||||||||||
| 683 | |||||||||||||||||||||||||||||
| 684 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 685 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 686 | |||||||||||||||||||||||||||||
| 687 | 0 | my $params = $class->_freeze({ | |||||||||||||||||||||||||||
| 688 | sessionId => $session_id, | ||||||||||||||||||||||||||||
| 689 | multimediaIds => $multimedia_ids | ||||||||||||||||||||||||||||
| 690 | }); | ||||||||||||||||||||||||||||
| 691 | |||||||||||||||||||||||||||||
| 692 | 0 | ▶ | my $command = $opt{command} || 'SetSessionMultimedia'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'SetSessionMultimedia'
MC/DC0%0/1
$opt{'command'} || 'SetSessionMultimedia'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 693 | 0 | my $som = $connection->call($command => %$params); | |||||||||||||||||||||||||||
| 694 | |||||||||||||||||||||||||||||
| 695 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 696 | |||||||||||||||||||||||||||||
| 697 | 0 | ▶ | my $success = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 698 | |||||||||||||||||||||||||||||
| 699 | 0 | return $success; | |||||||||||||||||||||||||||
| 700 | } | ||||||||||||||||||||||||||||
| 701 | |||||||||||||||||||||||||||||
| 702 | =head2 list_multimedia | ||||||||||||||||||||||||||||
| 703 | |||||||||||||||||||||||||||||
| 704 | my $multimedia = $meeting_obj->list_multimedia; | ||||||||||||||||||||||||||||
| 705 | |||||||||||||||||||||||||||||
| 706 | Lists all multimedia associated with the session. | ||||||||||||||||||||||||||||
| 707 | |||||||||||||||||||||||||||||
| 708 | See also L<Bb::Collaborate::V3::Multimedia>. | ||||||||||||||||||||||||||||
| 709 | |||||||||||||||||||||||||||||
| 710 | =cut | ||||||||||||||||||||||||||||
| 711 | |||||||||||||||||||||||||||||
| 712 | 0 | ▶ | sub list_multimedia { | ||||||||||||||||||||||||||
|
Subroutine
list_multimedia: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||
| 713 | 0 | my ($self, %opt) = @_; | |||||||||||||||||||||||||||
| 714 | 0 | ▶ | $opt{connection} ||= $self->connection; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{"connection"} ||= $self->connection
MC/DC0%0/2
$opt{"connection"} ||= $self->connection
$opt{"connection"}
$self->connection
Truth table0%0/3
A ||= B
A= $opt{"connection"}B= $self->connection
| |||||||||||||||||||||||||||||
| 715 | 0 | ▶ | my $session_id = $opt{sessionId} || $self->sessionId; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{'sessionId'} || $self->sessionId
MC/DC0%0/2
$opt{'sessionId'} || $self->sessionId
$opt{'sessionId'}
$self->sessionId
Truth table0%0/3
A || B
A= $opt{'sessionId'}B= $self->sessionId
| |||||||||||||||||||||||||||||
| 716 | |||||||||||||||||||||||||||||
| 717 | 0 | return Bb::Collaborate::V3::Multimedia | |||||||||||||||||||||||||||
| 718 | ->list(filter => {sessionId => $session_id}, | ||||||||||||||||||||||||||||
| 719 | %opt); | ||||||||||||||||||||||||||||
| 720 | } | ||||||||||||||||||||||||||||
| 721 | |||||||||||||||||||||||||||||
| 722 | =head2 list_presentation | ||||||||||||||||||||||||||||
| 723 | |||||||||||||||||||||||||||||
| 724 | my $presentation = $meeting_obj->list_presentation; | ||||||||||||||||||||||||||||
| 725 | |||||||||||||||||||||||||||||
| 726 | Lists all presentation associated with the session. | ||||||||||||||||||||||||||||
| 727 | |||||||||||||||||||||||||||||
| 728 | See also L<Bb::Collaborate::V3::Presentation>. | ||||||||||||||||||||||||||||
| 729 | |||||||||||||||||||||||||||||
| 730 | =cut | ||||||||||||||||||||||||||||
| 731 | |||||||||||||||||||||||||||||
| 732 | 0 | ▶ | sub list_presentation { | ||||||||||||||||||||||||||
|
Subroutine
list_presentation: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||
| 733 | 0 | my ($self, %opt) = @_; | |||||||||||||||||||||||||||
| 734 | 0 | ▶ | $opt{connection} ||= $self->connection; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{"connection"} ||= $self->connection
MC/DC0%0/2
$opt{"connection"} ||= $self->connection
$opt{"connection"}
$self->connection
Truth table0%0/3
A ||= B
A= $opt{"connection"}B= $self->connection
| |||||||||||||||||||||||||||||
| 735 | 0 | ▶ | my $session_id = $opt{sessionId} || $self->sessionId; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{'sessionId'} || $self->sessionId
MC/DC0%0/2
$opt{'sessionId'} || $self->sessionId
$opt{'sessionId'}
$self->sessionId
Truth table0%0/3
A || B
A= $opt{'sessionId'}B= $self->sessionId
| |||||||||||||||||||||||||||||
| 736 | |||||||||||||||||||||||||||||
| 737 | 0 | return Bb::Collaborate::V3::Presentation | |||||||||||||||||||||||||||
| 738 | ->list(filter => {sessionId => $session_id}, | ||||||||||||||||||||||||||||
| 739 | %opt); | ||||||||||||||||||||||||||||
| 740 | } | ||||||||||||||||||||||||||||
| 741 | |||||||||||||||||||||||||||||
| 742 | =head2 remove_presentation | ||||||||||||||||||||||||||||
| 743 | |||||||||||||||||||||||||||||
| 744 | my $presentation_list = $session->list_presentation; | ||||||||||||||||||||||||||||
| 745 | |||||||||||||||||||||||||||||
| 746 | foreach my $presentation_item (@$presentation_list) { | ||||||||||||||||||||||||||||
| 747 | $session->remove_presentation( $presentation_item ); | ||||||||||||||||||||||||||||
| 748 | } | ||||||||||||||||||||||||||||
| 749 | |||||||||||||||||||||||||||||
| 750 | Disassociate the given presentation item from the session | ||||||||||||||||||||||||||||
| 751 | |||||||||||||||||||||||||||||
| 752 | =cut | ||||||||||||||||||||||||||||
| 753 | |||||||||||||||||||||||||||||
| 754 | 0 | ▶ | sub remove_presentation { | ||||||||||||||||||||||||||
|
Subroutine
remove_presentation: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||
| 755 | 0 | my $class = shift; | |||||||||||||||||||||||||||
| 756 | 0 | my $presentation_id = shift; | |||||||||||||||||||||||||||
| 757 | 0 | my %opt = @_; | |||||||||||||||||||||||||||
| 758 | |||||||||||||||||||||||||||||
| 759 | 0 | my $session_id = delete $opt{sessionId}; | |||||||||||||||||||||||||||
| 760 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 761 | if Scalar::Util::blessed($class); | ||||||||||||||||||||||||||||
| 762 | |||||||||||||||||||||||||||||
| 763 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 764 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 765 | |||||||||||||||||||||||||||||
| 766 | 0 | my $params = $class->_freeze({ | |||||||||||||||||||||||||||
| 767 | sessionId => $session_id, | ||||||||||||||||||||||||||||
| 768 | presentationId => $presentation_id | ||||||||||||||||||||||||||||
| 769 | }); | ||||||||||||||||||||||||||||
| 770 | |||||||||||||||||||||||||||||
| 771 | 0 | ▶ | my $command = $opt{command} || 'RemoveSessionPresentation'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'RemoveSessionPresentation'
MC/DC0%0/1
$opt{'command'} || 'RemoveSessionPresentation'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 772 | 0 | my $som = $connection->call($command => %$params); | |||||||||||||||||||||||||||
| 773 | |||||||||||||||||||||||||||||
| 774 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 775 | |||||||||||||||||||||||||||||
| 776 | 0 | ▶ | my $success = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 777 | |||||||||||||||||||||||||||||
| 778 | 0 | return $success; | |||||||||||||||||||||||||||
| 779 | |||||||||||||||||||||||||||||
| 780 | } | ||||||||||||||||||||||||||||
| 781 | |||||||||||||||||||||||||||||
| 782 | =head2 remove_multimedia | ||||||||||||||||||||||||||||
| 783 | |||||||||||||||||||||||||||||
| 784 | my $multimedia_list = $session->list_multimedia; | ||||||||||||||||||||||||||||
| 785 | |||||||||||||||||||||||||||||
| 786 | foreach my $multimedia_item (@$multimedia_list) { | ||||||||||||||||||||||||||||
| 787 | $session->remove_multimedia( $multimedia_item ); | ||||||||||||||||||||||||||||
| 788 | } | ||||||||||||||||||||||||||||
| 789 | |||||||||||||||||||||||||||||
| 790 | Disassociate the given multimedia item from the session | ||||||||||||||||||||||||||||
| 791 | |||||||||||||||||||||||||||||
| 792 | =cut | ||||||||||||||||||||||||||||
| 793 | |||||||||||||||||||||||||||||
| 794 | 0 | ▶ | sub remove_multimedia { | ||||||||||||||||||||||||||
|
Subroutine
remove_multimedia: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||
| 795 | 0 | my $class = shift; | |||||||||||||||||||||||||||
| 796 | 0 | my $multimedia_id = shift; | |||||||||||||||||||||||||||
| 797 | 0 | my %opt = @_; | |||||||||||||||||||||||||||
| 798 | |||||||||||||||||||||||||||||
| 799 | 0 | my $session_id = delete $opt{sessionId}; | |||||||||||||||||||||||||||
| 800 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 801 | if Scalar::Util::blessed($class); | ||||||||||||||||||||||||||||
| 802 | |||||||||||||||||||||||||||||
| 803 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 804 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 805 | |||||||||||||||||||||||||||||
| 806 | 0 | my $params = $class->_freeze({ | |||||||||||||||||||||||||||
| 807 | sessionId => $session_id, | ||||||||||||||||||||||||||||
| 808 | multimediaId => $multimedia_id | ||||||||||||||||||||||||||||
| 809 | }); | ||||||||||||||||||||||||||||
| 810 | |||||||||||||||||||||||||||||
| 811 | 0 | ▶ | my $command = $opt{command} || 'RemoveSessionMultimedia'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'RemoveSessionMultimedia'
MC/DC0%0/1
$opt{'command'} || 'RemoveSessionMultimedia'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 812 | 0 | my $som = $connection->call($command => %$params); | |||||||||||||||||||||||||||
| 813 | |||||||||||||||||||||||||||||
| 814 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 815 | |||||||||||||||||||||||||||||
| 816 | 0 | ▶ | my $success = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 817 | |||||||||||||||||||||||||||||
| 818 | 0 | return $success; | |||||||||||||||||||||||||||
| 819 | |||||||||||||||||||||||||||||
| 820 | } | ||||||||||||||||||||||||||||
| 821 | |||||||||||||||||||||||||||||
| 822 | =head2 list_recordings | ||||||||||||||||||||||||||||
| 823 | |||||||||||||||||||||||||||||
| 824 | my $recordings = $meeting_obj->list_recordings; | ||||||||||||||||||||||||||||
| 825 | |||||||||||||||||||||||||||||
| 826 | Lists all recording associated with the session. | ||||||||||||||||||||||||||||
| 827 | |||||||||||||||||||||||||||||
| 828 | See also L<Bb::Collaborate::V3::Recording>. | ||||||||||||||||||||||||||||
| 829 | |||||||||||||||||||||||||||||
| 830 | =cut | ||||||||||||||||||||||||||||
| 831 | |||||||||||||||||||||||||||||
| 832 | 0 | ▶ | sub list_recordings { | ||||||||||||||||||||||||||
|
Subroutine
list_recordings: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||
| 833 | 0 | my ($self, %opt) = @_; | |||||||||||||||||||||||||||
| 834 | 0 | ▶ | $opt{connection} ||= $self->connection; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{"connection"} ||= $self->connection
MC/DC0%0/2
$opt{"connection"} ||= $self->connection
$opt{"connection"}
$self->connection
Truth table0%0/3
A ||= B
A= $opt{"connection"}B= $self->connection
| |||||||||||||||||||||||||||||
| 835 | 0 | ▶ | my $session_id = $opt{sessionId} || $self->sessionId; | ||||||||||||||||||||||||||
|
Condition0%0/3
$opt{'sessionId'} || $self->sessionId
MC/DC0%0/2
$opt{'sessionId'} || $self->sessionId
$opt{'sessionId'}
$self->sessionId
Truth table0%0/3
A || B
A= $opt{'sessionId'}B= $self->sessionId
| |||||||||||||||||||||||||||||
| 836 | |||||||||||||||||||||||||||||
| 837 | 0 | return Bb::Collaborate::V3::Recording | |||||||||||||||||||||||||||
| 838 | ->list( filter => {sessionId => $session_id}, %opt); | ||||||||||||||||||||||||||||
| 839 | } | ||||||||||||||||||||||||||||
| 840 | |||||||||||||||||||||||||||||
| 841 | =head2 session_url | ||||||||||||||||||||||||||||
| 842 | |||||||||||||||||||||||||||||
| 843 | my $session_url = $session->session_url(userId => 'bob'); | ||||||||||||||||||||||||||||
| 844 | |||||||||||||||||||||||||||||
| 845 | Returns a URL for the session. This provides authenthicated access for | ||||||||||||||||||||||||||||
| 846 | the given user. | ||||||||||||||||||||||||||||
| 847 | |||||||||||||||||||||||||||||
| 848 | =cut | ||||||||||||||||||||||||||||
| 849 | |||||||||||||||||||||||||||||
| 850 | 0 | ▶ | sub session_url { | ||||||||||||||||||||||||||
|
Subroutine
session_url: not called CC=10 SCAR=47.0
Pod
documented
| |||||||||||||||||||||||||||||
| 851 | 0 | my ($class, %opt) = @_; | |||||||||||||||||||||||||||
| 852 | |||||||||||||||||||||||||||||
| 853 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 854 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 855 | |||||||||||||||||||||||||||||
| 856 | 0 | my %params; | |||||||||||||||||||||||||||
| 857 | |||||||||||||||||||||||||||||
| 858 | 0 | my $session_id = $opt{sessionId}; | |||||||||||||||||||||||||||
| 859 | |||||||||||||||||||||||||||||
| 860 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 861 | if ref($class); | ||||||||||||||||||||||||||||
| 862 | |||||||||||||||||||||||||||||
| 863 | 0 | ▶ | croak "unable to determine sessionId" | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 864 | unless $session_id; | ||||||||||||||||||||||||||||
| 865 | |||||||||||||||||||||||||||||
| 866 | 0 | $params{sessionId} = $session_id; | |||||||||||||||||||||||||||
| 867 | |||||||||||||||||||||||||||||
| 868 | my $user_id = $opt{userId} | ||||||||||||||||||||||||||||
| 869 | 0 | ▶ | or croak "missing required field: userId"; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 870 | |||||||||||||||||||||||||||||
| 871 | 0 | $params{userId} = $user_id; | |||||||||||||||||||||||||||
| 872 | |||||||||||||||||||||||||||||
| 873 | $params{displayName} = $opt{displayName} | ||||||||||||||||||||||||||||
| 874 | 0 | ▶ | if defined $opt{displayName}; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 875 | |||||||||||||||||||||||||||||
| 876 | 0 | ▶ | my $command = $opt{command} || 'BuildSessionUrl'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'BuildSessionUrl'
MC/DC0%0/1
$opt{'command'} || 'BuildSessionUrl'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 877 | |||||||||||||||||||||||||||||
| 878 | 0 | my $som = $connection->call($command => %{ $class->_freeze(\%params) }); | |||||||||||||||||||||||||||
| 879 | |||||||||||||||||||||||||||||
| 880 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 881 | |||||||||||||||||||||||||||||
| 882 | 0 | ▶ | my $url = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 883 | |||||||||||||||||||||||||||||
| 884 | 0 | return $url; | |||||||||||||||||||||||||||
| 885 | } | ||||||||||||||||||||||||||||
| 886 | |||||||||||||||||||||||||||||
| 887 | =head2 set_api_callback_url | ||||||||||||||||||||||||||||
| 888 | |||||||||||||||||||||||||||||
| 889 | my $session_url = $session->set_api_callback_url($url); | ||||||||||||||||||||||||||||
| 890 | |||||||||||||||||||||||||||||
| 891 | This method calls the C< SetApiCallbackUrl> command, which is used to specify a | ||||||||||||||||||||||||||||
| 892 | callback URL that will be notified every time a room closes. | ||||||||||||||||||||||||||||
| 893 | |||||||||||||||||||||||||||||
| 894 | If a session is launched multiple times, there will be multiple rooms | ||||||||||||||||||||||||||||
| 895 | (instances of the session). When each room closes, the callback URL will be | ||||||||||||||||||||||||||||
| 896 | called. If the session is only launched once, the URL will be called once. | ||||||||||||||||||||||||||||
| 897 | |||||||||||||||||||||||||||||
| 898 | =cut | ||||||||||||||||||||||||||||
| 899 | |||||||||||||||||||||||||||||
| 900 | 0 | ▶ | sub set_api_callback_url { | ||||||||||||||||||||||||||
|
Subroutine
set_api_callback_url: not called CC=8 SCAR=42.8
Pod
documented
| |||||||||||||||||||||||||||||
| 901 | 0 | my ($class, $url, %opt) = @_; | |||||||||||||||||||||||||||
| 902 | |||||||||||||||||||||||||||||
| 903 | 0 | ▶ | my $connection = $opt{connection} || $class->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $class->connection
MC/DC0%0/2
$opt{'connection'} || $class->connection
$opt{'connection'}
$class->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $class->connection
| |||||||||||||||||||||||||||||
| 904 | or croak "Not connected"; | ||||||||||||||||||||||||||||
| 905 | |||||||||||||||||||||||||||||
| 906 | 0 | my $session_id = $opt{sessionId}; | |||||||||||||||||||||||||||
| 907 | |||||||||||||||||||||||||||||
| 908 | 0 | ▶ | $session_id ||= $class->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $class->sessionId
MC/DC0%0/2
$session_id ||= $class->sessionId
$session_id
$class->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $class->sessionId
| |||||||||||||||||||||||||||||
| 909 | if ref($class); | ||||||||||||||||||||||||||||
| 910 | |||||||||||||||||||||||||||||
| 911 | 0 | ▶ | croak "unable to determine sessionId" | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 912 | unless $session_id; | ||||||||||||||||||||||||||||
| 913 | |||||||||||||||||||||||||||||
| 914 | 0 | my %params; | |||||||||||||||||||||||||||
| 915 | 0 | $params{sessionId} = $session_id; | |||||||||||||||||||||||||||
| 916 | 0 | $params{apiCallbackUrl} = $url; | |||||||||||||||||||||||||||
| 917 | |||||||||||||||||||||||||||||
| 918 | 0 | ▶ | my $command = $opt{command} || 'SetApiCallbackUrl'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'SetApiCallbackUrl'
MC/DC0%0/1
$opt{'command'} || 'SetApiCallbackUrl'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 919 | |||||||||||||||||||||||||||||
| 920 | 0 | my $som = $connection->call($command => %{ $class->_freeze(\%params) }); | |||||||||||||||||||||||||||
| 921 | |||||||||||||||||||||||||||||
| 922 | 0 | my $results = $class->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 923 | |||||||||||||||||||||||||||||
| 924 | 0 | ▶ | my $success = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 925 | |||||||||||||||||||||||||||||
| 926 | 0 | return $success; | |||||||||||||||||||||||||||
| 927 | } | ||||||||||||||||||||||||||||
| 928 | |||||||||||||||||||||||||||||
| 929 | =head2 register_attendee | ||||||||||||||||||||||||||||
| 930 | |||||||||||||||||||||||||||||
| 931 | my %attendee = (userId => 'fred', displayName => 'Fred Nurk', isChair => 0); | ||||||||||||||||||||||||||||
| 932 | my $attendee_url = $session->register_attendee( \%attendee ); | ||||||||||||||||||||||||||||
| 933 | # or to call from the class level | ||||||||||||||||||||||||||||
| 934 | $attendee_url = Bb::Collaborate::V3::Session->register_attendee( \%attendee, sessionId => 123456 ); | ||||||||||||||||||||||||||||
| 935 | print "Please go to: $attendee_url"; | ||||||||||||||||||||||||||||
| 936 | |||||||||||||||||||||||||||||
| 937 | Ensures that the user is in the chair or non-chair list for this session and returns a join URL for the session. | ||||||||||||||||||||||||||||
| 938 | |||||||||||||||||||||||||||||
| 939 | The user may be added and/or promoted/demoted between the C<chairList> and C<nonChairList> as required. | ||||||||||||||||||||||||||||
| 940 | |||||||||||||||||||||||||||||
| 941 | =cut | ||||||||||||||||||||||||||||
| 942 | |||||||||||||||||||||||||||||
| 943 | 0 | ▶ | sub register_attendee { | ||||||||||||||||||||||||||
|
Subroutine
register_attendee: not called CC=10 SCAR=47.0
Pod
documented
| |||||||||||||||||||||||||||||
| 944 | 0 | my ($self, $_params, %opt) = @_; | |||||||||||||||||||||||||||
| 945 | 0 | ▶ | die "usage: \$self->register_attendee({userId => .., displayName => ..., isChar => ...}, \%opt)" | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 946 | unless Elive::Util::_reftype( $_params ) eq 'HASH'; | ||||||||||||||||||||||||||||
| 947 | die "missing required parameter: userId" | ||||||||||||||||||||||||||||
| 948 | 0 | ▶ | unless $_params->{userId}; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 949 | |||||||||||||||||||||||||||||
| 950 | 0 | my %params = %$_params; | |||||||||||||||||||||||||||
| 951 | |||||||||||||||||||||||||||||
| 952 | 0 | ▶ | my $command = $opt{command} || 'UpdateSessionAttendees'; | ||||||||||||||||||||||||||
|
Condition0%0/2
$opt{'command'} || 'UpdateSessionAttendees'
MC/DC0%0/1
$opt{'command'} || 'UpdateSessionAttendees'
$opt{'command'}
Truth table0%0/2
A
A= $opt{'command'}
| |||||||||||||||||||||||||||||
| 953 | 0 | ▶ | my $connection = $opt{connection} || $self->connection | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$opt{'connection'} || $self->connection
MC/DC0%0/2
$opt{'connection'} || $self->connection
$opt{'connection'}
$self->connection
Truth table0%0/3
A || B
A= $opt{'connection'}B= $self->connection
| |||||||||||||||||||||||||||||
| 954 | or die "not connected"; | ||||||||||||||||||||||||||||
| 955 | |||||||||||||||||||||||||||||
| 956 | 0 | my $session_id = $opt{sessionId}; | |||||||||||||||||||||||||||
| 957 | |||||||||||||||||||||||||||||
| 958 | 0 | ▶ | $session_id ||= $self->sessionId | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$session_id ||= $self->sessionId
MC/DC0%0/2
$session_id ||= $self->sessionId
$session_id
$self->sessionId
Truth table0%0/3
A ||= B
A= $session_idB= $self->sessionId
| |||||||||||||||||||||||||||||
| 959 | if ref($self); | ||||||||||||||||||||||||||||
| 960 | |||||||||||||||||||||||||||||
| 961 | 0 | ▶ | croak "unable to determine sessionId" | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 962 | unless $session_id; | ||||||||||||||||||||||||||||
| 963 | |||||||||||||||||||||||||||||
| 964 | 0 | $params{sessionId} = $session_id; | |||||||||||||||||||||||||||
| 965 | |||||||||||||||||||||||||||||
| 966 | 0 | my $som = $connection->call($command => %{ $self->_freeze(\%params) }); | |||||||||||||||||||||||||||
| 967 | |||||||||||||||||||||||||||||
| 968 | 0 | my $results = $self->_get_results( $som, $connection ); | |||||||||||||||||||||||||||
| 969 | |||||||||||||||||||||||||||||
| 970 | 0 | ▶ | my $url = @$results && $results->[0]; | ||||||||||||||||||||||||||
|
Condition0%0/3
@$results && $results->[0]
MC/DC0%0/2
@$results && $results->[0]
@$results
$results->[0]
Truth table0%0/3
A && B
A= @$resultsB= $results->[0]
| |||||||||||||||||||||||||||||
| 971 | |||||||||||||||||||||||||||||
| 972 | 0 | return $url; | |||||||||||||||||||||||||||
| 973 | } | ||||||||||||||||||||||||||||
| 974 | |||||||||||||||||||||||||||||
| 975 | =head2 attendance | ||||||||||||||||||||||||||||
| 976 | |||||||||||||||||||||||||||||
| 977 | my $yesterday = DateTime->today->subtract(days => 1); | ||||||||||||||||||||||||||||
| 978 | |||||||||||||||||||||||||||||
| 979 | my $attendance = $session->attendance( $yesterday->epoch.'000' ); | ||||||||||||||||||||||||||||
| 980 | |||||||||||||||||||||||||||||
| 981 | Reports on session attendance for a given day. It returns a reference to an array of L<Bb::Collaborate::V3::Session::Attendance> objects. | ||||||||||||||||||||||||||||
| 982 | |||||||||||||||||||||||||||||
| 983 | =cut | ||||||||||||||||||||||||||||
| 984 | |||||||||||||||||||||||||||||
| 985 | 0 | ▶ | sub attendance { | ||||||||||||||||||||||||||
|
Subroutine
attendance: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||
| 986 | 0 | my ($self, $start_time, %opt) = @_; | |||||||||||||||||||||||||||
| 987 | |||||||||||||||||||||||||||||
| 988 | 0 | ▶ | $start_time ||= $self->startTime; | ||||||||||||||||||||||||||
|
Condition0%0/3
$start_time ||= $self->startTime
MC/DC0%0/2
$start_time ||= $self->startTime
$start_time
$self->startTime
Truth table0%0/3
A ||= B
A= $start_timeB= $self->startTime
| |||||||||||||||||||||||||||||
| 989 | |||||||||||||||||||||||||||||
| 990 | 0 | return Bb::Collaborate::V3::Session::Attendance->list( | |||||||||||||||||||||||||||
| 991 | filter=> { | ||||||||||||||||||||||||||||
| 992 | sessionId => $self->sessionId, | ||||||||||||||||||||||||||||
| 993 | startTime => $start_time, | ||||||||||||||||||||||||||||
| 994 | }, | ||||||||||||||||||||||||||||
| 995 | connection => $self->connection, | ||||||||||||||||||||||||||||
| 996 | %opt, | ||||||||||||||||||||||||||||
| 997 | ); | ||||||||||||||||||||||||||||
| 998 | } | ||||||||||||||||||||||||||||
| 999 | |||||||||||||||||||||||||||||
| 1000 | 6 | 1; | |||||||||||||||||||||||||||