summaryrefslogtreecommitdiff
path: root/doc/messages_doc.h
blob: 11883439a9d98445ef1861ce9458ca2f039da619 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef __TIZEN_MESSAGES_DOC_H__
#define __TIZEN_MESSAGES_DOC_H__


/**
 * @ingroup CAPI_MESSAGING_FRAMEWORK
 * @defgroup CAPI_MESSAGING_MESSAGES_MODULE Messages
 * @addtogroup CAPI_MESSAGING_MESSAGES_MODULE
 * @brief The @ref CAPI_MESSAGING_MESSAGES_MODULE API provides functions to create, set properties, and send a SMS/MMS message.
 * @section CAPI_MESSAGING_MESSAGES_MODULE_HEADER Required Header
 *   \#include <messages.h>
 *
 * @section CAPI_MESSAGING_MESSAGES_MODULE_OVERVIEW Overview
 * The Messages API provides the following functionalities:
 * - Creating a message
 * - Setting the text of the message
 * - Setting the message recipient(s)
 * - Sending a message
 * - Searching for messages
 * - Registering/Unregistering a callback function to check whether a message is sent successfully or not
 * - Registering/Unregistering a callback function to receive notifications when an incoming message is received
 *
 * @section CAPI_MESSAGING_MESSAGES_MODULE_FEATURE Related Features
 * This API is related with the following features:\n
 * - http://tizen.org/feature/network.telephony\n
 * - http://tizen.org/feature/network.telephony.sms\n
 * - http://tizen.org/feature/network.telephony.mms\n
 * It is recommended to design feature related codes in your application for reliability.\n
 * 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
 * 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
 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 * <BR>
 */


/**
 * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
 * @defgroup CAPI_MESSAGING_MESSAGES_MMS_MODULE MMS
 * @addtogroup CAPI_MESSAGING_MESSAGES_MMS_MODULE
 * @brief The MMS API provides functions to manage attachments and subject of the MMS message.
 * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_HEADER Required Header
 *   \#include <messages.h>
 *
 * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_OVERVIEW Overview
 * The MMS API provides the following functionalities:
 * - Setting/Getting the subject
 * - Attaching the media files(image, video, audio)
 * - Retrieving the attachments
 * - Deleting all attachments
 *
 * @section CAPI_MESSAGING_MESSAGES_MMS_MODULE_FEATURE Related Features
 * This API is related with the following features:\n
 * - http://tizen.org/feature/network.telephony\n
 * - http://tizen.org/feature/network.telephony.sms\n
 * - http://tizen.org/feature/network.telephony.mms\n
 * It is recommended to design feature related codes in your application for reliability.\n
 * 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
 * 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
 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 */


/**
 * @ingroup CAPI_MESSAGING_MESSAGES_MODULE
 * @defgroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE WAP Push
 * @addtogroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE
 * @brief The WAP PUSH API provides functions to add/remove incoming callback for WAP Push messages and register current application to push server.
 * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_HEADER Required Header
 *   \#include <messages.h>
 *
 * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_OVERVIEW Overview
 * The WAP PUSH API provides the following functionalities:
 * - Adding/Removing incoming callback for WAP Push messages
 * - Managing the registration
 *
 * @section CAPI_MESSAGING_MESSAGES_PUSH_MODULE_FEATURE Related Features
 * This API is related with the following features:\n
 * - http://tizen.org/feature/network.telephony\n
 * - http://tizen.org/feature/network.telephony.sms\n
 *
 * It is recommended to design feature related codes in your application for reliability.\n
 * 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
 * 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
 * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 */


#endif /* __TIZEN_MESSAGES_DOC_H__ */