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 /**
  23  * @ingroup CAPI_MESSAGING_FRAMEWORK
  24  * @defgroup CAPI_MESSAGING_MESSAGES_MODULE Messages
  25  * @addtogroup CAPI_MESSAGING_MESSAGES_MODULE
  26  * @brief The @ref CAPI_MESSAGING_MESSAGES_MODULE API provides functions to create, set properties, and send a SMS/MMS message.
  27  * @section CAPI_MESSAGING_MESSAGES_MODULE_HEADER Required Header
  28  *   \#include <messages.h>
  29  *
  30  * @section CAPI_MESSAGING_MESSAGES_MODULE_OVERVIEW Overview
  31  * The Messages API provides the following functionalities:
  32  * - Creating a message
  33  * - Setting the text of the message
  34  * - Setting the message recipient(s)
  35  * - Sending a message
  36  * - Searching for messages
  37  * - Registering/Unregistering a callback function to check whether a message is sent successfully or not
  38  * - Registering/Unregistering a callback function to receive notifications when an incoming message is received
  39  *
  40  * @section CAPI_MESSAGING_MESSAGES_MODULE_FEATURE Related Features
  41  * This API is related with the following features:\n
  42  * - http://tizen.org/feature/network.telephony\n
  43  * - http://tizen.org/feature/network.telephony.sms\n
  44  * - http://tizen.org/feature/network.telephony.mms\n
  45  * It is recommended to design feature related codes in your application for reliability.\n
  46  * 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
  47  * 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
  48  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  49  * <BR>
  50  */
  51
  52
  53 /**
  54  * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
  55  * @defgroup CAPI_MESSAGING_MESSAGES_MMS_MODULE MMS
  56  * @addtogroup CAPI_MESSAGING_MESSAGES_MMS_MODULE
  57  * @brief The MMS API provides functions to manage attachments and subject of the MMS message.
  58  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_HEADER Required Header
  59  *   \#include <messages.h>
  60  *
  61  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_OVERVIEW Overview
  62  * The MMS API provides the following functionalities:
  63  * - Setting/Getting the subject
  64  * - Attaching the media files(image, video, audio)
  65  * - Retrieving the attachments
  66  * - Deleting all attachments
  67  *
  68  * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_FEATURE Related Features
  69  * This API is related with the following features:\n
  70  * - http://tizen.org/feature/network.telephony\n
  71  * - http://tizen.org/feature/network.telephony.sms\n
  72  * - http://tizen.org/feature/network.telephony.mms\n
  73  * It is recommended to design feature related codes in your application for reliability.\n
  74  * 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
  75  * 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
  76  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  77  */
  78
  79
  80 /**
  81  * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
  82  * @defgroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE WAP Push
  83  * @addtogroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE
  84  * @brief The WAP PUSH API provides functions to add/remove incoming callback for WAP Push messages and register current application to push server.
  85  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_HEADER Required Header
  86  *   \#include <messages.h>
  87  *
  88  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_OVERVIEW Overview
  89  * The WAP PUSH API provides the following functionalities:
  90  * - Adding/Removing incoming callback for WAP Push messages
  91  * - Managing the registration
  92  *
  93  * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_FEATURE Related Features
  94  * This API is related with the following features:\n
  95  * - http://tizen.org/feature/network.telephony\n
  96  * - http://tizen.org/feature/network.telephony.sms\n
  97  *
  98  * It is recommended to design feature related codes in your application for reliability.\n
  99  * 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
 100  * 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
 101  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 102  */
 103
 104
 105 #endif /* __TIZEN_MESSAGES_DOC_H__ */