File Coverage

blib/lib/Data/ICal/Entry/Alarm/Audio.pm
Criterion Covered Total %
statement 14 14 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod 2 2 100.0
total 21 21 100.0


line stmt bran cond sub pod time code
1 2     2   12 use warnings;
  2         3  
  2         70  
2 2     2   9 use strict;
  2         2  
  2         50  
3              
4             package Data::ICal::Entry::Alarm::Audio;
5              
6 2     2   8 use base qw/Data::ICal::Entry::Alarm/;
  2         2  
  2         753  
7              
8             =head1 NAME
9              
10             Data::ICal::Entry::Alarm::Audio - Represents an audio alarm in an iCalendar file
11              
12             =head1 SYNOPSIS
13              
14             my $valarm = Data::ICal::Entry::Alarm::Audio->new();
15             $valarm->add_properties(
16             attach => [ "ftp://host.com/pub/sounds/bell-01.aud", { fmttype => "audio/basic" } ],
17             # Dat*e*::ICal is not a typo here
18             trigger => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
19             );
20              
21             $vevent->add_entry($valarm);
22              
23             =head1 DESCRIPTION
24              
25             A L object represents an audio alarm
26             attached to a todo item or event in an iCalendar file. (Note that the
27             iCalendar RFC refers to entries as "components".) It is a subclass of
28             L and accepts all of its methods.
29              
30             =head1 METHODS
31              
32             =cut
33              
34             =head2 new
35              
36             Creates a new L object; sets its
37             C property to C
38              
39             =cut
40              
41             sub new {
42 5     5 1 9 my $class = shift;
43 5         23 my $self = $class->SUPER::new(@_);
44 5         20 $self->add_property( action => "AUDIO" );
45 5         9 return $self;
46             }
47              
48             =head2 optional_unique_properties
49              
50             In addition to C and C (see
51             L), audio alarms
52             may specify a value for C.
53              
54             =cut
55              
56             sub optional_unique_properties {
57             return (
58             shift->SUPER::optional_unique_properties,
59 60     60 1 98 "attach",
60             );
61             }
62              
63             =head1 AUTHOR
64              
65             Best Practical Solutions, LLC Emodules@bestpractical.comE
66              
67             =head1 LICENCE AND COPYRIGHT
68              
69             Copyright (c) 2005 - 2019, Best Practical Solutions, LLC. All rights reserved.
70              
71             This module is free software; you can redistribute it and/or
72             modify it under the same terms as Perl itself. See L.
73              
74             =cut
75              
76             1;