This page provides information about views with properties.
A view is a structure which describes properties of a record. A record can have basic properties of four types: integer, string, long integer. Each property of basic type has functions to operate on it:
For long long integer functions, "lli" stands for long long int, usually used to hold UTC time. Below you can find tables with view properties. Properties of type 'record' are other records. For example, the _calendar_event view has a 'calendar_alarm' property of type 'record'. This means that records of type calendar_alarm (_calendar_alarm view) can be children of the event record. If a name record holds the identifier of a event record in its 'event_id' property, it is the child record of the corresponding event record. Records can have many children of a given type. Please refer to the main section of Calendar API for a more detailed explanation and examples.
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this event view |
integer | id | read only | DB record ID of the event |
integer | calendar_book_id | read, write | ID of the calendar book to which the event belongs |
string | summary | read, write | The short description of the event |
string | description | read, write | The description of the event |
string | location | read, write | The location of the event |
string | categories | read, write | The category of the event. For example APPOINTMENT, BIRTHDAY |
string | exdate | read, write | The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma |
integer | event_status | read, write | Refer to the calendar_event_status_e |
integer | priority | read, write | Refer to the calendar_event_priority_e |
integer | timezone | read, write | The timezone_id of the event if it exists. Refer to the _calendar_timezone view |
integer | person_id | read, write | The person_id of the event if the event is a birthday. Refer to the contacts-service |
integer | busy_status | read, write | Refer to the calendar_event_busy_status_e |
integer | sensitivity | read, write | Refer to the calendar_sensitivity_e |
string | uid | read, write | The unique ID of the event |
string | organizer_name | read, write | The name of organizer of the event |
string | organizer_email | read, write | The email address of the organizer of the event |
integer | meeting_status | read, write | Refer to the calendar_meeting_status_e |
integer | original_event_id | read, write | The ID of the original event if the event is an exception. |
double | latitude | read, write | The latitude of the location of the event |
double | longitude | read, write | The longitude of the location of the event |
integer | email_id | read, write | ID of the email_id. Refer to the email-service. |
long long int | created_time | read, write | The time when the event is created |
long long int | last_modified_time | read only | The time when the event is updated |
integer | is_deleted | read only | |
integer | freq | read, write | The frequent type of event recurrence. Refer to the calendar_recurrence_frequency_e |
integer | range_type | read, write | Refer to the calendar_range_type_e |
calendar time | until_time | read, write | The end time of the event recurrence. If the range_type is CALENDAR_RANGE_UNTIL |
integer | count | read, write | The count of the event recurrence. If the range_type is CALENDAR_RANGE_COUNT |
integer | interval | read, write | The interval of the event recurrence |
string | bysecond | read, write | The second list of the event recurrence. The value can be from 0 to 59. The list is seperated by commas |
string | byminute | read, write | The minute list of the event recurrence. The value can be from 0 to 59. The list is seperated by commas |
string | byhour | read, write | The hour list of the event recurrence. The value can be from 0 to 23. The list is seperated by commas |
string | byday | read, write | The day list of the event recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is seperated by commas |
string | bymonthday | read, write | The month day list of the event recurrence. The value can be from 1 to 31 and from -31 to -1. The list is seperated by commas |
string | byyearday | read, write | The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is seperated by commas |
string | byweekno | read, write | The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is seperated by commas |
string | bymonth | read, write | The month list of the event recurrence. The value can be from 1 to 12. The list is seperated by commas |
string | bysetpos | read, write | The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is seperated by commas |
integer | wkst | read, write | The start day of the week. Refer to the calendar_days_of_week_e |
string | recurrence_id | read, write | RECURRENCE-ID of RFC #2445 |
string | rdate | read, write | RDATE of RFC #2445 |
integer | has_attendee | read only | Whether or not the event has an attendee list |
integer | has_alarm | read only | Whether or not the event has an alarm list |
integer | calendar_system_type | read, write | Refer to the calendar_system_type_e |
string | sync_data1 | read, write | The sync data of the event. If developer need to save some information related to the event, they can use this property |
string | sync_data2 | read, write | The sync data of the event. If developer need to save some information related to the event, they can use this property |
string | sync_data3 | read, write | The sync data of the event. If developer need to save some information related to the event, they can use this property |
string | sync_data4 | read, write | The sync data of the event. If developer need to save some information related to the event, they can use this property |
calendar time | start_time | read, write | The start time of the event |
string | start_tzid | read, write | The timezone of the start_time |
calendar time | end_time | read, write | The end time of the event |
string | end_tzid | read, write | The timezone of the end_time |
child list | calendar_alarm | read, write | The alarm list of the event. Refer to the _calendar_alarm view |
child list | calendar_attendee | read, write | The attendee list of the event. Refer to the _calendar_attendee view |
child list | exception | read, write | The exception mod event list of the event |
child list | extended | read, write | The extended property list of the event. Refer to the _calendar_extended_property view (read only) |
integer | is_allday | read only | The event is an allday event or not |
integer | link_count | read only | The event is a linked event (Since 4.0) |
integer | link_base_id | read only | The event is a base linked event (Since 4.0) |
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this todo view |
integer | id | read only | DB record ID of the todo |
integer | calendar_book_id | read, write | ID of the calendar book to which the todo belongs |
string | summary | read, write | The short description of the todo |
string | description | read, write | The description of the todo |
string | location | read, write | The location of the todo |
string | categories | read, write | The category of the todo. For example APPOINTMENT, BIRTHDAY |
integer | todo_status | read, write | Refer to the calendar_todo_status_e |
integer | priority | read, write | Refer to the calendar_todo_priority_e |
integer | sensitivity | read, write | Refer to the calendar_sensitivity_e |
string | uid | read, write | The unique ID of the todo |
double | latitude | read, write | The latitude of the location of the todo |
double | longitude | read, write | The longitude of the location of the todo |
long long int | created_time | read, write | The time when the todo is created |
long long int | last_modified_time | read only | The time when the todo is updated |
long long int | completed_time | read, write | The time when the todo is completed |
integer | progress | read, write | The progression of the todo. The value can be from 0 to 100 |
integer | is_deleted | read only | |
integer | freq | read, write | The frequent type of todo recurrence. Refer to the calendar_recurrence_frequency_e |
integer | range_type | read, write | Refer to the calendar_range_type_e |
calendar time | until_time | read, write | The end time of the todo recurrence. If the range_type is CALENDAR_RANGE_UNTIL |
integer | count | read, write | The count of the todo recurrence. If the range_type is CALENDAR_RANGE_COUNT |
integer | interval | read, write | The interval of the todo recurrence |
string | bysecond | read, write | The second list of the todo recurrence. The value can be from 0 to 59. The list is seperated by commas |
string | byminute | read, write | The minute list of the todo recurrence. The value can be from 0 to 59. The list is seperated by commas |
string | byhour | read, write | The hour list of the todo recurrence. The value can be from 0 to 23. The list is seperated by commas |
string | byday | read, write | The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is seperated by commas |
string | bymonthday | read, write | The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is seperated by commas |
string | byyearday | read, write | The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is seperated by commas |
string | byweekno | read, write | The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is seperated by commas |
string | bymonth | read, write | The month list of the todo recurrence. The value can be from 1 to 12. The list is seperated by commas |
string | bysetpos | read, write | The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is seperated by commas |
integer | wkst | read, write | The start day of the week. Refer to the calendar_days_of_week_e |
integer | has_alarm | read only | Whether or not the todo has an alarm list |
string | sync_data1 | read, write | The sync data of the todo. If developers need to save some information related to the todo, they can use this property |
string | sync_data2 | read, write | The sync data of the todo. If developers need to save some information related to the todo, they can use this property |
string | sync_data3 | read, write | The sync data of the todo. If developers need to save some information related to the todo, they can use this property |
string | sync_data4 | read, write | The sync data of the todo. If developers need to save some information related to the todo, they can use this property |
calendar time | start_time | read, write | The start time of the todo |
string | start_tzid | read, write | The timezone of the start_time |
calendar time | due_time | read, write | The due time of the todo |
string | due_tzid | read, write | The timezone of the due_time |
child list | calendar_alarm | read, write | The alarm list of the todo. Refer to the _calendar_alarm view |
string | organizer_name | read, write | The name of the organizer of the event |
string | organizer_email | read, write | The email address of the organizer of the event |
integer | has_attendee | read only | Whether or not the todo has an attendee list |
child list | calendar_attendee | read, write | The attendee list of the todo. Refer to the _calendar_attendee view |
child list | extended | read, write | The extended property list of the todo. Refer to the _calendar_extended_property view (read only) |
integer | is_allday | read only | The todo is an allday event or not |
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this timezone view |
integer | id | read only | DB record ID of the timezone |
integer | calendar_book_id | read, write | DB record ID of a related calendar book |
integer | tz_offset_from_gmt | read, write | UTC offset which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00) |
string | standard_name | read, write | Name of the Standard Time |
integer | standard_start_month | read, write | Starting month of the Standard Time. Month is 0-based. eg, 0 for January |
integer | standard_start_position_of_week | read, write | Starting day-of-week-in-month of the Standard Time. Day is 1-based |
integer | standard_start_day | read, write | Starting day-of-week of the Standard Time. Valid values are 1(SUNDAY) to 7(SATURDAY) |
integer | standard_start_hour | read, write | Starting hour of the Standard Time. Valid values are 0 to 23 |
integer | standard_bias | read, write | The number of minutes added during the Standard Time |
string | day_light_name | read, write | Name of Daylight |
integer | day_light_start_month | read, write | Starting month of Daylight. Month is 0-based. eg, 0 for January |
integer | day_light_start_position_of_week | read, write | Starting day-of-week-in-month of Daylight. Day is 1-based |
integer | day_light_start_day | read, write | Starting day-of-week of Daylight. Valid values are 1(SUNDAY) to 7(SATURDAY) |
integer | day_light_start_hour | read, write | Starting hour of Daylight. Valid values are 0 to 23 |
integer | day_light_bias | read, write | The number of minutes added during Daylight Time |
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this calendar attendee view |
integer | event_id | read only | Event/TODO that the attendee belongs to |
string | number | read, write | The number of the attendee |
integer | cutype | read, write | The type of attendee (one of CALENDAR_ATTENDEE_CUTYPE_INDIVIDUAL, CALENDAR_ATTENDEE_CUTYPE_GROUP, CALENDAR_ATTENDEE_CUTYPE_RESOURCE, CALENDAR_ATTENDEE_CUTYPE_ROOM, CALENDAR_ATTENDEE_CUTYPE_UNKNOWN) |
integer | person_id | read, write | Person ID that the attendee belongs to |
string | uid | read, write | Unique identifier |
string | email | read, write | The email address of the attendee |
integer | role | read, write | Attendee role (one of CALENDAR_ATTENDEE_ROLE_REQ_PARTICIPANT, CALENDAR_ATTENDEE_ROLE_OPT_PARTICIPANT, CALENDAR_ATTENDEE_ROLE_NON_PARTICIPANT, CALENDAR_ATTENDEE_ROLE_CHAIR) |
integer | status | read, write | Attendee status (one of CALENDAR_ATTENDEE_STATUS_PENDING, CALENDAR_ATTENDEE_STATUS_ACCEPTED, CALENDAR_ATTENDEE_STATUS_DECLINED, CALENDAR_ATTENDEE_STATUS_TENTATIVE, CALENDAR_ATTENDEE_STATUS_DELEGATED, CALENDAR_ATTENDEE_STATUS_COMPLETED, CALENDAR_ATTENDEE_STATUS_IN_PROCESS) |
integer | rsvp | read, write | RSVP invitation reply (one of true, false) |
string | delegatee_uri | read, write | Delegatee (DELEGATED-TO) |
string | delegator_uri | read, write | Delegator (DELEGATED-FROM) |
string | name | read, write | Attendee name |
string | member | read, write | Group that the attendee belongs to |