*\r
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/calendarbook_namespace.htm">Calendar book</a>.\r
*\r
- * The following diagram illustrates the relationships between %Calendarbook and related classes.\r
- * @image html social_calendarbook_using_the_apis_classdiagram.png\r
- *\r
* The following example demonstrates how to use the %Calendarbook class to add calendarbook event.\r
* @code\r
\r
* @param[in] pListener The event listener to register, @n\r
* else @c null if an event listener need not be registered\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @endif\r
*/\r
result Construct(IRecordEventListener* pListener);\r
*\r
* @return An error code\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result Construct(void);\r
\r
* @return An error code\r
* @param[in] listener The event listener to register\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result Construct(ICalendarbookEventListener& listener);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in,out] event The event to add\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c event is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddEvent(CalEvent& event);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in,out] event The event to add\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
* - The specified @c event is invalid. @n\r
- * - The specified @c calendarId is invalid. @n\r
- * - The specified calendar is created for CALENDAR_ITEM_TYPE_TODO.\r
+ * - The specified @c calendarId is invalid. @n\r
+ * - The specified calendar is created for CALENDAR_ITEM_TYPE_TODO.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddEvent(CalEvent& event, RecordId calendarId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in,out] todo The to-do to add\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c todo is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddTodo(CalTodo& todo);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in,out] todo The to-do to add\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c todo is invalid. @n\r
- * - The specified @c calendarId is invalid. @n\r
- * - The specified calendar is created for CALENDAR_ITEM_TYPE_EVENT.\r
+ * - The specified @c todo is invalid. @n\r
+ * - The specified @c calendarId is invalid. @n\r
+ * - The specified calendar is created for CALENDAR_ITEM_TYPE_EVENT.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddTodo(CalTodo& todo, RecordId calendarId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] event The calendar event to remove\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
+ * RemoveEventInstance() should be used instead of this method. @b Since: @b 2.1\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result RemoveEvent(CalEvent& event);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] eventId The calendar event ID to remove\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c eventId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
+ * RemoveEventInstance() should be used instead of this method. @b Since: @b 2.1\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result RemoveEvent(RecordId eventId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] todo The CalTodo ID to remove\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result RemoveTodo(CalTodo& todo);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] todoId The CalTodo ID to remove\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified input parameter is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result RemoveTodo(RecordId todoId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] event The CalEvent instance to update\r
* - The specified @c event is not #RECORD_TYPE_EVENT. @n\r
* - The specified @c event is not an entry type instance. @n\r
* - The date of the event is invalid. @n\r
- * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
+ * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
+ * UpdateEventInstance() should be used instead of this method. @b Since: @b 2.1\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result UpdateEvent(const CalEvent& event);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] todo The CalTodo instance to update\r
* @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID, or the date of the to-do item is invalid. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result UpdateTodo(const CalTodo& todo);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The matched event\r
* @param[in] eventId The event ID to find\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c eventId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
CalEvent* GetEventN(RecordId eventId) const;\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The matched to-do\r
* @param[in] todoId The ID of the to-do to find\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c todoId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*\r
*/\r
* For more information, see @ref CompCalendarbookGetTodosNPage "here".\r
* @endif\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list of all the matched CalTodo instances, @n\r
* else an empty list if there is no matched to-do item @n\r
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
* - The start time is later than the end date. @n\r
- * - The start or end time is not in a valid range. @n\r
+ * - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Tizen::Base::Collection::IList* GetTodosN(const Tizen::Base::DateTime& start, const Tizen::Base::DateTime& end, int pageNo, int countPerPage, unsigned long status = TODO_STATUS_ALL,\r
* @if OSPCOMPAT\r
* @page CompCalendarbookGetTodosNPage Compatibility for GetTodosN()\r
* @section CompCalendarbookGetTodosNPageIssueSection Issues\r
- * Implementing this method in OSP compatible applications has the following issues: @n\r
+ * Implementing this method in OSP compatible applications has the following issues: @n\r
* -# If the start date of a to-do is not in the time range of start/end parameters, @n\r
* the to-do is not retrieved even though the due date is in the time range.\r
*\r
* @section CompCalendarbookGetTodosNPageSolutionSection Resolutions\r
- * This issue has been resolved in Tizen. @n\r
+ * This issue has been resolved in Tizen. @n\r
* -# The to-do will be retrieved if the due date is in the range of start/end parameters.\r
* @endif\r
*/\r
* For more information, see @ref CompCalendarbookGetTodoCountPage "here".\r
* @endif\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The total number of to-dos, @n\r
* else @c -1 if an exception occurs\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
* - The start time is later than the end date. @n\r
- * - The start or end time is not in a valid range. @n\r
+ * - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
int GetTodoCount(const Tizen::Base::DateTime& start, const Tizen::Base::DateTime& end, unsigned long status = TODO_STATUS_ALL, unsigned long priority = TODO_PRIORITY_ALL) const;\r
* @if OSPCOMPAT\r
* @page CompCalendarbookGetTodoCountPage Compatibility for GetTodoCount()\r
* @section CompCalendarbookGetTodoCountPageIssueSection Issues\r
- * Implementing this method in OSP compatible applications has the following issues: @n\r
+ * Implementing this method in OSP compatible applications has the following issues: @n\r
* -# If the start date of a to-do is not in the time range of start/end parameters, @n\r
* the to-do is not counted even though the due date is in the time range.\r
*\r
* @section CompCalendarbookGetTodoCountPageSolutionSection Resolutions\r
- * This issue has been resolved in Tizen. @n\r
+ * This issue has been resolved in Tizen. @n\r
* -# The to-do will be counted if the due date is in the range of start/end parameters.\r
* @endif\r
*/\r
* @deprecated This method is deprecated. Instead of using this method, it is recommended to use GetInstancesOfAllDayEventsN() or GetInstancesOfNonAllDayEventsN().\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing all of the matched CalEvent instances, @n\r
- * else an empty list if there are no matched instances or @c null if an exception occurs @n\r
+ * else an empty list if there are no matched instances, or @c null if an exception occurs @n\r
* The results are listed in the following order: all day events, and other events. @n\r
* The results with the same property of all day event are ordered by their start time.\r
* @param[in] start The start of the time range\r
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
* - The specified @c category is invalid. @n\r
* - The start time is later than the end date. @n\r
- * - The start or end time is not in a valid range. @n\r
+ * - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
* @endif\r
*/\r
* @deprecated This method is deprecated. Instead of using this method, it is recommended to use GetInstancesOfAllDayEventsN() or GetInstancesOfNonAllDayEventsN().\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return An error code\r
* @param[in] start The start of the time range\r
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
* - The specified @c category is invalid. @n\r
* - The start time is later than the end date. @n\r
- * - The start or end time is not in a valid range. @n\r
+ * - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks IRecordListener::OnRecordsReceivedN(), Calendarbook::GetEventInstancesN()\r
* @endif\r
*/\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing all the CalEvent instances, @n\r
- * else an empty list if there are no events or @c null if an exception occurs @n\r
+ * else an empty list if there are no events, or @c null if an exception occurs @n\r
* The results are listed in the order of their event ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
* @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
* E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing all the CalTodo instances, @n\r
- * else an empty list if there are no to-dos or @c null if an exception occurs @n\r
+ * else an empty list if there are no to-dos, or @c null if an exception occurs @n\r
* The results are listed in the order of their to-do ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing all the Calendar instances, @n\r
- * else an empty list if there are no calendars or @c null if an exception occurs @n\r
+ * else an empty list if there are no calendars, or @c null if an exception occurs @n\r
* The results are listed in the order of their calendar ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing the CalEventChangeInfo instances, @n\r
- * else an empty list if there are no events or @c null if an exception occurs @n\r
+ * else an empty list if there are no events, or @c null if an exception occurs @n\r
* The results are listed in the order of their version.\r
* @param[in] version The version\r
* @param[out] latestVersion The latest change version among the changed events\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c version is invalid.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
* @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
* E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list containing the CalTodoChangeInfo instances, @n\r
- * else an empty list if there are no to-dos or @c null if an exception occurs @n\r
+ * else an empty list if there are no to-dos, or @c null if an exception occurs @n\r
* The results are listed in the order of their version.\r
* @param[in] version The version\r
* @param[out] latestVersion The latest change version among the changed to-dos\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c version is invalid.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
* @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
* E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in,out] calendar The calendar to add\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The record ID of the calendar is not #INVALID_RECORD_ID.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddCalendar(Calendar& calendar);\r
\r
- /*\r
+ /**\r
* Adds a calendar that is associated with the specified account. @n\r
* After adding the calendar to the database successfully, the calendar has a valid calendar ID.\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in,out] calendar The calendar to add\r
+ * @param[in,out] calendar The calendar to add\r
* @param[in] accountId The account Id\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The record ID of the calendar is not #INVALID_RECORD_ID. @n\r
- * - The specified @c accountId is invalid.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
+ * - The record ID of the calendar is not #INVALID_RECORD_ID. @n\r
+ * - The specified @c accountId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified account is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result AddCalendar(Calendar& calendar, AccountId accountId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] calendarId The calendar ID to remove\r
* @exception E_INVALID_ARG The specified @c calendarId is invalid, or\r
* the calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result RemoveCalendar(RecordId calendarId);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
* @param[in] calendar The Calendar instance to update\r
* @exception E_INVALID_ARG The calendar's recordId is #INVALID_RECORD_ID, or\r
* the calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
result UpdateCalendar(const Calendar& calendar);\r
\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The matched calendar, @n \r
* else @c null if an exception occurs\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @exception E_INVALID_ARG The specified @c calendarId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Calendar* GetCalendarN(RecordId calendarId) const;\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.write\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in] eventInstance The event instance to remove @n\r
- * The @c eventInstance must be an instance of the recurring event.\r
+ * @param[in] eventInstance The event instance to remove @n\r
+ * The @c eventInstance must be an instance of the recurring event.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_INVALID_ARG The instance is invalid.\r
- * @exception E_OBJ_NOT_FOUND The instance is not found.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_INVALID_ARG The instance is invalid.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the @eventInstance is not found.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The instance's start time is added to the recurrence of original event as exception date.\r
*/\r
result RemoveEventInstance(const CalEventInstance& eventInstance);\r
\r
/**\r
+ * Update the specified recurring event instance(@ref CalEventInstance). This method can be used for defining exception of the recurring event. @n\r
+ * In order to update an event instance, you should use copy of its original event(@ref CalEventInstance::GetOriginalEventId()). @n\r
+ * You can modify the properties of copy of the original event and use it as the second parameter of this method. @n\r
+ * (The start/end time of the original event should be set with the start/end time of the event instance.) @n\r
+ * This method adds the modified copy of the original event as a new event. Therefore the new event id will be assigned to it through @c event's record id @n\r
+ * and its existing event id inside the modified copy of the original event will become the base event id of the new event. @n\r
+ * However this method only updates the properties of the event, not add a new event, once added.\r
+ *\r
+ * @code\r
+\r
+ void UpdateRecurringEventInstance(const CalEventInstance& eventInstance)\r
+ {\r
+ CalEvent* pEvent = pCalendarbook->GetEventN(eventInstance.GetOriginalEventId());\r
+ if (pEvent == null)\r
+ {\r
+ AppLogException("GetEventN() has failed");\r
+ return;\r
+ }\r
+\r
+ // Sets the start time and end time\r
+ pEvent->SetRecurrence(null);\r
+ pEvent->SetStartAndEndTime(eventInstance.GetStartTime(), eventInstance.GetEndTime());\r
+\r
+ // Modifies the properties\r
+ pEvent->SetLocation(L"Meeting room on 11th floor");\r
+\r
+ // Updates the instance\r
+ result r = pCalendarbook->UpdateEventInstance(eventInstance, *pEvent);\r
+ if (IsFailed(r))\r
+ {\r
+ AppLogException("UpdateEventInstance() has failed");\r
+ delete pEvent;\r
+ return;\r
+ }\r
+\r
+ delete pEvent;\r
+ }\r
+\r
+ * @endcode\r
+ *\r
+ * @since 2.1\r
+ * @privlevel public\r
+ * @privilege %http://tizen.org/privilege/calendar.write\r
+ *\r
+ * @return An error code\r
+ * @param[in] eventInstance The event instance to update @n\r
+ * The @c eventInstance must be an instance of the recurring event.\r
+ * @param[in,out] event The modified copy of the original event @n\r
+ * @exception E_SUCCESS The method is successful.\r
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
+ * - The instance is invalid. @n\r
+ * - @c event is not referring to the original event.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the @c eventInstance is not found.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
+ */\r
+ result UpdateEventInstance(const CalEventInstance& eventInstance, CalEvent& event);\r
+\r
+ /**\r
* Gets the latest version of calendarbook.\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The latest version\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_SYSTEM A system error has occurred.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
int GetLatestVersion(void) const;\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return A list of searched results (the list of CalEvent, CalTodo, Calendar, or CalEventInstance), @n\r
- * else an empty list if there is no searched result or @c null if an exception occurs\r
+ * else an empty list if there is no searched result, or @c null if an exception occurs\r
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter will be searched.\r
* @param[in] propertySortedBy The property for sorting @n The searched results are ordered by the values of this property.\r
* @param[in] sortOrder The order for sorting\r
*\r
* @since 2.0\r
* @privlevel public\r
- * @privilege http://tizen.org/privilege/calendar.read\r
+ * @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The count of the searched results\r
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter will be searched.\r
\r
/**\r
* Parses the events from specific vCalendar file. @n\r
- * This method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).\r
+ * The %ParseEventsFromVcalendarN() method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).\r
*\r
* @since 2.0\r
*\r
* @return A list containing the CalEvent instances, @n\r
- * else an empty list if there are no events or @c null if an exception occurs\r
+ * else an empty list if there are no events, or @c null if an exception occurs\r
* @param[in] vCalFilePath The path of the vCalendar file\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.\r
\r
/**\r
* Parses the to-dos from specific vCalendar file. @n\r
- * This method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).\r
+ * The %ParseTodosFromVcalendarN() method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).\r
*\r
* @since 2.0\r
*\r
* @return A list containing the CalTodo instances, @n\r
- * else an empty list if there are no to-dos or @c null if an exception occurs\r
+ * else an empty list if there are no to-dos, or @c null if an exception occurs\r
* @param[in] vCalFilePath The path of the vCalendar file\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.\r
projects / framework / osp / social.git / blobdiff