UNPKG

vobject

Version:

iCalendar VObject Manipulation in NodeJS

github.com/outlook/vobject-js

outlook/vobject-js

34 lines (17 loc) • 1.19 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# vobject.alarm() [`RFC`](http://tools.ietf.org/html/rfc5545#section-3.6.6) This is a VALARM component which is a subclass of the [`component`](./component.md) object. ----------------------------------------------------------------------------------------- ##### alarm.setAction(action) - `action` of the alarm. Expects a STRING. Ex: DISPLAY, AUDIO, EMAIL ##### alarm.getAction() - **returns** the action of the alarm. Ex: DISPLAY, AUDIO, EMAIL ----------------------------------------------------------------------------------------- ##### alarm.setDescription(description) - `description` of the alarm. Expects a STRING. Ex: This is an event reminder ##### alarm.getDescription() - **returns** the description of the alarm. Ex: This is an event reminder ----------------------------------------------------------------------------------------- ##### alarm.setTrigger(trigger) - `trigger` to set for the alarm. Expects either a [`durationValue`](./durationValue.md) or [`dateTimeValue`](./dateTimeValue.md) object ##### alarm.getTrigger(trigger) - **returns** the [`durationValue`](./durationValue.md) or [`dateTimeValue`](./dateTimeValue.md) set as the trigger for the alarm