arno/etesync-android
1
0
Fork 0
mirror of https://github.com/etesync/android synced 2025-07-30 02:18:04 +00:00
Code Issues Releases Wiki Activity
350171c20c
etesync-android/libs/biweekly-0.3.1-javadoc/biweekly/component/VAlarm.html

995 lines
56 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_51) on Sat Sep 21 17:46:22 EDT 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
VAlarm (biweekly 0.3.1 API)
</TITLE>
<META NAME="date" CONTENT="2013-09-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../syntaxhighlighter.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="VAlarm (biweekly 0.3.1 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<script src="doc-files/shCore.js" type="text/javascript"></script> <script src="doc-files/shBrushJava.js" type="text/javascript"></script><HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VAlarm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../biweekly/component/StandardTime.html" title="class in biweekly.component"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../biweekly/component/VEvent.html" title="class in biweekly.component"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?biweekly/component/VAlarm.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="VAlarm.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_biweekly.component.ICalComponent">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
biweekly.component</FONT>
<BR>
Class VAlarm</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">biweekly.component.ICalComponent</A>
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>biweekly.component.VAlarm</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../src-html/biweekly/component/VAlarm.html#line.77"><B>VAlarm</B></A><DT>extends <A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></DL>
</PRE>
<P>
<p>
Defines a reminder for an event or to-do task. This class contains static
factory methods to aid in the construction of valid alarms.
</p>
<p>
<b>Examples:</b>
<pre class="brush:java">
//audio alarm
Trigger trigger = ...
Attachment sound = ...
VAlarm audio = VAlarm.audio(trigger, sound);
//display alarm
Trigger trigger = ...
String message = &quot;Meeting at 1pm&quot;;
VAlarm display = VAlarm.display(trigger, message);
//email alarm
Trigger trigger = ...
String subject = &quot;Reminder: Meeting at 1pm&quot;;
String body = &quot;Team,\n\nThe team meeting scheduled for 1pm is about to start. Snacks will be served!\n\nThanks,\nJohn&quot;;
List&lt;String&gt; to = Arrays.asList(&quot;janedoe@example.com&quot;, &quot;bobsmith@example.com&quot;);
VAlarm email = VAlarm.email(trigger, subject, body, to);
</pre>
</p>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Michael Angstadt</DD>
<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-71">RFC 5545 p.71-6</a></dd></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_biweekly.component.ICalComponent"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class biweekly.component.<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../biweekly/component/ICalComponent.html#components">components</A>, <A HREF="../../biweekly/component/ICalComponent.html#properties">properties</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#VAlarm(biweekly.property.Action, biweekly.property.Trigger)">VAlarm</A></B>(<A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A>&nbsp;action,
<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new alarm.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#addAttachment(biweekly.property.Attachment)">addAttachment</A></B>(<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&nbsp;attachment)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an attachment to the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#addAttendee(biweekly.property.Attendee)">addAttendee</A></B>(<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>&nbsp;attendee)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a person who will be emailed when the alarm fires (only applicable
for EMAIL alarms).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#audio(biweekly.property.Trigger)">audio</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an audio alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#audio(biweekly.property.Trigger, biweekly.property.Attachment)">audio</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&nbsp;sound)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an audio alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#display(biweekly.property.Trigger, java.lang.String)">display</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;displayText)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a display alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#email(biweekly.property.Trigger, java.lang.String, java.lang.String, java.util.List)">email</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;subject,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;body,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;recipients)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an email alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#email(biweekly.property.Trigger, java.lang.String, java.lang.String, java.lang.String...)">email</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;subject,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;body,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;recipients)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an email alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getAction()">getAction</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the type of action to invoke when the alarm is triggered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getAttachments()">getAttachments</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets any attachments that are associated with the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getAttendees()">getAttendees</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the people who will be emailed when the alarm fires (only applicable
for EMAIL alarms).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getDescription()">getDescription</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Gets a detailed description of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getDuration()">getDuration</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the length of the pause between alarm repetitions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getRepeat()">getRepeat</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the number of times an alarm should be repeated after its initial
trigger.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getSummary()">getSummary</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Gets the summary of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#getTrigger()">getTrigger</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets when the alarm will be triggered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setAction(biweekly.property.Action)">setAction</A></B>(<A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A>&nbsp;action)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the type of action to invoke when the alarm is triggered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setDescription(biweekly.property.Description)">setDescription</A></B>(<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A>&nbsp;description)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Sets a detailed description of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setDescription(java.lang.String)">setDescription</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Sets a detailed description of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setDuration(biweekly.util.Duration)">setDuration</A></B>(<A HREF="../../biweekly/util/Duration.html" title="class in biweekly.util">Duration</A>&nbsp;duration)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the length of the pause between alarm repetitions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setDuration(biweekly.property.DurationProperty)">setDuration</A></B>(<A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A>&nbsp;duration)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the length of the pause between alarm repetitions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setRepeat(int, biweekly.util.Duration)">setRepeat</A></B>(int&nbsp;count,
<A HREF="../../biweekly/util/Duration.html" title="class in biweekly.util">Duration</A>&nbsp;pauseDuration)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the repetition information for the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setRepeat(java.lang.Integer)">setRepeat</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&nbsp;count)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of times an alarm should be repeated after its initial
trigger.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setRepeat(biweekly.property.Repeat)">setRepeat</A></B>(<A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A>&nbsp;repeat)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of times an alarm should be repeated after its initial
trigger.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setSummary(java.lang.String)">setSummary</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;summary)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Sets the summary of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setSummary(biweekly.property.Summary)">setSummary</A></B>(<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A>&nbsp;summary)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Sets the summary of the alarm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#setTrigger(biweekly.property.Trigger)">setTrigger</A></B>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets when the alarm will be triggered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../biweekly/component/VAlarm.html#validate(java.util.List, java.util.List)">validate</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>&gt;&nbsp;components,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;warnings)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the component for data consistency problems or deviations from the
spec.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_biweekly.component.ICalComponent"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class biweekly.component.<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../biweekly/component/ICalComponent.html#addComponent(biweekly.component.ICalComponent)">addComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalComponent(java.lang.String)">addExperimentalComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalProperty(java.lang.String, biweekly.ICalDataType, java.lang.String)">addExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalProperty(java.lang.String, java.lang.String)">addExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#addProperty(biweekly.property.ICalProperty)">addProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#checkOptionalCardinality(java.util.List, java.lang.Class...)">checkOptionalCardinality</A>, <A HREF="../../biweekly/component/ICalComponent.html#checkRequiredCardinality(java.util.List, java.lang.Class...)">checkRequiredCardinality</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponent(java.lang.Class)">getComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponents()">getComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponents(java.lang.Class)">getComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponent(java.lang.String)">getExperimentalComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponents()">getExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponents(java.lang.String)">getExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperties()">getExperimentalProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperties(java.lang.String)">getExperimentalProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperty(java.lang.String)">getExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperties()">getProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperties(java.lang.Class)">getProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperty(java.lang.Class)">getProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeExperimentalComponents(java.lang.String)">removeExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeExperimentalProperty(java.lang.String)">removeExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeProperties(java.lang.Class)">removeProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#setComponent(java.lang.Class, T)">setComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#setComponent(biweekly.component.ICalComponent)">setComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalComponents(java.lang.String)">setExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalProperty(java.lang.String, biweekly.ICalDataType, java.lang.String)">setExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalProperty(java.lang.String, java.lang.String)">setExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setProperty(java.lang.Class, T)">setProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setProperty(biweekly.property.ICalProperty)">setProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List)">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="VAlarm(biweekly.property.Action, biweekly.property.Trigger)"><!-- --></A><H3>
VAlarm</H3>
<PRE>
public <A HREF="../../src-html/biweekly/component/VAlarm.html#line.84"><B>VAlarm</B></A>(<A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A>&nbsp;action,
<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</PRE>
<DL>
<DD>Creates a new alarm. Consider using one of the static factory methods
instead.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the alarm action (e.g. "email")<DD><CODE>trigger</CODE> - the trigger</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="audio(biweekly.property.Trigger)"><!-- --></A><H3>
audio</H3>
<PRE>
public static <A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.94"><B>audio</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</PRE>
<DL>
<DD>Creates an audio alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger
<DT><B>Returns:</B><DD>the alarm</DL>
</DD>
</DL>
<HR>
<A NAME="audio(biweekly.property.Trigger, biweekly.property.Attachment)"><!-- --></A><H3>
audio</H3>
<PRE>
public static <A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.104"><B>audio</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&nbsp;sound)</PRE>
<DL>
<DD>Creates an audio alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger<DD><CODE>sound</CODE> - a sound to play when the alarm triggers
<DT><B>Returns:</B><DD>the alarm</DL>
</DD>
</DL>
<HR>
<A NAME="display(biweekly.property.Trigger, java.lang.String)"><!-- --></A><H3>
display</H3>
<PRE>
public static <A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.118"><B>display</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;displayText)</PRE>
<DL>
<DD>Creates a display alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger<DD><CODE>displayText</CODE> - the display text
<DT><B>Returns:</B><DD>the alarm</DL>
</DD>
</DL>
<HR>
<A NAME="email(biweekly.property.Trigger, java.lang.String, java.lang.String, java.lang.String...)"><!-- --></A><H3>
email</H3>
<PRE>
public static <A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.132"><B>email</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;subject,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;body,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;recipients)</PRE>
<DL>
<DD>Creates an email alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger<DD><CODE>subject</CODE> - the email subject<DD><CODE>body</CODE> - the email body<DD><CODE>recipients</CODE> - the email address(es) to send the alert to
<DT><B>Returns:</B><DD>the alarm</DL>
</DD>
</DL>
<HR>
<A NAME="email(biweekly.property.Trigger, java.lang.String, java.lang.String, java.util.List)"><!-- --></A><H3>
email</H3>
<PRE>
public static <A HREF="../../biweekly/component/VAlarm.html" title="class in biweekly.component">VAlarm</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.144"><B>email</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;subject,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;body,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;recipients)</PRE>
<DL>
<DD>Creates an email alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger<DD><CODE>subject</CODE> - the email subject<DD><CODE>body</CODE> - the email body<DD><CODE>recipients</CODE> - the email address(es) to send the alert to
<DT><B>Returns:</B><DD>the alarm</DL>
</DD>
</DL>
<HR>
<A NAME="getAttachments()"><!-- --></A><H3>
getAttachments</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&gt; <A HREF="../../src-html/biweekly/component/VAlarm.html#line.159"><B>getAttachments</B></A>()</PRE>
<DL>
<DD>Gets any attachments that are associated with the alarm.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the attachments<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-80">RFC 5545 p.80-1</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="addAttachment(biweekly.property.Attachment)"><!-- --></A><H3>
addAttachment</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.169"><B>addAttachment</B></A>(<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>&nbsp;attachment)</PRE>
<DL>
<DD>Adds an attachment to the alarm. Note that AUDIO alarms should only have
1 attachment.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attachment</CODE> - the attachment to add<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-80">RFC 5545 p.80-1</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
public <A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.189"><B>getDescription</B></A>()</PRE>
<DL>
<DD><p>
Gets a detailed description of the alarm. The description should be more
detailed than the one provided by the <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A> property.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>DISPLAY - the display text</li>
<li>EMAIL - the body of the email message</li>
<li>all others - a general description of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the description or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setDescription(biweekly.property.Description)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.209"><B>setDescription</B></A>(<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A>&nbsp;description)</PRE>
<DL>
<DD><p>
Sets a detailed description of the alarm. The description should be more
detailed than the one provided by the <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A> property.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>DISPLAY - the display text</li>
<li>EMAIL - the body of the email message</li>
<li>all others - a general description of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - the description or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public <A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.230"><B>setDescription</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</PRE>
<DL>
<DD><p>
Sets a detailed description of the alarm. The description should be more
detailed than the one provided by the <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A> property.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>DISPLAY - the display text</li>
<li>EMAIL - the body of the email message</li>
<li>all others - a general description of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - the description or null to remove
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getSummary()"><!-- --></A><H3>
getSummary</H3>
<PRE>
public <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.250"><B>getSummary</B></A>()</PRE>
<DL>
<DD><p>
Gets the summary of the alarm.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>EMAIL - the subject line of the email</li>
<li>all others - a one-line summary of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the summary or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setSummary(biweekly.property.Summary)"><!-- --></A><H3>
setSummary</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.268"><B>setSummary</B></A>(<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A>&nbsp;summary)</PRE>
<DL>
<DD><p>
Sets the summary of the alarm.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>EMAIL - the subject line of the email</li>
<li>all others - a one-line summary of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>summary</CODE> - the summary or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setSummary(java.lang.String)"><!-- --></A><H3>
setSummary</H3>
<PRE>
public <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.287"><B>setSummary</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;summary)</PRE>
<DL>
<DD><p>
Sets the summary of the alarm.
</p>
<p>
This property has different meanings, depending on the alarm action:
<ul>
<li>EMAIL - the subject line of the email</li>
<li>all others - a one-line summary of the alarm</li>
</ul>
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>summary</CODE> - the summary or null to remove
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getAttendees()"><!-- --></A><H3>
getAttendees</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>&gt; <A HREF="../../src-html/biweekly/component/VAlarm.html#line.299"><B>getAttendees</B></A>()</PRE>
<DL>
<DD>Gets the people who will be emailed when the alarm fires (only applicable
for EMAIL alarms).
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the email recipients<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-107">RFC 5545 p.107-9</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="addAttendee(biweekly.property.Attendee)"><!-- --></A><H3>
addAttendee</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.309"><B>addAttendee</B></A>(<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>&nbsp;attendee)</PRE>
<DL>
<DD>Adds a person who will be emailed when the alarm fires (only applicable
for EMAIL alarms).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attendee</CODE> - the email recipient<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-107">RFC 5545 p.107-9</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getAction()"><!-- --></A><H3>
getAction</H3>
<PRE>
public <A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.318"><B>getAction</B></A>()</PRE>
<DL>
<DD>Gets the type of action to invoke when the alarm is triggered.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the action or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-132">RFC 5545 p.132-3</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setAction(biweekly.property.Action)"><!-- --></A><H3>
setAction</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.327"><B>setAction</B></A>(<A HREF="../../biweekly/property/Action.html" title="class in biweekly.property">Action</A>&nbsp;action)</PRE>
<DL>
<DD>Sets the type of action to invoke when the alarm is triggered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-132">RFC 5545 p.132-3</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getDuration()"><!-- --></A><H3>
getDuration</H3>
<PRE>
public <A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.336"><B>getDuration</B></A>()</PRE>
<DL>
<DD>Gets the length of the pause between alarm repetitions.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the duration or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-99">RFC 5545 p.99</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setDuration(biweekly.property.DurationProperty)"><!-- --></A><H3>
setDuration</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.345"><B>setDuration</B></A>(<A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A>&nbsp;duration)</PRE>
<DL>
<DD>Sets the length of the pause between alarm repetitions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - the duration or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-99">RFC 5545 p.99</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setDuration(biweekly.util.Duration)"><!-- --></A><H3>
setDuration</H3>
<PRE>
public <A HREF="../../biweekly/property/DurationProperty.html" title="class in biweekly.property">DurationProperty</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.355"><B>setDuration</B></A>(<A HREF="../../biweekly/util/Duration.html" title="class in biweekly.util">Duration</A>&nbsp;duration)</PRE>
<DL>
<DD>Sets the length of the pause between alarm repetitions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - the duration or null to remove
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-99">RFC 5545 p.99</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getRepeat()"><!-- --></A><H3>
getRepeat</H3>
<PRE>
public <A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.367"><B>getRepeat</B></A>()</PRE>
<DL>
<DD>Gets the number of times an alarm should be repeated after its initial
trigger.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the repeat count or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setRepeat(biweekly.property.Repeat)"><!-- --></A><H3>
setRepeat</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.377"><B>setRepeat</B></A>(<A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A>&nbsp;repeat)</PRE>
<DL>
<DD>Sets the number of times an alarm should be repeated after its initial
trigger.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>repeat</CODE> - the repeat count or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setRepeat(java.lang.Integer)"><!-- --></A><H3>
setRepeat</H3>
<PRE>
public <A HREF="../../biweekly/property/Repeat.html" title="class in biweekly.property">Repeat</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.389"><B>setRepeat</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&nbsp;count)</PRE>
<DL>
<DD>Sets the number of times an alarm should be repeated after its initial
trigger.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>count</CODE> - the repeat count (e.g. "2" to repeat it two more times after
it was initially triggered, for a total of three times) or null to remove
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setRepeat(int, biweekly.util.Duration)"><!-- --></A><H3>
setRepeat</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.402"><B>setRepeat</B></A>(int&nbsp;count,
<A HREF="../../biweekly/util/Duration.html" title="class in biweekly.util">Duration</A>&nbsp;pauseDuration)</PRE>
<DL>
<DD>Sets the repetition information for the alarm.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>count</CODE> - the repeat count (e.g. "2" to repeat it two more times after
it was initially triggered, for a total of three times)<DD><CODE>pauseDuration</CODE> - the length of the pause between repeats<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="getTrigger()"><!-- --></A><H3>
getTrigger</H3>
<PRE>
public <A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A> <A HREF="../../src-html/biweekly/component/VAlarm.html#line.414"><B>getTrigger</B></A>()</PRE>
<DL>
<DD>Gets when the alarm will be triggered.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the trigger time or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133-6</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="setTrigger(biweekly.property.Trigger)"><!-- --></A><H3>
setTrigger</H3>
<PRE>
public void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.423"><B>setTrigger</B></A>(<A HREF="../../biweekly/property/Trigger.html" title="class in biweekly.property">Trigger</A>&nbsp;trigger)</PRE>
<DL>
<DD>Sets when the alarm will be triggered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trigger</CODE> - the trigger time or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133-6</a></dd></DL>
</DD>
</DL>
<HR>
<A NAME="validate(java.util.List, java.util.List)"><!-- --></A><H3>
validate</H3>
<PRE>
protected void <A HREF="../../src-html/biweekly/component/VAlarm.html#line.429"><B>validate</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>&gt;&nbsp;components,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;warnings)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List, java.util.List)">ICalComponent</A></CODE></B></DD>
<DD>Checks the component for data consistency problems or deviations from the
spec. Meant to be overridden by child classes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List, java.util.List)">validate</A></CODE> in class <CODE><A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>components</CODE> - the hierarchy of components that the component belongs
to<DD><CODE>warnings</CODE> - the list to add the warnings to</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VAlarm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["gutter"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.defaults["toolbar"] = false; SyntaxHighlighter.all(); </script></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../biweekly/component/StandardTime.html" title="class in biweekly.component"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../biweekly/component/VEvent.html" title="class in biweekly.component"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?biweekly/component/VAlarm.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="VAlarm.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_biweekly.component.ICalComponent">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2013 Michael Angstadt. All Rights Reserved.
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink