X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSclPerson.h;h=faa30cf2bb51ab931a95d7be3e92e0125189fdef;hb=be709ea34fcecefd475c2434635b95750ebd49d3;hp=f8f6a60a99101e9d78bdd4cbb4f7363cb0298b16;hpb=2dc896e6cd2d75f7b3573bb663433e9f138c6c16;p=framework%2Fosp%2Fsocial.git diff --git a/inc/FSclPerson.h b/inc/FSclPerson.h index f8f6a60..faa30cf 100644 --- a/inc/FSclPerson.h +++ b/inc/FSclPerson.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -87,7 +86,7 @@ public: * @since 2.0 * * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance of %Tizen::Base::Object, @n - * else @c false + * else @c false * @param[in] rhs An instance of Tizen::Base::Object to compare */ virtual bool Equals(const Tizen::Base::Object& rhs) const; @@ -111,7 +110,7 @@ public: Tizen::Base::String GetDisplayName(void) const; /** - * Checks whether this is a favorite or not. + * Checks whether this is a favorite. * * @since 2.0 * @@ -127,7 +126,7 @@ public: * @since 2.0 * * @return The file path of the thumbnail - * @remarks If the thumbnail path has not been set, empty string is returned. + * @remarks If the thumbnail path has not been set, an empty string is returned. */ Tizen::Base::String GetThumbnailPath(void) const; @@ -137,12 +136,12 @@ public: * @since 2.0 * * @return The file path of the ringtone - * @remarks If the ringtone path has not been set, empty string is returned. + * @remarks If the ringtone path has not been set, an empty string is returned. */ Tizen::Base::String GetRingtonePath(void) const; /** - * Checks whether this has phone numbers or not. + * Checks whether this has phone numbers. * * @since 2.0 * @@ -152,7 +151,7 @@ public: bool HasPhoneNumber(void) const; /** - * Checks whether this has emails or not. + * Checks whether this has emails. * * @since 2.0 * @@ -162,14 +161,14 @@ public: bool HasEmail(void) const; /** - * Gets the list of account ID of contacts linked to the person. + * Gets the list of account IDs, of contacts linked to the person. * * @since 2.0 * * @return The account ID list * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. */ Tizen::Base::Collection::IListT* GetAccountIdsN(void) const; @@ -184,18 +183,19 @@ public: PersonId GetId(void) const; /** - * Sets whether this person is a favorite or not. + * Sets whether this person is a favorite. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] isFavorite Set to @c true to set this person as a favorite, @n - * else @c false to set this person as non-favorite + * @param[in] isFavorite Set to @c true to set this person as a favorite, @n + * else @c false to set this 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_SYSTEM The method cannot proceed due to a severe system error. + * @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. * @see IsFavorite() * @see AddressbookManager::GetFavoritePersonsN() */ @@ -210,11 +210,12 @@ public: * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] phoneNumber The phone number - * @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 phoneNumber is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] phoneNumber The phone number + * @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 invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see GetPrimaryPhoneNumber() */ result SetAsPrimaryPhoneNumber(const PhoneNumber& phoneNumber); @@ -227,11 +228,12 @@ public: * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] email The email - * @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 phoneNumber is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] email The email + * @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 invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see GetPrimaryEmail() */ result SetAsPrimaryEmail(const Email& email); @@ -243,10 +245,11 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return The primary phone number @n If this instance does not have the primary email, an empty PhoneNumber instance is returned. - * @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 The method cannot proceed due to a severe system error. + * @return The primary phone number @n If this instance does not have a primary email, an empty PhoneNumber instance is returned. + * @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. * @see SetAsPrimaryPhoneNumber() */ @@ -259,10 +262,11 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/contact.read * - * @return The primary email @n If this instance does not have the primary email, an empty Email instance is returned. - * @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 The method cannot proceed due to a severe system error. + * @return The primary email @n If this instance does not have a primary email, an empty Email instance is returned. + * @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. * @see SetAsPrimaryEmail() */