include/mapi/MapiSetting.h

   1 /*
   2 *
   3 * Copyright (c) 2000-2012 Samsung Electronics Co., Ltd. All Rights Reserved.
   4 *
   5 * This file is part of msg-service.
   6 *
   7 * Contact: Jaeyun Jeong <jyjeong@samsung.com>
   8 *          Sangkoo Kim <sangkoo.kim@samsung.com>
   9 *          Seunghwan Lee <sh.cat.lee@samsung.com>
  10 *          SoonMin Jung <sm0415.jung@samsung.com>
  11 *          Jae-Young Lee <jy4710.lee@samsung.com>
  12 *          KeeBum Kim <keebum.kim@samsung.com>
  13 *
  14 * PROPRIETARY/CONFIDENTIAL
  15 *
  16 * This software is the confidential and proprietary information of
  17 * SAMSUNG ELECTRONICS ("Confidential Information"). You shall not
  18 * disclose such Confidential Information and shall use it only in
  19 * accordance with the terms of the license agreement you entered
  20 * into with SAMSUNG ELECTRONICS.
  21 *
  22 * SAMSUNG make no representations or warranties about the suitability
  23 * of the software, either express or implied, including but not limited
  24 * to the implied warranties of merchantability, fitness for a particular
  25 * purpose, or non-infringement. SAMSUNG shall not be liable for any
  26 * damages suffered by licensee as a result of using, modifying or
  27 * distributing this software or its derivatives.
  28 *
  29 */
  30
  31 #ifndef MAPI_SETTING_H
  32 #define MAPI_SETTING_H
  33
  34 /**
  35  *      @section                Introduction
  36  *      - Introduction : Overview on Messaging Setting API
  37  *      @section                Program
  38  *      - Program : Messaging Setting API Reference
  39  */
  40
  41 /*==================================================================================================
  42                                          INCLUDE FILES
  43 ==================================================================================================*/
  44
  45 #include "MsgSettingTypes.h"
  46
  47 #ifdef __cplusplus
  48 extern "C"
  49 {
  50 #endif
  51
  52 /**
  53  *      @ingroup                MESSAGING_FRAMEWORK
  54  *      @defgroup       MESSAGING_SETTING_API   Messaging Setting API
  55  *      @{
  56  */
  57
  58 /*==================================================================================================
  59                                      FUNCTION PROTOTYPES
  60 ==================================================================================================*/
  61
  62 /**
  63
  64  * \par Description:
  65  * Sets a Messaging option such as SMS/MMS sending options, Push settings etc..
  66  *
  67  * \par Purpose:
  68  * This API is used to set message options.
  69  *
  70  * \par Typical use case:
  71  * Used in setting the messaging options such as SMS/MMS sending options, Push message settings etc.
  72  *
  73  * \par Method of function operation:
  74  * Stores the MSG_SETTING_S settings to storage such as gconf, etc.
  75  *
  76  * \par Sync (or) Async:
  77  * This is a Synchronous API.
  78  *
  79  * \par Important notes:
  80  * None
  81  *
  82  * \param input - MSG_HANDLE_T  handle is Message handle.
  83  * \param input - MSG_SETTING_S  setting is a pointer to setting information.
  84  *
  85  * \return Return Type int (MSG_ERROR_T) \n
  86  * - MSG_SUCCESS                                        Success in operation.
  87  * - MSG_ERR_SET_WRITE_ERROR            Setting configuration is error.
  88  *
  89  * \par Prospective clients:
  90  * External/Native Apps using Messaging Services.
  91  *
  92  * \par Related functions:
  93  * None
  94  *
  95  * \par Known issues/bugs:
  96  * None
  97  *
  98  * \par Sample code:
  99  * \code
 100  * ...
 101  *
 102  * MSG_HANDLE_T msgHandle = NULL;
 103  * MSG_SETTING_S setting;
 104  * MSG_ERROR_T err;
 105  *
 106  * ...
 107  * err = msg_set_config(msgHandle, &setting);
 108  * ...
 109  * \endcode
 110  */
 111 /*================================================================================================*/
 112 int msg_set_config(MSG_HANDLE_T handle, const MSG_SETTING_S *setting);
 113
 114
 115 /**
 116
 117  * \par Description:
 118  * Retrieve a Messaging option such as SMS/MMS sending options, Push settings etc..
 119  *
 120  * \par Purpose:
 121  * This API is used to getting message options.
 122  *
 123  * \par Typical use case:
 124  * Used in setting the messaging options such as SMS/MMS sending options, Push message settings etc.
 125  *
 126  * \par Method of function operation:
 127  * Stores the MSG_SETTING_S settings to storage such as gconf, etc.
 128  *
 129  * \par Sync (or) Async:
 130  * This is a Synchronous API.
 131  *
 132  * \par Important notes:
 133  * None
 134  *
 135  * \param input - MSG_HANDLE_T  handle is Message handle.
 136  * \param input - MSG_SETTING_S  setting is a pointer to setting information.
 137  *
 138  * \return Return Type int (MSG_ERROR_T) \n
 139  * - MSG_SUCCESS                                        Success in operation.
 140  * - MSG_ERR_SET_READ_ERROR             Getting configuration is error.
 141  *
 142  * \par Prospective clients:
 143  * External/Native Apps using Messaging Services.
 144  *
 145  * \par Related functions:
 146  * None
 147  *
 148  * \par Known issues/bugs:
 149  * None
 150  *
 151  * \par Sample code:
 152  * \code
 153  * ...
 154  *
 155  * MSG_HANDLE_T msgHandle = NULL;
 156  * MSG_SETTING_S setting;
 157  * MSG_ERROR_T err;
 158  *
 159  * ...
 160  * err = msg_get_config(msgHandle, &setting);
 161  * ...
 162  * \endcode
 163  */
 164 /*================================================================================================*/
 165 int msg_get_config(MSG_HANDLE_T handle, MSG_SETTING_S *setting);
 166
 167 /**
 168  *      @}
 169  */
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif // MAPI_SETTING_H
 176