//\r
-// Open Service Platform\r
// Copyright (c) 2012 Samsung Electronics Co., Ltd.\r
//\r
// Licensed under the Apache License, Version 2.0 (the License);\r
\r
/**\r
* @class Calendarbook\r
- * @brief This class manages the calendar data such as events, to-dos, and calendars.\r
+ * @brief This class manages calendar data such as events, to-dos, and calendars.\r
*\r
* @since 2.0\r
*\r
* @final This class is not intended for extension.\r
*\r
- * The %Calendarbook class manages the calendar data such as events, to-dos, and calendars.\r
+ * The %Calendarbook class manages calendar data such as events, to-dos, and calendars.\r
* The calendar book is a centralized database that is used by multiple applications to store events and to-do information.\r
* A calendar book represents the methods to read, add, remove, and update the events, to-do lists, and calendars stored in the device.\r
* The users must be notified of changes in the calendar book as multiple applications can share, change, or remove the data.\r
* @param[in,out] event The event 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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c event is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in,out] event The event to add\r
+ * @param[in,out] event The event to add\r
* @param[in] calendarId The 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
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c event is invalid.\r
+ * - The specified @c calendarId is invalid.\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 The method cannot proceed due to a severe system error.\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
+ * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c todo is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] calendarId The 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
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c todo is invalid.\r
+ * - The specified @c calendarId is invalid.\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 The method cannot proceed due to a severe system error.\r
* @param[in] event The calendar event to remove\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The specified recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\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
* @param[in] eventId The calendar event ID to remove\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
* @param[in] todo The CalTodo ID to remove\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The specified recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] todoId The CalTodo ID to remove\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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 The method cannot proceed due to a severe system error.\r
* @param[in] event The CalEvent instance to update\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c recordId is #INVALID_RECORD_ID. @n\r
- * - The specified @c event is not #RECORD_TYPE_EVENT. @n\r
- * - The specified @c event is not an entry type instance. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified recordId is #INVALID_RECORD_ID.\r
+ * - The specified @c event is not #RECORD_TYPE_EVENT.\r
+ * - The specified @c event is not an entry type instance.\r
* - The date of the event 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
* @param[in] todo The CalTodo instance to update\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified recordId is #INVALID_RECORD_ID.\r
+ * - 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 The method cannot proceed due to a severe system error.\r
* @param[in] eventId The event ID to find\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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 The method cannot proceed due to a severe system error.\r
* @param[in] todoId The ID of the to-do to find\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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 The method cannot proceed due to a severe system error.\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list of all the matched CalTodo instances, @n\r
+ * @return The list of all the matched CalTodo instances, @n\r
* else an empty list if there is no matched to-do item @n\r
* The items are sorted by due date.\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
* The default priority value is #TODO_PRIORITY_ALL that means all the priorities are returned.\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The start time is later than the end date.\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 The method cannot proceed due to a severe system error.\r
* @page CompCalendarbookGetTodosNPage Compatibility for GetTodosN()\r
* @section CompCalendarbookGetTodosNPageIssueSection Issues\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
+ * -# If the start date of a to-do is not in the time range of the 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
- * -# The to-do will be retrieved if the due date is in the range of start/end parameters.\r
+ * -# The to-do is retrieved if the due date is in the range of the start/end parameters.\r
* @endif\r
*/\r
\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
+ * else @c -1 if an exception occurs\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] status The to-do status @n\r
* The default priority value is #TODO_PRIORITY_ALL that means all the priorities are returned.\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The start time is later than the end date.\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 The method cannot proceed due to a severe system error.\r
* @page CompCalendarbookGetTodoCountPage Compatibility for GetTodoCount()\r
* @section CompCalendarbookGetTodoCountPageIssueSection Issues\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
+ * -# If the start date of a to-do is not in the time range of the 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
- * -# The to-do will be counted if the due date is in the range of start/end parameters.\r
+ * -# The to-do is counted if the due date is in the range of the start/end parameters.\r
* @endif\r
*/\r
\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all of the matched CalEvent instances, @n\r
+ * @return The list that contains 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
* 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
* The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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 specified @c category is invalid. @n\r
- * - The start time is later than the end date. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The specified @c category is invalid.\r
+ * - The start time is later than the end date.\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 The method cannot proceed due to a severe system error.\r
*\r
* @return An error code\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
- * @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
+ * @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] timeZone The time zone of the specified start and end times\r
* @param[in] pageNo The page number of the result list @n\r
- * It starts from @c 1.\r
+ * It starts from @c 1.\r
* @param[in] countPerPage The desired maximum count of the result items per page\r
* @param[in] category The event category @n\r
- * If a specific category is set, the events that have the specified @c category are returned. @n\r
- * The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\r
- * @param[out] reqId The ID of the request\r
+ * If a specific category is set, the events that have the specified @c category are returned. @n\r
+ * The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\r
+ * @param[out] reqId The ID of the request\r
* @param[in] listener The listener for receiving the responses of the request\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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 specified @c category is invalid. @n\r
- * - The start time is later than the end date. @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_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The specified @c category is invalid.\r
+ * - The start time is later than the end date.\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 The method cannot proceed due to a severe system error.\r
* @remarks IRecordListener::OnRecordsReceivedN(), Calendarbook::GetEventInstancesN()\r
* @endif\r
const IRecordListener& listener) const;\r
\r
/**\r
- * Gets all events.\r
+ * Gets all the events.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the CalEvent instances, @n\r
+ * @return The list that contains all the CalEvent instances, @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllEventsN(void) const;\r
\r
/**\r
- * Gets all to-dos.\r
+ * Gets all the to-dos.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the CalTodo instances, @n\r
+ * @return The list that contains 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
* 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
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllTodosN(void) const;\r
\r
/**\r
- * Gets all calendars.\r
+ * Gets all the calendars.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the Calendar instances, @n\r
+ * @return The list that contains all the Calendar instances, @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
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllCalendarsN(void) const;\r
\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing the CalEventChangeInfo instances, @n\r
+ * @return The list that contains the CalEventChangeInfo instances, @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c version is invalid.\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetChangedEventsAfterN(int version, int& latestVersion) const;\r
\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c version is invalid.\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetChangedTodosAfterN(int version, int& latestVersion) const;\r
\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
* @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The record ID of the calendar is not #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The calendar's recordId is not #INVALID_RECORD_ID.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\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
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The calendar's recordId is not #INVALID_RECORD_ID.\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
* @param[in] calendarId The calendar ID to remove\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c calendarId is invalid, or\r
- * the calendar represents default calendar.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c calendarId is invalid.\r
+ * - The calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] calendar The Calendar instance to update\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The calendar's recordId is #INVALID_RECORD_ID, or\r
- * the calendar represents default calendar.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The calendar's recordId is #INVALID_RECORD_ID.\r
+ * - The calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] calendarId The 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
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c calendarId is invalid.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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 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 The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Calendar* GetCalendarN(RecordId calendarId) const;\r
\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
+ * 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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The instance is invalid.\r
- * @exception E_OBJ_NOT_FOUND The original event of the @c eventInstance is not found.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the specified @c 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
* 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
+ * 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 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, does not add a new event that is already added.\r
*\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_USER_NOT_CONSENTED The user blocks an application from calling 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_USER_NOT_CONSENTED The user has blocked the application from calling this method.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The instance is invalid.\r
+ * - The specified @c event is not referring to the original event.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the specified @c eventInstance is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*\r
* @code\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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
* @privlevel public\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
- * @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
+ * @return The 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
+ * @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 are 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
- * @param[in] offset The offset of the searched results @n If this value is @c 0, it will be ignored.\r
- * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it will be ignored.\r
+ * @param[in] offset The offset of the searched results @n If this value is @c 0, it is ignored.\r
+ * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it is ignored.\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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c offset or @c maxCount is less than 0, or the @c propertySortedBy is not an element of the enumerator that corresponds with the type of the specified @c filter.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c offset or @c maxCount is less than 0.\r
+ * - The specified @c propertySortedBy is not an element of the enumerator that corresponds to the type of the specified @c filter.\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
* @see EventFilterProperty\r
* @see TodoFilterProperty\r
* @see CalendarFilterProperty\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
* @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\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
* @since 2.0\r
*\r
- * @return A list containing the CalEvent instances, @n\r
+ * @return The list that contains the CalEvent instances, @n\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
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.\r
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.\r
* @exception E_FILE_NOT_FOUND The specified vCalendar file is not found.\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
static Tizen::Base::Collection::IList* ParseEventsFromVcalendarN(const Tizen::Base::String& vCalFilePath);\r
\r
*\r
* @since 2.0\r
*\r
- * @return A list containing the CalTodo instances, @n\r
+ * @return The list that contains the CalTodo instances, @n\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
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.\r
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.\r
* @exception E_FILE_NOT_FOUND The specified vCalendar file is not found.\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
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
static Tizen::Base::Collection::IList* ParseTodosFromVcalendarN(const Tizen::Base::String& vCalFilePath);\r
\r
* @param[in] eventList The event list to export @n The list should contain CalEvent instances.\r
* @param[in] vCalFilePath The vCalendar file path\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_INVALID_ARG The specified @c eventList is invalid or\r
- * the specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access of vCalFilePath is denied due to insufficient permission.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c eventList is invalid.\r
+ * - The specified @c vCalFilePath is invalid.\r
+ * @exception E_ILLEGAL_ACCESS The access of the specified @c vCalFilePath is denied due to insufficient permission.\r
* @exception E_FILE_ALREADY_EXIST The vCalendar file already exists.\r
* @exception E_STORAGE_FULL The disk space is full.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] todoList The to-do list to export @n The list should contain CalTodo instances.\r
* @param[in] vCalFilePath The vCalendar file path\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_INVALID_ARG The specified @c todoList is invalid or\r
- * the specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access of vCalFilePath is denied due to insufficient permission.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c todoList is invalid.\r
+ * - The specified @c vCalFilePath is invalid.\r
+ * @exception E_ILLEGAL_ACCESS The access of the specified @c vCalFilePath is denied due to insufficient permission.\r
* @exception E_FILE_ALREADY_EXIST The vCalendar file already exists.\r
* @exception E_STORAGE_FULL The disk space is full.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
projects / framework / osp / social.git / blobdiff