Function: icalendar-match-valarm-component

icalendar-match-valarm-component is a byte-compiled function defined in icalendar-parser.el.gz.

Signature

(icalendar-match-valarm-component LIMIT)

Documentation

Matcher for VALARM component boundaries.

(Defined by icalendar-define-component.)

Source Code

;; Defined in /usr/src/emacs/lisp/calendar/icalendar-parser.el.gz
(ical:define-component ical:valarm "VALARM"
  "Represents an alarm.

An alarm is a notification or reminder for an event or task.  The
type of notification is determined by this component's
`icalendar-action' property: it may be an AUDIO, DISPLAY, or
EMAIL notification.
If it is an audio alarm, it can include an
`icalendar-attach' property specifying the audio to be rendered.
If it is a DISPLAY alarm, it must include an `icalendar-description'
property containing the text to be displayed.
If it is an EMAIL alarm, it must include both an
`icalendar-summary' and an `icalendar-description', which specify
the subject and body of the email, and one or more
`icalendar-attendee' properties, which specify the recipients.

The required `icalendar-trigger' property specifies when the
alarm triggers.  If the alarm repeats, then `icalendar-duration'
and `icalendar-repeat' properties are also both required.

This component must occur as a direct child of an
`icalendar-vevent' or `icalendar-vtodo' component, and cannot
contain any subcomponents."
  :child-spec (:one (ical:action ical:trigger)
               :zero-or-one (ical:duration ical:repeat)
               :zero-or-more (ical:summary
                              ical:description
                              ical:attendee
                              ical:attach
                              ical:other-property))
  :other-validator ical:valarm-validator
  :link "https://www.rfc-editor.org/rfc/rfc5545#section-3.6.6")