virtual ~CbsChannel(void);\r
\r
/**\r
- * Gets the range of a CBS channel\r
+ * Gets the range of a CBS channel.\r
*\r
* @since 2.0\r
*\r
\r
/**\r
* Deactivates the status of a CBS channel.\r
- * @privlevel platform\r
- * @privilege %http://tizen.org/privilege/cellbroadcast\r
*\r
* @since 2.0\r
+ * @privlevel platform\r
+ * @privilege %http://tizen.org/privilege/cellbroadcast\r
*\r
* @return An error code\r
* @exception E_SUCCESS The method is successful.\r
\r
/**\r
* Updates the name of a CBS channel.\r
- * @privlevel platform\r
- * @privilege %http://tizen.org/privilege/cellbroadcast\r
*\r
* @since 2.0\r
- *\r
+ * @privlevel platform\r
+ * @privilege %http://tizen.org/privilege/cellbroadcast\r
+ \r
* @return An error code\r
* @param[in] name The name of the CBS channel to update\r
* @exception E_SUCCESS The method is successful.\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 null.\r
+ * In case of an error, this method returns @c null.\r
*/\r
Tizen::Base::ByteBuffer* GetSerialNumberN(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- *\r
* @return The body of a message\r
*/\r
Tizen::Base::String GetText(void) const;\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 null. @n\r
- * The alphabet/coding and the language applied to CBS messages are defined in 3GPP TS 23.038\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
*/\r
byte GetDataCodingScheme(void) const;\r
\r
*\r
* @since 2.1\r
*\r
- * @return The language type of a message \r
+ * @return The language type of a message\r
*/\r
Tizen::Base::String GetLanguageType(void) const;\r
\r
* @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 RECIPIENT_TYPE_TO, RECIPIENT_TYPE_CC, RECIPIENT_TYPE_BCC.
+ * @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.
* @see GetAddress()
*/
result SetAddress(RecipientType type, const Tizen::Base::String& recipients);
*
* @code
*
- // Creates a listener to override the OnEmailMessageSent() function of IEmailListener
+ // Creates a listener to override the OnEmailMessageSent() method of IEmailListener
// in order to be notified of a change in the state of the message being sent.
class EmailListener
* @param[in] filePath The path of the file to remove
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The corresponding format file is not found.
- * @see AddAttachment(), GetAttachmentListN()
+ * @see AddAttachment()
+ * @see GetAttachmentListN()
*/
result RemoveAttachment(const Tizen::Base::String& filePath);
* @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 null.\r
+ * In case of an error, this method returns @c null.\r
*/\r
Tizen::Base::ByteBuffer* GetSerialNumberN(void) const;\r
\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 null.\r
+ * In case of an error, this method returns @c null.\r
*/\r
Tizen::Base::ByteBuffer* GetWarningSecurityInfoN(void) const;\r
\r
\r
/**\r
* @interface ICbsMessageEventListener\r
- * @brief This is the listener interface for receiving CBS messages.\r
+ * @brief This interface is the listener interface for receiving CBS messages.\r
*\r
* @since 2.0\r
*\r
/**
* @interface IEmailListener
- * @brief This is the listener interface for receiving email sent status.
+ * @brief This interface is the listener interface for receiving email sent status.
*
* @since 2.0
*
\r
/**\r
* @interface IEtwsPrimaryNotificationEventListener\r
- * @brief This is the listener interface for receiving ETWS primary notification.\r
+ * @brief This interface is the listener interface for receiving ETWS primary notification.\r
*\r
* @since 2.0\r
*\r
/**
* @interface IMmsListener
- * @brief This is the listener interface for receiving MMS sent status.
+ * @brief This interface is the listener interface for receiving MMS sent status.
*
* @since 2.0
*
{
/**
* @interface IPushEventListener
-* @brief This is the listener interface for receiving push messages.
+* @brief This interface is the listener interface for receiving push messages.
*
* @since 2.0
*
{
/**
* @interface IPushManagerListener
-* @brief This listener interface receives the registration result.
+* @brief This interface is the listener interface that receives the registration result.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] registrationId The registration ID of the recipient
* @param[in] r The result of the request, @n
- * Exception code may be given through this parameter.
+ * The following exceptions may be given through this parameter.
* @param[in] errorCode The error code from the server
* @param[in] errorMsg The error message from the server
* @exception E_SUCCESS The method is successful.
/**
* @file FMsgISmsEventListener.h
* @brief This is the header file for the %ISmsEventListener interface.
+ *
* This header file contains the declarations of the %ISmsEventListener interface.
*/
/**
* @interface ISmsEventListener
- * @brief This is the listener interface for receiving SMS messages.
+ * @brief This interface is the listener interface for receiving SMS messages.
*
* @since 2.0
*
{
/**
* @interface ISmsListener
- * @brief This is the listener interface for receiving SMS sent status.
+ * @brief This interface is the listener interface for receiving SMS sent status.
*
* @since 2.0
*
/**
* @interface ISmsMessageEventListener
- * @brief This is the listener interface for receiving SMS messages.
+ * @brief This interface is the listener interface for receiving SMS messages.
*
* @since 2.0
*
* @file FMsgIWapPushEventListener.h
* @brief This is the header file for the %IWapPushEventListener interface.
*
-* This header file contains the declaration of the %IWapPushEventListener interface.
+* This header file contains the declarations of the %IWapPushEventListener interface.
*/
#ifndef _FMSG_IWAP_PUSH_EVENT_LISTENER_H_
{
/**
* @interface IWapPushEventListener
-* @brief This is the listener interface for receiving WAP Push messages.
+* @brief This interface is the listener interface for receiving WAP Push messages.
*
* @since 2.0
*
*
* @code
*
- // Creates a listener to override the OnMmsMessageSent() function of IMmsListener
+ // Creates a listener to override the OnMmsMessageSent() method of IMmsListener
// in order to be notified of a change in the state of the message being sent.
class MmsListener
* Initializes this instance of %MmsManager with the specified parameter.
*
* @since 2.0
+ *
* @feature %http://tizen.org/feature/network.telephony.mms
* @return An error code
* @param[in] listener The listener to receive a send result asynchronously
* - The specified file format is already attached. @n
* - The specified @c format is invalid. @n
* - The specified file contains invalid or the media is not supported. @n
- * - The specified file format cannot be attached.@n
+ * - The specified file format cannot be attached. @n
* (An MMS attachment may contain either an image, audio, video, vCard, or a vCalendar file or a combination of an image, audio, vCard, and vCalendar file. @n
* MMS attachments cannot contain a video file in combination with an image or audio file.)
* @exception E_MAX_EXCEEDED The size of the file exceeds the maximum limit (Maximum 295KB). @n
/**
* Registers the push messaging service for the current application. @n
- * This method is asynchronous.
+ * The %RegisterPushService() method is asynchronous.
*
* @since 2.0
* @privlevel public
/**
* Unregisters the push messaging service for the current application. @n
- * This method is asynchronous.
+ * The %UnregisterPushService() method is asynchronous.
*
* @since 2.0
* @privlevel public
/**
* Gets the unread push messages. @n
- * If an application receives unread messages with this method, the messages are removed from the system.
+ * If an application receives unread messages with the %GetUnreadMessagesN() method, the messages are removed from the system.
*
* @since 2.0
* @privlevel public
* as a launch argument.
* The launch arguments are the input parameters for
* Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceivedN().
- * This function returns all the unread messages including the message
+ * This method returns all the unread messages including the message
* delivered as a launch argument.
* @see Tizen::App::IAppControlProviderEventListener
*/
/**
* Sends the push message to a single recipient. @n
- * This method is asynchronous.
+ * The %SendPushMessage() method is asynchronous.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/push and %http://tizen.org/privilege/http @n
- * Both privileges are required
+ * Both privileges are required.
*
* @pre In order to use the push messaging service, see <a href="../org.tizen.native.appprogramming/html/guide/messaging/push_messaging.htm">Push Messaging Guide</a>.
*
/**
* Sends the push message to multiple recipients. @n
- * This method is asynchronous.
+ * The %SendPushMessage() method is asynchronous.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/push and %http://tizen.org/privilege/http @n
- * Both privileges are required
+ * Both privileges are required.
*
* @pre In order to use the push messaging service, see <a href="../org.tizen.native.appprogramming/html/guide/messaging/push_messaging.htm">Push Messaging Guide</a>.
*
* Gets the body of the message.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated. Instead of using this method, use Tizen::Shell::NotificationRequest::GetAppMessage() method.
+ * @deprecated This method is deprecated. Instead of using this method, use the Tizen::Shell::NotificationRequest::GetAppMessage() method.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return The current instance's hash value
+ * @return The hash value of the current instance
*/
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 Send() method of each manager class (SmsManager, MmsManager, and EmailManager). @n
+ * @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.
* @see Set()
*
* @code
*
- // Creates a listener to override the OnSmsMessageSent() function of ISmsListener
+ // Creates a listener to override the OnSmsMessageSent() method of ISmsListener
// in order to be notified of a change in the state of the message being sent.
class SmsListener
* Initializes this instance of %SmsManager with the specified parameter.
*
* @since 2.0
+ *
* @feature %http://tizen.org/feature/network.telephony
* @return An error code
* @param[in] listener The listener to receive a send result asynchronously
* Adds the event listener for receiving SMS messages.
*
* @since 2.0
- *
* @privlevel partner
* @privilege %http://tizen.org/privilege/smstrigger
*
* Removes the event listener for receiving SMS messages.
*
* @since 2.0
- *
* @privlevel partner
* @privilege %http://tizen.org/privilege/smstrigger
*
* Adds the event listener for receiving SMS messages.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Removes the event listener for receiving SMS messages.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Sends the SMS message.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.write
*
* Gets the total number of SMS messages in the specified message box.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Searches the SMS messages by keyword and|or sender address in the Inbox.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Searches the SMS messages by keyword in the specified message box.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* 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.
- * @see SmsMessage, GetFullText()
+ * @see SmsMessage
+ * @see GetFullText()
*/
Tizen::Base::Collection::IList* SearchMessageBoxN(SmsMessageBoxType type, const Tizen::Base::String* pKeyword, int startIndex, int count, int& totalResultCount) const;
* Gets the full text of the SMS message in the message box using the message ID.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Sets the event listener for receiving CB messages.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] pListener The listener to receive CB messages
* Sets the event listener for receiving ETWS primary notification.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] pListener The listener to receive ETWS primary notification
result SetEtwsPrimaryNotificationEventListener(IEtwsPrimaryNotificationEventListener* pListener);
/**
- * Enables or disables the save option for CBS message to the CbsBox
+ * Enables or disables the save option for CBS message to the CbsBox.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] enable Set to @c true to save the message in the CbsBox, @n
* Checks whether the CB service is enabled.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
*
* Enables or disables the CB service.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] enable Set to @c true to enable the CB service, @n
* Adds a CBS channel with specified parameters.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] from The starting index of the message ID of the channel
* Removes a CBS channel.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return An error code
* @param[in] from The starting index of the message ID of the channel
* Gets a CBS channel with specified range.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
+ *
* @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @return A pointer to the CBS channel with specific range.
* @param[in] from The starting index of the message ID of the channel
* Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* - The specific error code can be accessed using the GetLastResult() method.
* @see AddCbsChannel()
- * @see RemoveCbsChannel()
+ * @see RemoveCbsChannel()
*/
CbsChannel* GetCbsChannelN(int from, int to) const;
* Gets the CBS channel list.
*
* @since 2.0
- * @feature %http://tizen.org/feature/network.telephony.sms.cbs
* @privlevel platform
* @privilege %http://tizen.org/privilege/cellbroadcast
*
+ * @feature %http://tizen.org/feature/network.telephony.sms.cbs
+ *
* @return A pointer to the list of CBS channel
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* Gets the sender address of the SMS message.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Gets the received time of the SMS message.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Gets the unique ID of the SMS message.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Gets the sent time of the SMS message.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Gets the type of the SMS message box.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Gets the list of the recipients.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
* Checks whether the SMS message contains more than @c 160 bytes for the body text.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/messaging.read
* (%http://tizen.org/privilege/messaging.sms is deprecated.)
//
/**
* @file FMsgTypes.h
- * @brief This is the header file for the %Messaging class.
+ * @brief This is the header file for the enumerations of the Messaging namespace.
*
- * This header file contains the type declarations for the %Messaging namespace.
+ * This header file contains the type declarations of the Messaging namespace.
*/
#ifndef _FMSG_TYPES_H_
/**
* @enum RecipientType
*
- * Defines the recipient type for a Short Message Service(SMS), Multimedia %Messaging Service(MMS) and email messages.
+ * Defines the recipient type for a Short Message Service(SMS), Multimedia %Messaging Service(MMS), and email messages.
*
* @since 2.0
*/
* @since 2.0
*
* @final This class is not intended for extension.
+*
+* The %WapPushManager class provides methods to use the WAP Push messaging service.
*/
class _OSP_EXPORT_ WapPushManager
: public Tizen::Base::Object
* Adds the event listener for receiving WAP Push messages for a specific WAP Push application ID.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/wappush
+ *
* @feature %http://tizen.org/feature/network.telephony
* @return An error code
* @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP Push application ID
* ID.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/wappush
+ *
* @feature %http://tizen.org/feature/network.telephony
* @return An error code
* @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP Push
* Registers a condition to receive WAP Push message.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/wappush
+ *
* @feature %http://tizen.org/feature/network.telephony
* @return An error code
- * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID.
- * @param[in] contentType The MIME content type of the content.
+ * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID
+ * @param[in] contentType The MIME content type of the content
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contentType or @c wapApplicationId is invalid.
* @exception E_ILLEGAL_ACCESS The application does not have the permission to register the conditions.
* Unregisters a condition to receive WAP push message.
*
* @since 2.0
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/wappush
+ *
* @feature %http://tizen.org/feature/network.telephony
* @return An error code
- * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID.
- * @param[in] contentType The MIME content type of the content.
+ * @param[in] wapApplicationId The X-Wap-Application-Id indicating a WAP push application ID
+ * @param[in] contentType The MIME content type of the content
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contentType or @c wapApplicationId is invalid.
* @exception E_ILLEGAL_ACCESS The application does not have the permission to unregister the conditions.
*
* @return The body of a message
* @remarks The message body can be any MIME content-type. @n
- * In case of error, this method returns null. @n
+ * In case of error, this method returns @c null. @n
* The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::ByteBuffer* GetBodyN(void) const;
* else @c null in case of an error
* @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.
*/
WapPushMessage* CloneN(void) const;
projects / framework / osp / messaging.git / commitdiff