| 1 | package Bb::Collaborate::V3::Server::QuotaLimits; | ||
| 2 | use warnings; use strict; | ||
| 3 | |||
| 4 | use Mouse; | ||
| 5 | |||
| 6 | extends 'Elive::DAO::Singleton','Bb::Collaborate::V3'; | ||
| 7 | |||
| 8 | use Scalar::Util; | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Bb::Collaborate::V3::Server::QuotaLimits - Gets quota limits and usage information | ||
| 13 | |||
| 14 | =cut | ||
| 15 | |||
| 16 | =head1 DESCRIPTION | ||
| 17 | |||
| 18 | This class is used to determine how much of your quotas you have used. | ||
| 19 | |||
| 20 | =cut | ||
| 21 | |||
| 22 | __PACKAGE__->entity_name('QuotaLimits'); | ||
| 23 | |||
| 24 | =head1 PROPERTIES | ||
| 25 | |||
| 26 | =head2 versionId (Int) | ||
| 27 | |||
| 28 | The version number as a 4 digit integer, e.g. C<1002>. | ||
| 29 | |||
| 30 | =cut | ||
| 31 | |||
| 32 | has 'versionId' => (is => 'rw', isa => 'Int'); | ||
| 33 | |||
| 34 | =head2 quotaName (Str) | ||
| 35 | |||
| 36 | The name of the quota. This may be one of the following: | ||
| 37 | |||
| 38 | =over 4 | ||
| 39 | |||
| 40 | =item * C<session> - The number of sessions. | ||
| 41 | |||
| 42 | =item * C<disk> - The number of bytes of disk storage. | ||
| 43 | |||
| 44 | =item * C<recordingConversion> - The number of conversions of recordings. | ||
| 45 | |||
| 46 | =item * C<recordingPlayback> - The number of times | ||
| 47 | recordings have been played back in the past 12 | ||
| 48 | months. | ||
| 49 | |||
| 50 | =back | ||
| 51 | |||
| 52 | =cut | ||
| 53 | |||
| 54 | has 'quotaName' => (is => 'rw', isa => 'Str'); | ||
| 55 | |||
| 56 | =head2 quotaUsage (Int) | ||
| 57 | |||
| 58 | How many have been used. | ||
| 59 | |||
| 60 | =cut | ||
| 61 | |||
| 62 | has 'quotaUsage' => (is => 'rw', isa => 'Int'); | ||
| 63 | |||
| 64 | =head2 quotaAvailable (Int) | ||
| 65 | |||
| 66 | The number available | ||
| 67 | |||
| 68 | =cut | ||
| 69 | |||
| 70 | has 'quotaAvailable' => (is => 'rw', isa => 'Int'); | ||
| 71 | |||
| 72 | =head1 METHODS | ||
| 73 | |||
| 74 | =cut | ||
| 75 | |||
| 76 | =head2 list | ||
| 77 | |||
| 78 | my $server_version = Bb::Collaborate::V3::Server::QuotaLimits->get; | ||
| 79 | print "ELM version is: ".$server_version->versionName."\n"; | ||
| 80 | |||
| 81 | Returns the server version information for the current connection. | ||
| 82 | |||
| 83 | =cut | ||
| 84 | |||
| 85 | sub list { | ||
| 86 | my ($class, %opt) = @_; | ||
| 87 | |||
| 88 | $opt{command} ||= 'GetQuotaLimits'; | ||
| 89 | |||
| 90 | return $class->SUPER::list(%opt); | ||
| 91 | } | ||
| 92 | |||
| 93 | 1; |