*
* @since 2.1
*
- * @param[in] rhs An instance of %Account
+ * @param[in] rhs An instance of %Account to copy
*/
Account(const Account& rhs);
*
* @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance, @n
* else @c false
- * @param[in] rhs An instance to compare
+ * @param[in] rhs An instance of Tizen::Base::Object to compare
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.1
*
- * @return An integer value indicating the hash value of the current instance
+ * @return The integer value that indicates the hash value of the current instance
*/
virtual int GetHashCode(void) const;
*
* @since 2.1
*
- * @return The key-value lists of the extended data, @n
+ * @return The key-value lists of the extended data, @n
* else an empty list if there is no extended data, or @c null if an exception occurs (String, String list)
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
*
* @since 2.1
*
- * @param[in] rhs An instance of %Account
+ * @param[in] rhs An instance of %Account to copy
*/
Account& operator =(const Account& rhs);
* @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 blocks an application from calling this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @remarks The platform will not take the ownership of @c pListener after this call.
*/
result SetEventListener(IAccountEventListener* pListener);
/**
- * Gets an account with a specified account ID.
+ * Gets an account with the specified account ID.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return An account with the specified @c accountId
+ * @return The account with the specified @c accountId
* @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_INVALID_ARG The specified @c accountId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c accountId is not found.
- * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Account GetAccount(AccountId accountId) const;
/**
- * Gets accounts associated with the account provider that has a specified application ID.
+ * Gets accounts associated with the account provider that has the specified application ID.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return A list of accounts, @n
- * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list)
+ * @return The list of accounts, @n
+ * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list)
* @param[in] accountProviderAppId The application ID of the account provider
* @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 accountProviderAppId is empty.
- * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAccountsByAccountProviderN(const Tizen::App::AppId& accountProviderAppId) const;
/**
- * Gets all accounts.
+ * Gets all the accounts.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return A list of accounts, @n
- * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list)
+ * @return The list of accounts, @n
+ * else an empty list if there is no account, or @c null if an exception occurs (@ref Account 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 proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllAccountsN(void) const;
/**
- * Gets an account provider with a specified application ID.
+ * Gets an account provider with the specified application ID.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return An account provider with the specified @c accountProviderAppId ID
+ * @return The account provider with the specified @c accountProviderAppId ID
* @param[in] accountProviderAppId The application ID of the account provider
* @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 accountProviderAppId is empty.
* @exception E_OBJ_NOT_FOUND The specified @c accountProviderAppId is not found.
- * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return A list of account providers, @n
- * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list)
+ * @return The list of account providers, @n
+ * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list)
* @param[in] capability The predefined capability or the vendor-specific capability defined as the IRI format
* @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 capability is empty.
- * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAccountProvidersByCapabilityN(const Tizen::Base::String& capability) const;
/**
- * Gets all currently registered account providers.
+ * Gets all the currently registered account providers.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return A list of account providers, @n
- * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list)
+ * @return The list of account providers, @n
+ * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider 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 proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllAccountProvidersN(void) const;
/**
- * Gets the %AccountAccessor instance.
+ * Gets an %AccountAccessor instance.
*
* @since 2.1
*
* @return A pointer to the %AccountAccessor instance, @n
- * else @c null if it fails
+ * else @c null if it fails
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AccountAccessor* GetInstance(void);
/**
* Adds an account. @n
* The user name must be set in the account.
- * If the account is added successfully, an account ID is newly assigned to it.
- * The %AddAccount() method can be used only by the application belonging to a package of an application that registers its own account provider.
+ * If the account is added successfully, an account ID is newly assigned to it. @n
+ * The %AddAccount() method can be used only by an application belonging to a package of an application that registers its own account provider.
*
* @since 2.1
* @privlevel public
* @param[in,out] account The account to add
* @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 user name is an empty string in the specified @c account. @n
- * - The account ID is not #INVALID_ACCOUNT_ID. @n
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The caller application does not belong to a package of an application that registers its own account provider. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The user name is an empty string in the specified @c account.
+ * - The account ID is not #INVALID_ACCOUNT_ID.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The caller application does not belong to a package of an application that registers its own account provider.
* - The account has already been added with the multiple accounts support set to @c false.
- * @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 AddAccount(Account& account);
* @exception E_INVALID_ARG The specified @c accountId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c accountId does not exist.
* @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to a package of an application that registers its own account provider.
- * @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 RemoveAccount(AccountId accountId);
/**
* Updates an account. @n
- * The user name must be set in an account.
+ * The user name must be set in the account.
* The %UpdateAccount() method can be used only by an application belonging to a package of an application that registers its own account provider.
*
* @since 2.1
* @param[in] account The account 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_INVALID_ARG Either of the following conditions has occurred: @n
- * - The user name is an empty string in the specified @c account. @n
- * - The account ID is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The user name is an empty string in the specified @c account.
+ * - The account ID is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c account does not exist.
* @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to a package of an application that registers its own account provider.
- * @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 UpdateAccount(const Account& account);
/**
- * Gets the %AccountManager instance.
+ * Gets an %AccountManager instance.
*
* @since 2.1
*
*
* @since 2.1
*
- * @param[in] rhs An instance of %AccountProvider
+ * @param[in] rhs An instance of %AccountProvider to copy
*/
AccountProvider(const AccountProvider& rhs);
*
* @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance, @n
* else @c false
- * @param[in] rhs An instance to compare
+ * @param[in] rhs An instance of Tizen::Base::Object to compare
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.1
*
- * @return An integer value indicating the hash value of the current instance
+ * @return The integer value that indicates the hash value of the current instance
*/
virtual int GetHashCode(void) const;
/**
- * Gets the app ID of the application that has registered this account provider.
+ * Gets the ID of the application that has registered this account provider.
*
* @since 2.1
*
- * @return The app ID
+ * @return The application ID
*/
Tizen::App::AppId GetAppId(void) const;
/**
- * Gets a list of capabilities that an account provider owns.
+ * Gets the list of capabilities that an account provider owns.
*
* @since 2.1
*
- * @return A list of capabilities which are predefined or the vendor-specific String defined as the IRI format, @n
- * else an empty list if there is no capability, or @c null if an exception occurs (String list)
+ * @return The list of capabilities which are predefined or the vendor-specific String defined as the IRI format, @n
+ * else an empty list if there is no capability, or @c null if an exception occurs (String list)
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetCapabilitiesN(void) const;
*
* @since 2.1
*
- * @param[in] rhs An instance of %AccountProvider
+ * @param[in] rhs An instance of %AccountProvider to copy
*/
AccountProvider& operator =(const AccountProvider& rhs);
/**
* @class Address
- * @brief This class represents the structured address type representing the ADR type definition of the vCard.
+ * @brief This class represents the structured address type representing the ADR type definition of a vCard.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %Address class represents the structured address type representing the ADR type definition of the vCard.
- * It is based on the MIME directory profile specification (RFC 2426).
- * The address information consists of country, city, state, street, post office box number, postal code, and the address type.
- * This class represents the structured address type representing the ADR type definition of the vCard.
+ * The %Address class represents the structured address type representing the ADR type definition of a vCard.
+ * It is based on the MIME directory profile specification (RFC 2426).
+ * The address information consists of the country, city, state, street, post office box number, postal code, and address type.
+ * This class represents the structured address type representing the ADR type definition of a vCard.
* It is based on the MIME directory profile specification (RFC 2426).
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/addressbook_namespace.htm">Addressbook</a>.
*
* @since 2.0
*
- * @param[in] rhs An instance of %Address
+ * @param[in] rhs An instance of %Address to copy
*/
Address(const Address& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
* @if OSPCOMPAT
* @page CompAddressGetTypePage Compatibility for GetType()
* @section CompAddressGetTypePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# ADDRESS_TYPE_CUSTOM is not supported. If the type of the address is ADDRESS_TYPE_CUSTOM, ADDRESS_TYPE_OTHER is returned instead.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# @c ADDRESS_TYPE_CUSTOM is not supported. If the type of the address is @c ADDRESS_TYPE_CUSTOM, @c ADDRESS_TYPE_OTHER is returned instead.
*
* @section CompAddressGetTypePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetExtendedPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetExtendedPage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompAddressSetExtendedPage Compatibility for SetExtended()
* @section CompAddressSetExtendedPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the extended address to be set is greater than @c 50 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the extended address to be set is greater than @c 50 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetExtendedPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @if OSPCOMPAT
* @page CompAddressSetStreetPage Compatibility for SetStreet()
* @section CompAddressSetStreetPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the street to be set is greater than @c 50 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the street to be set is greater than @c 50 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetStreetPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetCityPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetCityPage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompAddressSetCityPage Compatibility for SetCity()
* @section CompAddressSetCityPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the city to be set is greater than @c 50 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the city to be set is greater than @c 50 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetCityPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetStatePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetStatePage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompAddressSetStatePage Compatibility for SetState()
* @section CompAddressSetStatePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the state to be set is greater than @c 50 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the state to be set is greater than @c 50 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetStatePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @since 2.0
*
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetPostalCodePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetPostalCodePage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompAddressSetPostalCodePage Compatibility for SetPostalCode()
* @section CompAddressSetPostalCodePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the postal code to be set is greater than @c 20 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the postal code to be set is greater than @c 20 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetPostalCodePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @since 2.0
*
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetCountryCodePage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetCountryCodePage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompAddressSetCountryCodePage Compatibility for SetCountry()
* @section CompAddressSetCountryCodePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the country to be set is greater than @c 20 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the country to be set is greater than @c 20 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetCountryCodePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressSetPostOfficeBoxNumberPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompAddressSetPostOfficeBoxNumberPage "here".
* @endif
*
* @return An error code
- * @param[in] postOfficeBoxNumber The new post office box number value to set
+ * @param[in] postOfficeBoxNumber The new post office box number value to set
* @exception E_SUCCESS The method is successful.
*/
result SetPostOfficeBoxNumber(const Tizen::Base::String& postOfficeBoxNumber);
* @if OSPCOMPAT
* @page CompAddressSetPostOfficeBoxNumberPage Compatibility for SetPostOfficeBoxNumber()
* @section CompAddressSetPostOfficeBoxNumberPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the post office box number to be set is greater than @c 20 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the post office box number to be set is greater than @c 20 characters, @c E_INVALID_ARG is returned.
*
* @section CompAddressSetPostOfficeBoxNumberPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
/**
- * Gets the label of an address.
+ * Gets the label of the address.
*
* @since 2.0
*
Tizen::Base::String GetLabel(void) const;
/**
- * Sets the label of an address.
+ * Sets the label of the address.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %Address
+ * @param[in] rhs An instance of %Address to copy
*/
Address& operator =(const Address& rhs);
/**
- * Compares the specified instance of %Address with the calling instance.
+ * Compares the specified instance of %Address with the current instance.
*
* @since 2.0
*
bool operator ==(const Address& rhs) const;
/**
- * Compares the specified instance to the calling instance for inequality.
+ * Compares the specified instance to the current instance for inequality.
*
* @since 2.0
*
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/addressbook_namespace.htm">Address Book</a>.
*
- * The following example demonstrates how to use the %Addressbook class to create the categories and add contacts to them.
+ * The following example demonstrates how to use the %Addressbook class to create categories and add contacts to them.
*
* @code
*
/**
*
* The object is not fully constructed after this constructor is called. @n
- * An application must use AddressbookManager::GetAddressbookN() to get fully constructed %Addressbook instance.
+ * An application must use AddressbookManager::GetAddressbookN() to get a fully constructed %Addressbook instance.
+ *
* @since 2.0
*
* @see AddressbookManager::GetAddressbookN()
*
* @return An error code
* @param[in] pListener The event listener to register
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @endif
*/
result Construct(IRecordEventListener* pListener = null);
/**
- * Sets addressbook change event listener. @n
+ * Sets the 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.
*
* @privlevel public
* @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 blocks an application from calling this method. @b Since: @b 2.1
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @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. @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 the 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.
*
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
- * @param[in] pListener The event listener
- * @exception E_SUCCESS The method is successful.
+ * @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);
/**
* Adds a contact to the address book. @n
- * At least one property of the contact must have been set. @n
+ * At least one property of the contact must be set. @n
* If the contact has been added successfully, a contact ID is assigned to it.
*
* @since 2.0
*
* @return An error code
* @param[in,out] contact The contact to add
- * @exception E_SUCCESS The method is successful.
+ * @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 contact ID is not #INVALID_RECORD_ID, or
- * the properties of the contact have not been set.
+ * @exception E_USER_NOT_CONSENTEDThe 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.
* @exception E_STORAGE_FULL The storage 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 #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 last name.
- * And #CONTACT_PROPERTY_ID_LAST_REVISION automatically updated with the last update time.
+ * @n @c CONTACT_PROPERTY_ID_DISPLAY_NAME is automatically generated from the first name and last name.
+ * And @c CONTACT_PROPERTY_ID_LAST_REVISION is automatically updated with the last update time.
*/
result AddContact(Contact& contact);
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
- * @param[in,out] contact The contact to remove
- * @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 contact is invalid.
+ * @param[in,out] contact The contact to remove
+ * @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 contact is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c contact does not exist.
- * @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 RemoveContact(Contact& contact);
* @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 blocks an application from calling this method. @b Since: @b 2.1
- * @exception E_INVALID_ARG The specified @c contactId is invalid.
+ * @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 The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveContact(RecordId contactId);
/**
* Updates a specified contact. @n
- * At least one property of the contact must have been set.
+ * At least one property of the contact must be set.
*
* @since 2.0
* @privlevel public
* @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 blocks an application from calling this method. @b Since: @b 2.1
+ * @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_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.
*/
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompAddressbookAddCategoryPage "here".
+ * For more information, see @ref CompAddressbookAddCategoryPage "here".
* @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
- * @param[in,out] category The category to add
- * @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
- * - The category ID of the @c category is not #INVALID_RECORD_ID. @n
- * - 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.
+ * @param[in,out] category The category to add
+ * @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 name of the specified @c category has not been set.
+ * - The category ID of the specified @c category is not #INVALID_RECORD_ID.
+ * - 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 AddCategory(Category& category);
* @page CompAddressbookAddCategoryPage Compatibility for AddCategory()
* @section CompAddressbookAddCategoryPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issue: @n
- * -# If there already exist a category which has the same name, E_OBJ_ALREADY_EXIST is returned.
+ * -# If there already exists a category which has the same name, @c E_OBJ_ALREADY_EXIST is returned.
*
* @section CompAddressbookAddCategoryPageSolutionSection Resolutions
* The issue mentioned above has been resolved in Tizen.
*
* @return An error code
* @param[in,out] category The category to remove
- * @exception E_SUCCESS The method is successful.
+ * @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_CONSENTEDThe user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c category is invalid or a default category.
* @exception E_OBJ_NOT_FOUND The specified @c category does not exist in this address book.
- * @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.
* @see Category::IsDefault()
*/
result RemoveCategory(Category& category);
* @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_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 @ categoryId is a default category.
+ * @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 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.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Category::IsDefault()
*/
result RemoveCategory(RecordId categoryId);
* @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 blocks an application from calling this method. @b Since: @b 2.1
+ * @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_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.
*/
* @page CompAddressbookUpdateCategoryPage Compatibility for UpdateCategory()
* @section CompAddressbookUpdateCategoryPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issue: @n
- * -# If there already exist a category which has the same name, E_OBJ_ALREADY_EXIST is returned.
+ * -# If there already exists a category which has the same name, @c E_OBJ_ALREADY_EXIST is returned.
*
* @section CompAddressbookAddCategoryPageSolutionSection Resolutions
* The issue mentioned above has been resolved in Tizen.
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of all contacts in the addressbook, @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_SYSTEM The method cannot proceed due to a severe system error.
+ * @return The list of contacts in the addressbook, @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 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>.
+ * - 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 @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 a specified category. @n
- * If the specified @c category is INVALID_RECORD_ID, this method returns the list of contacts that are not member of any category.
+ * Gets the member contacts of the specified category. @n
+ * If the specified @c category is ::INVALID_RECORD_ID, this method returns the list of contacts that are not members 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 a 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
+ * @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_CONSENTEDThe 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>.
+ * - 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 @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;
/**
- * Gets contacts in a specified range in the address book. @n
+ * Gets contacts in the specified range in the address book. @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of contacts in a specified range, @n
+ * @return The list of contacts in the specified range, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
- * @param[in] pageNo The page number of the result list @n
- * It starts from @c 1.
- * @param[in] countPerPage The maximum count of the result items on a page
- * @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_OUT_OF_RANGE The specified @c pageNo or @c countPerPage is less than @c 1.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] pageNo The page number of the result list @n
+ * It starts from @c 1.
+ * @param[in] countPerPage The maximum count of the result items on a page
+ * @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_OUT_OF_RANGE The specified @c pageNo or @c countPerPage is less than @c 1.
+ * @exception E_INVALID_ARG A specified input parameter 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.
- * - 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>.
+ * - 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 @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* GetContactsN(int pageNo, int countPerPage) const;
/**
- * Gets contacts that are in the specified range of a specified category. @n
+ * Gets contacts that are in the specified range of the specified category. @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of contacts in the specified range of a specified category, @n
+ * @return The list of contacts in the specified range 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] category The category
- * @param[in] pageNo The page number of the result list, which starts from @c 1
- * @param[in] countPerPage The maximum count of the result items on a page
- * @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_OUT_OF_RANGE The specified @c pageNo or @c countPerPage is less than @c 1.
- * @exception E_INVALID_ARG The specified @c category is invalid, or
- * one of the contact members is invalid.
+ * @param[in] category The category
+ * @param[in] pageNo The page number of the result list, which starts from @c 1
+ * @param[in] countPerPage The maximum count of the result items on a page
+ * @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_OUT_OF_RANGE The specified @c pageNo or @c countPerPage is less than @c 1.
+ * @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_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>.
+ * - 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 @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* GetContactsInN(const Category& category, int pageNo, int countPerPage) const;
/**
- * Gets the contact with a specified contact ID.
+ * Gets the contact with the specified contact ID.
*
* @since 2.0
* @privlevel public
*
* @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.
+ * @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.
* 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.
*/
int GetContactCount(void) const;
/**
- * Adds a specified contact to a specified category.
+ * Adds the specified contact to the specified category.
*
* @since 2.0
* @privlevel 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 this 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 this 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);
/**
- * Removes a specified contact from a specified category.
+ * Removes the specified contact from the specified category.
*
* @since 2.0
* @privlevel public
* @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.
+ * @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 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 this 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 this addressbook.
* @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 in the address book. @n
+ * Gets all the categories in the address book. @n
* The categories are ordered by name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of categories in the address book, @n
+ * @return The list of categories in the address book, @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 a 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 have 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.
* 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.
*/
int GetCategoryCount(void) const;
/**
- * Gets the category with a specified category ID.
+ * Gets the category with the specified category ID.
*
* @since 2.0
* @privlevel 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.
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of all the matched contacts, @n
+ * @return The list of all the 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_INVALID_ARG The specified @c email is an empty string.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @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 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. @n 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>.
+ * - 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. @n
+ * 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;
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of all the matched contacts, @n
+ * @return The list of all the 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.
+ * @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.@n If possible, check whether the exception is E_OUT_OF_MEMORY or not.@n
+ * - There is a high probability for an occurrence of an out-of-memory exception.@n 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>.
*/
/**
* Searches the contacts that have the specified @c phoneNumber string as a substring of one of their phone numbers. @n
- * The %SearchContactsByPhoneNumberN() method returns the contacts whose phone number match the value of the specified @c phoneNumber. @n
+ * The %SearchContactsByPhoneNumberN() method returns the contacts whose phone number matches the value of the specified @c phoneNumber. @n
* The search operation is performed with a case insensitive key (param: @c phoneNumber). @n
* The contacts are ordered by display name.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A list of all the 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.
+ * @return The list of all the 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. @n If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n
+ * - There is a high probability for an occurrence of an out-of-memory exception. @n 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>.
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return The latest change version, @c
- * else @c -1 if an exception occurs
+ * @return The latest change version, @n
+ * 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()
int GetLatestVersion(void) const;
/**
- * Gets the change information of the contacts that have been changed after a specified change version. @n
+ * Gets the change information of the contacts that have been changed after the specified change version. @n
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, use GetChangedContactInfoListN().
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A 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)
+ * @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.
Tizen::Base::Collection::IList* GetChangedContactsAfterN(int version, int& latestVersion) const;
/**
- * Gets the change information of the contacts that have been changed after a specified change version.
+ * Gets the change information of the contacts that have been changed after the specified change version.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
- * @return A 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)
+ * @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
+ * @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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetLatestVersion()
*
* The following example demonstrates how to use the %GetChangedContactInfoListN() method.
Tizen::Base::Collection::IList* GetChangedContactInfoListN(int version, int& latestVersion) const;
/**
- * Gets the change information of the categories that have been changed after a specified version.
+ * Gets the change information of the categories that have been changed after the specified version.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, use GetChangedCategoryInfoListN().
* @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)
+ * @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.
Tizen::Base::Collection::IList* GetChangedCategoriesAfterN(int version, int& latestVersion) const;
/**
- * Gets the change information of the categories that have been changed after a specified version.
+ * Gets the change information of the categories that have been changed after the specified version.
*
* @since 2.1
* @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)
+ * @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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @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.
Tizen::Base::Collection::IList* GetChangedCategoryInfoListN(int version, int& latestVersion) const;
/**
- * Sets a user profile of this addressbook. @n
- * If user profile exists, removes existing user profile and adds new user profile. @n
- * To update the user profile, gets existing user profile and modifies the user profile and sets modified user profile. @n
+ * Sets the user profile of this addressbook. @n
+ * If the user profile exists, remove the existing user profile and add a new user profile. @n
+ * To update the user profile, get the existing user profile and modify the user profile and set the modified user profile. @n
* To remove the user profile, @c null must be passed.
*
* @since 2.1
* @param[in] pUserProfile The user profile to set
* @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 SetUserProfile(const UserProfile* pUserProfile);
/**
- * Gets a user profile of this addressbook.
+ * Gets the user profile of this addressbook.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/userprofile.read
*
* @return The user profile, @n
- * else @c null if the user profile does not exist, or if an exception has occurred
+ * else @c null if the user profile does not exist, or 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.
+ * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
UserProfile* GetUserProfileN(void) const;
/**
- * Checks whether the user profile of this address book has been changed after a specified version or not.
+ * Checks whether the user profile of this address book has been changed after the specified version or not.
* If the user profile does not exist, this method returns @c false.
*
* @since 2.1
* @param[in] version The changed version
* @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 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.
* @param[out] pContactIdList A pointer to the list of contact IDs that have been added successfully @n Pass @c null if the contact IDs are not necessary.
* @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 Either of the following conditions has occurred:
- * - The specified @c contactList is empty.
- * - The specified @c contactList contains an empty contact.
- * - The specified @c contactList contains a contact whose ID is not INVALID_RECORD_ID.
+ * - The specified @c contactList is empty.
+ * - The specified @c contactList contains an empty contact.
+ * - The specified @c contactList contains a contact whose ID is not ::INVALID_RECORD_ID.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks If an exception occurs during adding contacts, the changes are getting rollbacked. @n
+ * @remarks
+ * - If an exception occurs during adding contacts, the changes are getting rollbacked. @n
* This method blocks the execution of the calling thread until all contacts in the list has been added to the addressbook or if an exception occurs.
- * It is recommended to call this method on any thread other than the main thread.
+ * - It is recommended to call this method on any thread other than the main thread.
*/
result AddContacts(const Tizen::Base::Collection::IList& contactList, Tizen::Base::Collection::IListT<RecordId>* pContactIdList = null);
* @param[in] contactList The contacts to update @n The list should contain the Contact 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 Either of the following conditions has occurred:
- * - The specified @c contactList is empty.
- * - The specified @c contactList contains an empty contact.
- * - The specified @c contactList contains a contact whose ID is invalid.
+ * - The specified @c contactList is empty.
+ * - The specified @c contactList contains an empty contact.
+ * - The specified @c contactList contains a contact whose ID is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c contact does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks If an exception occurs during updating contacts, the changes are getting rollbacked. @n
- * This method blocks the execution of the calling thread until all contacts in the list has been updated or if an exception occurs. @n
- * It is recommended to call this method on any thread other than the main thread.
+ * @remarks
+ * - If an exception occurs during updating contacts, the changes are getting rollbacked. @n
+ * This method blocks the execution of the calling thread until all contacts in the list has been updated or if an exception occurs.
+ * - It is recommended to call this method on any thread other than the main thread.
*/
result UpdateContacts(const Tizen::Base::Collection::IList& contactList);
* @param[in] contactIdList The list of contact IDs to delete
* @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 contactIdList is empty or contains an invalid ID.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks If an exception occurs during removing contacts, the changes are getting rollbacked. @n
- * This method blocks the execution of the calling thread until all contacts in the list has been removed or if an exception occurs. @n
- * It is recommended to call this method on any thread other than the main thread.
+ * @remarks
+ * - If an exception occurs during removing contacts, the changes are getting rollbacked. @n
+ * This method blocks the execution of the calling thread until all contacts in the list has been removed or if an exception occurs.
+ * - It is recommended to call this method on any thread other than the main thread.
*/
result RemoveContacts(const Tizen::Base::Collection::IListT<RecordId>& contactIdList);
/**
* @class AddressbookFilter
- * @brief This class represents the condition for searching the specific item on addressbook.
+ * @brief This class represents the condition for searching a specific item on an addressbook.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %AddressbookFilter class represents the condition for searching the specific item on addressbook.
- * The type of the filter decides which item will be searched (such as addressbook, contacts, persons, categories). @n
+ * The %AddressbookFilter class represents the condition for searching a specific item on an addressbook.
+ * The type of the filter decides which item is searched (such as addressbook, contacts, persons, categories). @n
* The filter can consist of multiple filtering expressions and conjunctive operators.
* A filtering expression consists of a filter property, comparison operator and value.
- * The filter property must be an element of the enumerator that corresponds with the type of the filter. @n
+ * The filter property must be an element of the enumerator that corresponds to the type of the filter. @n
* <table border=1>
* <tr>
* <th> Filter type </th>
*
* @since 2.0
*
- * @param[in] type The type of the filter @n It decides the type of item to search.
+ * @param[in] type The type of the filter @n It decides the type of the item to search.
*/
AddressbookFilter(AddressbookFilterType type);
* @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;
virtual int GetHashCode(void) const;
/**
- * Appends the filtering expression for the integer value. @n
+ * Appends the filtering expression for an integer value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The integer value for comparison
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The type of the @c filterProperty is not @c int. @n
- * - The specified @c conjuctiveOperator is invalid.
+ * @param[in] value The integer value for comparison
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The type of the specified @c filterProperty is not @c int.
+ * - The specified @c conjuctiveOperator is invalid.
*/
result AppendInt(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, int value);
/**
- * Appends the filtering expression for the @c bool value. @n
+ * Appends the filtering expression for a @c bool value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator #FI_CMP_OP_EQUAL is only permitted
- * @param[in] value The @c bool value for comparison
+ * @param[in] value The @c bool value for comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter.
- * - The type of the @c filterProperty is not @c bool.
- * - The @c comparisonOperator is no #FI_CMP_OP_EQUAL.
- * - The specified @c conjuctiveOperator is invalid.
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The type of the specified @c filterProperty is not @c bool.
+ * - The specified @c comparisonOperator is not #FI_CMP_OP_EQUAL.
+ * - The specified @c conjuctiveOperator is invalid.
* @remarks If the filtering expression is appended firstly, the @c conjunctiveOperator is ignored.
*/
result AppendBool(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, bool value);
/**
- * Appends the filtering expression for the Tizen::Base::String value. @n
+ * Appends the filtering expression for a Tizen::Base::String value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The Tizen::Base::String value for matching
+ * @param[in] value The Tizen::Base::String value for matching
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The type of the @c filterProperty is not Tizen::Base::String. @n
- * - The specified @c conjuctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The type of the specified @c filterProperty is not Tizen::Base::String.
+ * - The specified @c conjuctiveOperator is invalid.
*/
result AppendString(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterStringOperator comparisonOperator, const Tizen::Base::String& value);
* Appends the filter. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expressions of the specified filter in parentheses and appends it. @n
- * The type of the specified @c filter must be same with the type of this filter.
+ * The type of the specified @c filter must be same as the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
- * @param[in] filter The filter to append
+ * If there is no filtering expression or the filter has been appended before, #FI_CONJ_OP_NONE must be used. Otherwise #FI_CONJ_OP_AND or #FI_CONJ_OP_OR can be used.
+ * @param[in] filter The filter to append
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The type of the specified @c filter is not same with the type of this filter. @n
- * - The specified @c filter is empty. @n
- * - The specified @c conjuctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The type of the specified @c filter is not same as the type of this filter.
+ * - The specified @c filter is empty.
+ * - The specified @c conjuctiveOperator is invalid.
*/
result AppendFilter(FilterConjunctiveOperator conjunctiveOperator, const AddressbookFilter& filter);
/**
* @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 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.
*
* @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.
* @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.
*/
* @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.
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
* @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.
* @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.
*
* @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);
* @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.
* @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.
* @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.
*/
* @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.
* @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()
* @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;
* @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.
* @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.
* @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.
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
* 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.
*/
* @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.
*/
* @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.
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.
* 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.
*/
* @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.
* @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;
* @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;
* @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;
* @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()
* @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.
* @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.
* @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.
/**
* 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
* @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.
* @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.
*
* @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;
* @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.
* @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);
* - 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.
* @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.
*/
* @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
* @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
*
* @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.
* @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);
* @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);
* @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);
* @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);
* @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()
*/
* @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.
* @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.
*
* @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 @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.
*/
* @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);
* @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.
*/
* @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
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %Attendee
+ * @param[in] rhs An instance of %Attendee to copy
*/
Attendee(const Attendee& rhs);
virtual ~Attendee(void);
/**
- * Compares the input Tizen::Base::Object with the calling %Attendee instance.
+ * Compares the specified Tizen::Base::Object with the current %Attendee instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %Attendee instance, @n
+ * @return @c true if the specified object equals the current %Attendee instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* @page CompAttendeeSetNamePage Compatibility for SetName()
* @section CompAttendeeSetNamePageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the name to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * -# If the length of the name to be set is greater than @c 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompAttendeeSetNamePageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
/**
* Sets the email address of the attendee. @n
- * This is the identifier of an attendee.
+ * This is the identifier of the attendee.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @page CompAttendeeSetEmailPage Compatibility for SetEmail()
* @section CompAttendeeSetEmailPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the email to be set is greater than 320 characters, E_INVALID_ARG is returned.
+ * -# If the length of the email to be set is greater than @c 320 characters, @c E_INVALID_ARG is returned.
*
* @section CompAttendeeSetEmailPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
*/
Tizen::Base::String GetPhoneNumber(void) const;
- /*
+ /**
* Sets the person ID that is an identifier used for Addressbook APIs.
*
* @since 2.0
*/
void SetPersonId(PersonId personId);
- /*
+ /**
* Gets the person ID that is an identifier used for Addressbook APIs.
*
* @since 2.0
*
* @since 2.0
*
- * @param[in] rhs An instance of %Attendee
+ * @param[in] rhs An instance of %Attendee to copy
*/
Attendee& operator =(const Attendee& rhs);
bool operator ==(const Attendee& rhs) const;
/**
- * Compares the specified instance of %Attendee with the calling instance for inequality.
+ * Compares the specified instance of %Attendee with the current instance for inequality.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEvent
+ * @param[in] rhs An instance of %CalEvent to copy
*/
CalEvent(const CalEvent& rhs);
virtual ~CalEvent(void);
/**
- * Compares the input Tizen::Base::Object with the calling %CalEvent instance.
+ * Compares the specified Tizen::Base::Object with the current %CalEvent instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %CalEvent instance, @n
+ * @return @c true if the specified object equals the current %CalEvent instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* Each instance of %CalEvent has its own recurrence ID.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
- * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for event instance.
+ * @deprecated This method is deprecated because %CalEvent class is not used for an event instance any more. @n
+ * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for an event instance.
* @since 2.0
*
* @return @c true if this instance is a %CalEvent instance, @n
* Checks whether the calendar event has a recurring pattern.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
- * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for event instance.
+ * @deprecated This method is deprecated because %CalEvent class is not used for an event instance any more. @n
+ * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for an event instance.
* @since 2.0
*
* @return @c true if the calendar event has a recurring pattern, @n
* The %CalEvent instance has an original @c CalEventId, that is a record ID of its entry.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
- * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for event instance.
+ * @deprecated This method is deprecated because %CalEvent class is not used for an event instance any more. @n
+ * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for an event instance.
* @since 2.0
*
* @return The original calendar event ID, @n
*
* @since 2.0
*
- * @return @c true if calendar event is an all day event, @n
+ * @return @c true if the calendar event is an all day event, @n
* else @c false
*/
bool IsAllDayEvent(void) const;
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value cannot be handled. @n
+ * @deprecated This method is deprecated because a string value cannot be handled. @n
* Instead of using this method, it is recommended to use GetUid().
* @since 2.0
*
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value cannot be handled. @n
+ * @deprecated This method is deprecated because a string value cannot be handled. @n
* Instead of using this method, it is recommended to use SetUid().
* @since 2.0
*
* @page CompCalEventAddAttendeePage Compatibility for AddAttendee()
* @section CompCalEventAddAttendeePageIssueSection Issues
* Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
- * - If the email of @c attendee is empty, the @c E_OBJ_ALREADY_EXIST is returned.
+ * - If the email of @c attendee is empty, @c E_OBJ_ALREADY_EXIST is returned.
*
* @section CompCalEventAddAttendeePageSolutionSection Resolutions
* The issue mentioned above is resolved in %Tizen API version 2.1.
- * - If the email of @c attendee is empty, the @c E_INVALID_ARG is returned.
+ * - If the email of @c attendee is empty, @c E_INVALID_ARG is returned.
*/
/**
* @param[in] attendee The attendee to remove @n
* The specified @c attendee must have an email address.
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND An attendee that has the same email address is not found.
+ * @exception E_OBJ_NOT_FOUND An attendee with the same email address is not found.
*/
result RemoveAttendee(const Attendee& attendee);
/**
- * Gets a list of all the attendees.
+ * Gets the list of attendees.
*
* @since 2.0
*
- * @return A list of the attendees
+ * @return The list of attendees
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Attendee
*/
/**
* Sets the time zone. @n
* Recurrence is calculated based on the time zone, thus the time zone must be set before setting a recurrence.
- * If the time zone is not set, it will be considered as Greenwich Mean Time (GMT) 0.
+ * If the time zone is not set, it is considered as Greenwich Mean Time (GMT).
*
* @since 2.0
*
* @exception E_FAILURE The method has failed.
* @remarks
* - As all day events are not affected by a time zone, it is recommended not to set the time zone.
- * - Only the time zone ID of the specified @c timeZone is set to the %CalEvent instance, and the other properties are ignored.
+ * - Only the time zone ID of the @c timeZone is set to the %CalEvent instance, and the other properties are ignored.
*/
result SetTimeZone(const Tizen::Locales::TimeZone& timeZone);
* The %GetRecurrenceId() method works only for the %CalEvent instances.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
- * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for event instance.
+ * @deprecated This method is deprecated because the %CalEvent class is not used for an event instance any more. @n
+ * Instead of using the %CalEvent class, it is recommended to use the CalEventInstance class for an event instance.
* @since 2.0
*
* @return The recurrence ID
*
* @since 2.0
*
- * @return An instance of Tizen::Base::DateTime representing the start date and time
+ * @return An instance of Tizen::Base::DateTime that represents the start date and time
*/
Tizen::Base::DateTime GetStartTime(void) const;
*
* @since 2.0
*
- * @return An instance of Tizen::Base::DateTime representing the end date and time
+ * @return An instance of Tizen::Base::DateTime that represents the end date and time
*/
Tizen::Base::DateTime GetEndTime(void) const;
* Gets the category of the calendar event.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the category of event is not used any more.
+ * @deprecated This method is deprecated because the category of the event is not used any more.
* @since 2.0
*
* @return The category of the calendar event
* @page CompCalEventSetSubjectPage Compatibility for SetSubject()
* @section CompCalEventSetSubjectPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the subject to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * -# If the length of the subject to be set is greater than @c 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompCalEventSetSubjectPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @page CompCalEventSetDescriptionPage Compatibility for SetDescription()
* @section CompCalEventSetDescriptionPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the description to be set is greater than 1000 characters, E_INVALID_ARG is returned.
+ * -# If the length of the description to be set is greater than @c 1000 characters, @c E_INVALID_ARG is returned.
*
* @section CompCalEventSetDescriptionPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @since 2.0
*
* @return An error code
- * @param[in] startDateTime The start date and time. @n Any value with a unit that is less than a second is ignored.
- * @param[in] endDateTime The end date and time. @n Any value with a unit that is less than a second is ignored.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @param[in] startDateTime The start date and time @n Any value with a unit that is less than a second is ignored.
+ * @param[in] endDateTime The end date and time @n Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c endDateTime value is earlier than the specified @c startDateTime value.
- * - The @c startDateTime or @c endDateTime is out of the valid range. @n
+ * - The specified @c startDateTime or @c endDateTime is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
- * @exception E_INVALID_CONDITION The recurrence date is already set.
- * @remarks The start and end time of all day events created from the base applications is the local time of the location where
- * they are added.
- * All the other events are Coordinated Universal Time (UTC).
- * In order to integrate it with the base applications, set the start and end time properly according to the above guidelines.
+ * @exception E_INVALID_CONDITION The recurrence date is already set.
+ * @remarks
+ * - The start and end time of all day events created from the base applications is the local time of the location where
+ * they are added. @n
+ * All the other events are in Coordinated Universal Time (UTC). @n
+ * In order to integrate it with the base applications, set the start and end time properly according to the above guidelines. @n
* If the seconds value of the start time is set, the alarm will not be fired.
- * There is no automatic time conversion based on the time zone property of the calendar event.
+ * - There is no automatic time conversion based on the time zone property of the calendar event.
*/
result SetStartAndEndTime(const Tizen::Base::DateTime& startDateTime, const Tizen::Base::DateTime& endDateTime);
* @page CompCalEventSetLocationPage Compatibility for SetLocation()
* @section CompCalEventSetLocationPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the location to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * -# If the length of the location to be set is greater than @c 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompCalEventSetLocationPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @if OSPCOMPAT
* @brief <i> [Deprecated] [Compatibility] </i>
* @endif
- * @deprecated This method is deprecated because the category of event is not used any more.
+ * @deprecated This method is deprecated because the category of the event is not used any more.
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* @section CompCalEventSetCategoryPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# When the anniversary category is set to the event, it is handled as all day event even though the all day event property is not set.
+ * -# When the anniversary category is set to the event, it is handled as an all day event even though the all day event property is not set.
*
* @section CompCalEventSetCategoryPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# The category property is deprecated and it is not used any more.
- * In Tizen, the all day event property will be set simultaneously when the anniversary category is set to the event.
- * If an application tries to change the all day event property of the anniversary event to @c false, it will not be changed.
+ * In Tizen, the all day event property is set simultaneously when the anniversary category is set to the event.
+ * If an application tries to change the all day event property of the anniversary event to @c false, it is not changed.
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] latitude The latitude in the range @n The valid range is [-90.0, 90.0].
- * @param[in] longitude The longitude in the range @n The valid range is [-180.0, 180.0].
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c latitude or @c longitude is out of the valid range.
+ * @param[in] latitude The latitude within the range @n The valid range is [-90.0, 90.0].
+ * @param[in] longitude The longitude within the range @n The valid range is [-180.0, 180.0].
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c latitude or @c longitude is outside the valid range.
*/
result SetCoordinates(double latitude, double longitude);
* else @c null to remove the previous recurrence
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The current event is a %CalEvent instance that has a recurrence ID.
- * @exception E_INVALID_CONDITION Either of the following conditions has occurred: @n
- * - The recurrence rule date is earlier than the start date and time of the event. @n
- * - The recurrence rule is invalid. @n
+ * @exception E_INVALID_CONDITION Either of the following conditions has occurred:
+ * - The recurrence rule date is earlier than the start date and time of the event.
+ * - The recurrence rule is invalid.
* - The duration of the event is too long. @n
* It must be shorter than the (interval x frequency) days set for the recurrence rule.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - When the frequency is #FREQ_WEEKLY, DayOfWeek is not set. @n
- * - When the frequency is #FREQ_MONTHLY, neither DayOfMonth nor DayOfWeek and WeekOfMonth are not set. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - When the frequency is #FREQ_WEEKLY, DayOfWeek is not set.
+ * - When the frequency is #FREQ_MONTHLY, neither DayOfMonth nor DayOfWeek and WeekOfMonth are set.
* - When the frequency is #FREQ_YEARLY, neither DayOfMonth and MonthOfYear nor DayOfWeek,
- * WeekOfMonth and MonthOfYear are not set. @n
- * - When the frequency is #FREQ_YEARLY and MonthOfYear is 2, DayOfMonth is greater than 29 (> 29). @n
- * - When the frequency is #FREQ_YEARLY and MonthOfYear is 4 or 6 or 9 or 11,
- * DayOfMonth is greater than 30 (> 30).
+ * WeekOfMonth and MonthOfYear are set.
+ * - When the frequency is #FREQ_YEARLY and MonthOfYear is @c 2, DayOfMonth is greater than @c 29 (> 29).
+ * - When the frequency is #FREQ_YEARLY and MonthOfYear is @c 4, @c 6, @c 9 or @c 11,
+ * DayOfMonth is greater than @c 30 (> 30).
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks If the until property of the recurrence is set with too distant future from the event's start date, @n
- * too many recurring events are generated. It is the same when the value of recurrence count is big. @n
- * The system limits the count of the recurring events that are generated by recurrence rule of an event. @n
+ * @remarks If the until property of the recurrence is set too far from the event's start date, @n
+ * too many recurring events are generated. It is the same when the value of the recurrence count is large. @n
+ * The system limits the count of the recurring events that are generated by the recurrence rule of an event. @n
* In this case, some recurring events that exceed the system limitation cannot be retrieved.
*
* The following example demonstrates how to use the %SetRecurrence() method.
* @page CompCalEventSetRecurrencePage Compatibility for SetRecurrence()
* @section CompCalEventSetRecurrencePageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * - If the category is anniversary and the frequency of recurrence is not yearly, E_TYPE_MISMATCH exception is occurred. @n
- * Yearly frequency is only accepted for anniversary category.
+ * - If the category is anniversary and the frequency of recurrence is not yearly, @c E_TYPE_MISMATCH exception is returned. @n
+ * Yearly frequency is only accepted for the anniversary category.
*
* @section CompCalEventSetRecurrencePageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
- * -# All recurrence frequency will be accepted because the category of event is not used any more.
+ * -# All recurrence frequencies are accepted because the category of the event is not used any more.
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index of reminder to remove
+ * @param[in] index The index of the reminder to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The index is either equal to or greater than the number of reminders or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is either greater than or equal to the number of reminders.
+ * - The specified @c index is less than @c 0.
*/
result RemoveReminderAt(int index);
/**
- * Gets a list of all the reminders.
+ * Gets the list of reminders.
*
* @since 2.0
*
- * @return A list containing the Reminder instances, @n
+ * @return The list that contains Reminder instances, @n
* else an empty list if there are no reminders
*/
const Tizen::Base::Collection::IList& GetAllReminders(void) const;
/**
* Gets the base event ID.
- * This method return the ID of the base recurring event for which this event is a recurrence exception.
+ * This method returns the ID of the base recurring event for which this event is a recurrence exception.
*
* @since 2.1
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEvent
+ * @param[in] rhs An instance of %CalEvent to copy
*/
CalEvent& operator =(const CalEvent& rhs);
// limitations under the License.
//
/**
- * @file FSclCalEventChangeInfo.h
+ * @file FSclCalEventChangeInfo.h
* @brief This is the header file for the %CalEventChangeInfo class.
*
* This header file contains the declarations of the %CalEventChangeInfo class.
*
* @final This class is not intended for extension.
*
- * The %CalEventChangeInfo class represents the change information of an event that is managed in calendarbook.
+ * The %CalEventChangeInfo class represents the change information of an event that is managed in the calendarbook.
*/
class _OSP_EXPORT_ CalEventChangeInfo
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEventChangeInfo
+ * @param[in] rhs An instance of %CalEventChangeInfo to copy
*/
CalEventChangeInfo(const CalEventChangeInfo& rhs);
virtual ~CalEventChangeInfo(void);
/**
- * Compares the input Tizen::Base::Object with the calling %CalEventChangeInfo instance.
+ * Compares the specified Tizen::Base::Object with the current %CalEventChangeInfo instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %CalEventChangeInfo instance, @n
+ * @return @c true if the specified object equals the current %CalEventChangeInfo instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEventChangeInfo
+ * @param[in] rhs An instance of %CalEventChangeInfo to copy
*/
CalEventChangeInfo& operator =(const CalEventChangeInfo& rhs);
/**
* @class CalEventInstance
- * @brief This class represents the instance of calendar book event.
+ * @brief This class represents the instance of a calendar book event.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %CalEventInstance class represents the instance of calendar book event.
+ * The %CalEventInstance class represents the instance of a calendar book event.
*/
class _OSP_EXPORT_ CalEventInstance
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEventInstance
+ * @param[in] rhs An instance of %CalEventInstance to copy
*/
CalEventInstance(const CalEventInstance& rhs);
virtual ~CalEventInstance(void);
/**
- * Compares the input Tizen::Base::Object with the calling %CalEventInstance instance.
+ * Compares the specified Tizen::Base::Object with the current %CalEventInstance instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %CalEventInstance instance, @n
- else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @return @c true if the specified object equals the current %CalEventInstance instance, @n
+ * else @c false
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalEventInstance
+ * @param[in] rhs An instance of %CalEventInstance to copy
*/
CalEventInstance& operator =(const CalEventInstance& rhs);
* @final This class is not intended for extension.
*
* The %CalTodo class is a subset of vTodo. An instance of %CalTodo includes the subject, description, start date, due date, location, sensitivity,
- * priority, and status.
+ * priority, and status.
* This class represents the information of a calendar book to-do.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/caltodo.htm">Calendar Tasks</a>.
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalTodo
+ * @param[in] rhs An instance of %CalTodo to copy
*/
CalTodo(const CalTodo& rhs);
virtual ~CalTodo(void);
/**
- * Compares the input Tizen::Base::Object with the calling %CalTodo instance.
+ * Compares the specified Tizen::Base::Object with the current %CalTodo instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %CalTodo instance, @n
+ * @return @c true if the specified object equals the current %CalTodo instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @return The start date, @n
* the minimum value of Tizen::Base::DateTime, if the start date has been not set
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The start date has been not set.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
*/
Tizen::Base::DateTime GetStartDate(void) const;
* @return The due date, @n
* the minimum value of Tizen::Base::DateTime, if the due date has been not set
* @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The due date has been not set.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
+ * @exception E_DATA_NOT_FOUND The due date has been not set.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
*/
Tizen::Base::DateTime GetDueDate(void) const;
* @page CompCalTodoSetSubjectPage Compatibility for SetSubject()
* @section CompCalTodoSetSubjectPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the subject to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * -# If the length of the subject to be set is greater than @c 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompCalTodoSetSubjectPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @page CompCalTodoSetDescriptionPage Compatibility for SetDescription()
* @section CompCalTodoSetDescriptionPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the description to be set is greater than 1000 characters, E_INVALID_ARG is returned.
+ * -# If the length of the description to be set is greater than @c 1000 characters, @c E_INVALID_ARG is returned.
*
* @section CompCalTodoSetDescriptionPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompCalTodoSetStartAndDueDatePage "here".
+ * For more information, see @ref CompCalTodoSetStartAndDueDatePage "here".
* @endif
*
* @return An error code
* @param[in] startDate The start date. @n Any value with a unit that is less than a second is ignored.
- * @param[in] dueDate The due date. @n Any value with a unit that is less than a second is ignored.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @param[in] dueDate The due date. @n Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c dueDate is earlier than the specified @c startDate.
- * - The @c startDate or @c dueDate is not a valid range. @n
+ * - The specified @c startDate or @c dueDate is not a valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @endcond
*/
* @if OSPCOMPAT
* @page CompCalTodoSetStartAndDueDatePage Compatibility for SetStartAndDueDate()
* @section CompCalTodoSetStartAndDueDatePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# The start and due date cannot be unset. And if the SetStartAndDueDate() is not called, the default start and due date @n
- * are set to the system time when the to-do is constructed.
+ * are set to the system time when the to-do is constructed.
*
* @section CompCalTodoSetStartAndDueDatePageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
/**
* Sets the start date for the current instance of %CalTodo. @n
- * If the @c startDate is minimum value of Tizen::Base::DateTime, the start date is changed to unset. @n
- * And if the start date is later than due date, the due date will be changed to unset.
+ * If the @c startDate is the minimum value of Tizen::Base::DateTime, the start date is changed to unset. @n
+ * And if the start date is later than the due date, the due date is changed to unset.
*
* @since 2.0
*
* @return An error code
- * @param[in] startDate The start date. @n Any value with a unit that is less than a second is ignored.
+ * @param[in] startDate The start date. @n Any value with a unit that is less than a second is ignored.
* @exception E_SUCCESS The method is successful. @n
- * Either @c startDate is between Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime(), or
+ * The specified @c startDate is between Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime(). @n
* @c startDate is the minimum value of Tizen::Base::DateTime to unset the start date.
- * @exception E_INVALID_ARG The specified @c start date is invalid.
+ * @exception E_INVALID_ARG The specified @c startDate is invalid.
* @remarks The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
*/
result SetStartDate(const Tizen::Base::DateTime& startDate);
/**
* Sets the end date for the current instance of %CalTodo. @n
- * If the @c dueDate is minimum value of Tizen::Base::DateTime, the due date is changed to unset. @n
- * And if the due date is earlier than start date, the start date will be changed to unset.
+ * If the @c dueDate is the minimum value of Tizen::Base::DateTime, the due date is changed to unset. @n
+ * And if the due date is earlier than the start date, the start date is changed to unset.
*
* @since 2.0
*
* @return An error code
* @param[in] dueDate The due date. @n Any value with a unit that is less than a second is ignored.
* @exception E_SUCCESS The method is successful. @n
- * Either @c dueDate is between Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime(), or
+ * The specified @c dueDate is between Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime(). @n
* @c dueDate is the minimum value of Tizen::Base::DateTime to unset the due date.
- * @exception E_INVALID_ARG The specified @c due date is invalid.
+ * @exception E_INVALID_ARG The specified @c dueDate is invalid.
* @remarks The minimum value can be acquired using Tizen::Base::DateTime::GetMinValue().
*/
result SetDueDate(const Tizen::Base::DateTime& dueDate);
* @since 2.0
*
* @return An error code
- * @param[in] latitude The latitude in the range @n The valid range is [-90.0, 90.0].
- * @param[in] longitude The longitude in the range @n The valid range is [-180.0, 180.0].
+ * @param[in] latitude The latitude within the range @n The valid range is [-90.0, 90.0].
+ * @param[in] longitude The longitude within the range @n The valid range is [-180.0, 180.0].
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c latitude or @c longitude is out of the valid range.
+ * @exception E_INVALID_ARG The specified @c latitude or @c longitude is out of the valid range.
*/
result SetCoordinates(double latitude, double longitude);
result AddReminder(const Reminder& reminder);
/**
- * Removes a reminder at the index.
+ * Removes the reminder at the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of reminder to remove
+ * @param[in] index The index of the reminder to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The index is either equal to or greater than the number of reminders or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is either greater than or equal to the number of reminders.
+ * - The specified @c index is less than @c 0.
*/
result RemoveReminderAt(int index);
/**
- * Gets a list of all the reminders.
+ * Gets a list of reminders.
*
* @since 2.0
*
- * @return A list containing the Reminder instances, @n
+ * @return The list that contains the Reminder instances, @n
* else an empty list if there are no reminders
*/
const Tizen::Base::Collection::IList& GetAllReminders(void) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalTodo
+ * @param[in] rhs An instance of %CalTodo to copy
*/
CalTodo& operator =(const CalTodo& rhs);
// limitations under the License.
//
/**
- * @file FSclCalTodoChangeInfo.h
+ * @file FSclCalTodoChangeInfo.h
* @brief This is the header file for the %CalTodoChangeInfo class.
*
* This header file contains the declarations of the %CalTodoChangeInfo class.
*
* @final This class is not intended for extension.
*
- * The %CalTodoChangeInfo class represents the change information of a to-do that is managed in calendarbook.
+ * The %CalTodoChangeInfo class represents the change information of a to-do that is managed in a calendarbook.
*/
class _OSP_EXPORT_ CalTodoChangeInfo
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalTodoChangeInfo
+ * @param[in] rhs An instance of %CalTodoChangeInfo to copy
*/
CalTodoChangeInfo(const CalTodoChangeInfo& rhs);
virtual ~CalTodoChangeInfo(void);
/**
- * Compares the input Tizen::Base::Object with the calling %CalTodoChangeInfo instance.
+ * Compares the specified Tizen::Base::Object with the current %CalTodoChangeInfo instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %CalTodoChangeInfo instance, @n
+ * @return @c true if the specified object equals the current %CalTodoChangeInfo instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %CalTodoChangeInfo
+ * @param[in] rhs An instance of %CalTodoChangeInfo to copy
*/
CalTodoChangeInfo& operator =(const CalTodoChangeInfo& rhs);
* @final This class is not intended for extension.
*
* The %Calendar class represents calendar information. @n
- * Multiple calendars can be created, each of which can have its own events and to-dos. An event or to-do can be retrieved using the respective calendar ID.
+ * Multiple calendars can be created, each of which can have their own events and to-dos. An event or to-do can be retrieved using the respective calendar ID.
*/
class _OSP_EXPORT_ Calendar
: public Record
*
* @since 2.0
*
- * @param[in] itemType The calendar item type to specify which kind of item the calendar can contain
+ * @param[in] itemType The calendar item type to specify which kind of item the calendar can contain
*/
explicit Calendar(CalendarItemType itemType);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Calendar
+ * @param[in] rhs An instance of %Calendar to copy
*/
Calendar(const Calendar& rhs);
virtual ~Calendar(void);
/**
- * Compares the input Tizen::Base::Object with the calling %Calendar instance.
+ * Compares the specified Tizen::Base::Object with the current %Calendar instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %Calendar instance, @n
+ * @return @c true if the specified object equals the current %Calendar instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
/**
* Gets the calendar color. @n
- * If the color has not been set, all color components are set with 0x0 and E_DATE_NOT_FOUND exception is returned.
+ * If the color has not been set, all color components are set with 0x0 and @c E_DATE_NOT_FOUND exception is returned.
*
* @since 2.0
*
- * @param[out] r The red component
- * @param[out] g The green component
- * @param[out] b The blue component
- * @exception E_SUCCESS The method is successful.
+ * @param[out] r The red component
+ * @param[out] g The green component
+ * @param[out] b The blue component
+ * @exception E_SUCCESS The method is successful.
* @exception E_DATA_NOT_FOUND The color has not been set.
*/
result GetColor(byte& r, byte& g, byte& b) const;
*
* @since 2.0
*
- * @param[in] name The calendar name
+ * @param[in] name The calendar name
*/
void SetName(const Tizen::Base::String& name);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Calendar
+ * @param[in] rhs An instance of %Calendar to copy
*/
Calendar& operator =(const Calendar& rhs);
\r
/**\r
* @class Calendarbook\r
- * @brief This class manages the calendar data such as events, to-dos, and calendars.\r
+ * @brief This class manages calendar data such as events, to-dos, and calendars.\r
*\r
* @since 2.0\r
*\r
* @final This class is not intended for extension.\r
*\r
- * The %Calendarbook class manages the calendar data such as events, to-dos, and calendars.\r
+ * The %Calendarbook class manages calendar data such as events, to-dos, and calendars.\r
* The calendar book is a centralized database that is used by multiple applications to store events and to-do information.\r
* A calendar book represents the methods to read, add, remove, and update the events, to-do lists, and calendars stored in the device.\r
* The users must be notified of changes in the calendar book as multiple applications can share, change, or remove the data.\r
* @param[in,out] event The event to add\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c event is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in,out] event The event to add\r
+ * @param[in,out] event The event to add\r
* @param[in] calendarId The calendar ID\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c event is invalid. @n\r
- * - The specified @c calendarId is invalid. @n\r
- * - The specified calendar is created for CALENDAR_ITEM_TYPE_TODO.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c event is invalid.\r
+ * - The specified @c calendarId is invalid.\r
+ * - The specified calendar is created for ::CALENDAR_ITEM_TYPE_TODO.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in,out] todo The to-do to add\r
+ * @param[in,out] todo The to-do to add\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c todo is invalid.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] calendarId The calendar ID\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c todo is invalid. @n\r
- * - The specified @c calendarId is invalid. @n\r
- * - The specified calendar is created for CALENDAR_ITEM_TYPE_EVENT.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c todo is invalid.\r
+ * - The specified @c calendarId is invalid.\r
+ * - The specified calendar is created for ::CALENDAR_ITEM_TYPE_EVENT.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] event The calendar event to remove\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The specified recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
* RemoveEventInstance() should be used instead of this method. @b Since: @b 2.1\r
* @param[in] eventId The calendar event ID to remove\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c eventId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_INVALID_OPERATION This method cannot be used for the recurrence exception of the recurring event. @n\r
* @param[in] todo The CalTodo ID to remove\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The specified recordId is #INVALID_RECORD_ID.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] todoId The CalTodo ID to remove\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified input parameter is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] event The CalEvent instance to update\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c recordId is #INVALID_RECORD_ID. @n\r
- * - The specified @c event is not #RECORD_TYPE_EVENT. @n\r
- * - The specified @c event is not an entry type instance. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified recordId is #INVALID_RECORD_ID.\r
+ * - The specified @c event is not #RECORD_TYPE_EVENT.\r
+ * - The specified @c event is not an entry type instance.\r
* - The date of the event is invalid. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @param[in] todo The CalTodo instance to update\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c recordId is #INVALID_RECORD_ID, or the date of the to-do item is invalid. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified recordId is #INVALID_RECORD_ID.\r
+ * - The date of the to-do item is invalid. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] eventId The event ID to find\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c eventId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] todoId The ID of the to-do to find\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c todoId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified record is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list of all the matched CalTodo instances, @n\r
+ * @return The list of all the matched CalTodo instances, @n\r
* else an empty list if there is no matched to-do item @n\r
* The items are sorted by due date.\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
* The default priority value is #TODO_PRIORITY_ALL that means all the priorities are returned.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
- * - The start time is later than the end date. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The start time is later than the end date.\r
* - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @page CompCalendarbookGetTodosNPage Compatibility for GetTodosN()\r
* @section CompCalendarbookGetTodosNPageIssueSection Issues\r
* Implementing this method in OSP compatible applications has the following issues: @n\r
- * -# If the start date of a to-do is not in the time range of start/end parameters, @n\r
+ * -# If the start date of a to-do is not in the time range of the start/end parameters, @n\r
* the to-do is not retrieved even though the due date is in the time range.\r
*\r
* @section CompCalendarbookGetTodosNPageSolutionSection Resolutions\r
* This issue has been resolved in Tizen. @n\r
- * -# The to-do will be retrieved if the due date is in the range of start/end parameters.\r
+ * -# The to-do is retrieved if the due date is in the range of the start/end parameters.\r
* @endif\r
*/\r
\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
* @return The total number of to-dos, @n\r
- * else @c -1 if an exception occurs\r
+ * else @c -1 if an exception occurs\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] status The to-do status @n\r
* The default priority value is #TODO_PRIORITY_ALL that means all the priorities are returned.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The start time is later than the end date. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The start time is later than the end date.\r
* - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @page CompCalendarbookGetTodoCountPage Compatibility for GetTodoCount()\r
* @section CompCalendarbookGetTodoCountPageIssueSection Issues\r
* Implementing this method in OSP compatible applications has the following issues: @n\r
- * -# If the start date of a to-do is not in the time range of start/end parameters, @n\r
+ * -# If the start date of a to-do is not in the time range of the start/end parameters, @n\r
* the to-do is not counted even though the due date is in the time range.\r
*\r
* @section CompCalendarbookGetTodoCountPageSolutionSection Resolutions\r
* This issue has been resolved in Tizen. @n\r
- * -# The to-do will be counted if the due date is in the range of start/end parameters.\r
+ * -# The to-do is counted if the due date is in the range of the start/end parameters.\r
* @endif\r
*/\r
\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all of the matched CalEvent instances, @n\r
+ * @return The list that contains all of the matched CalEvent instances, @n\r
* else an empty list if there are no matched instances, or @c null if an exception occurs @n\r
* The results are listed in the following order: all day events, and other events. @n\r
* The results with the same property of all day event are ordered by their start time.\r
* The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
- * - The specified @c category is invalid. @n\r
- * - The start time is later than the end date. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The specified @c category is invalid.\r
+ * - The start time is later than the end date.\r
* - The start or end time is out of the valid range. @n\r
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*\r
* @return An error code\r
* @param[in] start The start of the time range. @n Any value with a unit that is less than a second is ignored.\r
- * @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
+ * @param[in] end The end of the time range. @n Any value with a unit that is less than a second is ignored.\r
* @param[in] timeZone The time zone of the specified start and end times\r
* @param[in] pageNo The page number of the result list @n\r
- * It starts from @c 1.\r
+ * It starts from @c 1.\r
* @param[in] countPerPage The desired maximum count of the result items per page\r
* @param[in] category The event category @n\r
- * If a specific category is set, the events that have the specified @c category are returned. @n\r
- * The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\r
- * @param[out] reqId The ID of the request\r
+ * If a specific category is set, the events that have the specified @c category are returned. @n\r
+ * The default category value is #EVENT_CATEGORY_ALL, which means all the categories are returned.\r
+ * @param[out] reqId The ID of the request\r
* @param[in] listener The listener for receiving the responses of the request\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The specified @c pageNo or @c countPerPage is less than @c 1. @n\r
- * - The specified @c category is invalid. @n\r
- * - The start time is later than the end date. @n\r
- * - The start or end time is out of the valid range. @n\r
- * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c pageNo or @c countPerPage is less than @c 1.\r
+ * - The specified @c category is invalid.\r
+ * - The start time is later than the end date.\r
+ * - The start or end time is out of the valid range. @n\r
+ * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks IRecordListener::OnRecordsReceivedN(), Calendarbook::GetEventInstancesN()\r
* @endif\r
const IRecordListener& listener) const;\r
\r
/**\r
- * Gets all events.\r
+ * Gets all the events.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the CalEvent instances, @n\r
+ * @return The list that contains all the CalEvent instances, @n\r
* else an empty list if there are no events, or @c null if an exception occurs @n\r
* The results are listed in the order of their event ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllEventsN(void) const;\r
\r
/**\r
- * Gets all to-dos.\r
+ * Gets all the to-dos.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the CalTodo instances, @n\r
+ * @return The list that contains all the CalTodo instances, @n\r
* else an empty list if there are no to-dos, or @c null if an exception occurs @n\r
* The results are listed in the order of their to-do ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllTodosN(void) const;\r
\r
/**\r
- * Gets all calendars.\r
+ * Gets all the calendars.\r
*\r
* @since 2.0\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing all the Calendar instances, @n\r
+ * @return The list that contains all the Calendar instances, @n\r
* else an empty list if there are no calendars, or @c null if an exception occurs @n\r
* The results are listed in the order of their calendar ID.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetAllCalendarsN(void) const;\r
\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list containing the CalEventChangeInfo instances, @n\r
+ * @return The list that contains the CalEventChangeInfo instances, @n\r
* else an empty list if there are no events, or @c null if an exception occurs @n\r
* The results are listed in the order of their version.\r
* @param[in] version The version\r
* @param[out] latestVersion The latest change version among the changed events\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c version is invalid.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetChangedEventsAfterN(int version, int& latestVersion) const;\r
\r
* @param[out] latestVersion The latest change version among the changed to-dos\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The specified @c version is invalid.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
Tizen::Base::Collection::IList* GetChangedTodosAfterN(int version, int& latestVersion) const;\r
\r
* @privilege %http://tizen.org/privilege/calendar.write\r
*\r
* @return An error code\r
- * @param[in,out] calendar The calendar to add\r
+ * @param[in,out] calendar The calendar to add\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The record ID of the calendar is not #INVALID_RECORD_ID.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The calendar's recordId is not #INVALID_RECORD_ID.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] accountId The account Id\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The record ID of the calendar is not #INVALID_RECORD_ID. @n\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The calendar's recordId is not #INVALID_RECORD_ID.\r
* - The specified @c accountId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified account is not found.\r
* @exception E_STORAGE_FULL The storage is insufficient.\r
* @param[in] calendarId The calendar ID to remove\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c calendarId is invalid, or\r
- * the calendar represents default calendar.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c calendarId is invalid.\r
+ * - The calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] calendar The Calendar instance to update\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The calendar's recordId is #INVALID_RECORD_ID, or\r
- * the calendar represents default calendar.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The calendar's recordId is #INVALID_RECORD_ID.\r
+ * - The calendar represents default calendar.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*/\r
* @param[in] calendarId The calendar ID\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c calendarId is invalid.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG The specified @c calendarId is invalid.\r
* @exception E_OBJ_NOT_FOUND The specified calendar is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
+ * @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Calendar* GetCalendarN(RecordId calendarId) const;\r
\r
*\r
* @return An error code\r
* @param[in] eventInstance The event instance to remove @n\r
- * The @c eventInstance must be an instance of the recurring event.\r
+ * The @c eventInstance must be an instance of the recurring event.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_INVALID_ARG The instance is invalid.\r
- * @exception E_OBJ_NOT_FOUND The original event of the @c eventInstance is not found.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the specified @c eventInstance is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The instance's start time is added to the recurrence of original event as exception date.\r
*/\r
* In order to update an event instance, you should use copy of its original event(@ref CalEventInstance::GetOriginalEventId()). @n\r
* You can modify the properties of copy of the original event and use it as the second parameter of this method. @n\r
* (The start/end time of the original event should be set with the start/end time of the event instance.) @n\r
- * This method adds the modified copy of the original event as a new event. Therefore the new event ID will be assigned to it through @c event's record ID @n\r
+ * This method adds the modified copy of the original event as a new event. Therefore the new event ID will be assigned to it through event's record ID @n\r
* and its existing event ID inside the modified copy of the original event will become the base event ID of the new event. @n\r
* However this method only updates the properties of the event, does not add a new event that is already added.\r
*\r
* @param[in,out] event The modified copy of the original event @n\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.\r
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
- * - The instance is invalid. @n\r
- * - @c event is not referring to the original event.\r
- * @exception E_OBJ_NOT_FOUND The original event of the @c eventInstance is not found.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The instance is invalid.\r
+ * - The specified @c event is not referring to the original event.\r
+ * @exception E_OBJ_NOT_FOUND The original event of the specified @c eventInstance is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
*\r
* @code\r
* @return The latest version\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/calendar.read\r
*\r
- * @return A list of searched results (the list of CalEvent, CalTodo, Calendar, or CalEventInstance), @n\r
- * else an empty list if there is no searched result, or @c null if an exception occurs\r
- * @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter will be searched.\r
+ * @return The list of searched results (the list of CalEvent, CalTodo, Calendar, or CalEventInstance), @n\r
+ * else an empty list if there is no searched result, or @c null if an exception occurs\r
+ * @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter are searched.\r
* @param[in] propertySortedBy The property for sorting @n The searched results are ordered by the values of this property.\r
* @param[in] sortOrder The order for sorting\r
- * @param[in] offset The offset of the searched results @n If this value is @c 0, it will be ignored.\r
- * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it will be ignored.\r
+ * @param[in] offset The offset of the searched results @n If this value is @c 0, it is ignored.\r
+ * @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it is ignored.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
- * @exception E_INVALID_ARG The specified @c offset or @c maxCount is less than 0, or the @c propertySortedBy is not an element of the enumerator that corresponds with the type of the specified @c filter.\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c offset or @c maxCount is less than 0.\r
+ * - The specified @c propertySortedBy is not an element of the enumerator that corresponds to the type of the specified @c filter.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
* @see EventFilterProperty\r
* @see TodoFilterProperty\r
* @see CalendarFilterProperty\r
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter will be searched.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1\r
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
*\r
* @since 2.0\r
*\r
- * @return A list containing the CalEvent instances, @n\r
+ * @return The list that contains the CalEvent instances, @n\r
* else an empty list if there are no events, or @c null if an exception occurs\r
* @param[in] vCalFilePath The path of the vCalendar file\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.\r
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.\r
* @exception E_FILE_NOT_FOUND The specified vCalendar file is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
static Tizen::Base::Collection::IList* ParseEventsFromVcalendarN(const Tizen::Base::String& vCalFilePath);\r
\r
*\r
* @since 2.0\r
*\r
- * @return A list containing the CalTodo instances, @n\r
+ * @return The list that contains the CalTodo instances, @n\r
* else an empty list if there are no to-dos, or @c null if an exception occurs\r
* @param[in] vCalFilePath The path of the vCalendar file\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.\r
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.\r
* @exception E_FILE_NOT_FOUND The specified vCalendar file is not found.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method.\r
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
- * E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is\r
+ * @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer\r
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
static Tizen::Base::Collection::IList* ParseTodosFromVcalendarN(const Tizen::Base::String& vCalFilePath);\r
\r
* @param[in] eventList The event list to export @n The list should contain CalEvent instances.\r
* @param[in] vCalFilePath The vCalendar file path\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_INVALID_ARG The specified @c eventList is invalid or\r
- * the specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access of vCalFilePath is denied due to insufficient permission.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c eventList is invalid.\r
+ * - The specified @c vCalFilePath is invalid.\r
+ * @exception E_ILLEGAL_ACCESS The access of the specified @c vCalFilePath is denied due to insufficient permission.\r
* @exception E_FILE_ALREADY_EXIST The vCalendar file already exists.\r
* @exception E_STORAGE_FULL The disk space is full.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @param[in] todoList The to-do list to export @n The list should contain CalTodo instances.\r
* @param[in] vCalFilePath The vCalendar file path\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_INVALID_ARG The specified @c todoList is invalid or\r
- * the specified @c vCalFilePath is invalid.\r
- * @exception E_ILLEGAL_ACCESS Access of vCalFilePath is denied due to insufficient permission.\r
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:\r
+ * - The specified @c todoList is invalid.\r
+ * - The specified @c vCalFilePath is invalid.\r
+ * @exception E_ILLEGAL_ACCESS The access of the specified @c vCalFilePath is denied due to insufficient permission.\r
* @exception E_FILE_ALREADY_EXIST The vCalendar file already exists.\r
* @exception E_STORAGE_FULL The disk space is full.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
// limitations under the License.
//
/**
- * @file FSclCalendarbookFilter.h
+ * @file FSclCalendarbookFilter.h
* @brief This is the header file for the %CalendarbookFilter class.
*
* This header file contains the declarations of the %CalendarbookFilter class.
/**
* @class CalendarbookFilter
- * @brief This class represents the condition for searching the specific item on calendarbook.
+ * @brief This class represents the condition for searching a specific item on a calendarbook.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %CalendarbookFilter class represents the condition for searching the specific item on calendarbook.
+ * The %CalendarbookFilter class represents the condition for searching a specific item on a calendarbook.
* The type of the filter decides which item will be searched (such as events, to-dos, calendars, all day event instances, or non-all day event instances). @n
* The filter can consist of multiple filtering expressions and conjunctive operators.
* A filtering expression consists of a filter property, comparison operator and value.
- * The filter property must be an element of the enumerator that corresponds with the type of the filter. @n
+ * The filter property must be an element of the enumerator that corresponds to the type of the filter. @n
* <table border=1>
* <tr>
* <th> Filter type </th>
* @code
*
//search condition: (calendarId=3 OR calendarId=4) AND (subject LIKE '%meeting%')
- CalendarbookFilter subFilter(CB_FI_TYPE_EVENT);
- subFilter.AppendInt(FI_CONJ_OP_NONE, EVENT_FI_PR_CALENDAR_ID, FI_CMP_OP_EQUAL, 3);
+ CalendarbookFilter subFilter(CB_FILTER_TYPE_EVENT);
+ subFilter.AppendInt(FI_CONJ_OP_NONE, EVENT_FI_PR_CALENDAR_ID, FI_CMP_O_EQUAL, 3);
subFilter.AppendInt(FI_CONJ_OP_OR, EVENT_FI_PR_CALENDAR_ID, FI_CMP_OP_EQUAL, 4);
CalendarbookFilter mainFilter(CB_FI_TYPE_EVENT);
*
* @since 2.0
*
- * @param[in] type The type of the filter @n It decides the type of item to search.
+ * @param[in] type The type of the filter @n It decides the type of item to search.
*/
explicit CalendarbookFilter(CalendarbookFilterType type);
virtual int GetHashCode(void) const;
/**
- * Appends the filtering expression for the integer value. @n
+ * Appends the filtering expression for an integer value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The integer value for comparison
+ * @param[in] value The integer value for comparison
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The @c filterProperty is not for integer value. @n
- * - The specified @c conjunctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The specified @c filterProperty is not an integer value.
+ * - The specified @c conjunctiveOperator is invalid.
*/
result AppendInt(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, int value);
/**
- * Appends the filtering expression for the double value. @n
+ * Appends the filtering expression for a double value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The double value for comparison
+ * @param[in] value The double value for comparison
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The @c filterProperty is not for double value. @n
- * - The specified @c conjunctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The specified @c filterProperty is not a double value.
+ * - The specified @c conjunctiveOperator is invalid.
*/
result AppendDouble(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, double value);
/**
- * Appends the filtering expression for the bool value. @n
+ * Appends the filtering expression for a @c bool value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator FILTER_COMPARISON_OPERATOR_EQUAL is only permitted
- * @param[in] value The bool value for comparison
+ * @param[in] value The @c bool value for comparison
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The @c filterProperty is not for bool value. @n
- * - The specified @c conjunctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The specified @c filterProperty is not a @c bool value.
+ * - The specified @c conjunctiveOperator is invalid.
*/
result AppendBool(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, bool value);
/**
- * Appends the filtering expression for the Tizen::Base::DateTime value. @n
+ * Appends the filtering expression for a Tizen::Base::DateTime value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The Tizen::Base::DateTime value for comparison. @n Any value with a unit that is less than a second is ignored.
+ * @param[in] value The Tizen::Base::DateTime value for comparison. @n Any value with a unit that is less than a second is ignored.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter.
- * - The @c filterProperty is not for Tizen::Base::DateTime value.
- * - The specified @c conjunctiveOperator is invalid.
- * - The specified @c value is out of the valid range.
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The specified @c filterProperty is not a Tizen::Base::DateTime value.
+ * - The specified @c conjunctiveOperator is invalid.
+ * - The specified @c value is out of the valid range.
*/
result AppendDateTime(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, const Tizen::Base::DateTime& value);
/**
- * Appends the filtering expression for the Tizen::Base::String value. @n
+ * Appends the filtering expression for a Tizen::Base::String value. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expression in parentheses and appends it. @n
* The filtering expression consists of the filter property, comparison operator, and value.
- * The specified @c filterProperty must be an element of the enumerator that corresponds with the type of this filter.
+ * The specified @c filterProperty must be an element of the enumerator that corresponds to the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filterProperty The filter property
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filterProperty The filter property
* @param[in] comparisonOperator The comparison operator
- * @param[in] value The Tizen::Base::String value for matching
+ * @param[in] value The Tizen::Base::String value for matching
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n
- * - The @c filterProperty is not for Tizen::Base::String value. @n
- * - The specified @c conjunctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filterProperty is not an element of the enumerator that corresponds to the type of this filter.
+ * - The specified @c filterProperty is not a Tizen::Base::String value.
+ * - The specified @c conjunctiveOperator is invalid.
*/
result AppendString(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterStringOperator comparisonOperator, const Tizen::Base::String& value);
* Appends the filter. @n
* Firstly, this method appends the conjunctive operator.
* Then, this method puts the filtering expressions of the specified filter in parentheses and appends it. @n
- * The type of the specified @c filter must be same with the type of this filter.
+ * The type of the specified @c filter must be same as the type of this filter.
*
* @since 2.0
*
* @return The error code
* @param[in] conjunctiveOperator The conjunctive operator to append the filtering expression @n
- * If there is no filtering expression or filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
- * @param[in] filter The filter to append
+ * If there is no filtering expression or the filter has been appended before, FI_CONJ_OP_NON must be used. Otherwise FI_CONJ_OP_AND or FI_CONJ_OP_OR can be used.
+ * @param[in] filter The filter to append
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The type of the specified @c filter is not same with the type of this filter. @n
- * - The specified @c filter is empty. @n
- * - The specified @c conjunctiveOperator is invalid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The type of the specified @c filter is not same as the type of this filter.
+ * - The specified @c filter is empty.
+ * - The specified @c conjunctiveOperator is invalid.
*/
result AppendFilter(FilterConjunctiveOperator conjunctiveOperator, const CalendarbookFilter& filter);
*
* @since 2.0
*
- * @param [in] rhs An instance of %Category
+ * @param [in] rhs An instance of %Category to copy
*/
Category(const Category& rhs);
* @since 2.0
*
* @return An error code
- * @param [in] contactId The contact ID
- * @exception E_SUCCESS The method is successful.
+ * @param [in] contactId The contact ID
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The specified @c contactId is already a member of this category.
* @exception E_INVALID_ARG The specified @c contactId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @deprecated This method is deprecated. Instead of using this method, use Addressbook::GetCategoriesByContactN().
* @since 2.0
*
- * @return @c true if the category contains the specified contact, @n
+ * @return @c true if the category contains the specified contact, @n
* else @c false
* @param [in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param [in] contactId The contact ID
+ * @param [in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contactId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* For more information, see @ref CompCategorySetNamePage "here".
* @endif
*
- * @return An error code
- * @param [in] name The category name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c name is an empty string.
+ * @return An error code
+ * @param [in] name The category name
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c name is an empty string.
* @exception E_INVALID_OPERATION This category is a read-only category.
* @remarks It is not allowed to change the name of a read-only category.
* @see GetName()
* @if OSPCOMPAT
* @page CompCategorySetNamePage Compatibility for SetName()
* @section CompCategorySetNamePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the category name to be set is greater than 100 characters, E_INVALID_ARG is returned.
- * -# if the category is a default category, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the category name to be set is greater than 100 characters, @c E_INVALID_ARG is returned.
+ * -# if the category is a default category, @c E_INVALID_ARG is returned.
*
* @section CompCategorySetNamePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param [in] filePath The file path of the ringtone
- * @exception E_SUCCESS The method is successful.
+ * @param [in] filePath The file path of the ringtone
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c filePath exceeds system limitations.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @see GetRingtonePath()
Tizen::Base::String GetRingtonePath(void) const;
/**
- * Checks whether this category is a default category or not. @n
+ * Checks whether this category is a default category . @n
*
* @since 2.0
*
bool IsDefault(void) const;
/**
- * Checks whether this category is read-only or not. @n
+ * Checks whether this category is read-only. @n
* If a category is default, it is not possible to update the category name and delete the category.
- * However it is possible to add or remove contacts and change thumbnail and ringtone.
+ * However it is possible to add or remove contacts and change the thumbnail and ringtone.
*
* @since 2.1
*
* @since 2.2
*
* @return The key-value map of the extended data where the key and value are of type Tizen::Base::String, @n
- * else and empty map if there is no extra data, or @c null if an exception occurs.
+ * else an empty map if there is no extra data, or @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IMap* GetExtraDataN(void) const;
*
* @since 2.0
*
- * @param [in] rhs An instance of %Category
+ * @param [in] rhs An instance of %Category to copy
*/
Category& operator =(const Category& rhs);
/**
* @class CategoryChangeInfo
- * @brief This class provides a category change information.
+ * @brief This class provides the category change information.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %CategoryChangeInfo class provides a category change information.
+ * The %CategoryChangeInfo class provides the category change information.
*
*/
class _OSP_EXPORT_ CategoryChangeInfo
*
* @since 2.0
*
- * @param[in] rhs An instance of %CategoryChangeInfo
+ * @param[in] rhs An instance of %CategoryChangeInfo to copy
*/
CategoryChangeInfo(const CategoryChangeInfo& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %CategoryChangeInfo
+ * @param[in] rhs An instance of %CategoryChangeInfo to copy
*/
CategoryChangeInfo& operator =(const CategoryChangeInfo& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Contact
+ * @param[in] rhs An instance of %Contact to copy
*/
Contact(const Contact& rhs);
/**
* @if OSPDEPREC
- * Gets the @c Tizen::Graphics::Bitmap object of the thumbnail image. @n
+ * Gets the Tizen::Graphics::Bitmap object of the thumbnail image. @n
* If the thumbnail is not set, @c null is returned.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, use GetThumbnailPath()
* @since 2.0
*
- * @return The @c Tizen::Graphics::Bitmap object of the thumbnail image
+ * @return The Tizen::Graphics::Bitmap object of the thumbnail image
* @exception E_SUCCESS The method is successful.
* @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
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompIoPathPage "here".
+ * For more information, see @ref CompIoPathPage "here".
* @endif
*
* @return An error code
- * @param[in] filePath The file path of the thumbnail image
- * @exception E_SUCCESS The method is successful.
+ * @param[in] filePath The file path of the thumbnail image
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c filePath exceeds system limitations.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @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.
* @see GetThumbnailPath()
*/
result SetThumbnail(const Tizen::Base::String& filePath);
/**
- * Sets the value of the property having the specified ID to the specified value.
+ * Sets the value of the property having the specified ID, to the specified value.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompContactSetValuePage "here".
* @endif
*
- * @return An error code
- * @param[in] id The ID of the property whose value is to set
- * @param[in] value A new string value to set
+ * @return An error code
+ * @param[in] id The ID of the property whose value is set
+ * @param[in] value The new string value to set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c id is #CONTACT_PROPERTY_ID_DISPLAY_NAME or @if OSPDEPREC #CONTACT_PROPERTY_ID_THUMBNAIL, or @endif
+ * @exception E_INVALID_ARG The specified @c id is #CONTACT_PROPERTY_ID_DISPLAY_NAME, @if OSPDEPREC #CONTACT_PROPERTY_ID_THUMBNAIL, or @endif
* the ringtone file path (value) is invalid if @c id is #CONTACT_PROPERTY_ID_RINGTONE.
* @remarks
* - The #CONTACT_PROPERTY_ID_DISPLAY_NAME property cannot be set. @n
* @if OSPCOMPAT
* @page CompContactSetValuePage Compatibility for SetValue()
* @section CompContactSetValuePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the length of the value is greater than the maximum length of the specified property, E_INVALID_ARG is returned.
- * -# The path should begin with an allowed path prefix such as @b '/Home', @b '/Home/Share', @b '/Res', @b '/Share/[@e appid]',
- * @b '/Media', and @b '/Storagecard/Media'.
+ * Implementing this method in OSP compatible applications has the following issues: @n
+ * -# If the length of the value is greater than the maximum length of the specified property, @c E_INVALID_ARG is returned.
+ * -# The path should begin with an allowed path prefix such as @b '/Home', @b '/Home/Share', @b '/Res', @b '/Share/[@e appid]',
+ * @b '/Media', and @b '/Storagecard/Media'.
*
* @section CompContactSetValuePageSolutionSection Resolutions
* -# The first issue mentioned above has been resolved in Tizen.
- * -# There are no specific allowed path prefixes. Applications can obtain accessible directory path using the following methods. @n
+ * -# There are no specific allowed path prefixes. Applications can obtain an accessible directory path using the following methods. @n
* - For accessing its own data directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"data" @n
* or Tizen::App::App::GetInstance()->GetAppDataPath().
* - For accessing its own resource directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"res". @n
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the property whose value is to set
+ * @param[in] id The ID of the property whose value is set
* @param[in] value An instance of Tizen::Base::DateTime value to set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The property with the specified contact property ID is not of Tizen::Base::DateTime type, or
- * the property is read-only.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The property with the specified contact property ID is not of Tizen::Base::DateTime type.
+ * - The property is read-only.
* @if OSPDEPREC
* @remarks
- * - In case @c id is set to #CONTACT_PROPERTY_ID_BIRTHDAY, @n
- * - If this contact has events whose types are #CONTACT_EVENT_TYPE_BIRTHDAY, the date value of the first event among them is set to the @c value. @n
- * - If not, a new event whose type is #CONTACT_EVENT_TYPE_BIRTHDAY is added to this contact. @n
- * - In case @c id is set to #CONTACT_PROPERTY_ID_ANNIVERSARY, @n
- * - If this contact has events whose types are #CONTACT_EVENT_TYPE_ANNIVERSARY, the date value of the first event among them is set to the @c value. @n
- * - If not, a new event whose type is #CONTACT_EVENT_TYPE_ANNIVERSARY is added to this contact. @n
+ * - In case @c id is set to #CONTACT_PROPERTY_ID_BIRTHDAY,
+ * - If this contact has events whose types are #CONTACT_EVENT_TYPE_BIRTHDAY, the date value of the first event among them is set to the @c value.
+ * - If not, a new event whose type is #CONTACT_EVENT_TYPE_BIRTHDAY is added to this contact.
+ * - In case @c id is set to #CONTACT_PROPERTY_ID_ANNIVERSARY,
+ * - If this contact has events whose types are #CONTACT_EVENT_TYPE_ANNIVERSARY, the date value of the first event among them is set to the @c value.
+ * - If not, a new event whose type is #CONTACT_EVENT_TYPE_ANNIVERSARY is added to this contact.
* @endif
*/
result SetValue(ContactPropertyId id, const Tizen::Base::DateTime& value);
* @since 2.0
*
* @return An error code
- * @param[in] id The property ID
+ * @param[in] id The property ID
* @param[out] value The property value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified contact property ID is not supported.
+ * @exception E_INVALID_ARG The specified contact property ID is not supported.
*/
result GetValue(ContactPropertyId id, Tizen::Base::String& value) const;
/**
* Gets the value of the specified Tizen::Base::DateTime property such as birthday. @n
- * If the Tizen::Base::DateTime value has not been set for the specified property, the property has value, '1899, 12, 31, 00:00:00'.
+ * If the %Tizen::Base::DateTime value has not been set for the specified property, the property has a value, '1899, 12, 31, 00:00:00'.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The property ID
+ * @param[in] id The property ID
* @param[out] value The property value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified contact property ID is not supported.
+ * @exception E_INVALID_ARG The specified contact property ID is not supported.
*/
result GetValue(ContactPropertyId id, Tizen::Base::DateTime& value) const;
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] phoneNumber An instance of PhoneNumber to set, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] email An instance of Email
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c email is empty.
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] url An instance of Url
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c url is empty.
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] address An instance of Address
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c address is empty.
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] imAddress An instance of ImAddress
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c imAddress is empty.
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
- * @param[in] note The note to set
- * @exception E_SUCCESS The method is successful.
+ * @param[in] index The index at which to set the value
+ * @param[in] note The note to set
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c note is empty.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
- * @param[in] nickname The nick name to set
- * @exception E_SUCCESS The method is successful.
+ * @param[in] index The index at which to set the value
+ * @param[in] nickname The nick name to set
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c nickname is empty.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
- * @param[in] event The event to set
- * @exception E_SUCCESS The method is successful.
+ * @param[in] index The index at which to set the value
+ * @param[in] event The event to set
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The date of the specified @c event has not been set.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
* @since 2.0
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] organization The organization to set
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c organization is empty.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
* @since 2.1
*
* @return An error code
- * @param[in] index An index to set the value
+ * @param[in] index The index at which to set the value
* @param[in] relationship The relationship to set
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c relationship is empty.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
result SetRelationshipAt(int index, const Relationship& relationship);
/**
- * Sets the app launch data at a specified index.
+ * Sets the app launch data at the specified index.
*
* @since 2.2
*
*
* @return An error code
- * @param[in] index An index to set the contact app launch data
+ * @param[in] index The index at which to set the contact app launch data
* @param[in] appLaunchData The app launch data to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c appLaunchData has no relevant information.
PersonId GetPersonId(void) const;
/**
- * Gets a list of the values belonging to the specific multi value property.
+ * Gets the list of values belonging to the specific multi value property.
*
* @since 2.0
*
- * @return A list of the values belonging to the specific multi value property
- * @param[in] id A property ID
+ * @return The list of values belonging to the specific multi value property
+ * @param[in] id The property ID
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An error code
- * @param[in] phoneNumber The phone number to add
- * @exception E_SUCCESS The method is successful.
+ * @param[in] phoneNumber The phone number to add
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c phoneNumber is empty.
*/
result AddPhoneNumber(const PhoneNumber& phoneNumber);
* @since 2.0
*
* @return An error code
- * @param[in] email The mail address to add
- * @exception E_SUCCESS The method is successful.
+ * @param[in] email The email address to add
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c email is empty.
*/
result AddEmail(const Email& email);
* @since 2.0
*
* @return An error code
- * @param[in] url The URL to add
- * @exception E_SUCCESS The method is successful.
+ * @param[in] url The URL to add
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c url is empty.
*/
result AddUrl(const Url& url);
* @since 2.0
*
* @return An error code
- * @param[in] address The address to add
- * @exception E_SUCCESS The method is successful.
+ * @param[in] address The address to add
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c address is empty.
*/
result AddAddress(const Address& address);
* @since 2.0
*
* @return An error code
- * @param[in] imAddress The IM address to add
- * @exception E_SUCCESS The method is successful.
+ * @param[in] imAddress The IM address to add
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c imAddress is empty.
*/
result AddImAddress(const ImAddress& imAddress);
* @return An error code
* @param[in] note The note to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c note is empty.
+ * @exception E_INVALID_ARG The specified @c note is empty.
*/
result AddNote(const Tizen::Base::String& note);
* @return An error code
* @param[in] nickname The nick name to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c nickname is empty.
+ * @exception E_INVALID_ARG The specified @c nickname is empty.
*/
result AddNickname(const Tizen::Base::String& nickname);
* @return An error code
* @param[in] event The event to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The date of the specified @c event has not been set.
+ * @exception E_INVALID_ARG The date of the specified @c event has not been set.
*/
result AddEvent(const ContactEvent& event);
*
* @return An error code
* @param[in] organization The organization to add
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c organization is empty.
*/
result AddOrganization(const Organization& organization);
*
* @return An error code
* @param[in] relationship The relationship to add
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c organization is empty.
*/
result AddRelationship(const Relationship& relationship);
/**
- * Adds a specified app launch data to the contact.
+ * Adds the specified app launch data to the contact.
*
* @since 2.2
*
* @return An error code
* @param[in] appLaunchData The app launch data to add
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c appLaunchData has no relevant information.
*/
result AddContactAppLaunchData(const ContactAppLaunchData& appLaunchData);
/**
- * Removes the specific value at the specified index of the multi value property.
+ * Removes the value at the specified index of the multi value property.
*
* @since 2.0
*
* @return An error code
- * @param[in] id A property ID
+ * @param[in] id The property ID
* @param[in] index The index of the value to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
+ * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*/
result RemoveAt(ContactMultiPropertyId id, int index);
/**
- * Checks whether this contact is a favorite or not.
+ * Checks whether this contact is a favorite.
*
* @since 2.1
*
* @return @c true if this contact is a favorite, @n
- * else @c false
+ * else @c false
* @see SetAsFavorite()
*/
bool IsFavorite(void) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %Contact
+ * @param[in] rhs An instance of %Contact to copy
*/
Contact& operator =(const Contact& rhs);
* @final This class is not intended for extension.
*
* The %ContactAppLaunchData class provides the information required to launch an application from a contact.
- * This information consists of application ID, operation ID, MIME type, URI, display text, and extra data.
+ * This information consists of the application ID, operation ID, MIME type, URI, display text, and extra data.
*/
class _OSP_EXPORT_ ContactAppLaunchData
*
* @since 2.1
*
- * @param[in] rhs An instance of %ContactAppLaunchData
+ * @param[in] rhs An instance of %ContactAppLaunchData to copy
*/
ContactAppLaunchData(const ContactAppLaunchData& rhs);
virtual ~ContactAppLaunchData(void);
/**
- * Checks whether the value of a specified instance is equal to the value of the current instance of Tizen::Base::Object.
+ * Checks whether the value of the specified instance is equal to the value of the current instance of Tizen::Base::Object.
*
* @since 2.1
*
* @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;
Tizen::Base::String GetDisplayText(void) const;
/**
- * Gets an application ID.
+ * Gets the application ID.
*
* @since 2.1
*
- * @return An application ID
+ * @return The application ID
*/
Tizen::Base::String GetAppId(void) const;
/**
- * Gets an operation ID.
+ * Gets the operation ID.
*
* @since 2.1
*
- * @return An operation ID
+ * @return The operation ID
*/
Tizen::Base::String GetOperationId(void) const;
*
* @since 2.1
*
- * @return The URI of an application
+ * @return The URI of the application
*/
Tizen::Base::String GetUri(void) const;
*
* @since 2.1
*
- * @return The MIME type of an application
+ * @return The MIME type of the application
*/
Tizen::Base::String GetMime(void) const;
void SetDisplayText(const Tizen::Base::String& displayText);
/**
- * Sets an application ID.
+ * Sets the application ID.
*
* @since 2.1
*
void SetAppId(const Tizen::Base::String& appId);
/**
- * Sets an operation ID.
+ * Sets the operation ID.
*
* @since 2.1
*
*
* @since 2.1
*
- * @param[in] uri The URI of an application to set
+ * @param[in] uri The URI of the application to set
*/
void SetUri(const Tizen::Base::String& uri);
*
* @since 2.1
*
- * @param[in] mime The MIME type of an application to set
+ * @param[in] mime The MIME type of the application to set
*/
void SetMime(const Tizen::Base::String& mime);
*
* @since 2.1
*
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key and value is of type Tizen::Base::String @n
- * If @c null is passed, the current extra data is removed.
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair where the key and value are of type Tizen::Base::String @n
+ * If @c null is passed, the current extra data is removed.
*/
result SetExtraData(const Tizen::Base::Collection::IMap* pExtraData);
*
* @since 2.1
*
- * @param[in] rhs An instance of %ContactAppLaunchData
+ * @param[in] rhs An instance of %ContactAppLaunchData to copy
*/
ContactAppLaunchData& operator =(const ContactAppLaunchData& rhs);
/**
* @class ContactChangeInfo
- * @brief This class provides a contact change information.
+ * @brief This class provides the contact change information.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %ContactChangeInfo class provides a contact change information.
+ * The %ContactChangeInfo class provides the contact change information.
*
*/
class _OSP_EXPORT_ ContactChangeInfo
*
* @since 2.0
*
- * @param[in] rhs An instance of %ContactChangeInfo
+ * @param[in] rhs An instance of %ContactChangeInfo to copy
*/
ContactChangeInfo(const ContactChangeInfo& rhs);
RecordChangeType GetChangeType(void) const;
/**
- * Checks whether the thumbnail has been changed or not.
+ * Checks whether the thumbnail has been changed.
*
* @since 2.1
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %ContactChangeInfo
+ * @param[in] rhs An instance of %ContactChangeInfo to copy
*/
ContactChangeInfo& operator =(const ContactChangeInfo& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %ContactEvent
+ * @param[in] rhs An instance of %ContactEvent to copy
*/
ContactEvent(const ContactEvent& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
*
* @since 2.0
*
- * @return The type of the event
+ * @return The event type
*/
ContactEventType GetType(void) const;
*
* @since 2.0
*
- * @param[in] type The type of the event
+ * @param[in] type The event type
*/
void SetType(ContactEventType type);
*
* @since 2.0
*
- * @param[in] rhs An instance of %ContactEvent
+ * @param[in] rhs An instance of %ContactEvent to copy
*/
ContactEvent& operator =(const ContactEvent& rhs);
/**
* Initializes this instance of %Email with the specified @c type and @c email. @n
- * This constructs an instance of %Email of the specified @c type.
+ * This constructs an instance of %Email with the specified @c type.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %Email
+ * @param[in] rhs An instance of %Email to copy
*/
Email(const Email& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
* @if OSPCOMPAT
* @page CompEmailGetTypePage Compatibility for GetType()
* @section CompEmailGetTypePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# EMAIL_TYPE_CUSTOM is not supported. If the type of the email is EMAIL_TYPE_CUSTOM, EMAIL_TYPE_OTHER is returned instead.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# EMAIL_TYPE_CUSTOM is not supported. If the type of the email is EMAIL_TYPE_CUSTOM, EMAIL_TYPE_OTHER is returned instead.
*
* @section CompEmailGetTypePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* @if OSPCOMPAT
* @page CompEmailSetEmailPage Compatibility for SetEmail()
* @section CompEmailSetEmailPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of an email address to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of an email address to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompEmailSetEmailPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %Email
+ * @param[in] rhs An instance of %Email to copy
*/
Email& operator =(const Email& rhs);
bool operator ==(const Email& rhs) const;
/**
- * Checks whether the value of the specified instance of %Email does not equal the value of the current instance.
+ * Checks whether the value of the specified instance of %Email is not equal to the value of the current instance.
*
* @since 2.0
*
- * @return @c true if the value of the specified instance of %Email does not equal the value of the current instance, @n
+ * @return @c true if the value of the specified instance of %Email is not equal to the value of the current instance, @n
* else @c false
* @param[in] rhs An instance of %Email
*/
{
/**
* @class EmailContact
- * @brief This class provides summarized contact information with email.
+ * @brief This class provides the summarized contact information with the email.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %EmailContact class provides summarized contact information. @n
- * This provides part of contact information - ID, person ID, addressbook ID, display name, ringtone, thumbnail, and email.
+ * The %EmailContact class provides the summarized contact information. @n
+ * This provides part of the contact information such as the ID, person ID, addressbook ID, display name, ringtone, thumbnail, and email.
*/
class _OSP_EXPORT_ EmailContact
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %EmailContact
+ * @param[in] rhs An instance of %EmailContact to copy
*/
EmailContact(const EmailContact& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %EmailContact
+ * @param[in] rhs An instance of %EmailContact to copy
*/
EmailContact& operator =(const EmailContact& rhs);
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
// limitations under the License.
//
/**
-* @file FSclIAddressbookChangeEventListener.h
-* @brief This is the header file for the %IAddressbookChangeEventListener interface.
+* @file FSclIAddressbookChangeEventListener.h
+* @brief This is the header file for the %IAddressbookChangeEventListener interface.
*
* This header file contains the declarations of the %IAddressbookChangeEventListener interface.
*/
public:
/**
* This polymorphic destructor should be overridden if required. @n
- * This way, the destructors of the derived classes
- * are called when the destructor of this interface is called.
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
* @since 2.1
*
* @param[in] categoryChangeInfoList The list of category change information (@ref CategoryChangeInfo list)
- * @remarks This listener method is called when the following changes have occurred: @n
- * - Categories are added, updated, or removed
+ * @remarks This listener method is called when the following changes have occurred:
+ * - Categories are added, updated, or removed
*
* The following example demonstrates how to use the %OnCategoriesChanged() method.
* @code
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %IAddressbookEventListener interface is deprecated.
* @since 2.0
*
* @param[in] contactChangeInfoList The list of contact change information (@ref ContactChangeInfo list)
- * @remarks This listener method is called when the following changes have occurred: @n
- * - Contacts are added, updated, or removed
- * - Contacts are added/removed to/from categories
+ * @remarks This listener method is called when the following changes have occurred:
+ * - Contacts are added, updated, or removed
+ * - Contacts are added/removed to/from categories
*
* The following example demonstrates how to use the %OnContactsChanged() method.
* @code
* @since 2.0
*
* @param[in] categoryChangeInfoList The list of category change information (@ref CategoryChangeInfo list)
- * @remarks This listener method is called when the following changes have occurred: @n
- * - Categories are added, updated, or removed
- * - Contacts are added/removed to/from categories
+ * @remarks This listener method is called when the following changes have occurred:
+ * - Categories are added, updated, or removed
+ * - Contacts are added/removed to/from categories
*
* The following example demonstrates how to use the %OnCategoriesChanged() method.
* @code
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
/**
* @if OSPDEPREC
* @interface IRecordEventListener
- * @brief <i> [Deprecated] </i> This interface provides a listener that receives the events associated with the record.
+ * @brief <i> [Deprecated] </i> This interface provides a listener that receives the events associated with a record.
*
* @deprecated This interface is deprecated. Instead of using this listener, use IAddressbookEventListener or ICalendarbookEventListener.
*
* @since 2.0
*
- * The %IRecordEventListener interface provides a listener that receives the events associated with the record.
+ * The %IRecordEventListener interface provides a listener that receives the events associated with a record.
* @endif
*/
class _OSP_EXPORT_ IRecordEventListener
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %IRecordEventListener interface is deprecated. @n
- * Instead of using this listener, use IAddressbookEventListener or ICalendarbookEventListener.
+ * Instead of using this listener, use IAddressbookEventListener or ICalendarbookEventListener.
*
* @since 2.0
* @endif
* @brief <i> [Deprecated][Compatibility] </i>
* @endif
* @deprecated This method is deprecated because the %IRecordEventListener interface is deprecated. @n
- * Instead of using this listener, use IAddressbookEventListener or ICalendarbookEventListener.
+ * Instead of using this listener, use IAddressbookEventListener or ICalendarbookEventListener.
*
* @since 2.0
* @if OSPCOMPAT
* @param[in] record The Record instance that has changed @n
* If the eventType is #RECORD_REMOVED, the %Record instance only has @c recordId and @c recordType but no data. @n
* When multiple records have changed (#MULTI_RECORDS_ADDED, #MULTI_RECORDS_UPDATED, #MULTI_RECORDS_REMOVED),
- * the %Record instance is an invalid record instance with @c INVALID_RECORD_ID.
+ * the %Record instance is an invalid record instance with ::INVALID_RECORD_ID.
* @param[in] pUpdatedProperties This parameter is not supported, do not use it.
* @param[in] pUpdatedMultiProperties This parameter is not supported, do not use it.
* @endif
* @section CompIRecordEventListenerOnRecordChangedNPageIssueSection Issues
* Implementation of this method has the following issue: @n
* Even in OSP compatible applications, we cannot support the following operation.
- * -# If an application "A" changes a record, all the applications exception "A" receive the change notification.
+ * -# If an application "A" changes a record, all the applications except "A" receive the change notification.
*
* In Tizen (including OSP compatible applications),
* -# If an application "A" changes a record, all the applications including "A" receive the change notification.
/**
* @if OSPDEPREC
* @interface IRecordListener
- * @brief <i> [Deprecated] </i> This interface represents a listener to asynchronously retrieve the records from the Calendarbook or Addressbook.
+ * @brief <i> [Deprecated] </i> This interface represents a listener to asynchronously retrieve records from the Calendarbook or Addressbook.
*
* @deprecated This interface is deprecated because the @ref Calendarbook::GetEventInstances method is deprecated.
*
* @since 2.0
*
- * The %IRecordListener interface represents a listener to asynchronously retrieve the records from the Calendarbook or Addressbook.
+ * The %IRecordListener interface represents a listener to asynchronously retrieve records from the Calendarbook or Addressbook.
* @endif
*/
class _OSP_EXPORT_ IRecordListener
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %IRecordListener interface is deprecated.
*
* @param[in] reqId The request ID
* @param[in] pRecords The result of a specific asynchronous method @n
- * A list containing all of the retrieved Record instances, @n
+ * The list that contains all the retrieved Record instances, @n
* else an empty list if there are no retrieved records, or @c null if an exception occurs
* @param[in] r The result of the request
* @exception E_SUCCESS The request is successful.
*
* @since 2.0
*
- * @param[in] rhs An instance of %ImAddress
+ * @param[in] rhs An instance of %ImAddress to copy
*/
ImAddress(const ImAddress& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompImAddressSetImAddressPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompImAddressSetImAddressPage "here".
* @endif
*
* @return An error code
* @if OSPCOMPAT
* @page CompImAddressSetImAddressPage Compatibility for SetImAddress()
* @section CompImAddressSetImAddressPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of an IM address to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of an IM address to be set is greater than 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompImAddressSetImAddressPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %ImAddress
+ * @param[in] rhs An instance of %ImAddress to copy
*/
ImAddress& operator =(const ImAddress& rhs);
bool operator ==(const ImAddress& rhs) const;
/**
- * Checks whether the value of the specified instance of %ImAddress does not match the value of the current instance.
+ * Checks whether the value of the specified instance of %ImAddress is not equal to the value of the current instance.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %Organization class represents the organization information of a person. @n
- * The organization information consists of name, job title, role, agent, and department.
+ * The organization information consists of the name, job title, role, agent, and department.
*/
class _OSP_EXPORT_ Organization
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %Organization
+ * @param[in] rhs An instance of %Organization to copy
*/
Organization(const Organization& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
*
* @since 2.1
*
- * @param[in] description The description
+ * @param[in] description The description
*/
void SetDescription(const Tizen::Base::String& description);
*
* @since 2.1
*
- * @param[in] filePath The file path of the logo image
+ * @param[in] filePath The file path of the logo image
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c filePath exceeds system limitations.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The logo image is copied to the specific directory for logo images by the system when the contact is added or updated.
+ * @remarks The logo image is copied to the specific directory for logo images by the system, when the contact is added or updated.
* Therefore, GetLogoPath() returns the file path to which the logo image is copied.
*/
result SetLogo(const Tizen::Base::String& filePath);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Organization
+ * @param[in] rhs An instance of %Organization to copy
*/
Organization& operator =(const Organization& rhs);
* @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;
Tizen::Base::String GetDisplayName(void) const;
/**
- * Checks whether this is a favorite or not.
+ * Checks whether this is a favorite.
*
* @since 2.0
*
* @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;
* @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
*
bool HasPhoneNumber(void) const;
/**
- * Checks whether this has emails or not.
+ * Checks whether this has emails.
*
* @since 2.0
*
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<AccountId>* GetAccountIdsN(void) const;
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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
- * @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()
*/
* @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_USER_NOT_CONSENTED The user blocks an 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.
+ * @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);
* @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_USER_NOT_CONSENTED The user blocks an 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.
+ * @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);
* @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
- * @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()
*/
* @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
- * @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()
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %PhoneNumber
+ * @param[in] rhs An instance of %PhoneNumber to copy
*/
PhoneNumber(const PhoneNumber& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
* @if OSPCOMPAT
* @page CompPhoneNumberGetTypePage Compatibility for GetType()
* @section CompPhoneNumberGetTypePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead.
*
* @section CompPhoneNumberGetTypePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
* For more information, see @ref CompPhoneNumberSetPhoneNumberPage "here".
* @endif
*
- * @return An error code
- * @param[in] number The phone number to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified number is an empty string.
+ * @return An error code
+ * @param[in] number The phone number to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c number is an empty string.
*/
result SetPhoneNumber(const Tizen::Base::String& number);
* @if OSPCOMPAT
* @page CompPhoneNumberSetPhoneNumberPage Compatibility for SetPhoneNumber()
* @section CompPhoneNumberSetPhoneNumberPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of the phone number to be set is greater than 50 characters, E_INVALID_ARG is returned.
- * -# Only alphabets (a~z, A~Z), numbers, plus (+), asterisk (*), pound (#), and comma (,) are allowed.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of the phone number to be set is greater than 50 characters, @c E_INVALID_ARG is returned.
+ * -# Only alphabets (a~z, A~Z), numbers, plus (+), asterisk (*), pound (#), and comma (,) are allowed.
*
* @section CompPhoneNumberSetPhoneNumberPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %PhoneNumber
+ * @param[in] rhs An instance of %PhoneNumber to copy
*/
PhoneNumber& operator =(const PhoneNumber& rhs);
{
/**
* @class PhoneNumberContact
- * @brief This class provides summarized contact information with phone number.
+ * @brief This class provides the summarized contact information with the phone number.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %PhoneNumberContact class provides summarized contact information. @n
- * This provides part of contact information - ID, person ID, addressbook ID, display name, ringtone, thumbnail, and phone number.
+ * The %PhoneNumberContact class provides the summarized contact information. @n
+ * This provides a part of the contact information such as the ID, person ID, addressbook ID, display name, ringtone, thumbnail, and phone number.
*/
class _OSP_EXPORT_ PhoneNumberContact
: public Tizen::Base::Object
*
* @since 2.0
*
- * @param[in] rhs An instance of %PhoneNumberContact
+ * @param[in] rhs An instance of %PhoneNumberContact to copy
*/
PhoneNumberContact(const PhoneNumberContact& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %PhoneNumberContact
+ * @param[in] rhs An instance of %PhoneNumberContact to copy
*/
PhoneNumberContact& operator =(const PhoneNumberContact& rhs);
*/
enum RecordType
{
- RECORD_TYPE_CONTACT = 0x01, /**< The contact type */
+ RECORD_TYPE_CONTACT = 0x01, /**< The contact type */
RECORD_TYPE_CATEGORY = 0x02, /**< The category type */
RECORD_TYPE_EVENT = 0x04, /**< The event type */
- RECORD_TYPE_TODO = 0x08, /**< The to-do type */
- RECORD_TYPE_CALENDAR = 0x10 /**< The calendar type */
+ RECORD_TYPE_TODO = 0x08, /**< The to-do type */
+ RECORD_TYPE_CALENDAR = 0x10 /**< The calendar type */
};
/**
* @since 2.0
*
* The %Record class defines the general behavior of records used in the Social namespace. Users cannot create an instance directly from this
- * class. Instead, instantiate the classes derived from %Record.
+ * class. Instead, they have to instantiate the classes derived from %Record.
*/
class _OSP_EXPORT_ Record
: public Tizen::Base::Object
/**
* Gets the local-wide unique ID of the current instance of %Record. @n
* The @c RecordId is assigned by an address book when a record is added to it. @n
- * A newly constructed record instance has @c INVALID_RECORD_ID.
+ * A newly constructed record instance has ::INVALID_RECORD_ID.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %Recurrence class provides methods to access the information of a %Recurrence.
- * A CalEvent can be made a recurring event using this class. To set or get the information of a recurrence (such as start time and recurrence
- * pattern) use the methods of this class. The recurrence date is the start date of the CalEvent, if they do not match.
+ * A CalEvent can be made a recurring event using this class. To set or get the information of a recurrence (such as the start time and recurrence
+ * pattern) use the methods of this class. The recurrence date is the start date of the %CalEvent, if they do not match.
*
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/recurrence_reminder_sensitivity.htm">Recurrence, Reminder, and Sensitivity Properties of Calendar Items</a>.
*
* @since 2.0
*
- * @param[in] rhs An instance of %Recurrence
+ * @param[in] rhs An instance of %Recurrence to copy
*/
Recurrence(const Recurrence& rhs);
virtual ~Recurrence(void);
/**
- * Compares the input Tizen::Base::Object with the calling %Recurrence instance.
+ * Compares the specified Tizen::Base::Object with the current %Recurrence instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %Recurrence instance, @n
+ * @return @c true if the specified object equals the current %Recurrence instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @return An integer value representing the recurrence interval, @n
+ * @return The integer value that represents the recurrence interval, @n
* else @c 1 if this property is not set
*/
int GetInterval(void) const;
/**
- * Gets the end date and time of recurrence.
+ * Gets the end date and time of the recurrence.
*
* @since 2.0
*
- * @return An instance of Tizen::Base::DateTime representing the end date and time
+ * @return An instance of Tizen::Base::DateTime that represents the end date and time
* @remarks If this method returns @c null, get the recurrence counts using the GetCounts() method.
*
*/
*
* @since 2.0
*
- * @return An integer value representing the number of recurrences
+ * @return The integer value that represents the number of recurrences
* @remarks If this method returns @c 0, get the recurrence end date and time using the GetUntil() method.
*
*/
*
* @since 2.0
*
- * @return An integer value representing the first day of the week
+ * @return The integer value that represents the first day of the week
*
*/
CalDayOfWeek GetWeekStart(void) const;
*
* @since 2.0
*
- * @return An integer value representing the CalDayofWeek
+ * @return The integer value that represents the CalDayofWeek
* @remarks The Frequency property must be obtained. If the frequency is #FREQ_WEEKLY, the return value may be a combination of days,
* like #CAL_MONDAY| #CAL_THURSDAY.
*
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 31 representing the day of a month
+ * @return The integer value between @c 1 and @c 31 that represents the day of the month
* @remarks The Frequency property must be obtained.
*/
int GetDayOfMonth(void) const;
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 5 representing the week of a month
+ * @return The integer value between @c 1 and @c 5 that represents the week of the month
* @remarks The Frequency property must be obtained.
*
*/
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 12 representing the month of a year
+ * @return The integer value between @c 1 and @c 12 that represents the month of the year
* @remarks The Frequency property must be obtained.
*
*/
/**
* Sets a recurring frequency type among specific types (daily, weekly, monthly, and yearly). @n
- * This property must be set before setting the day of recurrence. After setting the frequency, other properties are reset to default values. @n
- * For weekly, the day of week must be set. @n
+ * This property must be set before setting the day of the recurrence. After setting the frequency, other properties are reset to default values. @n
+ * For weekly, the day of the week must be set. @n
* For monthly, the day of the week and the week of the month must be set. @n
* For yearly, either the day of the month and the month of the year, or the day of the week, the week of the month, and the month of the year must be set.
*
/**
* Sets the interval of recurrence. @n
- * If the frequency is weekly and the recurrence interval is set to 2, the event occurs every two weeks.
+ * If the frequency is weekly and the recurrence interval is set to @c 2, the event occurs every two weeks.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @page CompRecurrenceSetIntervalPage Compatibility for SetInterval()
* @section CompRecurrenceSetIntervalPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the value of the interval to be set is greater than 255, E_INVALID_ARG is returned.
+ * -# If the value of the interval to be set is greater than @c 255, @c E_INVALID_ARG is returned.
*
* @section CompRecurrenceSetIntervalPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @since 2.0
*
* @return An error code
- * @param[in] pUntil The end date and time
- * @exception E_SUCCESS The method is successful.
+ * @param[in] pUntil The end date and time
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pUntil is out of the valid range. @n
- * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
+ * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @remarks Either the until or count properties may be set. @n
* When the until property is set, the count property becomes @c 0. @n
* When the count property is set, the until property becomes @c null.
* Sets the first day of the week. @n
* The default value is set to #CAL_MONDAY. The valid values are #CAL_SUNDAY and #CAL_MONDAY. @n
* This value is very important when the recurrence type is weekly and the interval is greater than @c 1. @n
- * The weekly recurrence rule will be calculated based on the week start value.
+ * The weekly recurrence rule is calculated based on the week's start value.
*
* @since 2.0
*
* @return An error code
* @param[in] weekStart The day on which the week starts
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c day is invalid.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c weekStart is invalid.
*/
result SetWeekStart(CalDayOfWeek weekStart);
* @since 2.0
*
* @return An error code
- * @param[in] day An integer value representing the day of the week
+ * @param[in] day The integer value that represents the day of the week
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c day is invalid.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_WEEKLY, #FREQ_MONTHLY, or #FREQ_YEARLY.
* Sets the day of the month which indicates when the event recurs. @n
* The Frequency property must be set before setting this property. @n
* This property is valid for the following #RecurFrequency enumeration types: #FREQ_MONTHLY and #FREQ_YEARLY. @n
- * If the day of the month is 31 and the frequency is monthly, the months which have only 30 days are not included in the recurrence instance set. @c
- * Accordingly, with the recurrence rule, 2/29 yearly, 2/29 every four years will be included in the recurrence set.
+ * If the day of the month is @c 31 and the frequency is monthly, the months which have only @c 30 days are not included in the recurrence instance set. @c
+ * Accordingly, with the recurrence rule, 2/29 yearly, 2/29 every four years is included in the recurrence set.
*
* @since 2.0
*
* @return An error code
- * @param[in] day An integer value between @c 1 and @c 31 indicating the day of the month
+ * @param[in] day The integer value between @c 1 and @c 31 that indicates the day of the month
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c day is less than @c 1 or greater than @c 31.
+ * @exception E_INVALID_ARG The specified @c day is either less than @c 1 or greater than @c 31.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_MONTHLY or #FREQ_YEARLY.
* @remarks After this property is set, the DayOfWeek and WeekOfMonth property value are reset automatically.
*/
* @since 2.0
*
* @return An error code
- * @param[in] week An integer value between @c 1 and @c 5 representing the week of the month
+ * @param[in] week The integer value between @c 1 and @c 5 that represents the week of the month
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c week is less than @c 1 or greater than @c 5.
+ * @exception E_INVALID_ARG The specified @c week is either less than @c 1 or greater than @c 5.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_MONTHLY or #FREQ_YEARLY.
* @remarks After this property is set, the DayOfMonth property value is reset automatically.
*/
* @since 2.0
*
* @return An error code
- * @param[in] month An integer value between @c 1 and @c 12 representing the month of the year
+ * @param[in] month The integer value between @c 1 and @c 12 that represents the month of the year
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c month is less than @c 1 or greater than @c 12.
+ * @exception E_INVALID_ARG The specified @c month is either less than @c 1 or greater than @c 12.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_YEARLY.
*/
result SetMonthOfYear(int month);
/**
* Adds an exception date to this event. @n
- * The instance that its start date and time matched with the exception date will be exclude from recurrence instances.
- * If there are any changes in this recurrence, the exception dates would be cleared.
+ * The instance whose start date and time matches the exception date is excluded from the recurrence instances.
+ * If there are any changes in this recurrence, the exception dates are cleared.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return A list containing the exception dates, @n
+ * @return The list that contains the exception dates, @n
* else an empty list if there are no exception dates, or @c null if an exception occurs @n
* The results are listed in the order of date and time.
* @exception E_SUCCESS The method is successful.
*
* @since 2.0
*
- * @param[in] rhs An instance of %Recurrence
+ * @param[in] rhs An instance of %Recurrence to copy
*/
Recurrence& operator =(const Recurrence& rhs);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Relationship
+ * @param[in] rhs An instance of %Relationship to copy
*/
Relationship(const Relationship& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
void SetType(RelationshipType type);
/**
- * Sets the label of a relation.
+ * Sets the label of the relation.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %Relationship
+ * @param[in] rhs An instance of %Relationship to copy
*/
Relationship& operator =(const Relationship& rhs);
* @final This class is not intended for extension.
*
* The %Reminder class represents the information of a reminder. An application uses this class to get or set the information of a reminder,
- * such as the reminder time or the media file to be played for the reminder.
+ * such as the reminder time or the media file to be played for a reminder.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/recurrence_reminder_sensitivity.htm">Recurrence, Reminder, and Sensitivity Properties of Calendar Items</a>.
*
*
* @since 2.0
*
- * @param[in] rhs An instance of %Reminder
+ * @param[in] rhs An instance of %Reminder to copy
*/
Reminder(const Reminder& rhs);
virtual ~Reminder(void);
/**
- * Compares the input Tizen::Base::Object with the calling %Reminder instance.
+ * Compares the specified Tizen::Base::Object with the current %Reminder instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %Reminder instance, @n
+ * @return @c true if the specified object equals the current %Reminder instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* @since 2.0
*
* @return An error code
- * @param[in] minutes The time offset in minutes
- * @exception E_SUCCESS The method is successful.
+ * @param[in] minutes The time offset in minutes
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified time offset is less than @c 0 or greater than @c 40320.
* @remarks The maximum value of the time offset is @c 40320.
* @endif
* @param[in] filePath The path and name of the new sound file, @n
* else @c null to remove the previously set sound file
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The file path is invalid or the file does not exist.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c filePath is invalid.
+ * - The specified file does not exist.
*/
result SetSoundFile(const Tizen::Base::String& filePath);
* @param[in] timeUnit The reminder time unit
* @param[in] timeOffset The reminder time offset
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c timeUnit is @c REMINDER_TIME_UNIT_NONE.
* - The specified @c timeOffset is less than @c 0.
* @remarks The time offset and absolute time are mutually exclusive. @n
/**
* Sets the reminder absolute time. @n
- * The time is Coordinated Universal Time (UTC).
+ * The time is in Coordinated Universal Time (UTC).
*
* @since 2.1
*
* @exception E_INVALID_ARG The specified @c time is out of the valid range. @n
* The valid range of the time can be referenced from Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime().
* @remarks The time offset and absolute time are mutually exclusive. @n
- * When the absolute time is set, the time unit is @c REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
+ * When the absolute time is set, the time unit is ::REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
* When the time offset is set, the absolute time is reset.
*/
result SetAbsoluteTime(const Tizen::Base::DateTime& time);
* @return @c true if the absolute time is set, @n
* else @c false
* @remarks The time offset and absolute time are mutually exclusive. @n
- * When the absolute time is set, the time unit is @c REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
+ * When the absolute time is set, the time unit is ::REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
* When the time offset is set, the absolute time is reset.
*/
bool IsAbsolute(void) const;
*
* @since 2.0
*
- * @param[in] rhs An instance of %Reminder
+ * @param[in] rhs An instance of %Reminder to copy
*/
Reminder& operator =(const Reminder& rhs);
/**
* @file FSclTypes.h
- * @brief This is the header file for the types in the Social namespace.
+ * @brief This is the header file for the types in the %Social namespace.
*
* This header file contains the declarations of the types in the Social namespace.
*/
/**
* A unique ID. This ID is unique within a local storage only. @n
* @c RecordId is assigned by the local storage (for example, Addressbook and Calendarbook) when a record is saved to the storage. @n
- * A newly constructed record instance has @c INVALID_RECORD_ID.
+ * A newly constructed record instance has ::INVALID_RECORD_ID.
*
* @since 2.0
*/
const AccountId INVALID_ACCOUNT_ID = -1;
/**
+ * @typedef RecurrenceId
* Defines the recurrence ID that is used to identify a specific instance of a recurring calendar component (CalEvent). @n
- * The value type is @c Tizen::Base::DateTime. The property value is the effective value of the start time ("DTSTART" property) of the Recurrence instance.
+ * The value type is Tizen::Base::DateTime. The property value is the effective value of the start time ("DTSTART" property) of the Recurrence instance.
*
* @since 2.0
*/
CONTACT_PROPERTY_ID_LAST_NAME, /**< The last name property ID (String type) */
CONTACT_PROPERTY_ID_DISPLAY_NAME, /**< The formatted name property ID (String type) */
CONTACT_PROPERTY_ID_NICK_NAME, /**< @if OSPDEPREC The nick name property ID (String type)
- @deprecated This enum value is deprecated because there can be multiple nicknames
- in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NICKNAMES. @endif */
+ @deprecated This enum value is deprecated because there can be multiple nicknames
+ in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NICKNAMES. @endif */
CONTACT_PROPERTY_ID_THUMBNAIL, /**< @if OSPDEPREC The thumbnail property ID (Bitmap type)
- @deprecated This enumeration value is deprecated because it is not used any longer. @endif */
+ @deprecated This enumeration value is deprecated because it is not used any longer. @endif */
CONTACT_PROPERTY_ID_BIRTHDAY, /**< @if OSPDEPREC The birthday property ID (DateTime type)
- @deprecated This enum value is deprecated because there can be multiple birthday events.
- Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS. @endif */
+ @deprecated This enum value is deprecated because there can be multiple birthday events.
+ Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS. @endif */
CONTACT_PROPERTY_ID_JOB_TITLE, /**< @if OSPDEPREC The job title property ID (String type)
- @deprecated This enum value is deprecated because there can be multiple organizational information.
- Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS. @endif */
+ @deprecated This enum value is deprecated because there can be multiple organizational information.
+ Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS. @endif */
CONTACT_PROPERTY_ID_COMPANY, /**< @if OSPDEPREC The company property ID (String type)
- @deprecated This enum value is deprecated because there can be multiple organizational information.
- Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS.@endif */
- CONTACT_PROPERTY_ID_NOTE, /**< @if OSPDEPREC The note property ID (String type)
- @deprecated This enum value is deprecated because there can be multiple notes
- in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NOTES.@endif */
+ @deprecated This enum value is deprecated because there can be multiple organizational information.
+ Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS.@endif */
+ CONTACT_PROPERTY_ID_NOTE, /**< @if OSPDEPREC The note property ID (String type)
+ @deprecated This enum value is deprecated because there can be multiple notes
+ in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NOTES.@endif */
CONTACT_PROPERTY_ID_ANNIVERSARY, /**< @if OSPDEPREC The anniversary property ID (DateTime type)
- @deprecated This enum value is deprecated because there can be multiple anniversary events.
- Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS.@endif */
+ @deprecated This enum value is deprecated because there can be multiple anniversary events.
+ Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS.@endif */
CONTACT_PROPERTY_ID_RINGTONE, /**< The ringtone property ID (String type) */
CONTACT_PROPERTY_ID_MIDDLE_NAME, /**< The middle name property ID (String type) */
- CONTACT_PROPERTY_ID_LAST_REVISION, /**< An ID for the calendar date and time for the last update in Coordinated Universal Time (UTC) @n Read-only (DateTime type). */
+ CONTACT_PROPERTY_ID_LAST_REVISION, /**< An ID for the calendar date and time of the last update in Coordinated Universal Time (UTC) @n Read-only (DateTime type) */
CONTACT_PROPERTY_ID_NAME_PREFIX, /**< The name honorific prefix property ID (String type) */
CONTACT_PROPERTY_ID_NAME_SUFFIX, /**< The name honorific suffix property ID (String type) */
CONTACT_PROPERTY_ID_PHONETIC_FIRST_NAME, /**< The phonetic first name property ID (String type) @b Since: @b 2.1 */
CONTACT_PROPERTY_ID_PHONETIC_LAST_NAME, /**< The phonetic last name property ID (String type) @b Since: @b 2.1 */
CONTACT_PROPERTY_ID_PHONETIC_MIDDLE_NAME, /**< The phonetic middle name property ID (String type) @b Since: @b 2.1 */
- CONTACT_PROPERTY_ID_UID, /**< The globally unique ID (String type) @b Since: @b 2.1 */
+ CONTACT_PROPERTY_ID_UID, /**< The globally unique ID (String type) @b Since: @b 2.1 */
};
/**
{
CONTACT_MPROPERTY_ID_PHONE_NUMBERS, /**< The phone number property ID (PhoneNumber class) */
CONTACT_MPROPERTY_ID_EMAILS, /**< The email property ID (Email class) */
- CONTACT_MPROPERTY_ID_URLS, /**< The URL property ID (Url class) */
+ CONTACT_MPROPERTY_ID_URLS, /**< The URL property ID (Url class) */
CONTACT_MPROPERTY_ID_ADDRESSES, /**< The address property ID (Address class) */
CONTACT_MPROPERTY_ID_IMADDRESSES, /**< The Instant Message property ID (ImAddress class) */
CONTACT_MPROPERTY_ID_EVENTS, /**< The contact event property ID (ContactEvent type) */
CONTACT_MPROPERTY_ID_ORGANIZATIONS, /**< The organization property ID (Organization type) */
- CONTACT_MPROPERTY_ID_NOTES, /**< The note property ID (String type) */
+ CONTACT_MPROPERTY_ID_NOTES, /**< The note property ID (String type) */
CONTACT_MPROPERTY_ID_NICKNAMES, /**< The nickname property ID (String type) */
CONTACT_MPROPERTY_ID_RELATIONSHIPS, /**< The relationship property ID (Relationship type) */
- CONTACT_MPROPERTY_ID_APP_LAUNCH_DATA, /**< The app launch data property ID (ContactAppLaunchData type) @b Since: @b 2.1 */
+ CONTACT_MPROPERTY_ID_APP_LAUNCH_DATA, /**< The app launch data property ID (ContactAppLaunchData type) @b Since: @b 2.1 */
};
/**
*/
enum RecordSensitivity
{
- SENSITIVITY_PUBLIC, /**< The public sensitivity */
+ SENSITIVITY_PUBLIC, /**< The public sensitivity */
SENSITIVITY_PRIVATE, /**< The private sensitivity */
SENSITIVITY_CONFIDENTIAL /**< The confidential sensitivity */
};
*/
enum AttendeeRole
{
- ATTENDEE_ROLE_ATTENDEE, /**< The attendee */
- ATTENDEE_ROLE_REQUIRED_ATTENDEE, /**< The required attendee */
- ATTENDEE_ROLE_ORGANIZER /**< The organizer */
+ ATTENDEE_ROLE_ATTENDEE, /**< The attendee */
+ ATTENDEE_ROLE_REQUIRED_ATTENDEE, /**< The required attendee */
+ ATTENDEE_ROLE_ORGANIZER /**< The organizer */
};
/**
*/
enum AttendeeStatus
{
- ATTENDEE_STATUS_NONE, /**< The none status */
+ ATTENDEE_STATUS_NONE, /**< No status */
ATTENDEE_STATUS_NOT_RESPONDED, /**< The not-responded status */
ATTENDEE_STATUS_ACCEPTED, /**< The accepted status */
- ATTENDEE_STATUS_DECLINED, /**< The declined status*/
- ATTENDEE_STATUS_TENTATIVE, /**< The tentative status*/
+ ATTENDEE_STATUS_DECLINED, /**< The declined status */
+ ATTENDEE_STATUS_TENTATIVE, /**< The tentative status */
};
/**
* @enum EventCategory
* @brief <i> [Deprecated] </i> Defines the categories to classify the event.
*
- * @deprecated This enum type is deprecated because the category of event is not used any more.
+ * @deprecated This enum type is deprecated because the category of the event is not used any more.
* @since 2.0
* @endif
*/
* All the event categories.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This constant is deprecated because the category of event is not used any more.
+ * @deprecated This constant is deprecated because the category of the event is not used any more.
* @since 2.0
* @endif
*/
enum EventPriority
{
EVENT_PRIORITY_LOW, /**< The low priority */
- EVENT_PRIORITY_NORMAL, /**< The normal priority */
+ EVENT_PRIORITY_NORMAL, /**< The normal priority */
EVENT_PRIORITY_HIGH /**< The high priority */
};
*/
enum EventStatus
{
- EVENT_STATUS_NONE, /**< The none status */
+ EVENT_STATUS_NONE, /**< No status */
EVENT_STATUS_CONFIRMED, /**< The confirmed status */
- EVENT_STATUS_CANCELLED, /**< The canceled status */
+ EVENT_STATUS_CANCELLED, /**< The cancelled status */
EVENT_STATUS_TENTATIVE /**< The tentative status */
};
*/
enum BusyStatus
{
- BUSY_STATUS_FREE, /**< The free status */
- BUSY_STATUS_BUSY, /**< The busy status */
+ BUSY_STATUS_FREE, /**< The free status */
+ BUSY_STATUS_BUSY, /**< The busy status */
BUSY_STATUS_UNAVAILABLE, /**< The unavailable status */
- BUSY_STATUS_TENTATIVE /**< The tentative status */
+ BUSY_STATUS_TENTATIVE /**< The tentative status */
};
/**
*/
enum TodoStatus
{
- TODO_STATUS_NONE = 0x00000001, /**< The none status */
- TODO_STATUS_NEEDS_ACTION = 0x00000002, /**< The needs action status */
- TODO_STATUS_COMPLETED = 0x00000004, /**< The completed status */
- TODO_STATUS_IN_PROCESS = 0x00000008, /**< The in process status */
- TODO_STATUS_CANCELLED = 0x00000010, /**< The canceled status */
+ TODO_STATUS_NONE = 0x00000001, /**< No status */
+ TODO_STATUS_NEEDS_ACTION = 0x00000002, /**< The needs action status */
+ TODO_STATUS_COMPLETED = 0x00000004, /**< The completed status */
+ TODO_STATUS_IN_PROCESS = 0x00000008, /**< The in process status */
+ TODO_STATUS_CANCELLED = 0x00000010, /**< The cancelled status */
};
/** All the to-do statuses.
*/
enum TodoPriority
{
- TODO_PRIORITY_LOW = 0x00000001, /**< The low priority */
- TODO_PRIORITY_NORMAL = 0x00000002, /**< The normal priority */
- TODO_PRIORITY_HIGH = 0x00000004, /**< The high priority */
+ TODO_PRIORITY_LOW = 0x00000001, /**< The low priority */
+ TODO_PRIORITY_NORMAL = 0x00000002, /**< The normal priority */
+ TODO_PRIORITY_HIGH = 0x00000004, /**< The high priority */
};
/** All the to-do priorities.
*/
enum RecordEventType
{
- RECORD_ADDED, /**< @if OSPDEPREC The adding of a new record @endif */
- RECORD_UPDATED, /**< @if OSPDEPREC The updating of a record @endif */
+ RECORD_ADDED, /**< @if OSPDEPREC Adding a new record @endif */
+ RECORD_UPDATED, /**< @if OSPDEPREC Updating a record @endif */
RECORD_REMOVED, /**< @if OSPDEPREC The removal of a record @endif */
- ALL_RECORDS_REMOVED, /**<
- * @if OSPDEPREC
- * The removal of all records @n
- * @deprecated This enum value is deprecated because it is not used any more.
- * @endif
- */
- MULTI_RECORDS_ADDED, /**< @if OSPDEPREC The adding of multiple records @endif */
- MULTI_RECORDS_UPDATED, /**< @if OSPDEPREC The adding, updating, and/or removal of multiple records @endif */
+ ALL_RECORDS_REMOVED, /**<
+ * @if OSPDEPREC
+ * The removal of all the records @n
+ * @deprecated This enum value is deprecated because it is not used any more.
+ * @endif
+ */
+ MULTI_RECORDS_ADDED, /**< @if OSPDEPREC Adding multiple records @endif */
+ MULTI_RECORDS_UPDATED, /**< @if OSPDEPREC Adding, updating, and/or removal of multiple records @endif */
MULTI_RECORDS_REMOVED /**< @if OSPDEPREC The removal of multiple records @endif */
};
*/
enum RecurFrequency
{
- FREQ_DAILY, /**< The daily recurrence */
+ FREQ_DAILY, /**< The daily recurrence */
FREQ_WEEKLY, /**< The weekly recurrence */
FREQ_MONTHLY, /**< The monthly recurrence */
- FREQ_YEARLY /**< The yearly recurrence */
+ FREQ_YEARLY /**< The yearly recurrence */
};
/**
CAL_SUNDAY = 0x0001, /**< The day of the week is Sunday */
CAL_MONDAY = 0x0002, /**< The day of the week is Monday */
CAL_TUESDAY = 0x0004, /**< The day of the week is Tuesday */
- CAL_WEDNESDAY = 0x0008, /**< The day of the week is Wednesday */
+ CAL_WEDNESDAY = 0x0008, /**< The day of the week is Wednesday */
CAL_THURSDAY = 0x0010, /**< The day of the week is Thursday */
CAL_FRIDAY = 0x0020, /**< The day of the week is Friday */
CAL_SATURDAY = 0x0040 /**< The day of the week is Saturday */
/**
* @enum RecordChangeType
- * Defines the change type of Record.
+ * Defines the change type of a Record.
*
* @since 2.0
*/
/**
* @enum CalendarItemType
- * Defines item types to specify which kind of item the calendar can contain.
+ * Defines the item types to specify which kind of item the calendar can contain.
*
* @since 2.0
*/
enum CalendarItemType
{
- CALENDAR_ITEM_TYPE_EVENT_ONLY = 0x1, /**< The item type for event */
- CALENDAR_ITEM_TYPE_TODO_ONLY = 0x2, /**< The item type for to-do item */
- CALENDAR_ITEM_TYPE_EVENT_AND_TODO = 0x3 /**< The item type for event and to-do item */
+ CALENDAR_ITEM_TYPE_EVENT_ONLY = 0x1, /**< The item type for an event */
+ CALENDAR_ITEM_TYPE_TODO_ONLY = 0x2, /**< The item type for a to-do item */
+ CALENDAR_ITEM_TYPE_EVENT_AND_TODO = 0x3 /**< The item type for an event and a to-do item */
};
/**
* @enum PhoneNumberType
*
- * Defines the types of phone number.
+ * Defines the types of phone numbers.
* @since 2.0
*/
enum PhoneNumberType
{
- PHONENUMBER_TYPE_HOME, /**< The phone number type for home telephone*/
- PHONENUMBER_TYPE_WORK, /**< The phone number type for work telephone*/
- PHONENUMBER_TYPE_MOBILE, /**< The phone number type for mobile */
+ PHONENUMBER_TYPE_HOME, /**< The phone number type for a home telephone */
+ PHONENUMBER_TYPE_WORK, /**< The phone number type for a work telephone */
+ PHONENUMBER_TYPE_MOBILE, /**< The phone number type for a mobile */
PHONENUMBER_TYPE_HOME_FAX, /**< The phone number type for home fax */
PHONENUMBER_TYPE_WORK_FAX, /**< The phone number type for work fax */
- PHONENUMBER_TYPE_PAGER, /**< The phone number type for pager */
+ PHONENUMBER_TYPE_PAGER, /**< The phone number type for a pager */
PHONENUMBER_TYPE_OTHER, /**< The phone number type for other */
- PHONENUMBER_TYPE_CUSTOM, /**< The custom type @n The actual type can be set in the label. */
- PHONENUMBER_TYPE_ASSISTANT /**< The phone number type for assistant. @b Since: @b 2.1 */
+ PHONENUMBER_TYPE_CUSTOM, /**< The custom type @n The actual type can be set in the label */
+ PHONENUMBER_TYPE_ASSISTANT /**< The phone number type for an assistant @b Since: @b 2.1 */
};
/**
enum ReminderTimeUnit
{
REMINDER_TIME_UNIT_MINUTE, /**< The unit of time offset is minute */
- REMINDER_TIME_UNIT_HOUR, /**< The unit of time offset is hour */
+ REMINDER_TIME_UNIT_HOUR, /**< The unit of time offset is hour */
REMINDER_TIME_UNIT_DAY, /**< The unit of time offset is day */
- REMINDER_TIME_UNIT_WEEK, /**< The unit of time offset is week */
- REMINDER_TIME_UNIT_NONE, /**< The unit of time offset is none @b Since @b 2.1 */
+ REMINDER_TIME_UNIT_WEEK, /**< The unit of time offset is week */
+ REMINDER_TIME_UNIT_NONE, /**< The unit of time offset is none @b Since @b 2.1 */
};
/**
* @enum EmailType
*
- * Defines the types of email.
+ * Defines the types of emails.
*
* @since 2.0
*/
enum EmailType
{
EMAIL_TYPE_PERSONAL, /**< The email type for personal*/
- EMAIL_TYPE_WORK, /**< The email type for work */
- EMAIL_TYPE_OTHER, /**< The email type for other */
- EMAIL_TYPE_CUSTOM, /**< The custom type @n The actual type can be set in the label. */
- EMAIL_TYPE_MOBILE /**< The email type for mobile. @b Since: @b 2.1 */
+ EMAIL_TYPE_WORK, /**< The email type for work */
+ EMAIL_TYPE_OTHER, /**< The email type for other */
+ EMAIL_TYPE_CUSTOM, /**< The custom type @n The actual type can be set in the label */
+ EMAIL_TYPE_MOBILE /**< The email type for mobile @b Since: @b 2.1 */
};
/**
- * Defines the types of address.
+ * Defines the types of addresses.
*
* @since 2.0
*/
enum AddressType
{
- ADDRESS_TYPE_HOME, /**< The address type for home address */
- ADDRESS_TYPE_WORK, /**< The address type for work address */
+ ADDRESS_TYPE_HOME, /**< The address type for a home address */
+ ADDRESS_TYPE_WORK, /**< The address type for a work address */
ADDRESS_TYPE_OTHER, /**< The address type for other */
- ADDRESS_TYPE_CUSTOM /**< The custom type @n The actual type can be set in the label. */
+ ADDRESS_TYPE_CUSTOM /**< The custom type @n The actual type can be set in the label */
};
/**
* @enum ContactEventType
*
- * Defines the types of event.
+ * Defines the types of events.
*
* @since 2.0
*/
enum ContactEventType
{
- CONTACT_EVENT_TYPE_BIRTHDAY, /**< The event type for birthday */
- CONTACT_EVENT_TYPE_ANNIVERSARY, /**< The event type for anniversary */
- CONTACT_EVENT_TYPE_OTHER, /**< The event type for other */
- CONTACT_EVENT_TYPE_CUSTOM /**< The custom event @n The actual type can be set in the label. */
+ CONTACT_EVENT_TYPE_BIRTHDAY, /**< The event type for a birthday */
+ CONTACT_EVENT_TYPE_ANNIVERSARY, /**< The event type for an anniversary */
+ CONTACT_EVENT_TYPE_OTHER, /**< The event type for other */
+ CONTACT_EVENT_TYPE_CUSTOM /**< The custom event @n The actual type can be set in the label */
};
/**
* @enum UrlType
*
- * Defines the types of URL.
+ * Defines the types of URLs.
*
* @since 2.0
*/
enum UrlType
{
- URL_TYPE_PERSONAL, /**< The URL type is personal */
- URL_TYPE_WORK, /**< The URL type is work */
- URL_TYPE_OTHER, /**< The URL type is other */
- URL_TYPE_CUSTOM /**< The custom type @n The actual type can be set in the label. */
+ URL_TYPE_PERSONAL, /**< The URL type is personal */
+ URL_TYPE_WORK, /**< The URL type is work */
+ URL_TYPE_OTHER, /**< The URL type is other */
+ URL_TYPE_CUSTOM /**< The custom type @n The actual type can be set in the label */
};
/**
* @enum RelationshipType
*
- * Defines the types of relationship.
+ * Defines the types of relationships.
*
* @since 2.0
*/
enum RelationshipType
{
- CONTACT_RELATIONSHIP_TYPE_ASSISTANT, /**< The relation type for assistant */
- CONTACT_RELATIONSHIP_TYPE_BROTHER, /**< The relation type for brother */
- CONTACT_RELATIONSHIP_TYPE_CHILD, /**< The relation type for child */
- CONTACT_RELATIONSHIP_TYPE_DOMESTIC_PARTNER, /**< The relation type for domestic partner */
- CONTACT_RELATIONSHIP_TYPE_FATHER, /**< The relation type for father */
- CONTACT_RELATIONSHIP_TYPE_FRIEND, /**< The relation type for friend */
- CONTACT_RELATIONSHIP_TYPE_MANAGER, /**< The relation type for manager */
- CONTACT_RELATIONSHIP_TYPE_MOTHER, /**< The relation type for mother */
- CONTACT_RELATIONSHIP_TYPE_PARENT, /**< The relation type for parent */
- CONTACT_RELATIONSHIP_TYPE_PARTNER, /**< The relation type for partner */
+ CONTACT_RELATIONSHIP_TYPE_ASSISTANT, /**< The relation type for an assistant */
+ CONTACT_RELATIONSHIP_TYPE_BROTHER, /**< The relation type for a brother */
+ CONTACT_RELATIONSHIP_TYPE_CHILD, /**< The relation type for a child */
+ CONTACT_RELATIONSHIP_TYPE_DOMESTIC_PARTNER, /**< The relation type for a domestic partner */
+ CONTACT_RELATIONSHIP_TYPE_FATHER, /**< The relation type for a father */
+ CONTACT_RELATIONSHIP_TYPE_FRIEND, /**< The relation type for a friend */
+ CONTACT_RELATIONSHIP_TYPE_MANAGER, /**< The relation type for a manager */
+ CONTACT_RELATIONSHIP_TYPE_MOTHER, /**< The relation type for a mother */
+ CONTACT_RELATIONSHIP_TYPE_PARENT, /**< The relation type for a parent */
+ CONTACT_RELATIONSHIP_TYPE_PARTNER, /**< The relation type for a partner */
CONTACT_RELATIONSHIP_TYPE_REFERRED_BY, /**< The relation type for referred-by */
- CONTACT_RELATIONSHIP_TYPE_RELATIVE, /**< The relation type for relative */
- CONTACT_RELATIONSHIP_TYPE_SISTER, /**< The relation type for sister */
- CONTACT_RELATIONSHIP_TYPE_SPOUSE, /**< The relation type for spouse */
- CONTACT_RELATIONSHIP_TYPE_CUSTOM /**< The custom event @n The actual type can be set in the label. */
+ CONTACT_RELATIONSHIP_TYPE_RELATIVE, /**< The relation type for a relative */
+ CONTACT_RELATIONSHIP_TYPE_SISTER, /**< The relation type for a sister */
+ CONTACT_RELATIONSHIP_TYPE_SPOUSE, /**< The relation type for a spouse */
+ CONTACT_RELATIONSHIP_TYPE_CUSTOM /**< The custom event @n The actual type can be set in the label */
};
/**
* @enum OrganizationType
*
- * Defines the types of organization.
+ * Defines the types of organizations.
*
* @since 2.1
*/
*/
static const int MAX_PHONE_NUMBER_LENGTH = 50;
+//This value is for internal use only. Using this value can cause behavioral,
+//security-related, and consistency-related issues in the application.
+typedef int AccountId;
+
/**
* The person ID.
*
typedef int AddressbookId;
/**
-* An invalid address book ID indicates that the address book has not been properly stored to the address book database.
+* An invalid address book ID indicates that the address book has not been properly stored in the address book database.
*
* @since 2.0
*/
*/
enum FilterComparisonOperator
{
- FI_CMP_OP_EQUAL, /**< = operator */
- FI_CMP_OP_LESS_THAN, /**< < operator */
- FI_CMP_OP_LESS_THAN_OR_EQUAL, /**< <= operator */
- FI_CMP_OP_GREATER_THAN, /**< > operator*/
- FI_CMP_OP_GREATER_THAN_OR_EQUAL, /**< >= operator */
- FI_CMP_OP_IS_NULL, /**< IS NULL operator */
+ FI_CMP_OP_EQUAL, /**< = operator */
+ FI_CMP_OP_LESS_THAN, /**< < operator */
+ FI_CMP_OP_LESS_THAN_OR_EQUAL, /**< <= operator */
+ FI_CMP_OP_GREATER_THAN, /**< > operator */
+ FI_CMP_OP_GREATER_THAN_OR_EQUAL, /**< >= operator */
+ FI_CMP_OP_IS_NULL, /**< NULL operator */
};
/**
*/
enum FilterStringOperator
{
- FI_STR_OP_EQUAL, /**< The operator for matching the string exactly */
+ FI_STR_OP_EQUAL, /**< The operator for matching the string exactly */
FI_STR_OP_FULL_STRING, /**< The operator for matching the full-string without case sensitive */
FI_STR_OP_START_WITH, /**< The operator for matching the string starting with the specified keyword */
FI_STR_OP_END_WITH, /**< The operator for matching the string ending with the specified keyword */
- FI_STR_OP_CONTAIN, /**< The operator for matching the string containing the specified keyword */
- FI_STR_OP_IS_NOT_NULL, /**< The operator for matching any string(except NULL) @n The specified is ignored. */
+ FI_STR_OP_CONTAIN, /**< The operator for matching the string containing the specified keyword */
+ FI_STR_OP_IS_NOT_NULL, /**< The operator for matching any string(except NULL) @n The specified is ignored */
};
/**
*/
enum AddressbookFilterType
{
- AB_FI_TYPE_ADDRESSBOOK, /**< The filter for the addressbooks @n AddressbookFilterProperty is only used in this type filter.
- The search result with this filter is a list of Addressbook. */
- AB_FI_TYPE_PERSON, /**< The filter for the persons @n PersonFilterProperty is only used in this type filter.
- The search result with this filter is a list of Person. */
- AB_FI_TYPE_CONTACT, /**< The filter for the contacts @n ContactFilterProperty is only used in this type filter.
- The search result with this filter is a list of Contact. */
- AB_FI_TYPE_CATEGORY, /**< The filter for the categories @n CategoryFilterProperty is only used in this type filter.
- The search result with this filter is a list of Category. */
- AB_FI_TYPE_PHONE_CONTACT, /**< The filter for the contacts with phone number @n PhoneContactFilterProperty is only used in this type filter.
- The search result with this filter is a list of PhoneNumberContact. */
- AB_FI_TYPE_EMAIL_CONTACT, /**< The filter for the contacts with email @n EmailContactFilterProperty is only used in this type filter.
- The search result with this filter is a list of EmailContact. */
+ AB_FI_TYPE_ADDRESSBOOK, /**< The filter for the addressbooks @n AddressbookFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of Addressbook */
+ AB_FI_TYPE_PERSON, /**< The filter for the persons @n PersonFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of Person */
+ AB_FI_TYPE_CONTACT, /**< The filter for the contacts @n ContactFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of Contact */
+ AB_FI_TYPE_CATEGORY, /**< The filter for the categories @n CategoryFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of Category */
+ AB_FI_TYPE_PHONE_CONTACT, /**< The filter for the contacts with phone number @n PhoneContactFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of PhoneNumberContact */
+ AB_FI_TYPE_EMAIL_CONTACT, /**< The filter for the contacts with email @n EmailContactFilterProperty is only used in this type of filter @n
+ The search result with this filter is a list of EmailContact */
};
/**
enum AddressbookFilterProperty
{
AB_FI_PR_ADDRESSBOOK_ID = 1, /**< The addressbook ID: int (AddressbookId) */
- AB_FI_PR_ACCOUNT_ID, /**< The account ID: int (AccountId) */
- AB_FI_PR_NAME, /**< The addressbook name: String */
+ AB_FI_PR_ACCOUNT_ID, /**< The account ID: int (AccountId) */
+ AB_FI_PR_NAME, /**< The addressbook name: String */
};
/**
* @enum PersonFilterProperty
- * Defines the property for filtering the persons. @n
+ * Defines the property for filtering a person. @n
* These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_PERSON type.
*
* @since 2.0
enum PersonFilterProperty
{
PERSON_FI_PR_PERSON_ID = 100, /**< The person ID: int (RecordId) */
- PERSON_FI_PR_DISPLAY_NAME, /**< The display name: String */
- PERSON_FI_PR_HAS_PHONE, /**< Whether the person has phone numbers or not: bool */
- PERSON_FI_PR_HAS_EMAIL, /**< Whether the person has emails or not: bool */
- PERSON_FI_PR_IS_FAVORITE, /**< Whether the person is favorite or not: bool */
- PERSON_FI_PR_CATEGORY_ID, /**< The category ID: int (RecordId) */
+ PERSON_FI_PR_DISPLAY_NAME, /**< The display name: String */
+ PERSON_FI_PR_HAS_PHONE, /**< Whether the person has phone numbers or not: bool */
+ PERSON_FI_PR_HAS_EMAIL, /**< Whether the person has emails or not: bool */
+ PERSON_FI_PR_IS_FAVORITE, /**< Whether the person is a favorite or not: bool */
+ PERSON_FI_PR_CATEGORY_ID, /**< The category ID: int (RecordId) */
PERSON_FI_PR_ADDRESSBOOK_ID, /**< The addressbook ID: int (AddressbookId) */
};
{
CONTACT_FI_PR_CONTACT_ID = 200, /**< The contact ID: int (RecordId) */
CONTACT_FI_PR_ADDRESSBOOK_ID, /**< The addressbook ID: int (AddressbookId) */
- CONTACT_FI_PR_PERSON_ID, /**< The person ID: int (PersonId) */
+ CONTACT_FI_PR_PERSON_ID, /**< The person ID: int (PersonId) */
CONTACT_FI_PR_DISPLAY_NAME, /**< The display name: String */
- CONTACT_FI_PR_HAS_PHONE, /**< Whether the contact has phone numbers or not: bool */
- CONTACT_FI_PR_HAS_EMAIL, /**< Whether the contact has emails or not: bool */
+ CONTACT_FI_PR_HAS_PHONE, /**< Whether the contact has phone numbers or not: bool */
+ CONTACT_FI_PR_HAS_EMAIL, /**< Whether the contact has emails or not: bool */
};
/**
{
CATEGORY_FI_PR_CATEGORY_ID = 300, /**< The category ID: int (RecordId) */
CATEGORY_FI_PR_ADDRESSBOOK_ID, /**< The addressbook ID: int (AddressbookId) */
- CATEGORY_FI_PR_NAME, /**< The category name: String */
+ CATEGORY_FI_PR_NAME, /**< The category name: String */
};
/**
*/
enum UserProfilePropertyId
{
- USER_PROFILE_PROPERTY_ID_FIRST_NAME = 1, /**< The first name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_LAST_NAME, /**< The last name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_MIDDLE_NAME, /**< The middle name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_NAME_PREFIX, /**< The name honorific prefix property ID (String type) */
- USER_PROFILE_PROPERTY_ID_NAME_SUFFIX, /**< The name honorific suffix property ID (String type) */
- USER_PROFILE_PROPERTY_ID_DISPLAY_NAME, /**< The formatted name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_PHONETIC_FIRST_NAME, /**< The phonetic first name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_PHONETIC_LAST_NAME, /**< The phonetic last name property ID (String type) */
- USER_PROFILE_PROPERTY_ID_PHONETIC_MIDDLE_NAME, /**< The phonetic middle name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_FIRST_NAME = 1, /**< The first name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_LAST_NAME, /**< The last name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_MIDDLE_NAME, /**< The middle name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_NAME_PREFIX, /**< The name honorific prefix property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_NAME_SUFFIX, /**< The name honorific suffix property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_DISPLAY_NAME, /**< The formatted name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_PHONETIC_FIRST_NAME, /**< The phonetic first name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_PHONETIC_LAST_NAME, /**< The phonetic last name property ID (String type) */
+ USER_PROFILE_PROPERTY_ID_PHONETIC_MIDDLE_NAME, /**< The phonetic middle name property ID (String type) */
};
/**
*/
enum CalendarbookFilterType
{
- CB_FI_TYPE_EVENT, /**< The filter for the event of Calendarbook @n EventFilterProperty is only used in this type filter. The search result with this filter is a list of CalEvent. */
- CB_FI_TYPE_TODO, /**< The filter for the to-do of Calendarbook @n TodoFilterProperty is only used in this type filter. The search result with this filter is a list of CalTodo. */
- CB_FI_TYPE_CALENDAR, /**< The filter for the calendar of Calendarbook @n CalendarFilterProperty is only used in this type filter. The search result with this filter is a list of Calendar. */
- CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE, /**< The filter for all day event instance of Calendarbook @n EventInstanceFilterProperty is only used in this type filter. The search result with this filter is a list of CalEventInstance. */
- CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE /**< The filter for non-all day event instance of Calendarbook @n EventInstanceFilterProperty is only used in this type filter. The search result with this filter is a list of CalEventInstance. */
+ CB_FI_TYPE_EVENT, /**< The filter for the event of Calendarbook @n EventFilterProperty is only used in this type of filter @n The search result with this filter is a list of CalEvent */
+ CB_FI_TYPE_TODO, /**< The filter for the to-do of Calendarbook @n TodoFilterProperty is only used in this type of filter @n The search result with this filter is a list of CalTodo */
+ CB_FI_TYPE_CALENDAR, /**< The filter for the calendar of Calendarbook @n CalendarFilterProperty is only used in this type of filter @n The search result with this filter is a list of Calendar */
+ CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE, /**< The filter for all day event instances of Calendarbook @n EventInstanceFilterProperty is only used in this type of filter @n The search result with this filter is a list of CalEventInstance */
+ CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE /**< The filter for non-all day event instances of Calendarbook @n EventInstanceFilterProperty is only used in this type of filter @n The search result with this filter is a list of CalEventInstance */
};
/**
{
EVENT_FI_PR_EVENT_ID = 1, /**< The event ID: int (RecordId) */
EVENT_FI_PR_CALENDAR_ID, /**< The calendar ID: long long (RecordId) */
- EVENT_FI_PR_SUBJECT, /**< The subject of the event: String */
+ EVENT_FI_PR_SUBJECT, /**< The subject of the event: String */
EVENT_FI_PR_DESCRIPTION, /**< The description of the event: String */
EVENT_FI_PR_LOCATION, /**< The location of the event: String */
- EVENT_FI_PR_BUSY_STATUS, /**< The busy status of the event: int (BusyStatus) */
- EVENT_FI_PR_PRIORITY, /**< The priority of the event: int (EventPriority) */
- EVENT_FI_PR_SENSITIVITY, /**< The sensitivity of the event: int (RecordSensitivity) */
- EVENT_FI_PR_STATUS, /**< The status of the event: int (EventStatus) */
+ EVENT_FI_PR_BUSY_STATUS, /**< The busy status of the event: int (BusyStatus) */
+ EVENT_FI_PR_PRIORITY, /**< The priority of the event: int (EventPriority) */
+ EVENT_FI_PR_SENSITIVITY, /**< The sensitivity of the event: int (RecordSensitivity) */
+ EVENT_FI_PR_STATUS, /**< The status of the event: int (EventStatus) */
EVENT_FI_PR_UID, /**< The uid of the event: String */
- EVENT_FI_PR_LATITUDE, /**< The latitude of the event: Double */
+ EVENT_FI_PR_LATITUDE, /**< The latitude of the event: Double */
EVENT_FI_PR_LONGITUDE, /**< The longitude of the event: Double */
- EVENT_FI_PR_LAST_REVISED_TIME, /**< The last revised time of the event: DateTime */
- EVENT_FI_PR_HAS_REMINDER, /**< Whether the event has the reminder or not: bool*/
- EVENT_FI_PR_HAS_ATTENDEE /**< Whether the event has the attendee or not: bool*/
+ EVENT_FI_PR_LAST_REVISED_TIME, /**< The last revised time of the event: DateTime */
+ EVENT_FI_PR_HAS_REMINDER, /**< Whether the event has a reminder or not: bool*/
+ EVENT_FI_PR_HAS_ATTENDEE /**< Whether the event has an attendee or not: bool*/
};
/**
enum TodoFilterProperty
{
TODO_FI_PR_TODO_ID = 100, /**< The todo ID: long long (RecordId) */
- TODO_FI_PR_CALENDAR_ID, /**< The calendar ID: long long (RecordId) */
- TODO_FI_PR_START_DATE, /**< The start date of the to-do: DateTime*/
- TODO_FI_PR_DUE_DATE, /**< The due date of the to-do: DateTime */
- TODO_FI_PR_SUBJECT, /**< The subject of the to-do: String */
- TODO_FI_PR_DESCRIPTION, /**< The description of the to-do: String */
+ TODO_FI_PR_CALENDAR_ID, /**< The calendar ID: long long (RecordId) */
+ TODO_FI_PR_START_DATE, /**< The start date of the to-do: DateTime*/
+ TODO_FI_PR_DUE_DATE, /**< The due date of the to-do: DateTime */
+ TODO_FI_PR_SUBJECT, /**< The subject of the to-do: String */
+ TODO_FI_PR_DESCRIPTION, /**< The description of the to-do: String */
TODO_FI_PR_LOCATION, /**< The location of the to-do: String */
TODO_FI_PR_PRIORITY, /**< The priority of the to-do: int (TodoPriority)*/
- TODO_FI_PR_SENSITIVITY, /**< The sensitivity of the to-do: int (RecordSensitivity) */
- TODO_FI_PR_STATUS, /**< The status of the to-do: int (TodoStatus) */
- TODO_FI_PR_LATITUDE, /**< The latitude of the to-do: double*/
- TODO_FI_PR_LONGITUDE, /**< The longitude of the to-do: double*/
- TODO_FI_PR_LAST_REVISED_TIME, /**< The last revised time of the to-do: DateTime */
- TODO_FI_PR_HAS_REMINDER /**< Whether the to-do has the reminder or not: bool*/
+ TODO_FI_PR_SENSITIVITY, /**< The sensitivity of the to-do: int (RecordSensitivity) */
+ TODO_FI_PR_STATUS, /**< The status of the to-do: int (TodoStatus) */
+ TODO_FI_PR_LATITUDE, /**< The latitude of the to-do: double*/
+ TODO_FI_PR_LONGITUDE, /**< The longitude of the to-do: double*/
+ TODO_FI_PR_LAST_REVISED_TIME, /**< The last revised time of the to-do: DateTime */
+ TODO_FI_PR_HAS_REMINDER /**< Whether the to-do has a reminder or not: bool*/
};
/**
* @enum EventInstanceFilterProperty
* Defines the property for filtering the all day event instances or non-all day event instances. @n
-* These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE type or CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE type.
+* These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE or CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE type.
*
* @since 2.0
*/
enum EventInstanceFilterProperty
{
EVENT_INST_FI_PR_ORIGINAL_EVENT_ID = 200, /**< The original event ID: int (RecordId) */
- EVENT_INST_FI_PR_CALENDAR_ID, /**< The calendar ID: int (RecordId) */
- EVENT_INST_FI_PR_START_TIME, /**< The start time of the event instance: DateTime */
- EVENT_INST_FI_PR_END_TIME, /**< The end time of the event instance: DateTime */
- EVENT_INST_FI_PR_SUBJECT, /**< The subject of the event instance: String */
- EVENT_INST_FI_PR_DESCRIPTION, /**< The description of the event instance: String */
- EVENT_INST_FI_PR_LOCATION, /**< The location of the event instance: String */
- EVENT_INST_FI_PR_BUSY_STATUS, /**< The busy status of the event instance: int (BusyStatus) */
- EVENT_INST_FI_PR_PRIORITY, /**< The priority of the event instance: int (EventPriority) */
- EVENT_INST_FI_PR_SENSITIVITY, /**< The sensitivity of the event instance: int (RecordSensitivity) */
- EVENT_INST_FI_PR_STATUS, /**< The status of the event instance: int (EventStatus) */
- EVENT_INST_FI_PR_LATITUDE, /**< The latitude of the event instance: Double */
- EVENT_INST_FI_PR_LONGITUDE, /**< The latitude of the event instance: Double */
- EVENT_INST_FI_PR_IS_RECURRING, /**< Whether the event instance is the recurring event or not: bool*/
- EVENT_INST_FI_PR_HAS_REMINDER /**< Whether the event instance has the reminder or not: bool*/
+ EVENT_INST_FI_PR_CALENDAR_ID, /**< The calendar ID: int (RecordId) */
+ EVENT_INST_FI_PR_START_TIME, /**< The start time of the event instance: DateTime */
+ EVENT_INST_FI_PR_END_TIME, /**< The end time of the event instance: DateTime */
+ EVENT_INST_FI_PR_SUBJECT, /**< The subject of the event instance: String */
+ EVENT_INST_FI_PR_DESCRIPTION, /**< The description of the event instance: String */
+ EVENT_INST_FI_PR_LOCATION, /**< The location of the event instance: String */
+ EVENT_INST_FI_PR_BUSY_STATUS, /**< The busy status of the event instance: int (BusyStatus) */
+ EVENT_INST_FI_PR_PRIORITY, /**< The priority of the event instance: int (EventPriority) */
+ EVENT_INST_FI_PR_SENSITIVITY, /**< The sensitivity of the event instance: int (RecordSensitivity) */
+ EVENT_INST_FI_PR_STATUS, /**< The status of the event instance: int (EventStatus) */
+ EVENT_INST_FI_PR_LATITUDE, /**< The latitude of the event instance: Double */
+ EVENT_INST_FI_PR_LONGITUDE, /**< The latitude of the event instance: Double */
+ EVENT_INST_FI_PR_IS_RECURRING, /**< Whether the event instance is a recurring event or not: bool*/
+ EVENT_INST_FI_PR_HAS_REMINDER /**< Whether the event instance has a reminder or not: bool*/
};
/**
enum CalendarFilterProperty
{
CALENDAR_FI_PR_CALENDAR_ID = 400, /**< The calendar ID: int (RecordId) */
- CALENDAR_FI_PR_ACCOUNT_ID, /**< The account ID of calendar: int (AccountId) */
- CALENDAR_FI_PR_NAME, /**< The name of calendar: String */
- CALENDAR_FI_PR_ITEM_TYPE /**< The type of calendar: int (CalendarItemType) */
+ CALENDAR_FI_PR_ACCOUNT_ID, /**< The account ID of the calendar: int (AccountId) */
+ CALENDAR_FI_PR_NAME, /**< The name of the calendar: String */
+ CALENDAR_FI_PR_ITEM_TYPE /**< The type of the calendar: int (CalendarItemType) */
};
}} // Tizen::Social
*
* @since 2.0
*
- * @param[in] rhs An instance of %Url
+ * @param[in] rhs An instance of %Url to copy
*/
Url(const Url& rhs);
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of Tizen::Base::Object
+ * @return The integer value that indicates the hash value of the current instance of Tizen::Base::Object
*/
virtual int GetHashCode(void) const;
* @if OSPCOMPAT
* @page CompUrlGetTypePage Compatibility for GetType()
* @section CompUrlGetTypePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# URL_TYPE_CUSTOM is not supported. If the type of the url is URL_TYPE_CUSTOM, URL_TYPE_OTHER is returned instead.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# URL_TYPE_CUSTOM is not supported. If the type of the url is URL_TYPE_CUSTOM, URL_TYPE_OTHER is returned instead.
*
* @section CompUrlGetTypePageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
*
* @endif
*/
/**
- * Gets the label of an URL.
+ * Gets the label of a URL.
*
* @since 2.0
*
Tizen::Base::String GetLabel(void) const;
/**
- * Sets the label of an URL.
+ * Sets the label of a URL.
*
* @since 2.0
*
* @if OSPCOMPAT
* @page CompUrlSetUrlPage Compatibility for SetUrl()
* @section CompUrlSetUrlPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issue: @n
- * -# If the length of an URL to be set is greater than 100 characters, E_INVALID_ARG is returned.
+ * Implementing this method in OSP compatible applications has the following issue: @n
+ * -# If the length of a URL to be set is greater than 100 characters, @c E_INVALID_ARG is returned.
*
* @section CompUrlSetUrlPageSolutionSection Resolutions
- * The issue mentioned above has been resolved in Tizen.
+ * The issue mentioned above has been resolved in Tizen.
* @endif
*/
/**
*
* @since 2.0
*
- * @param[in] rhs An instance of %Url
+ * @param[in] rhs An instance of %Url to copy
*/
Url& operator =(const Url& rhs);
/**
- * Checks whether the specified instance is equal to the calling instance.
+ * Checks whether the specified instance is equal to the current instance.
*
* @since 2.0
*
bool operator ==(const Url& rhs) const;
/**
- * Compares the specified instance with the calling instance for inequality.
+ * Compares the specified instance with the current instance for inequality.
*
* @since 2.0
*
/**
* @class UserProfile
- * @brief This class represents the user’s contact information.
+ * @brief This class represents the user's contact information.
*
* @since 2.1
*
*
* @since 2.1
*
- * @param[in] rhs An instance of %UserProfile
+ * @param[in] rhs An instance of %UserProfile to copy
*/
UserProfile(const UserProfile& rhs);
*
* @since 2.1
*
- * @return The file path of a thumbnail
+ * @return The file path of the thumbnail
* @remarks If the thumbnail has not been set, an empty string is returned.
*/
Tizen::Base::String GetThumbnailPath(void) const;
*
* @return An error code
* @param[in] id The ID of the property whose value is set
- * @param[in] value A new string value to set
+ * @param[in] value The new string value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified property is read-only.
*/
result SetValue(UserProfilePropertyId id, const Tizen::Base::String& value);
/**
- * Gets the value of a specified property.
+ * Gets the value of the specified property.
*
* @since 2.1
*
Tizen::Base::String GetValue(UserProfilePropertyId id) const;
/**
- * Sets a specified phone number at the specified @c index.
+ * Sets the specified phone number at the specified @c index.
*
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] phoneNumber An instance of PhoneNumber to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c phoneNumber is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] email An instance of Email
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c email is empty.
result SetEmailAt(int index, const Email& email);
/**
- * Sets a specified URL corresponding to the specified @c index.
+ * Sets the specified URL corresponding to the specified @c index.
*
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] url An instance of Url
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c url is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] address An instance of Address
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c address is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] imAddress An instance of ImAddress
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c imAddress is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] note The note to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c note is empty.
result SetNoteAt(int index, const Tizen::Base::String& note);
/**
- * Sets a specified nick name corresponding to the specified @c index.
+ * Sets the specified nick name corresponding to the specified @c index.
*
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] nickname The nick name to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] event The event to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c event is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] organization The organization to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c organization is empty.
* @since 2.1
*
* @return An error code
- * @param[in] index An index at which the value is set
+ * @param[in] index The index at which the value is set
* @param[in] relationship An instance of Relationship to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c relationship is empty.
AddressbookId GetAddressbookId(void) const;
/**
- * Gets a list of the values belonging to a specific multi value property.
+ * Gets the list of values belonging to a specific multi value property.
*
* @since 2.1
*
- * @return A list of the values belonging to the specific multi value property
- * @param[in] id A property ID
+ * @return The list of values belonging to the specific multi value property
+ * @param[in] id The property ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
Tizen::Base::Collection::IList* GetValuesN(UserProfileMultiPropertyId id) const;
/**
- * Adds a specified phone number to the user profile.
+ * Adds the specified phone number to the user profile.
*
* @since 2.1
*
result AddEmail(const Email& email);
/**
- * Adds a specified URL to the user profile.
+ * Adds the specified URL to the user profile.
*
* @since 2.1
*
result AddAddress(const Address& address);
/**
- * Adds a specified instant message information to the user profile.
+ * Adds the specified instant message information to the user profile.
*
* @since 2.1
*
result AddNote(const Tizen::Base::String& note);
/**
- * Adds a specified nick name to the user profile.
+ * Adds the specified nick name to the user profile.
*
* @since 2.1
*
result AddRelationship(const Relationship& relationship);
/**
- * Removes a specific value at the specified @c index of a multi value property.
+ * Removes the value at the specified @c index of a multi value property.
*
* @since 2.1
*
* @return An error code
- * @param[in] id A property ID
+ * @param[in] id The property ID
* @param[in] index The index at which the value is removed
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties.
*
* @since 2.1
*
- * @param[in] rhs An instance of %UserProfile
+ * @param[in] rhs An instance of %UserProfile to copy
*/
UserProfile& operator =(const UserProfile& rhs);
/**
* @namespace Tizen::Social
- * @brief This namespace contains the classes and interfaces for managing the social information of the user.
+ * @brief This namespace contains classes and interfaces for managing the social information of a user.
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FSocial.h> @n
- * @b Library : @b osp-social
+ * @b Library: @b osp-social
*
*
- * The %Social namespace provides various classes to manage personal data, such as contacts, schedules, and accounts on the device.
+ * The %Social namespace provides various classes to manage personal data, such as contacts, schedules, and accounts on a device.
*
* For more information on the %Social namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/social/social_namespace.htm">Social Guide</a>.
*
- * The following diagrams illustrate the relationships between the classes belonging to the Social namespace.
+ * The following diagrams illustrate the relationships between the classes belonging to the %Social namespace.
*
* [Account]
* @image html social_account_classdiagram.png
projects / framework / osp / social.git / commitdiff