V3/Session/Attendance.pm

filter: Statementstmt 100% 24 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 5 / 5 Podpod n/a totaltotal 100% 29 / 29 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« V3/Presentation.pm ↑ Summary V3/Session/Attendee.pm »
1 package Bb::Collaborate::V3::Session::Attendance;
2 7 ▶use warnings; use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
Subroutine BEGIN: called CC=1 SCAR=0.0
3  
4 7 ▶use Mouse;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 7 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
6  
7 7 extends 'Bb::Collaborate::V3';
8  
9 7 ▶use Bb::Collaborate::V3::Session::Attendees;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 =head1 NAME
12  
13 Bb::Collaborate::V3::Session::Attendance - Session Attendance Report
14  
15 =head1 DESCRIPTION
16  
17 This is the main entity class for session attendance reports.
18  
19 =cut
20  
21 7 __PACKAGE__->entity_name('SessionAttendance');
22 7 __PACKAGE__->params(sessionId => 'Int',
23 startTime => 'HiResDate',
24 endTime => 'HiResDate',
25 );
26  
27 =head1 PROPERTIES
28  
29 =head2 roomName (Str)
30  
31 The name of the room. This is derived from the name of the session as it was defined at the time the scheduled session was launched.
32  
33 =cut
34  
35 7 has 'roomName' => (is => 'rw', isa => 'Str', required => 1,
36 documentation => 'Name of the room'
37 );
38  
39 =head2 roomOpened (HiResDate)
40  
41 The date and time that the room opened (also known as the date and time session was launched) in milliseconds.
42  
43 =cut
44  
45 7 has 'roomOpened' => (is => 'rw', isa => 'HiResDate', required => 1,
46 documentation => 'date and time that the session was launched');
47  
48 =head2 roomClosed (HiResDate)
49  
50 The date and time that the room shut down.
51  
52 =cut
53  
54 7 has 'roomClosed' => (is => 'rw', isa => 'HiResDate', required => 1,
55 documentation => 'date and time that room shut down');
56  
57 =head2 attendees (Arr)
58  
59 This is a collection of L<Bb::Collaborate::V3::Session::Attendee> objects. This collection represents all the attendees who were present in this session between the roomOpen and roomClosed time.
60  
61 Since guests can attend sessions, not all the attendees may be users in your system.
62  
63 =cut
64  
65 7 has 'attendees' => (is => 'rw', isa => 'Bb::Collaborate::V3::Session::Attendees',
66 coerce => 1, documentation => 'Session attendees',);
67  
68 # give soap a helping hand
69 7 __PACKAGE__->_alias(attendeeResponseCollection => 'attendees');
70  
71 =head1 METHODS
72  
73 =cut
74  
75 =head2 list
76  
77 my $session_id = '123456789012';
78 my $yesterday = DateTime->today->subtract(days => 1);
79  
80 my $attendance = Bb::Collaborate::V3::Session::Attendance->list(
81 sessionId => $session_id,
82 startTime => $yesterday->epoch.'000');
83  
84 Gets a session attendance report. It returns a reference to an array of Bb::Collaborate::V3::Session::Attendance objects.
85  
86 The attendance information is returned for the specified session for the 24 hour period starting from the date/time passed in. If the session ran more than once during that 24 hour period, you will get the attendance data for all instances of the session that ran during that date.
87 =cut
88  
89 7 1;
« V3/Presentation.pm ↑ Summary V3/Session/Attendee.pm »