include/ServiceEngine/SE_AutoConfig.h

   1 /*
   2  * oma-ds-service
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: JuHak Park <juhaki.park@samsung.com>,
   7  *          JuneHyuk Lee <junhyuk7.lee@samsung.com>,
   8  *          SunBong Ha <sunbong.ha@samsung.com>
   9  *
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  *
  22  */
  23
  24
  25
  26
  27
  28 /*
  29  * For any sort of issue you concern as to this software,
  30  * you may use following point of contact.
  31  * All resources contributed on this software
  32  * are orinigally written by S-Core Inc., a member of Samsung Group.
  33  *
  34  * SeongWon Shim <seongwon.shim@samsung.com>
  35  */
  36
  37 /**
  38  *   @SE_AutoConfig.h
  39  *   @version                                                                   0.1
  40  *   @brief                                                                             This file is the header file of interface of Auto Configuration
  41  */
  42
  43 #ifndef SE_AUTOCONFIG_H_
  44 #define SE_AUTOCONFIG_H_
  45
  46 #include <stdbool.h>
  47 #include <glib.h>
  48 #include <stdlib.h>
  49
  50 /**
  51  * @par Description: API to process auto configure
  52  * This API can be used to process auto configure using inputed information by UI
  53  * This API uses Notification API which for notifying auto configure result to UI
  54  *
  55  * @par Purpose:
  56  * @par Typical use case:
  57  * @par Method of function operation:
  58  * @par Important notes:
  59  * @param[in]           string type, profileDirName(identify profile in UI)
  60  *
  61  * @return                              true on success
  62  *                                                      false on error
  63  *
  64  * @par Errors:
  65  *
  66  * @pre None.
  67  * @post
  68  * @see
  69  * @remarks None.
  70  *
  71  * @par Sample Code:
  72  * @code
  73  * @endcode
  74  */
  75 /*TODO have to be removed after removing vconf*/
  76 bool autoconfigure_from_vconf(char *profile);
  77
  78 /**
  79  * @par Description: API to process auto configure
  80  * This API can be used to process auto configure using inputed information by UI
  81  * This API uses Notification API which for notifying auto configure result to UI
  82  *
  83  * @par Purpose:
  84  * @par Typical use case:
  85  * @par Method of function operation:
  86  * @par Important notes:
  87  * @param[in]           string type, profileDirName(identify profile in UI)
  88  *
  89  * @return                              true on success
  90  *                                                      false on error
  91  *
  92  * @par Errors:
  93  *
  94  * @pre None.
  95  * @post
  96  * @see
  97  * @remarks None.
  98  *
  99  * @par Sample Code:
 100  * @code
 101 int main()
 102 {
 103         bool ret = 0;
 104         ret = autoconfigure(profildDirName, addr, id, password);
 105         if (ret == true)
 106         {
 107                 //synchronization success
 108         }
 109         else
 110         {
 111                 //synchronization fail
 112         }
 113
 114         return 0;
 115 }
 116  * @endcode
 117  */
 118 bool autoconfigure(char *profildDirName, char *addr, char *id, char *password);
 119
 120 #endif /* SE_AUTOCONFIG_H_ */