//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @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
*
{
public:
/**
- * Creates an addressbook with the specified account ID and name.
+ * 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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An addressbook instance
* @param[in] accountId The account ID
* @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_INVALID_ARG The specified @c accountId is invalid.
- * @exception E_OBJ_ALREADY_EXIST The addressbook with the specified account ID and name already exists.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
Addressbook* CreateAddressbookN(AccountId accountId, const Tizen::Base::String& name);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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_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 A system error has occurred.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result DeleteAddressbook(AddressbookId addressbookId);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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* 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
+ * @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_SYSTEM A system error has occurred.
+ * @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
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return An addressbook instance
* @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 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 A system error has occurred.
+ * @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.
*/
Addressbook* GetAddressbookN(AddressbookId addressbookId = DEFAULT_ADDRESSBOOK_ID) const;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @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_SYSTEM A system error has occurred.
+ * @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.
*
* @since 2.1
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @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 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);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in,out] contact The contact to add
* @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_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_SYSTEM A system error has occurred.
+ * @exception E_STORAGE_FULL The storage is insufficient.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The #CONTACT_PROPERTY_ID_DISPLAY_NAME and #CONTACT_PROPERTY_ID_LAST_REVISION
* properties cannot be set. @n #CONTACT_PROPERTY_ID_DISPLAY_NAME is automatically generated from the first name and
* the last name. And #CONTACT_PROPERTY_ID_LAST_REVISION is automatically updated with the last update time.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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 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 A system error has occurred.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveContact(RecordId contactId);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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 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_SYSTEM A system error has occurred.
+ * @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.
*/
result UpdateContact(const Contact& contact);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in,out] category The category to add
* @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_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 capacity of this address book is full.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_STORAGE_FULL The storage is insufficient.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result AddCategory(Category& category, AddressbookId addressbookId);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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_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 A system error has occurred.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Category::IsDefault()
*/
result RemoveCategory(RecordId categoryId);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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 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_SYSTEM A system error has occurred.
+ * @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
+ * @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_SYSTEM A system error has occurred.
+ * @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
+ * @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_INVALID_ARG The specified @c categoryId is less than INVALID_RECORD_ID.
- * @exception E_SYSTEM A system error has occurred.
+ * @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;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched contact, @n
* else @c null if no contact matches the specified contact ID
* @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 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 A system error has occurred.
+ * @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.
*/
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
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The number of contacts in the address book, @n
* 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_SYSTEM A system error has occurred.
+ * @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.
*/
int GetContactCount(void) const;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param [in] categoryId The category ID
* @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_INVALID_ARG The specified contact or category does not exist,
- * or the specified contact and category are not in the same addressbook.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
result AddMemberToCategory(RecordId categoryId, RecordId contactId);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param [in] categoryId The category ID
* @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 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 A system error has occurred.
+ * @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.
*/
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
+ * @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_SYSTEM A system error has occurred.
+ * @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
+ * @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 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 A system error has occurred.
+ * @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* GetCategoriesByContactN(RecordId contactId) const;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The number of categories on the device, @n
* 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_SYSTEM A system error has occurred.
+ * @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.
*/
int GetCategoryCount(void) const;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched category, @n
* else @c null if no category matches the specified category ID
* @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 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 A system error has occurred.
+ * @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.
*/
Category* GetCategoryN(RecordId categoryId) const;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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_SYSTEM A system error has occurred.
+ * @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()
* @see GetChangedCategoriesAfterN()
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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 GetLatestVersion()
* @see ContactChangeInfo
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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 A system error has occurred.
+ * @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 GetLatestVersion()
* @see CategoryChangeInfo
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched person, @n
* else @c null if an exception occurs
* @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 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.
/**
* 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
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @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 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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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
+ * @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 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
+ * @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 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()
- */
- Tizen::Base::Collection::IList* GetFavoritePersonsN() const;
+ * 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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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;
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @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 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.
* - Removes the source person.
* - Updates information of the target person.
*
- * This method does nothing if the source or target person does not exist.
+ * The %MergePersons() method does nothing if the source or target person does not exist.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] sourcePersonId The source person ID
* @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 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);
* - 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.
- * This method does nothing if the contact has not been linked to the person or does not exist.
+ * The %UnlinkContact() method does nothing if the contact has not been linked to the person or does not exist.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.write
+ * @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] personId The ID of the person that the contact is unlinked from
* @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 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.
*/
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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_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.
- * @exception E_SYSTEM A system error has occurred.
+ * @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
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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_SYSTEM A system error has occurred.
+ * @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
* @see PersonFilterProperty
/**
* Parses contacts from the specified vCard file. @n
- * This method supports vCard formation 2.1 and 3.0.
+ * The %ParseContactsFromVcardN() method supports vCard formation 2.1 and 3.0.
*
* @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.
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @param[in] person The person to export
* @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 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 disk space is full.
+ * @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);
*
* @since 2.0
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
- * @param[in] personList The person list to export @n The list should contain Person instances.
+ * @param[in] personList The person list to export @n The list should contain the Person instances.
* @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_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 disk space is full.
+ * @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);
* @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 disk space is full.
+ * @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);
* @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 disk space is full.
+ * @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);
* @since 2.1
*
* @return The exported vcard stream, @n
- * else @c null if an exception occurs.
+ * else @c null if an exception occurs
* @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()
*/
* @since 2.1
*
* @return The exported vcard stream, @n
- * else @c null if an exception occurs.
- * @param[in] contactList The contact list to export @n The list should contain Contact instances
+ * else @c null if an exception occurs
+ * @param[in] contactList The contact list to export @n The list should contain the Contact instances
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contactList contains an invalid contact.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*
* @since 2.1
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @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 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.
*
* @since 2.1
* @privlevel public
- * @privilege http://tizen.org/privilege/contact.read
+ * @privilege %http://tizen.org/privilege/contact.read
*
* @return The exported vcard stream, @n
- * else @c null if an exception occurs.
- * @param[in] personList The person list to export @n The list should contain Person instances.
+ * else @c null if an exception occurs
+ * @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 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.
/**
* Parses contacts from the specified vCard stream. @n
- * This method supports vCard formation 2.1 and 3.0.
+ * The %ParseVcardStreamN() method supports vCard formation 2.1 and 3.0.
*
* @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.
* @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.
*/
* @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. The list should contain UserProfile instance
+ * 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.
*/
* @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 disk space is full.
+ * @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);
* @since 2.1
*
* @return An error code
- * @param[in] userProfileList The user profile list to export @n The list should contain UserProfile instances.
+ * @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 disk space is full.
+ * @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. @n
+ * Gets all the user profiles on the device.
*
* @since 2.1
* @privlevel public
- * @privilege http://tizen.org/privilege/userprofile.read
+ * @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 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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllUserProfilesN(void) const;
/**
- * Gets the user profile of the address book specified by the address book ID.
+ * Gets a user profile of the address book specified by the address book ID.
*
* @since 2.1
* @privlevel public
- * @privilege http://tizen.org/privilege/userprofile.read
+ * @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 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
*
projects / framework / osp / social.git / blobdiff