mobile/include/ITapiGps.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Ja-young Gu <jygu@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  * @open
  23  * @ingroup             TelephonyAPI
  24  * @addtogroup  GPS_TAPI                GPS
  25  * @{
  26  *
  27  * @file ITapiGps.h
  28
  29  @brief This file serves as a "C" header file defines functions for Tapi GPS\n
  30  It contains a sample set of function prototypes that would be required by applications.
  31  * GPS APIs allow an application to accomplish the following services: @n
  32  * - Confirm gps measure position information. @n
  33  */
  34
  35
  36 #ifndef _ITAPI_GPS_H_
  37 #define _ITAPI_GPS_H_
  38
  39 #include <tapi_common.h>
  40 #include <TelErr.h>
  41 #include <TelDefines.h>
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 /**
  49  * @brief  This function sends the confirmation data for measure position message.
  50  *
  51  * @par Sync (or) Async:
  52  * This is an Synchronous API.
  53  *
  54  * @par Important Notes:
  55  * - None.
  56  *
  57  * @warning
  58  * - None.
  59  *
  60  * @param [in] handle
  61  * - handle from tel_init().
  62  *
  63  * @param [in] data
  64  * -#user confirmation data for each vender.
  65  *
  66  * @param [in] data_len
  67  * - data length
  68  *
  69  * @pre
  70  * - TAPI_EVENT_GPS_MEASURE_POSITION_IND should be sent to application by Telephony Server.
  71  *
  72  * @post
  73  *
  74  * @return Return Type (int) \n
  75  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
  76  * - Refer #TapiResult_t for failure and error code
  77  *
  78  * @par Prospective Clients:
  79  * GPS Deamon
  80  *
  81  *
  82  * @code
  83  *
  84  *      int result;
  85  *      gps_measure_position_confirm_t data;
  86  *      result = tel_confirm_gps_measure_pos(handle, (unsigned char *)&data, sizeof(gps_measure_position_confirm_t));
  87  *
  88  *
  89  */
  90 /*================================================================================================*/
  91 int tel_confirm_gps_measure_pos(TapiHandle *handle, unsigned char *data, unsigned int data_len);
  92
  93 /**
  94  * @brief  This function is invoked to set the gps frequency aiding and allows the underlying OEM provider to scan the set band.
  95  *
  96  * This function makes Dbus method call to Telephony Sever and returns immediate value.
  97  * However it just means that the API request has been transfered to the CP successfully.
  98  * The actual operation result is being delivered in the corresponding event asynchronously.
  99  *
 100  * @par Sync (or) Async:
 101  * This is an Asynchronous API.
 102  *
 103  * @par Important Notes:
 104  * - None.
 105  *
 106  * @warning
 107  * - None.
 108  *
 109  * @param [in] handle
 110  * - handle from tel_init().
 111  *
 112  * @param [in] state
 113  * - enable / disable state.
 114  *
 115  * @param [in] data_len
 116  * - data length
 117
 118  * @param [in] callback
 119  * - To register callback function for result.
 120  *
 121  * @param [in] user_data
 122  * - user_data for user specification.
 123  *
 124  * @par Async Response Message:
 125  * The event associated is TAPI_EVENT_GPS_FREQ_AIDING_SET_RESP and there is no event data associated with this event and asynchronous.
 126  *
 127  * @pre
 128  *  - None.
 129  *
 130  * @post
 131  *  - None.
 132  *
 133  * @return Return Type (int) \n
 134  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 135  * - Refer #TapiResult_t for failure and error code
 136  *
 137  * @par Prospective Clients:
 138  * GPS daemon.
 139  *
 140  * @code
 141  *
 142  *      unsigned char state = true;
 143  *
 144  *      result = tel_set_gps_frequency_aiding(handle, state, on_gps_set_frequency_aiding, NULL);
 145  *
 146  * @endcode
 147  *
 148  * @see
 149  *  - None.
 150  *
 151  * @remarks
 152  *  - None.
 153  *
 154  *
 155  *
 156  */
 157 /*================================================================================================*/
 158
 159 int tel_set_gps_frequency_aiding(TapiHandle *handle, unsigned char state, tapi_response_cb callback, void *user_data);
 160
 161
 162 #ifdef __cplusplus
 163 }
 164 #endif
 165
 166 #endif  /* _ITAPI_GPS_H_ */
 167
 168 /**
 169  * @}
 170  */