Created: [Apr 6, 2004]
Defines a TRIGGER iCalendar component property.
4.8.6.3 Trigger
Property Name: TRIGGER
Purpose: This property specifies when an alarm will trigger.
Value Type: The default value type is DURATION. The value type can be
set to a DATE-TIME value type, in which case the value MUST specify a
UTC formatted DATE-TIME value.
Property Parameters: Non-standard, value data type, time zone
identifier or trigger relationship property parameters can be
specified on this property. The trigger relationship property
parameter MUST only be specified when the value type is DURATION.
Conformance: This property MUST be specified in the "VALARM" calendar
component.
Description: Within the "VALARM" calendar component, this property
defines when the alarm will trigger. The default value type is
DURATION, specifying a relative time for the trigger of the alarm.
The default duration is relative to the start of an event or to-do
that the alarm is associated with. The duration can be explicitly set
to trigger from either the end or the start of the associated event
or to-do with the "RELATED" parameter. A value of START will set the
alarm to trigger off the start of the associated event or to-do. A
value of END will set the alarm to trigger off the end of the
associated event or to-do.
Either a positive or negative duration may be specified for the
"TRIGGER" property. An alarm with a positive duration is triggered
after the associated start or end of the event or to-do. An alarm
with a negative duration is triggered before the associated start or
end of the event or to-do.
The "RELATED" property parameter is not valid if the value type of
the property is set to DATE-TIME (i.e., for an absolute date and time
alarm trigger). If a value type of DATE-TIME is specified, then the
property value MUST be specified in the UTC time format. If an
absolute trigger is specified on an alarm for a recurring event or
to-do, then the alarm will only trigger for the specified absolute
date/time, along with any specified repeating instances.
If the trigger is set relative to START, then the "DTSTART" property
MUST be present in the associated "VEVENT" or "VTODO" calendar
component. If an alarm is specified for an event with the trigger set
relative to the END, then the "DTEND" property or the "DSTART" and
"DURATION' properties MUST be present in the associated "VEVENT"
calendar component. If the alarm is specified for a to-do with a
trigger set relative to the END, then either the "DUE" property or
the "DSTART" and "DURATION' properties MUST be present in the
associated "VTODO" calendar component.
Alarms specified in an event or to-do which is defined in terms of a
DATE value type will be triggered relative to 00:00:00 UTC on the
specified date. For example, if "DTSTART:19980205, then the duration
trigger will be relative to19980205T000000Z.
Format Definition: The property is defined by the following notation:
trigger = "TRIGGER" (trigrel / trigabs)
trigrel = *(
; the following are optional,
; but MUST NOT occur more than once
(";" "VALUE" "=" "DURATION") /
(";" trigrelparam) /
; the following is optional,
; and MAY occur more than once
(";" xparam)
) ":" dur-value
trigabs = 1*(
; the following is REQUIRED,
; but MUST NOT occur more than once
(";" "VALUE" "=" "DATE-TIME") /
; the following is optional,
; and MAY occur more than once
(";" xparam)
) ":" date-time
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private TemporalAmountAdapter | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | Trigger(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| public | |
| public | |
| private | |
| public | Trigger(final ParameterList
a list of parameters for this component aList, final Dur a duration in milliseconds duration)
Deprecated
|
| public | Trigger(final ParameterList
a list of parameters for this component aList, final TemporalAmount a duration in milliseconds duration)
|
| private | |
| public | |
| public | Trigger(final ParameterList
a list of parameters for this component aList, final Instant a date representation of a date-time dateTime)
|
| Modifier and Type | Method and Description |
|---|---|
| public final TemporalAmount | |
| public final String | |
| public boolean | Returns: true if the trigger is absoluteIndicates whether the trigger is relative or absolute. |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public void | setDate(final Instant
The dateTime to set. dateTime)Overrides net. Sets the date value of this property. |
| public void | setDefaultTimeZone(ZoneId
a timezone identifier defaultTimeZone)Overrides net. Overrides default net. A default timezone may be specified for interpreting floating DATE-TIME values. |
| public final void | |
| public void | setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry)
Overrides net. Overrides default net.
|
| public final void | setValue(final String
a string representation of a DATE or DATE-TIME value aValue)Overrides net. Default setValue() implementation. |
| public ValidationResult | validate()
Overrides net. Perform validation on a property. |
| duration | back to summary |
|---|---|
| private TemporalAmountAdapter duration | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides net. | |
| Trigger | back to summary |
|---|---|
| public Trigger() Default constructor. | |
| Trigger | back to summary |
|---|---|
public Trigger(final ParameterList aList, final String aValue)
| |
| Trigger | back to summary |
|---|---|
| public Trigger(final Dur duration)
Deprecated
| |
| Trigger | back to summary |
|---|---|
public Trigger(final TemporalAmount duration)
| |
| Trigger | back to summary |
|---|---|
| private Trigger(final TemporalAmountAdapter duration) | |
| Trigger | back to summary |
|---|---|
| public Trigger(final ParameterList aList, final Dur duration)
Deprecated
| |
| Trigger | back to summary |
|---|---|
public Trigger(final ParameterList aList, final TemporalAmount duration)
| |
| Trigger | back to summary |
|---|---|
| private Trigger(final ParameterList aList, final TemporalAmountAdapter duration) | |
| Trigger | back to summary |
|---|---|
public Trigger(final Instant dateTime)
| |
| Trigger | back to summary |
|---|---|
public Trigger(final ParameterList aList, final Instant dateTime)
| |
| getDuration | back to summary |
|---|---|
public final TemporalAmount getDuration()
| |
| getValue | back to summary |
|---|---|
| public final String getValue() Overrides net.
| |
| isAbsolute | back to summary |
|---|---|
| public boolean isAbsolute() Indicates whether the trigger is relative or absolute.
| |
| newFactory | back to summary |
|---|---|
| protected PropertyFactory Implements abstract net. Doc from net. Returns a new property factory used to create deep copies.
| |
| setDate | back to summary |
|---|---|
| public void setDate(final Instant dateTime) Overrides net. Doc from net. Sets the date value of this property. The timezone and value of this instance will also be updated accordingly. | |
| setDefaultTimeZone | back to summary |
|---|---|
| public void setDefaultTimeZone(ZoneId defaultTimeZone) Overrides net. Overrides default net. Doc from net. A default timezone may be specified for interpreting floating DATE-TIME values. In the absence of a default timezone the system default timezone will be used. | |
| setDuration | back to summary |
|---|---|
public final void setDuration(final TemporalAmount duration)
| |
| setTimeZoneRegistry | back to summary |
|---|---|
| public void setTimeZoneRegistry(TimeZoneRegistry timeZoneRegistry) Overrides net. Overrides default net.
| |
| setValue | back to summary |
|---|---|
| public final void setValue(final String aValue) Overrides net. Doc from net. Default setValue() implementation. Allows for either DATE or DATE-TIME values.
Note that this method will use the system default zone rules to parse the string value. For parsing string
values in a different timezone use | |
| validate | back to summary |
|---|---|
| public ValidationResult validate() throws ValidationException Overrides net. Doc from net. Perform validation on a property.
| |
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Trigger | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Trigger |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Trigger createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Trigger createProperty() Implements net.
| |