diff options
Diffstat (limited to 'inc/FSclAddressbookManager.h')
| -rw-r--r-- | inc/FSclAddressbookManager.h | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/inc/FSclAddressbookManager.h b/inc/FSclAddressbookManager.h index a3e62f7..fd17fc3 100644 --- a/inc/FSclAddressbookManager.h +++ b/inc/FSclAddressbookManager.h @@ -65,7 +65,9 @@ class _OSP_EXPORT_ AddressbookManager { 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 a account. @n + * The name of the addressbook must be specified and the name must be unique among the addressbooks on the device. * * @since 2.0 * @privlevel public @@ -76,8 +78,9 @@ 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_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_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_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -211,7 +214,8 @@ public: * - The properties of the contact have not been set. @n * - 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 A system error has occurred. * @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. @@ -250,6 +254,7 @@ public: * @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_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM A system error has occurred. */ result UpdateContact(const Contact& contact); @@ -273,7 +278,7 @@ public: * - One of the member contacts is invalid. @n * - The category ID of the @c category is not #INVALID_RECORD_ID. @n * - The specified @c addressbookId is invalid. - * @exception E_STORAGE_FULL The capacity of this address book is full. + * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM A system error has occurred. */ result AddCategory(Category& category, AddressbookId addressbookId); @@ -310,6 +315,7 @@ public: * @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_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM A system error has occurred. */ result UpdateCategory(const Category& category); @@ -1023,7 +1029,7 @@ public: * @exception E_INVALID_ARG The specified @c person is invalid. * @exception E_ILLEGAL_ACCESS 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); @@ -1044,7 +1050,7 @@ public: * the specified @c vcardPath is invalid. * @exception E_ILLEGAL_ACCESS 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); @@ -1061,7 +1067,7 @@ public: * @exception E_INVALID_ARG The specified @c contact is invalid. * @exception E_ILLEGAL_ACCESS 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); @@ -1079,7 +1085,7 @@ public: * the specified @c vcardPath is invalid. * @exception E_ILLEGAL_ACCESS 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); @@ -1213,7 +1219,7 @@ public: * @exception E_INVALID_ARG The specified @c userProfile is invalid. * @exception E_ILLEGAL_ACCESS 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); @@ -1231,7 +1237,7 @@ public: * the specified @c vcardPath is invalid. * @exception E_ILLEGAL_ACCESS 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); |