* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
*\r
- * @remarks In case of error, this method returns @c null. @n\r
- * The specific error code can be accessed using the GetLastResult() method.\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
*/\r
CbsMessage* CloneN(void) const;\r
\r
* @return The serial number of the CBS message\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n\r
- * In case of an error, this method returns @c null.\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
*/\r
Tizen::Base::ByteBuffer* GetSerialNumberN(void) const;\r
\r
* @return The Data Coding Scheme of the CBS message\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n\r
- * In case of an error, this method returns @c null. @n\r
- * The alphabet/coding and the language applied to CBS messages are defined in 3GPP TS 23.038.\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
byte GetDataCodingScheme(void) const;\r
\r
* @param[in] type The type of recipient
* @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(;). @n
- * The specified @c type contains RECIPIENT_TYPE_TO, RECIPIENT_TYPE_CC, RECIPIENT_TYPE_BCC. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
* @see SetAddress()
*
*/
* @return A pointer to the attachment list
* @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. @n
- * After using the attachment list, you can call Tizen::Base::Collection::IList::RemoveAll(true) to clean up items in the list.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - After using the attachment list, you can call Tizen::Base::Collection::IList::RemoveAll(true) to clean up items in the list.
* @see EmailAttachment
* @see SetAttachmentList()
*/
* @param[in] messageId The message ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c messageId is @c 0.
- * @remarks The message ID is an automatically generated field. @n
- * It is used to prevent multiple delivery and for reference in In-Reply-To.
+ * @remarks
+ * - The message ID is an automatically generated field.
+ * - It is used to prevent multiple delivery and for reference in In-Reply-To.
* @see GetMessageId()
*/
result SetMessageId(const Tizen::Base::String& messageId);
* @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(;). @n
- * The specified @c type contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC.
+ * @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);
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
*\r
- * @remarks In case of error, this method returns @c null. @n\r
- * The specific error code can be accessed using the GetLastResult() method.\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
*/\r
EtwsPrimaryNotification* CloneN(void) const;\r
\r
* @return The serial number of the ETWS primary notification\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n\r
- * In case of an error, this method returns @c null.\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
*/\r
Tizen::Base::ByteBuffer* GetSerialNumberN(void) const;\r
\r
* @return The warning security information of the ETWS primary notification\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n\r
- * In case of an error, this method returns @c null.\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
*/\r
Tizen::Base::ByteBuffer* GetWarningSecurityInfoN(void) const;\r
\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Before calling this method, check whether the feature is supported by
+ * @remarks Before calling this method, check whether the feature is supported by
* Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(IMmsListener &listener);
* @exception E_MAX_EXCEEDED The number of recipients has crossed the maximum limit (Maximum 10).
* @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. @n
- * In this case, the result of the status report will be the E_FAILURE exception. @n
- * The CC and BCC recipients in the @c recipientList are merged with the TO recipients when sending an MMS message.
+ * @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.
+ * - The CC and BCC recipients in the @c recipientList are merged with the TO recipients when sending an MMS message.
* @see IMmsListener::OnMmsMessageSent()
*/
result Send(const MmsMessage& message, const RecipientList& recipientList, bool saveToSentbox);
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
- * @remarks Before calling this method, check whether the feature is supported by
+ * @remarks Before calling this method, check whether the feature is supported by
* Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see IPushManagerListener
* @see IPushEventListener
* @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.
- * If the user launches the application using a ticker or a quick panel,
- * the push message related to the notification is delivered to the application
- * as a launch argument.
- * The launch arguments are the input parameters for
- * Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceivedN().
- * This method returns all the unread messages including the message
- * delivered as a launch argument.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the user launches the application using a ticker or a quick panel,
+ * the push message related to the notification is delivered to the application
+ * as a launch argument.
+ * - The launch arguments are the input parameters for
+ * Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceivedN().
+ * - This method returns all the unread messages including the message
+ * delivered as a launch argument.
* @see Tizen::App::IAppControlProviderEventListener
*/
Tizen::Base::Collection::IList* GetUnreadMessagesN(void);
* @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 maximum limit can be checked by using GetMaxRecipientCount().
+ * @remarks The maximum limit can be checked by using GetMaxRecipientCount().
* @see IPushManagerListener::OnPushMessageSent()
*/
result SendPushMessage(const PushMessage& message, const Tizen::Base::Collection::IList& registrationIdList, const Tizen::Base::String& appSecret, RequestId& reqId);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks PushMessage supports to set only alert text of NotificationRequest instance, and others are ignored.
+ * @remarks PushMessage supports to set only alert text of NotificationRequest instance, and others are ignored.
* @see Tizen::Shell::NotificationRequest
*/
result SetNotification(const Tizen::Shell::NotificationRequest& notificationRequest);
* @since 2.0
*
* @return The notification request
- * @remarks PushMessage supports to get only alert text of NotificationRequest instance, and others are ignored.
+ * @remarks PushMessage supports to get only alert text of NotificationRequest instance, and others are ignored.
* @see Tizen::Shell::NotificationRequest
*/
Tizen::Shell::NotificationRequest GetNotification(void) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks Two equal instances should return the same hash value. @n
- * For better performance, the used hash function must generate a random distribution for all inputs.
+ * @remarks
+ * - Two equal instances should return the same hash value.
+ * - For better performance, the used hash function must generate a random distribution for all inputs.
*/
virtual int GetHashCode(void) const;
* @exception E_OBJ_ALREADY_EXIST The specified @c recipient is already added.
* @exception E_INVALID_ARG The specified @c recipient string length is too short (< 3) or too long (> 320), or
* the specified @c type is invalid.
- * @remarks The limit of the number of recipients is not checked in this method. This is done in the SmsManager::Send(), MmsManager::Send(), and EmailManager::Send() methods. @n
- * The minimum length of a recipient is @c 3 for a phone number and @c 5 for an email address. @n
- * The maximum length of a recipient is @c 41 for a phone number and @c 320 for an email address.
+ * @remarks
+ * - The limit of the number of recipients is not checked in this method. This is done in the SmsManager::Send(),
+ * MmsManager::Send(), and EmailManager::Send() methods.
+ * - The minimum length of a recipient is @c 3 for a phone number and @c 5 for an email address.
+ * - The maximum length of a recipient is @c 41 for a phone number and @c 320 for an email address.
* @see Set()
* @see GetListN()
* @see SmsManager::Send()
* the specified @c type is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OBJ_ALREADY_EXIST A duplicate recipient in the recipient list already exists.
- * @remarks The limit of recipients is not checked in this method. @n
- * This is done in the SmsManager::Send(), MmsManager::Send(), and EmailManager::Send() methods.
+ * @remarks
+ * - The limit of recipients is not checked in this method.
+ * - This is done in the SmsManager::Send(), MmsManager::Send(), and EmailManager::Send() methods.
* @see Add()
* @see GetListN()
*/
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c type is invalid.
- * @remarks The recipient is an email address for an email message or a telephone number for an SMS or MMS message. @n
- * The specified @c type contains RECIPIENT_TYPE_TO, RECIPIENT_TYPE_CC, RECIPIENT_TYPE_BCC. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The recipient is an email address for an email message or a telephone number for an SMS or MMS message.
+ * - The specified @c type contains @c RECIPIENT_TYPE_TO, @c RECIPIENT_TYPE_CC, @c RECIPIENT_TYPE_BCC. @n
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see Add()
* @see Set()
*/
* @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 In case of an error, this method returns the negative value. For example, @c -1. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
*/
int GetTotalMessageCount(SmsMessageBoxType type) const;
* @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. @n
- * The search with the specified keywords searches using only the first 50 characters of the body text. @n
- * The SMS messages in the searched result contain only @c 160 bytes for the body text. @n
- * To check whether there is additional text, use the SmsMessage::HasMoreText() method. @n
- * To get the full body text, use GetFullText() with its message ID.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The search with the specified keywords searches using only the first 50 characters of the body text.
+ * - The SMS messages in the searched result contain only @c 160 bytes for the body text.
+ * - To check whether there is additional text, use the SmsMessage::HasMoreText() method. @n
+ * - To get the full body text, use GetFullText() with its message ID.
* @see SmsMessage
* @see GetFullText()
*/
* @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. @n
- * The search with the specified keywords searches using only the first 50 characters of the body text. @n
- * The SMS messages in the searched result contain only @c 160 bytes for the body text. @n
- * To check whether there is additional text, use the SmsMessage::HasMoreText() method. @n
- * To get the full body text, use the GetFullText() method with its message ID.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The search with the specified keywords searches using only the first 50 characters of the body text.
+ * - The SMS messages in the searched result contain only @c 160 bytes for the body text.
+ * - To check whether there is additional text, use the SmsMessage::HasMoreText() method.
+ * - To get the full body text, use the GetFullText() method with its message ID.
* @see SmsMessage
* @see GetFullText()
*/
* @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. @n
- * In case of an error, this method returns an empty string.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - In case of an error, this method returns an empty string.
* @see SmsMessage::HasMoreText()
*/
Tizen::Base::String GetFullText(int messageId) const;
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
- * - Before calling this method, check whether the feature is supported by
+ * - Before calling this method, check whether the feature is supported by
* Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* - The specific error code can be accessed using the GetLastResult() method.
* @see AddCbsChannel()
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
- * - Before calling this method, check whether the feature is supported by
+ * - Before calling this method, check whether the feature is supported by
* Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* - The specific error code can be accessed using the GetLastResult() method.
* @see AddCbsChannel()
* @since 2.0
*
* @return The body of the SMS message
- * @remarks If the message is from the Inbox, Sentbox, or Outbox, it may contain only @c 160 bytes for the body text. @n
- * To check whether the message contains more than @c 160 bytes for the body text, use the HasMoreText() method. @n
- * To get the full body text, use the SmsManager::GetFullText() method with its message ID.
+ * @remarks
+ * - If the message is from the Inbox, Sentbox, or Outbox, it may contain only @c 160 bytes for the body text.
+ * - To check whether the message contains more than @c 160 bytes for the body text, use the HasMoreText() method.
+ * - To get the full body text, use the SmsManager::GetFullText() method with its message ID.
* @see SetText()
* @see HasMoreText()
* @see GetId()
* @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. @n
- * 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.
+ * - In case of an error, this method returns the instance denoting 00:00:00, January 1, 1.
*/
Tizen::Base::DateTime GetReceivedTime(void) const;
* @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. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
*/
int GetId(void) const;
* @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. @n
+ * @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;
* @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. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
*/
SmsMessageBoxType GetMessageBoxType(void) const;
* @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 If the return value is @c true, the SMS message contains more than @c 160 bytes for the body text. @n
- * To get the full body text, use SmsManager::GetFullText(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the return value is @c true, the SMS message contains more than @c 160 bytes for the body text.
+ * - To get the full body text, use SmsManager::GetFullText().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
bool HasMoreText(void) const;
* @since 2.0
*
* @return The body of a message
- * @remarks The message body can be any MIME content-type. @n
- * In case of error, this method returns @c null. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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