doc/messages_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_MESSAGES_DOC_H__
  19 #define __TIZEN_MESSAGES_DOC_H__
  20
  21 /**
  22  * @defgroup CAPI_MESSAGING_MESSAGES_MODULE Messages
  23  * @brief The @ref CAPI_MESSAGING_MESSAGES_MODULE API provides functions to create, set properties and send a SMS/MMS message.
  24  * @ingroup CAPI_MESSAGING_FRAMEWORK
  25  *
  26  * @addtogroup CAPI_MESSAGING_MESSAGES_MODULE
  27  *
  28  * @section CAPI_MESSAGING_MESSAGES_MODULE_HEADER Required Header
  29  *   \#include <messages.h>
  30  *
  31  * @section CAPI_MESSAGING_MESSAGES_MODULE_OVERVIEW Overview
  32  *
  33  * The Messages API provides the following functionalities:
  34  *
  35  * - Creating a message
  36  * - Setting the text of the message
  37  * - Setting the message recipient(s)
  38  * - Sending a message
  39  * - Searching for messages
  40  * - Registering/Unregistering a callback function to check whether a message is sent successfully or not
  41  * - Registering/Unregistering a callback function to receive notifications when an incoming message is received
  42  *
  43  * @section CAPI_MESSAGING_MESSAGES_MODULE_FEATURE Related Features
  44  * This API is related with the following features:\n
  45  *  - http://tizen.org/feature/network.telephony\n
  46  *  - http://tizen.org/feature/network.telephony.mms\n
  47  *
  48  * It is recommended to design feature related codes in your application for reliability.\n
  49  *
  50  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  51  *
  52  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  53  *
  54  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  55  * <BR>
  56  */
  57
  58 /**
  59  * @defgroup CAPI_MESSAGING_MESSAGES_MMS_MODULE MMS
  60  * @brief The MMS API provides functions to manage attachments and subject of the MMS message.
  61  * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
  62  *
  63  * @addtogroup CAPI_MESSAGING_MESSAGES_MMS_MODULE
  64  *
  65  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_HEADER Required Header
  66  *   \#include <messages.h>
  67  *
  68  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_OVERVIEW Overview
  69  *
  70  * The MMS API provides the following functionalities:
  71  *
  72  * - Setting/Getting the subject
  73  * - Attaching the media files(image, video, audio)
  74  * - Retrieving the attachments
  75  * - Deleting all attachments
  76  *
  77  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_FEATURE Related Features
  78  * This API is related with the following features:\n
  79  *  - http://tizen.org/feature/network.telephony\n
  80  *  - http://tizen.org/feature/network.telephony.mms\n
  81  *
  82  * It is recommended to design feature related codes in your application for reliability.\n
  83  *
  84  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  85  *
  86  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  87  *
  88  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  89  *
  90  */
  91
  92 /**
  93  * @defgroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE WAP Push
  94  * @brief The MMS API provides functions to add/remove incoming callback for WAP Push messages and register current application to push server.
  95  * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
  96  *
  97  * @addtogroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE
  98  *
  99  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_HEADER Required Header
 100  *   \#include <messages.h>
 101  *
 102  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_OVERVIEW Overview
 103  *
 104  * The WAP PUSH API provides the following functionalities:
 105  *
 106  * - Adding/Removing incoming callback for WAP Push messages
 107  * - Managing the registration
 108  *
 109  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_FEATURE Related Features
 110  * This API is related with the following features:\n
 111  *  - http://tizen.org/feature/network.telephony\n
 112  *
 113  * It is recommended to design feature related codes in your application for reliability.\n
 114  *
 115  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 116  *
 117  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 118  *
 119  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
 120  *
 121  */
 122
 123 #endif /* __TIZEN_MESSAGES_DOC_H__ */