Get to which time alarm trigger relates to.
Can be either START or END. If the value is
START the alarm is triggerd relative to the event start time.
If the value is END the alarm is triggerd relative to the event end time
Return a shallow copy of the alarm's options for JSON stringification.
Third party objects like moment.js values are stringified as well. Can
be used for persistence.
Get the trigger time for the alarm. Can either
be a date and time value ([[ICalDateTimeValue]]) or
a number, which will represent the seconds between
alarm and event start. The number is negative, if the
alarm is triggered after the event started.
Get the trigger time for the alarm. Can either
be a date and time value ([[ICalDateTimeValue]]) or
a number, which will represent the seconds between
alarm and event start. The number is negative, if the
alarm is triggered before the event started.
Get the trigger time for the alarm. Can either
be a date and time value ([[ICalDateTimeValue]]) or
a number, which will represent the seconds between
alarm and event start. The number is negative, if the
alarm is triggered after the event started.
Usually you get an
+ICalAlarm
object like this:- Preparing search index...
- The search index is not available
ical-generator - v6.0.1-develop.3Class ICalAlarm
Usually you get an
ICalAlarm
object like this:You can also use the [[
-ICalAlarm
]] object directly:Hierarchy
Index
Constructors
Index
Constructors
Methods
Constructors
constructor
Constructor of [[
ICalAttendee
]]. The event reference is required +Constructors
constructor
Constructor of [[
ICalAttendee
]]. The event reference is required to query the calendar's timezone and summary when required.Parameters
data: ICalAlarmData
Alarm Data
-event: ICalEvent
Returns ICalAlarm
Methods
attach
mime: null | string;
uri: string;
}
Get Attachment
+event: ICalEvent
Returns ICalAlarm
Methods
attach
mime: null | string;
uri: string;
}
Get Attachment
Returns null | {
mime: null | string;
uri: string;
}
Since
0.2.1
-Set Alarm attachment. Used to set the alarm sound +
Set Alarm attachment. Used to set the alarm sound if alarm type is audio. Defaults to "Basso".
Parameters
attachment: null | string | {
mime?: null | string;
uri: string;
}
Returns ICalAlarm
Since
0.2.1
-description
Get the alarm description. Used to set the alarm message +
description
Get the alarm description. Used to set the alarm message if alarm type is display. Defaults to the event's summary.
Returns null | string
Since
0.2.1
-Set the alarm description. Used to set the alarm message +
Set the alarm description. Used to set the alarm message if alarm type is display. Defaults to the event's summary.
Parameters
description: null | string
Returns ICalAlarm
Since
0.2.1
-relates To
Get to which time alarm trigger relates to. +
relates To
Get to which time alarm trigger relates to. Can be either
START
orEND
. If the value isSTART
the alarm is triggerd relative to the event start time. If the value isEND
the alarm is triggerd relative to the event end timeReturns null | ICalAlarmRelatesTo
Since
4.0.1
-Use this method to set to which time alarm trigger relates to. +
Use this method to set to which time alarm trigger relates to. Works only if trigger is a
number
Parameters
relatesTo: null | ICalAlarmRelatesTo
Returns ICalAlarm
Since
4.0.1
-repeat
Get Alarm Repetitions
+repeat
Get Alarm Repetitions
Returns null | ICalAlarmRepeatData
Since
0.2.1
-Set Alarm Repetitions. Use this to repeat the alarm.
+Set Alarm Repetitions. Use this to repeat the alarm.
Parameters
repeat: null | ICalAlarmRepeatData
Returns ICalAlarm
Since
0.2.1
-toJSON
Return a shallow copy of the alarm's options for JSON stringification. +
toJSON
Return a shallow copy of the alarm's options for JSON stringification. Third party objects like moment.js values are stringified as well. Can be used for persistence.
Returns ICalAlarmJSONData
Since
0.2.4
-to String
Return generated event as a string.
+to String
Return generated event as a string.
-Returns string
trigger
Get the trigger time for the alarm. Can either +
Returns string
trigger
Get the trigger time for the alarm. Can either be a date and time value ([[
ICalDateTimeValue
]]) or a number, which will represent the seconds between alarm and event start. The number is negative, if the alarm is triggered after the event started.Returns number | ICalDateTimeValue
Since
0.2.1
-Use this method to set the alarm time.
+Use this method to set the alarm time.
You can use any supported date object, see readme for details about supported values and timezone handling.
Parameters
trigger: number | ICalDateTimeValue
Returns ICalAlarm
Since
0.2.1
-trigger After
Get the trigger time for the alarm. Can either +
trigger After
Get the trigger time for the alarm. Can either be a date and time value ([[
ICalDateTimeValue
]]) or a number, which will represent the seconds between alarm and event start. The number is negative, if the alarm is triggered before the event started.Returns number | ICalDateTimeValue
Since
0.2.1
-Use this method to set the alarm time. Unlike
trigger
, this time +Use this method to set the alarm time. Unlike
@@ -82,14 +82,14 @@ readme for details about supported values and timezone handling.trigger
, this time the alarm takes place after the event has started.Parameters
trigger: number | ICalDateTimeValue
Returns ICalAlarm
Since
0.2.1
-trigger Before
Get the trigger time for the alarm. Can either +
trigger Before
Get the trigger time for the alarm. Can either be a date and time value ([[
ICalDateTimeValue
]]) or a number, which will represent the seconds between alarm and event start. The number is negative, if the alarm is triggered after the event started.Parameters
trigger: number | ICalDateTimeValue
Returns ICalAlarm
Since
0.2.1
Alias
trigger
-Use this method to set the alarm time.
+Use this method to set the alarm time.
You can use any supported date object, see @@ -97,23 +97,23 @@
Alias
trigger
for details about supported values and timezone handling.Returns number | ICalDateTimeValue
Since
0.2.1
Alias
trigger
-type
Get the alarm type
+type
Get the alarm type
Parameters
type: ICalAlarmType
Returns ICalAlarm
Since
0.2.1
-Set the alarm type. See [[
ICalAlarmType
]] +Set the alarm type. See [[
ICalAlarmType
]] for available status options.Returns ICalAlarmType
Since
0.2.1
-x
Set X-* attributes. Woun't filter double attributes, +
x
Set X-* attributes. Woun't filter double attributes, which are also added by another method (e.g. type), so these attributes may be inserted twice.
Parameters
keyOrArray: Record<string, string> | [string, string][] | {
key: string;
value: string;
}[]
Returns ICalAlarm
Since
1.9.0
-Set a X-* attribute. Woun't filter double attributes, +
Set a X-* attribute. Woun't filter double attributes, which are also added by another method (e.g. type), so these attributes may be inserted twice.
Parameters
keyOrArray: string
value: string
Returns ICalAlarm
Since
1.9.0
-key: string;
value: string;
}[]
Get all custom X-* attributes.
+key: string;
value: string;
}[]
Get all custom X-* attributes.
Returns {
key: string;
value: string;
}[]
Since
1.9.0
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc