diff options
author | hs321.lee <hs321.lee@samsung.com> | 2013-10-23 13:41:48 +0900 |
---|---|---|
committer | hs321.lee <hs321.lee@samsung.com> | 2013-12-03 13:49:01 +0900 |
commit | 95f6b6383fa17b44bcad9df080f058a2adfc713a (patch) | |
tree | 1980dd3e8d098749d8a264e7f25eb7516adbedfb /inc/FSclAddressbookManager.h | |
parent | 59bf0526bb43f08ab3e12908a3459a2b93507954 (diff) | |
download | social-95f6b6383fa17b44bcad9df080f058a2adfc713a.tar.gz social-95f6b6383fa17b44bcad9df080f058a2adfc713a.tar.bz2 social-95f6b6383fa17b44bcad9df080f058a2adfc713a.zip |
Update the doxygen by LB
Change-Id: Id63d33146f4f71d3fe8502a112ac8729478e5635
Signed-off-by: hs321.lee <hs321.lee@samsung.com>
Diffstat (limited to 'inc/FSclAddressbookManager.h')
-rw-r--r-- | inc/FSclAddressbookManager.h | 401 |
1 files changed, 207 insertions, 194 deletions
diff --git a/inc/FSclAddressbookManager.h b/inc/FSclAddressbookManager.h index b6bd131..7c4cbc9 100644 --- a/inc/FSclAddressbookManager.h +++ b/inc/FSclAddressbookManager.h @@ -51,7 +51,7 @@ class IAddressbookChangeEventListener; /** * @class AddressbookManager - * @brief This class manages addressbooks and all contacts in the device storage. + * @brief This class manages addressbooks and contacts in the device storage. * * @since 2.0 * @@ -64,7 +64,7 @@ class _OSP_EXPORT_ AddressbookManager { public: /** - * Creates an addressbook with a specified account ID and name. @n + * Creates an addressbook with the specified account ID and name. @n * The accountId must specify a valid account and only one addressbook can be created per account. @n * The name of the addressbook must be specified and the name must be unique among existing addressbooks on the device. * @@ -77,9 +77,11 @@ public: * @param[in] name The addressbook name * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified @c accountId is invalid or @c name is an empty string. - * @exception E_OBJ_ALREADY_EXIST The addressbook with the specified account ID or name already exists. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c accountId is invalid. + * - The specified @c name is an empty string. + * @exception E_OBJ_ALREADY_EXIST The addressbook with the specified @c accountId or @c name already exists. * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -99,8 +101,10 @@ public: * @param[in] addressbookId The addressbook ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified @c addressbookId is invalid or the addressbook specified by @c addressbookId is a default addressbook. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c addressbookId is invalid. + * - The addressbook specified by the @c addressbookId is a default addressbook. * @exception E_OBJ_NOT_FOUND The specified @c addressbookId does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -113,12 +117,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of addressbooks, @n + * @return The list of addressbooks, @n * else an empty list if there is no addressbook, or @c null if an exception occurs (@ref Addressbook list) * @param[in] accountId The account ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c accountId is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -126,24 +130,24 @@ public: Tizen::Base::Collection::IList* GetAddressbooksByAccountN(AccountId accountId) const; /** - * Gets a list of all addressbooks. + * Gets the list of addressbooks. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of addressbooks, @n + * @return The list of addressbooks, @n * else an empty list if there is no addressbook, or @c null if an exception occurs (@ref Addressbook list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllAddressbooksN(void) const; /** - * Gets an instance of an addressbook specified by the addressbook ID. + * Gets an instance of the addressbook specified by the addressbook ID. * * @since 2.0 * @privlevel public @@ -153,7 +157,7 @@ public: * @param[in] addressbookId The addressbook ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c addressbookId is invalid. * @exception E_OBJ_NOT_FOUND The specified @c addressbookId does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -178,13 +182,13 @@ public: * @param[in] pListener The event listener * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SetEventListener(IAddressbookEventListener* pListener); /** - * Sets addressbook change event listener. @n + * Sets an addressbook change event listener. @n * The listener is called when a contact or a category has been changed. * To reset the event listener, @c null must be passed. * @@ -196,7 +200,7 @@ public: * @param[in] pListener The event listener * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error */ result SetAddressbookChangeEventListener(IAddressbookChangeEventListener* pListener); @@ -215,10 +219,10 @@ public: * @param[in] addressbookId The addressbook ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The contact ID is not #INVALID_RECORD_ID. @n - * - The properties of the contact have not been set. @n + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The contact ID is not #INVALID_RECORD_ID. + * - The properties of the specified @c contact have not been set. * - The specified @c addressbookId is invalid. * @exception E_OBJ_NOT_FOUND The specified addressbook is not found. * @exception E_STORAGE_FULL The storage is insufficient. @@ -240,7 +244,7 @@ public: * @param[in] contactId The contact ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c contactId is invalid. * @exception E_OBJ_NOT_FOUND The specified @c contactId does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -259,10 +263,11 @@ public: * @param[in] contact The contact to update * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_OBJ_NOT_FOUND The specified @c contact does not exist in this address book. - * @exception E_INVALID_ARG The specified @c contact is invalid, or - * the properties of the specified @c contact have not been set. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c contact is invalid. + * - The properties of the specified @c contact have not been set. * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -282,11 +287,11 @@ public: * @param[in] addressbookId The addressbook ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The name of the category has not been set. @n - * - One of the member contacts is invalid. @n - * - The category ID of the @c category is not #INVALID_RECORD_ID. @n + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The name of the category has not been set. + * - One of the member contacts is invalid. + * - The category ID of the specified @c category is not #INVALID_RECORD_ID. * - The specified @c addressbookId is invalid. * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -304,8 +309,10 @@ public: * @param[in] categoryId The category ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified @c categoryId is invalid or the category specified by @c categoryId is a default category. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c categoryId is invalid. + * - The category specified by the @c categoryId is a default category. * @exception E_OBJ_NOT_FOUND The specified @c categoryId does not exist in this address book. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see Category::IsDefault() @@ -323,61 +330,62 @@ public: * @param[in] category The category to update * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_OBJ_NOT_FOUND The specified @c category does not exist in this address book. - * @exception E_INVALID_ARG The specified @c category is invalid, or - * one of the contact members is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c category is invalid. + * - One of the contact members is invalid. * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result UpdateCategory(const Category& category); /** - * Gets all contacts on the device. @n + * Gets all the contacts on the device. @n * The contacts are ordered by display name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all contacts on the device, @n - * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) + * @return The list of contacts on the device, @n + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* GetAllContactsN(void) const; /** * Gets the member contacts of the specified category. @n - * If the specified @c categoryId is INVALID_RECORD_ID, this method returns the list of contacts that are not member of any category. + * If the specified @c categoryId is ::INVALID_RECORD_ID, this method returns the list of contacts that are not a member of any category. * The contacts are ordered by display name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of contacts that are members of the specified category, @n - * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) + * @return The list of contacts that are members of the specified category, @n + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] categoryId The category ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified @c categoryId is less than INVALID_RECORD_ID. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG The specified @c categoryId is less than ::INVALID_RECORD_ID. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* GetContactsByCategoryN(RecordId categoryId) const; @@ -388,12 +396,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of contacts that are linked to this person, @n - * else @c null if an exception occurs (@ref Contact list) + * @return The list of contacts that are linked to this person, @n + * else @c null if an exception occurs (@ref Contact list) * @param[in] personId The person ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -409,12 +417,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of categories that has the specified person as a member, @n - * else an empty list if there is no category, or @c null if an exception occurs (@ref Category list) + * @return The list of categories that has the specified person as a member, @n + * else an empty list if there is no category, or @c null if an exception occurs (@ref Category list) * @param[in] personId The person ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -433,7 +441,7 @@ public: * @param[in] contactId The contact ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c contactId is invalid. * @exception E_OBJ_NOT_FOUND The specified @c contactId is not found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -442,7 +450,7 @@ public: Contact* GetContactN(RecordId contactId) const; /** - * Gets the number of contacts in all addressbooks. + * Gets the number of contacts in all the addressbooks. * * @since 2.0 * @privlevel public @@ -452,7 +460,7 @@ public: * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -470,9 +478,10 @@ public: * @param [in] contactId The contact ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified contact or category does not exist, - * or the specified contact and category are not in the same addressbook. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified contact or category does not exist. + * - The specified contact and category are not in the same addressbook. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks If the contact is already a member of the category, this method does nothing. */ @@ -490,7 +499,7 @@ public: * @param [in] contactId The contact ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified contact or category does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks If the contact is not a member of the category, this method does nothing. @@ -498,37 +507,37 @@ public: result RemoveMemberFromCategory(RecordId categoryId, RecordId contactId); /** - * Gets all categories on the device. @n + * Gets all the categories on the device. @n * The categories are ordered by name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of categories on the device, @n + * @return The list of categories on the device, @n * else an empty list if there is no category, or @c null if an exception occurs (@ref Category list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllCategoriesN(void) const; /** - * Gets all categories whose member is the specified contact. @n + * Gets all the categories whose member is the specified contact. @n * The categories are ordered by name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of categories that has the specified contact as a member, @n - * else an empty list if there is no category, or @c null if an exception occurs (@ref Category list) + * @return The list of categories that has the specified contact as a member, @n + * else an empty list if there is no category, or @c null if an exception occurs (@ref Category list) * @param[in] contactId The contact ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c contactId is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -546,7 +555,7 @@ public: * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -564,7 +573,7 @@ public: * @param[in] categoryId The category ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c categoryId is invalid. * @exception E_OBJ_NOT_FOUND The specified record is not found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -581,20 +590,20 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all matched contacts, @n + * @return The list of all matched contacts, @n * else an empty list if there is no matched contact, or @c null if an exception occurs (@ref Contact list) * @param[in] email The substring of the email to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c email is an empty string. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* SearchContactsByEmailN(const Tizen::Base::String& email) const; @@ -608,20 +617,20 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all matched contacts, @n + * @return The list of all matched contacts, @n * else an empty list if there is no matched contact, or @c null if an exception occurs (@ref Contact list) * @param[in] name The substring of the name to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c name is an empty string. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* SearchContactsByNameN(const Tizen::Base::String& name) const; @@ -635,20 +644,20 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all matched contacts, @n + * @return The list of all matched contacts, @n * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] phoneNumber The substring of the phone number to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c phoneNumber is an empty string. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* SearchContactsByPhoneNumberN(const Tizen::Base::String& phoneNumber) const; @@ -660,10 +669,10 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return The latest change version, @n - * else @c -1 if an exception occurs + * else @c -1 if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetChangedContactsAfterN() @@ -681,13 +690,13 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of contact change information, @n + * @return The list of contact change information, @n * else an empty list if there is no changed contact, or @c null if an exception occurs (@ref ContactChangeInfo list) * @param[in] version The change version * @param[out] latestVersion The latest change version among the changed contacts * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c version is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -726,13 +735,13 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of category change information, @n - * else an empty list if there is no changed category, or @c null if an exception occurs (@ref CategoryChangeInfo list) - * @param[in] version The change version - * @param[out] latestVersion The latest change version among the changed categories + * @return The list of category change information, @n + * else an empty list if there is no changed category, or @c null if an exception occurs (@ref CategoryChangeInfo list) + * @param[in] version The change version + * @param[out] latestVersion The latest change version among the changed categories * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c version is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -773,7 +782,7 @@ public: * @param[in] personId The person ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId is invalid. * @exception E_OBJ_NOT_FOUND The specified @c personId is not found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -783,7 +792,7 @@ public: /** * Removes a person. @n - * All contacts linked to the person will be removed, too. + * All the contacts linked to the person are removed, too. * * @since 2.0 * @privlevel public @@ -793,7 +802,7 @@ public: * @param[in] personId The person ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId is invalid. * @exception E_OBJ_NOT_FOUND The specified person does not exist. * @exception E_SYSTEM The method cannot be proceed due to a severe system error. @@ -808,74 +817,74 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all persons on the device, @n - * else an empty list if there is no person, or @c null if an exception occurs (@ref Person list) + * @return The list of all persons on the device, @n + * else an empty list if there is no person, or @c null if an exception occurs (@ref Person list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot be proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* GetAllPersonsN(void) const; /** * Gets the persons that are members of the specified category where a person is a member of a category if a contact linked to it is a member of the category. @n - * If the specified @c categoryId is INVALID_RECORD_ID, this method returns the persons that are not members of any category. @n + * If the specified @c categoryId is ::INVALID_RECORD_ID, this method returns the persons that are not members of any category. @n * The persons are ordered by display name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of persons that are members of the specified category, @n - * else an empty list if there is no person, or @c null if an exception occurs (@ref Person list) + * @return The list of persons that are members of the specified category, @n + * else an empty list if there is no person, or @c null if an exception occurs (@ref Person list) * @param[in] categoryId The category ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c categoryId is invalid. * @exception E_OBJ_NOT_FOUND The specified category does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* GetPersonsByCategoryN(RecordId categoryId) const; /** - * Gets a list of the favorite persons. @n + * Gets the list of favorite persons. @n * The persons are ordered by display name. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of the favorite persons, @n - * else an empty list if there is no favorite person, or @c null if an exception occurs (@ref Person list) + * @return The list of favorite persons, @n + * else an empty list if there is no favorite person, or @c null if an exception occurs (@ref Person list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. - * @see SetPersonAsFavorite() - */ + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * @see SetPersonAsFavorite() + */ Tizen::Base::Collection::IList* GetFavoritePersonsN(void) const; /** - * Searches the persons that contains the specified @c keyword string in its properties. @n + * Searches the persons that contain the specified @c keyword string in its properties. @n * The search operation is performed with a case insensitive key (param: @c keyword). @n * The persons are ordered by display name. * @@ -883,20 +892,20 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of all matched persons, @n - * else an empty list if there is no matched person, or @c null if an exception occurs (@ref Person list) + * @return The list of all matched persons, @n + * else an empty list if there is no matched person, or @c null if an exception occurs (@ref Person list) * @param[in] keyword The key to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c keyword is an empty string. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. */ Tizen::Base::Collection::IList* SearchPersonsN(const Tizen::Base::String& keyword) const; @@ -908,12 +917,12 @@ public: * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] personId The person ID - * @param[in] isFavorite Set to @c true to set the specified person as a favorite, @n - * else @c false to set the specified person as a non-favorite + * @param[in] personId The person ID + * @param[in] isFavorite Set to @c true to set the specified person as a favorite, @n + * else @c false to set the specified person as a non-favorite * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId is invalid. * @exception E_OBJ_NOT_FOUND The specified person does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -941,9 +950,9 @@ public: * @param[in] targetPersonId The target person ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c sourcePersonId or @c targetPersonId is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result MergePersons(PersonId sourcePersonId, PersonId targetPersonId); @@ -953,7 +962,7 @@ public: * - Unlinks the contact specified by @c contactId. * - Creates a new person. * - Links the unlinked contact to the new person. - * - Updates information of the persons. + * - Updates information of a person. * * It is not allowed to unlink a contact if it is the only one contact linked to a person. * The %UnlinkContact() method does nothing if the contact has not been linked to the person or does not exist. @@ -968,7 +977,7 @@ public: * @param[out] newPersonId The ID of the new person * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c personId or @c contactId is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -984,25 +993,26 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return A list of searched results (The list of Addressbook, Person, Contact, Category, PhoneNumberContact, EmailContact), @n + * @return The list of searched results (The list of Addressbook, Person, Contact, Category, PhoneNumberContact, EmailContact), @n * else an empty list if there is no searched result, or @c null if an exception occurs - * @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. - * @param[in] propertyToSort The property for sorting @n The searched results are ordered by the values of this property. - * @param[in] sortOrder The order for sorting - * @param[in] offset The offset of the searched results @n If this value is @c 0, it will be ignored. - * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it will be ignored. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG The specified @c offset or @c maxCount is less than @c 0. - * Or, the @c propertyToSort is not an elements of the enumerator that corresponds with the type of the specified @c filter. + * @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. + * @param[in] propertyToSort The property for sorting @n The searched results are ordered by the values of this property. + * @param[in] sortOrder The order for sorting + * @param[in] offset The offset of the searched results @n If this value is @c 0, it is ignored. + * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it is ignored. + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c offset or @c maxCount is less than @c 0. + * - The specified @c propertyToSort is not an element of the enumerator that corresponds to the type of the @c filter. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - There is a high probability for an occurrence of an out-of-memory exception. - * If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n - * For more information on how to handle the out-of-memory exception, refer - * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. + * If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n + * For more information on how to handle the out-of-memory exception, refer + * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>. * @see AddressbookFilterProperty * @see PersonFilterProperty * @see ContactFilterProperty @@ -1022,10 +1032,10 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return The count of the searched results - * @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. + * @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. * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see AddressbookFilterProperty @@ -1043,12 +1053,12 @@ public: * * @since 2.0 * - * @return A list of contacts, @n - * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) + * @return The list of contacts, @n + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c vcardPath is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified file cannot be found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -1067,11 +1077,11 @@ public: * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_INVALID_ARG The specified @c person is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportPersonToVcard(const Person& person, const Tizen::Base::String& vcardPath); @@ -1088,12 +1098,13 @@ public: * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 - * @exception E_INVALID_ARG Either the specified @c personList is invalid or - * the specified @c vcardPath is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c personList is invalid. + * - The specified @c vcardPath is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportPersonsToVcard(const Tizen::Base::Collection::IList& personList, const Tizen::Base::String& vcardPath); @@ -1108,9 +1119,9 @@ public: * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contact is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportContactToVcard(const Contact& contact, const Tizen::Base::String& vcardPath); @@ -1124,11 +1135,12 @@ public: * @param[in] contactList The contact list to export @n The list should contain Contact instances. * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the specified @c contactList is invalid or - * the specified @c vcardPath is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c contactList is invalid. + * - The specified @c vcardPath is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportContactsToVcard(const Tizen::Base::Collection::IList& contactList, const Tizen::Base::String& vcardPath); @@ -1143,7 +1155,7 @@ public: * @param[in] contact The contact to export * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contact is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ExportContactToVcard() */ @@ -1173,11 +1185,11 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return The exported vcard stream, @n - * else @c null if an exception occurs. + * else @c null if an exception occurs * @param[in] person The person to export * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_INVALID_ARG The specified @c person is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -1197,7 +1209,7 @@ public: * @param[in] personList The person list to export @n The list should contain the Person instances. * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_INVALID_ARG The specified @c personList contains invalid person. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -1211,7 +1223,7 @@ public: * * @since 2.1 * - * @return A list of contacts, @n + * @return The list of contacts, @n * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] vcardStream The vCard stream * @exception E_SUCCESS The method is successful. @@ -1228,10 +1240,10 @@ public: * @since 2.1 * * @return The exported vCard stream, @n - * else @c null if an exception occurs - * @param[in] userProfile The user profile to export + * else @c null if an exception occurs + * @param[in] userProfile The user profile to export * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c userProfile is invalid. + * @exception E_INVALID_ARG The specified @c userProfile is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -1243,10 +1255,10 @@ public: * @since 2.1 * * @return The exported vCard stream, @n - * else @c null if an exception occurs - * @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances + * else @c null if an exception occurs + * @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c userProfile is invalid. + * @exception E_INVALID_ARG The specified @c userProfile is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -1262,9 +1274,9 @@ public: * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c userProfile is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportUserProfileToVcard(const UserProfile& userProfile, const Tizen::Base::String& vcardPath); @@ -1278,27 +1290,28 @@ public: * @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the specified @c userProfileList is invalid or - * the specified @c vcardPath is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c userProfileList is invalid. + * - The specified @c vcardPath is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_STORAGE_FULL The storage is insufficient. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result ExportUserProfilesToVcard(const Tizen::Base::Collection::IList& userProfileList, const Tizen::Base::String& vcardPath); /** - * Gets all user profiles on the device. + * Gets all the user profiles on the device. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/userprofile.read * - * @return A list of all user profiles on the device, @n - * else an empty list if there is no user profile, or @c null if an exception occurs (@ref UserProfile list) + * @return The list of all the user profiles on the device, @n + * else an empty list if there is no user profile, or @c null if an exception occurs (@ref UserProfile list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot be proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -1312,20 +1325,20 @@ public: * @privilege %http://tizen.org/privilege/userprofile.read * * @return The matched user profile, @n - * else @c null if an exception occurs + * else @c null if an exception occurs * @param[in] addressbookId The addressbook ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_INVALID_ARG The specified @c addressbookId is invalid. - * @exception E_OBJ_NOT_FOUND The specified @c addressbook is not found. + * @exception E_OBJ_NOT_FOUND The specified addressbook is not found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ UserProfile* GetUserProfileN(AddressbookId addressbookId) const; /** - * Gets the addressbook manager instance. + * Gets an %AddressbookManager instance. * * @since 2.0 * |