blob: 9d1c7fd1015297257783f97530880b3ad55c301e (
plain)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>JtxAlarm</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>ical4android</span>
</a>
</div>
<div>
</div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="ical4android::at.techbee.jtx/JtxContract.JtxAlarm///PointingToDeclaration//579055962">
<div class="breadcrumbs"><a href="../../../../index.html">ical4android</a><span class="delimiter">/</span><a href="../../index.html">at.techbee.jtx</a><span class="delimiter">/</span><a href="../index.html">JtxContract</a><span class="delimiter">/</span><span class="current">JtxAlarm</span></div>
<div class="cover ">
<h1 class="cover"><span>Jtx</span><wbr></wbr><span><span>Alarm</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">JtxAlarm</a></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="1629176489%2FClasslikes%2F579055962" anchor-label="AlarmAction" id="1629176489%2FClasslikes%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-alarm-action/index.html"><span>Alarm</span><wbr></wbr><span><span>Action</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1629176489%2FClasslikes%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">enum </span><a href="-alarm-action/index.html">AlarmAction</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a><span class="token operator"><</span><span class="token keyword"></span><a href="-alarm-action/index.html">JtxContract.JtxAlarm.AlarmAction</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">This enum class defines the possible values for the attribute <a href="-a-c-t-i-o-n.html">ACTION</a> for the Component VALARM</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2047934616%2FClasslikes%2F579055962" anchor-label="AlarmRelativeTo" id="2047934616%2FClasslikes%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-alarm-relative-to/index.html"><span>Alarm</span><wbr></wbr><span>Relative</span><wbr></wbr><span><span>To</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2047934616%2FClasslikes%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">enum </span><a href="-alarm-relative-to/index.html">AlarmRelativeTo</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a><span class="token operator"><</span><span class="token keyword"></span><a href="-alarm-relative-to/index.html">JtxContract.JtxAlarm.AlarmRelativeTo</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">This enum class defines the possible values for the attribute <a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-t-o.html">TRIGGER_RELATIVE_TO</a> for the Component VALARM</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="210518119%2FProperties%2F579055962" anchor-label="ACTION" id="210518119%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-c-t-i-o-n.html"><span><span>ACTION</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="210518119%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="210518119%2FProperties%2F579055962" anchor-label="ACTION" id="210518119%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-c-t-i-o-n.html">ACTION</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="210518119%2FProperties%2F579055962" anchor-label="ACTION" id="210518119%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Each "VALARM" calendar component has a particular type of action with which it is associated. This property specifies the type of action. Applications MUST ignore alarms with x-name and iana-token values they don't recognize. Currently only "DISPLAY" is supported, all other values can be stored but are ignored Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-694767816%2FProperties%2F579055962" anchor-label="ATTACH" id="-694767816%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-t-t-a-c-h.html"><span><span>ATTACH</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-694767816%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-694767816%2FProperties%2F579055962" anchor-label="ATTACH" id="-694767816%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-t-t-a-c-h.html">ATTACH</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-694767816%2FProperties%2F579055962" anchor-label="ATTACH" id="-694767816%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Contains the uri of an attachment Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1689515421%2FProperties%2F579055962" anchor-label="ATTENDEE" id="-1689515421%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-t-t-e-n-d-e-e.html"><span><span>ATTENDEE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1689515421%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-1689515421%2FProperties%2F579055962" anchor-label="ATTENDEE" id="-1689515421%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-t-t-e-n-d-e-e.html">ATTENDEE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-1689515421%2FProperties%2F579055962" anchor-label="ATTENDEE" id="-1689515421%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">This property contains a CSV-list of attendees as Uris e.g. "mailto:contact@techbee.at,mailto:jtx@techbee.at"</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1705864183%2FProperties%2F579055962" anchor-label="CONTENT_URI" id="1705864183%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-c-o-n-t-e-n-t_-u-r-i.html"><span><span>CONTENT_URI</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1705864183%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="1705864183%2FProperties%2F579055962" anchor-label="CONTENT_URI" id="1705864183%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-c-o-n-t-e-n-t_-u-r-i.html">CONTENT_URI</a><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/net/Uri.html">Uri</a></div><div class="brief "><a data-name="1705864183%2FProperties%2F579055962" anchor-label="CONTENT_URI" id="1705864183%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">The content uri of the resources table</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2013620545%2FProperties%2F579055962" anchor-label="DESCRIPTION" id="2013620545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-d-e-s-c-r-i-p-t-i-o-n.html"><span><span>DESCRIPTION</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2013620545%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="2013620545%2FProperties%2F579055962" anchor-label="DESCRIPTION" id="2013620545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-e-s-c-r-i-p-t-i-o-n.html">DESCRIPTION</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="2013620545%2FProperties%2F579055962" anchor-label="DESCRIPTION" id="2013620545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1782731465%2FProperties%2F579055962" anchor-label="DURATION" id="1782731465%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-d-u-r-a-t-i-o-n.html"><span><span>DURATION</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1782731465%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="1782731465%2FProperties%2F579055962" anchor-label="DURATION" id="1782731465%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-u-r-a-t-i-o-n.html">DURATION</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="1782731465%2FProperties%2F579055962" anchor-label="DURATION" id="1782731465%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">The alarm can be defined such that it triggers repeatedly. A definition of an alarm with a repeating trigger MUST include both the "DURATION" and "REPEAT" properties. The "DURATION" property specifies the delay period, after which the alarm will repeat. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-547986073%2FProperties%2F579055962" anchor-label="ICALOBJECT_ID" id="-547986073%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-i-c-a-l-o-b-j-e-c-t_-i-d.html"><span><span>ICALOBJECT_ID</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-547986073%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-547986073%2FProperties%2F579055962" anchor-label="ICALOBJECT_ID" id="-547986073%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-i-c-a-l-o-b-j-e-c-t_-i-d.html">ICALOBJECT_ID</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-547986073%2FProperties%2F579055962" anchor-label="ICALOBJECT_ID" id="-547986073%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">The name of the Foreign Key Column for IcalObjects. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, references <a href="../-jtx-i-cal-object/-i-d.html">JtxICalObject.ID</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2145572130%2FProperties%2F579055962" anchor-label="ID" id="2145572130%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-i-d.html"><span><span>ID</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2145572130%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="2145572130%2FProperties%2F579055962" anchor-label="ID" id="2145572130%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-i-d.html">ID</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="2145572130%2FProperties%2F579055962" anchor-label="ID" id="2145572130%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">The name of the ID column for attachments. This is the unique identifier of an Attachment Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, references <a href="../-jtx-i-cal-object/-i-d.html">JtxICalObject.ID</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-122994515%2FProperties%2F579055962" anchor-label="OTHER" id="-122994515%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-o-t-h-e-r.html"><span><span>OTHER</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-122994515%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-122994515%2FProperties%2F579055962" anchor-label="OTHER" id="-122994515%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-o-t-h-e-r.html">OTHER</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-122994515%2FProperties%2F579055962" anchor-label="OTHER" id="-122994515%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Purpose: To specify other properties for the alarm. see [https://tools.ietf.org/html/rfc5545#section-3.8.4.3] Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-243254110%2FProperties%2F579055962" anchor-label="REPEAT" id="-243254110%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-r-e-p-e-a-t.html"><span><span>REPEAT</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-243254110%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-243254110%2FProperties%2F579055962" anchor-label="REPEAT" id="-243254110%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-r-e-p-e-a-t.html">REPEAT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-243254110%2FProperties%2F579055962" anchor-label="REPEAT" id="-243254110%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">The "REPEAT" property specifies the number of additional repetitions that the alarm will be triggered. This repetition count is in addition to the initial triggering of the alarm. Both of these properties MUST be present in order to specify a repeating alarm. If one of these two properties is absent, then the alarm will not repeat beyond the initial trigger. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="409194711%2FProperties%2F579055962" anchor-label="SUMMARY" id="409194711%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-s-u-m-m-a-r-y.html"><span><span>SUMMARY</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="409194711%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="409194711%2FProperties%2F579055962" anchor-label="SUMMARY" id="409194711%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-s-u-m-m-a-r-y.html">SUMMARY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="409194711%2FProperties%2F579055962" anchor-label="SUMMARY" id="409194711%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">This property defines a short summary or subject for the calendar component. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1807416611%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_DURATION" id="-1807416611%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-d-u-r-a-t-i-o-n.html"><span><span>TRIGGER_RELATIVE_DURATION</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1807416611%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-1807416611%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_DURATION" id="-1807416611%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-d-u-r-a-t-i-o-n.html">TRIGGER_RELATIVE_DURATION</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-1807416611%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_DURATION" id="-1807416611%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Purpose: Specifying a relative time for the trigger of the alarm. The default duration is relative to the start of an event or to-do with which the alarm is associated. The duration can be explicitly set to trigger from either the end or the start of the associated event or to-do with the <a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-t-o.html">TRIGGER_RELATIVE_TO</a> 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. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-667783466%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_TO" id="-667783466%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-t-o.html"><span><span>TRIGGER_RELATIVE_TO</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-667783466%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-667783466%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_TO" id="-667783466%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-r-i-g-g-e-r_-r-e-l-a-t-i-v-e_-t-o.html">TRIGGER_RELATIVE_TO</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-667783466%2FProperties%2F579055962" anchor-label="TRIGGER_RELATIVE_TO" id="-667783466%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Purpose: This property defines the field to which the duration is relatiive to. The possible values of a status are defined in the enum <a href="-alarm-relative-to/index.html">AlarmRelativeTo</a>. Use e.g. AlarmRelativeTo.START.name to put a correct String value in this field. AlarmRelativeTo.START would make the duration relative to DTSTART. AlarmRelativeTo.END would make the duration relative to DUE (only VTODO is supported!). If no valid AlarmRelativeTo is provided, the default value is AlarmRelativeTo.START. Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="857673545%2FProperties%2F579055962" anchor-label="TRIGGER_TIME" id="857673545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-r-i-g-g-e-r_-t-i-m-e.html"><span><span>TRIGGER_TIME</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="857673545%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="857673545%2FProperties%2F579055962" anchor-label="TRIGGER_TIME" id="857673545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-r-i-g-g-e-r_-t-i-m-e.html">TRIGGER_TIME</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="857673545%2FProperties%2F579055962" anchor-label="TRIGGER_TIME" id="857673545%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Stores a timestamp with the absolute time when the alarm should be triggered. This value is stored as UNIX timestamp (milliseconds). Either a Alarm Trigger Time OR a Alarm Relative Duration must be provided, but not both! Type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-268138723%2FProperties%2F579055962" anchor-label="TRIGGER_TIMEZONE" id="-268138723%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/release" data-filterable-set=":dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-r-i-g-g-e-r_-t-i-m-e-z-o-n-e.html"><span><span>TRIGGER_TIMEZONE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-268138723%2FProperties%2F579055962"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/release"><a data-name="-268138723%2FProperties%2F579055962" anchor-label="TRIGGER_TIMEZONE" id="-268138723%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-r-i-g-g-e-r_-t-i-m-e-z-o-n-e.html">TRIGGER_TIMEZONE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><a data-name="-268138723%2FProperties%2F579055962" anchor-label="TRIGGER_TIMEZONE" id="-268138723%2FProperties%2F579055962" data-filterable-set=":dokkaHtml/release"></a><p class="paragraph">Purpose: This column/property specifies the timezone of the absolute trigger time. The corresponding datetime is stored in <a href="-t-r-i-g-g-e-r_-t-i-m-e.html">TRIGGER_TIME</a>. The value of a timezone can be:</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>
|
