Release 4.0.0-preview1-00253
[platform/core/csapi/tizenfx.git] / src / Tizen.Pims.Calendar / Tizen.Pims.Calendar / CalendarTypes.cs
1 /*
2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3 *
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 namespace Tizen.Pims.Calendar
18 {
19     /// <summary>
20     /// This class provides enumerations about calendar information.
21     /// </summary>
22     /// <since_tizen> 4 </since_tizen>
23     /// <remarks>
24     /// Most enumerations are based on vcalendar, icalendar(ver 2.0) specification.
25     /// https://www.ietf.org/rfc/rfc2445.txt
26     /// </remarks>
27     public static class CalendarTypes
28     {
29         /// <summary>
30         /// Enumeration for Default book
31         /// </summary>
32         /// <since_tizen> 4 </since_tizen>
33         public enum DefaultBook
34         {
35             /// <summary>
36             /// Default event calendar book.
37             /// </summary>
38             /// <since_tizen> 4 </since_tizen>
39             Event,
40             /// <summary>
41             /// Default Todo calendar book.
42             /// </summary>
43             /// <since_tizen> 4 </since_tizen>
44             Todo,
45             /// <summary>
46             /// Default Birthday calendar book.
47             /// </summary>
48             /// <since_tizen> 4 </since_tizen>
49             Birthday,
50         }
51
52         /// <summary>
53         /// Enumeration for Store type
54         /// </summary>
55         /// <since_tizen> 4 </since_tizen>
56         public enum StoreType
57         {
58             /// <summary>
59             /// Book type
60             /// </summary>
61             /// <since_tizen> 4 </since_tizen>
62             Book,
63             /// <summary>
64             /// Event type
65             /// </summary>
66             /// <since_tizen> 4 </since_tizen>
67             Event,
68             /// <summary>
69             /// Todo type
70             /// </summary>
71             /// <since_tizen> 4 </since_tizen>
72             Todo,
73         }
74
75         /// <summary>
76         /// Enumeration for the book mode.
77         /// </summary>
78         /// <since_tizen> 4 </since_tizen>
79         public enum BookMode
80         {
81             /// <summary>
82             /// All modules can read and write records of this calendar_book
83             /// </summary>
84             /// <since_tizen> 4 </since_tizen>
85             Default,
86             /// <summary>
87             /// All modules can only read records of this calendar book
88             /// </summary>
89             /// <since_tizen> 4 </since_tizen>
90             ReadOnly,
91         }
92
93         /// <summary>
94         /// Enumeration for the event status.
95         /// </summary>
96         /// <since_tizen> 4 </since_tizen>
97         public enum EventStatus
98         {
99             /// <summary>
100             /// No status
101             /// </summary>
102             /// <since_tizen> 4 </since_tizen>
103             None = 0x01,
104             /// <summary>
105             /// The event is tentative
106             /// </summary>
107             /// <since_tizen> 4 </since_tizen>
108             Tentative = 0x02,
109             /// <summary>
110             /// The event is confirmed
111             /// </summary>
112             /// <since_tizen> 4 </since_tizen>
113             Confirmed = 0x04,
114             /// <summary>
115             /// The event is cancelled
116             /// </summary>
117             /// <since_tizen> 4 </since_tizen>
118             Cancelled = 0x08,
119         }
120
121         /// <summary>
122         /// Enumeration for for the status of a to-do.
123         /// </summary>
124         /// <since_tizen> 4 </since_tizen>
125         public enum TodoStatus
126         {
127             /// <summary>
128             /// No status
129             /// </summary>
130             /// <since_tizen> 4 </since_tizen>
131             None = 0x0100,
132             /// <summary>
133             /// Needs action status
134             /// </summary>
135             /// <since_tizen> 4 </since_tizen>
136             NeedAction = 0x0200,
137             /// <summary>
138             /// Completed status
139             /// </summary>
140             /// <since_tizen> 4 </since_tizen>
141             Completed = 0x0400,
142             /// <summary>
143             /// Work in process status
144             /// </summary>
145             /// <since_tizen> 4 </since_tizen>
146             InProcess = 0x0800,
147             /// <summary>
148             /// Cancelled status
149             /// </summary>
150             /// <since_tizen> 4 </since_tizen>
151             Cancelled = 0x1000,
152         }
153
154         /// <summary>
155         /// Enumeration for the busy status of an event.
156         /// </summary>
157         /// <since_tizen> 4 </since_tizen>
158         public enum BusyStatus
159         {
160             /// <summary>
161             /// The free status
162             /// </summary>
163             /// <since_tizen> 4 </since_tizen>
164             Free,
165             /// <summary>
166             /// The busy status
167             /// </summary>
168             /// <since_tizen> 4 </since_tizen>
169             Busy,
170             /// <summary>
171             /// The unavailable status
172             /// </summary>
173             /// <since_tizen> 4 </since_tizen>
174             Unavailable,
175             /// <summary>
176             /// The tentative status
177             /// </summary>
178             /// <since_tizen> 4 </since_tizen>
179             Tentative,
180         }
181
182         /// <summary>
183         /// Enumeration for the calendar sensitivity type.
184         /// </summary>
185         /// <since_tizen> 4 </since_tizen>
186         public enum Sensitivity
187         {
188             /// <summary>
189             /// Public Sensitivity
190             /// </summary>
191             /// <since_tizen> 4 </since_tizen>
192             Public,
193             /// <summary>
194             /// Private Sensitivity
195             /// </summary>
196             /// <since_tizen> 4 </since_tizen>
197             Private,
198             /// <summary>
199             /// Confidential Sensitivity
200             /// </summary>
201             /// <since_tizen> 4 </since_tizen>
202             Confidential,
203         }
204
205         /// <summary>
206         /// Enumeration for the meeting status.
207         /// </summary>
208         /// <since_tizen> 4 </since_tizen>
209         public enum MeetingStatus
210         {
211             /// <summary>
212             /// No meeting
213             /// </summary>
214             /// <since_tizen> 4 </since_tizen>
215             NoMeeting,
216             /// <summary>
217             /// Meeting exists
218             /// </summary>
219             /// <since_tizen> 4 </since_tizen>
220             Meeting,
221             /// <summary>
222             /// Meeting received
223             /// </summary>
224             /// <since_tizen> 4 </since_tizen>
225             Received,
226             /// <summary>
227             /// Meeting cancelled
228             /// </summary>
229             /// <since_tizen> 4 </since_tizen>
230             Cancelled,
231         }
232
233         /// <summary>
234         /// Enumeration for the calendar event item's priority
235         /// </summary>
236         /// <since_tizen> 4 </since_tizen>
237         public enum Priority
238         {
239             /// <summary>
240             /// No priority
241             /// </summary>
242             /// <since_tizen> 4 </since_tizen>
243             None = 0x01,
244             /// <summary>
245             /// Low priority
246             /// </summary>
247             /// <since_tizen> 4 </since_tizen>
248             High = 0x02,
249             /// <summary>
250             /// Normal priority
251             /// </summary>
252             /// <since_tizen> 4 </since_tizen>
253             Normal = 0x04,
254             /// <summary>
255             /// High priority
256             /// </summary>
257             /// <since_tizen> 4 </since_tizen>
258             Low = 0x08,
259         }
260
261         /// <summary>
262         /// Enumeration for the frequency of an event's recurrence.
263         /// </summary>
264         /// <since_tizen> 4 </since_tizen>
265         public enum Recurrence
266         {
267             /// <summary>
268             /// No recurrence event
269             /// </summary>
270             /// <since_tizen> 4 </since_tizen>
271             None,
272             /// <summary>
273             /// An event occurs every day
274             /// </summary>
275             /// <since_tizen> 4 </since_tizen>
276             Daily,
277             /// <summary>
278             /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week
279             /// </summary>
280             /// <since_tizen> 4 </since_tizen>
281             Weekly,
282             /// <summary>
283             /// An event occurs on the same day of every month
284             /// </summary>
285             /// <since_tizen> 4 </since_tizen>
286             Monthly,
287             /// <summary>
288             /// An event occurs on the same day of every year
289             /// </summary>
290             /// <since_tizen> 4 </since_tizen>
291             Yearly,
292         }
293
294         /// <summary>
295         /// Enumeration for the range type.
296         /// </summary>
297         /// <since_tizen> 4 </since_tizen>
298         public enum RangeType
299         {
300             /// <summary>
301             /// Range until
302             /// </summary>
303             /// <since_tizen> 4 </since_tizen>
304             Until,
305             /// <summary>
306             /// Range count
307             /// </summary>
308             /// <since_tizen> 4 </since_tizen>
309             Count,
310             /// <summary>
311             /// No range
312             /// </summary>
313             /// <since_tizen> 4 </since_tizen>
314             None,
315         }
316
317         /// <summary>
318         /// Enumeration for the system type.
319         /// </summary>
320         /// <since_tizen> 4 </since_tizen>
321         public enum SystemType
322         {
323             /// <summary>
324             /// Locale's default calendar
325             /// </summary>
326             /// <since_tizen> 4 </since_tizen>
327             Default,
328             /// <summary>
329             /// Locale's default calendar
330             /// </summary>
331             /// <since_tizen> 4 </since_tizen>
332             Gregorian,
333             /// <summary>
334             /// East Asian lunisolar calendar
335             /// </summary>
336             /// <since_tizen> 4 </since_tizen>
337             Lunisolar,
338         }
339
340         /// <summary>
341         /// Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on.
342         /// </summary>
343         /// <since_tizen> 4 </since_tizen>
344         public enum TickUnit
345         {
346             /// <summary>
347             /// No reminder set
348             /// </summary>
349             /// <since_tizen> 4 </since_tizen>
350             None = -1,
351             /// <summary>
352             /// Specific in seconds
353             /// </summary>
354             /// <since_tizen> 4 </since_tizen>
355             Specific = 1,
356             /// <summary>
357             /// Alarm time unit in minutes
358             /// </summary>
359             /// <since_tizen> 4 </since_tizen>
360             Minute = 60,
361             /// <summary>
362             /// Alarm time unit in hours
363             /// </summary>
364             /// <since_tizen> 4 </since_tizen>
365             Hour = 3600,
366             /// <summary>
367             /// Alarm time unit in days
368             /// </summary>
369             /// <since_tizen> 4 </since_tizen>
370             Day = 86400,
371             /// <summary>
372             /// Alarm time unit in weeks
373             /// </summary>
374             /// <since_tizen> 4 </since_tizen>
375             Week = 604800,
376         }
377
378         /// <summary>
379         /// Enumeration for weekdays.
380         /// </summary>
381         /// <since_tizen> 4 </since_tizen>
382         public enum WeekDay
383         {
384             /// <summary>
385             /// Sunday
386             /// </summary>
387             /// <since_tizen> 4 </since_tizen>
388             Sunday = 1,
389             /// <summary>
390             /// Monday
391             /// </summary>
392             /// <since_tizen> 4 </since_tizen>
393             Monday,
394             /// <summary>
395             /// Tuesday
396             /// </summary>
397             /// <since_tizen> 4 </since_tizen>
398             Tuesday,
399             /// <summary>
400             /// Wednesday
401             /// </summary>
402             /// <since_tizen> 4 </since_tizen>
403             Wednesday,
404             /// <summary>
405             /// Thursday
406             /// </summary>
407             /// <since_tizen> 4 </since_tizen>
408             Thursday,
409             /// <summary>
410             /// Friday
411             /// </summary>
412             /// <since_tizen> 4 </since_tizen>
413             Friday,
414             /// <summary>
415             /// Saturday
416             /// </summary>
417             /// <since_tizen> 4 </since_tizen>
418             Saturday,
419         }
420
421         /// <summary>
422         /// Enumeration to specify the type of calendar user specified by the property.
423         /// </summary>
424         /// <since_tizen> 4 </since_tizen>
425         public enum Cutype
426         {
427             /// <summary>
428             /// An individual
429             /// </summary>
430             /// <since_tizen> 4 </since_tizen>
431             Individual,
432             /// <summary>
433             /// A group of individuals
434             /// </summary>
435             /// <since_tizen> 4 </since_tizen>
436             Group,
437             /// <summary>
438             /// A physical resource
439             /// </summary>
440             /// <since_tizen> 4 </since_tizen>
441             Resource,
442             /// <summary>
443             /// A room resource
444             /// </summary>
445             /// <since_tizen> 4 </since_tizen>
446             Room,
447             /// <summary>
448             /// Otherwise not known
449             /// </summary>
450             /// <since_tizen> 4 </since_tizen>
451             Unknown,
452         }
453
454         /// <summary>
455         /// Enumeration for the attendee role.
456         /// </summary>
457         /// <since_tizen> 4 </since_tizen>
458         public enum AttendeeRole
459         {
460             /// <summary>
461             /// Participation is required
462             /// </summary>
463             /// <since_tizen> 4 </since_tizen>
464             ReqParticipant,
465             /// <summary>
466             /// Accepted status
467             /// </summary>
468             /// <since_tizen> 4 </since_tizen>
469             OptParticipant,
470             /// <summary>
471             /// Non-Participant
472             /// </summary>
473             /// <since_tizen> 4 </since_tizen>
474             NonParticipant,
475             /// <summary>
476             /// Chairperson
477             /// </summary>
478             /// <since_tizen> 4 </since_tizen>
479             Chair,
480         }
481
482         /// <summary>
483         /// Enumeration for the attendee status.
484         /// </summary>
485         /// <since_tizen> 4 </since_tizen>
486         public enum AttendeeStatus
487         {
488             /// <summary>
489             /// Pending status
490             /// </summary>
491             /// <since_tizen> 4 </since_tizen>
492             Pending,
493             /// <summary>
494             /// Accepted status
495             /// </summary>
496             /// <since_tizen> 4 </since_tizen>
497             Accepted,
498             /// <summary>
499             /// Declined status
500             /// </summary>
501             /// <since_tizen> 4 </since_tizen>
502             Declined,
503             /// <summary>
504             /// Tentative status
505             /// </summary>
506             /// <since_tizen> 4 </since_tizen>
507             Tentative,
508             /// <summary>
509             /// Delegated status
510             /// </summary>
511             /// <since_tizen> 4 </since_tizen>
512             Delegated,
513             /// <summary>
514             /// Completed status
515             /// </summary>
516             /// <since_tizen> 4 </since_tizen>
517             Completed,
518             /// <summary>
519             /// In process status
520             /// </summary>
521             /// <since_tizen> 4 </since_tizen>
522             InProcess,
523         }
524
525         /// <summary>
526         /// Enumeration for the alarm action.
527         /// </summary>
528         /// <since_tizen> 4 </since_tizen>
529         public enum Action
530         {
531             /// <summary>
532             /// Audio action
533             /// </summary>
534             /// <since_tizen> 4 </since_tizen>
535             Audio,
536             /// <summary>
537             /// Display action
538             /// </summary>
539             /// <since_tizen> 4 </since_tizen>
540             Display,
541             /// <summary>
542             /// Email action
543             /// </summary>
544             /// <since_tizen> 4 </since_tizen>
545             Email,
546         }
547     }
548 }
549