4 * Copyright (c) 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: Ja-young Gu <jygu@samsung.com>
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 * @ingroup TelephonyAPI
24 * @addtogroup GPS_TAPI GPS
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
39 #include <tapi_common.h>
41 #include <TelDefines.h>
49 * @brief This function sends the confirmation data for measure position message.
51 * @par Sync (or) Async:
52 * This is an Synchronous API.
54 * @par Important Notes:
61 * - handle from tel_init().
64 * -#user confirmation data for each vender.
66 * @param [in] data_len
70 * - TAPI_EVENT_GPS_MEASURE_POSITION_IND should be sent to application by Telephony Server.
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
78 * @par Prospective Clients:
85 * gps_measure_position_confirm_t data;
86 * result = tel_confirm_gps_measure_pos(handle, (unsigned char *)&data, sizeof(gps_measure_position_confirm_t));
90 /*================================================================================================*/
91 int tel_confirm_gps_measure_pos(TapiHandle *handle, unsigned char *data, unsigned int data_len);
94 * @brief This function is invoked to set the gps frequency aiding and allows the underlying OEM provider to scan the set band.
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.
100 * @par Sync (or) Async:
101 * This is an Asynchronous API.
103 * @par Important Notes:
110 * - handle from tel_init().
113 * - enable / disable state.
115 * @param [in] data_len
118 * @param [in] callback
119 * - To register callback function for result.
121 * @param [in] user_data
122 * - user_data for user specification.
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.
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
137 * @par Prospective Clients:
142 * unsigned char state = true;
144 * result = tel_set_gps_frequency_aiding(handle, state, on_gps_set_frequency_aiding, NULL);
157 /*================================================================================================*/
159 int tel_set_gps_frequency_aiding(TapiHandle *handle, unsigned char state, tapi_response_cb callback, void *user_data);
166 #endif /* _ITAPI_GPS_H_ */