*\r
* @since 2.0\r
*\r
- * @return The name of the channel\r
- *\r
- * @remarks The name can be an empty string.\r
+ * @return The name of the channel @n\r
+ * The name can be an empty string.\r
*/\r
Tizen::Base::String GetName(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- * @return An instance of %CbsMessage\r
+ * @return An instance of %CbsMessage @n\r
+ * The value is @c null in case of an error.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
*\r
- * @remarks \r
- * - In case of error, this method returns @c null.\r
- * - 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
CbsMessage* CloneN(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- * @return The serial number of the CBS message\r
+ * @return The serial number of the CBS message @n\r
+ * The value is @c null in case of an error.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks \r
- * - The specific error code can be accessed using the GetLastResult() method.\r
- * - In case of an error, this method returns @c null.\r
+ * @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Tizen::Base::ByteBuffer* GetSerialNumberN(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- * @return The Data Coding Scheme of the CBS message\r
+ * @return The Data Coding Scheme of the CBS message @n\r
+ * The value is @c null in case of an error.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
* @remarks \r
- * - In case of an error, this method returns @c null.\r
* - The specific error code can be accessed using the GetLastResult() method.\r
* - The alphabet/coding and the language applied to CBS messages are defined in 3GPP TS 23.038.\r
*/\r
*
* @since 2.0
*
- * @return The email address of the specific recipient type
- * @param[in] type The type of recipient
+ * @return The email address of the specific recipient type @n
+ * The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;).
+ * @param[in] type The type of recipient @n
+ * The value contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c type is invalid.
- * @remarks
- * - The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;).
- * - The specified @c type contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAddress()
*
*/
* @since 2.0
*
* @return An error code
- * @param[in] type The type of recipient
- * @param[in] recipients The recipients string
+ * @param[in] type The type of recipient @n
+ * The value contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC.
+ * @param[in] recipients The recipients string @n
+ * The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;).
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c type is invalid, or
* the specified @c recipients string length is too short (< 5).
- * @remarks
- * - The values for the various recipients can be a string with multiple email addresses separated by semi-colons(;).
- * - The specified @c type contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC.
* @see GetAddress()
*/
result SetAddress(RecipientType type, const Tizen::Base::String& recipients);
*\r
* @since 2.0\r
*\r
- * @return An instance of %EtwsPrimaryNotification\r
+ * @return An instance of %EtwsPrimaryNotification @n\r
+ * The value is @c null in case of an error.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
*\r
- * @remarks \r
- * - In case of error, this method returns @c null.\r
- * - 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
EtwsPrimaryNotification* CloneN(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- * @return The warning security information of the ETWS primary notification\r
+ * @return The warning security information of the ETWS primary notification @n\r
+ * The value is @c null in case of an error.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks \r
- * - The specific error code can be accessed using the GetLastResult() method.\r
- * - In case of an error, this method returns @c null.\r
+ * @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Tizen::Base::ByteBuffer* GetWarningSecurityInfoN(void) const;\r
\r
* @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
* @remarks
- * - Some service providers may not support sending MMS messages with an empty subject or body.
- * - In this case, the result of the status report will be the E_FAILURE exception.
+ * - Some service providers may not support sending MMS messages with an empty subject or body. @n
+ * In this case, the result of the status report will be the E_FAILURE exception.
* - The CC and BCC recipients in the @c recipientList are merged with the TO recipients when sending an MMS message.
* @see IMmsListener::OnMmsMessageSent()
*/
* @privilege %http://tizen.org/privilege/messaging.read @n
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
*
- * @return The full text of the specified SMS message
+ * @return The full text of the specified SMS message @n
+ * The value is an empty string in case of an error.
* @param[in] messageId The unique ID of the message
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c messageId is invalid, or it must be greater than or equal to @c 0.
* @exception E_SYSTEM A system error has occurred.
* @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
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - In case of an error, this method returns an empty string.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SmsMessage::HasMoreText()
*/
Tizen::Base::String GetFullText(int messageId) const;
* @privilege %http://tizen.org/privilege/messaging.read @n
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
*
- * @return The received time of the SMS message
+ * @return The received time of the SMS message @n
+ * The value is 00:00:00, January 1, 1 in case of an error.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION This operation is only allowed to the incoming message or the message from the Inbox.
* @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
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - In case of an error, this method returns the instance denoting 00:00:00, January 1, 1.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::DateTime GetReceivedTime(void) const;
* @privilege %http://tizen.org/privilege/messaging.read @n
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
*
- * @return The unique ID of the SMS message
+ * @return The unique ID of the SMS message @n
+ * The value is a negative value in case of an error. For example, @c -1.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION This operation is allowed only when the message is from the Inbox, Sentbox, or Outbox.
* @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
- * @remarks
- * - In case of an error, this method returns the negative value. For example, @c -1.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetId(void) const;
* @privilege %http://tizen.org/privilege/messaging.read @n
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
*
- * @return The sent time of the SMS message
+ * @return The sent time of the SMS message @n
+ * The value is 00:00:00, January 1, 1 in case of an error.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION This operation is allowed only when the message is from the Sentbox or Outbox.
* @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
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * In case of an error, this method returns the instance denoting 00:00:00, January 1, 1.
*/
Tizen::Base::DateTime GetSentTime(void) const;
* @privilege %http://tizen.org/privilege/messaging.read @n
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
*
- * @return The type of the SMS message box
+ * @return The type of the SMS message box @n
+ * The value is @c SMS_MESSAGE_BOX_TYPE_NONE in case of an error.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION This operation is allowed only when the message is from the Inbox, Sentbox, or Outbox.
* @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
- * @remarks
- * - In case of an error, this method returns the SMS_MESSAGE_BOX_TYPE_NONE value.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
SmsMessageBoxType GetMessageBoxType(void) const;
*
* @since 2.0
*
- * @return The header of a message
- * @remarks The header has X-Wap-Application-Id and Content-Type fields.
+ * @return The header of a message @n
+ * The header has X-Wap-Application-Id and Content-Type fields.
*/
Tizen::Base::String GetHeader(void) const;
*
* @since 2.0
*
- * @return The body of a message
+ * @return The body of a message @n
+ * The value is @c null in case of an error.
* @remarks
* - The message body can be any MIME content-type.
- * - In case of error, this method returns @c null.
* - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::ByteBuffer* GetBodyN(void) const;
projects / framework / osp / messaging.git / commitdiff