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>
50 * @brief This function sends the confirmation data for measure position message.
52 * @par Sync (or) Async:
53 * This is an Synchronous API.
55 * @par Important Notes:
62 * - handle from tel_init().
65 * -#user confirmation data for each vender.
67 * @param [in] data_len
71 * - TAPI_EVENT_GPS_MEASURE_POSITION_IND should be sent to application by Telephony Server.
76 * @return Return Type (int) \n
77 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
78 * - Refer #TapiResult_t for failure and error code
80 * @par Prospective Clients:
87 * gps_measure_position_confirm_t data;
88 * result = tel_confirm_gps_measure_pos(handle, (unsigned char *)&data, sizeof(gps_measure_position_confirm_t));
92 /*================================================================================================*/
93 int tel_confirm_gps_measure_pos(TapiHandle *handle, unsigned char *data, unsigned int data_len);
96 * @brief This function is invoked to set the gps frequency aiding.
98 * This function makes Dbus method call to Telephony Sever and returns immediate value.
99 * However it just means that the API request has been transfered to the CP successfully.
100 * The actual operation result is being delivered in the corresponding event asynchronously.
102 * @par Sync (or) Async:
103 * This is an Asynchronous API.
105 * @par Important Notes:
112 * - handle from tel_init().
115 * - enable / disable state.
117 * @param [in] data_len
120 * @param [in] callback
121 * - To register callback function for result.
123 * @param [in] user_data
124 * - user_data for user specification.
126 * @par Async Response Message:
135 * @return Return Type (int) \n
136 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
137 * - Refer #TapiResult_t for failure and error code
139 * @par Prospective Clients:
144 * unsigned char state = true;
146 * result = tel_set_gps_frequency_aiding(handle, state, on_gps_set_frequency_aiding, NULL);
159 /*================================================================================================*/
161 int tel_set_gps_frequency_aiding(TapiHandle *handle, unsigned char state, tapi_response_cb callback, void *user_data);
164 * @brief This function is invoked to enable smart assistant.
166 * This function makes Dbus method call to Telephony Sever and returns immediate value.
167 * However it just means that the API request has been transfered to the CP successfully.
168 * The actual operation result is being delivered in the corresponding event asynchronously.
170 * @par Sync (or) Async:
171 * This is an Asynchronous API.
173 * @par Important Notes:
180 * - handle from tel_init().
182 * @param [in] callback
183 * - To register callback function for result.
185 * @param [in] user_data
186 * - user_data for user specification.
188 * @par Async Response Message:
197 * @return Return Type (int) \n
198 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
199 * - Refer #TapiResult_t for failure and error code
201 * @par Prospective Clients:
205 * #include <ITapiGps.h>
206 * TapiHandle *handle;
207 * tapi_response_cb callback;
210 * result = tel_enable_smart_assistant(handle, callback, user_data);
223 /*================================================================================================*/
224 int tel_enable_smart_assistant(TapiHandle *handle, tapi_response_cb callback, void* user_data);
227 * @brief This function is invoked to disable smart assistant.
229 * This function makes Dbus method call to Telephony Sever and returns immediate value.
230 * However it just means that the API request has been transfered to the CP successfully.
231 * The actual operation result is being delivered in the corresponding event asynchronously.
233 * @par Sync (or) Async:
234 * This is an Asynchronous API.
236 * @par Important Notes:
243 * - handle from tel_init().
245 * @param [in] callback
246 * - To register callback function for result.
248 * @param [in] user_data
249 * - user_data for user specification.
251 * @par Async Response Message:
260 * @return Return Type (int) \n
261 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
262 * - Refer #TapiResult_t for failure and error code
264 * @par Prospective Clients:
268 * #include <ITapiGps.h>
269 * TapiHandle *handle;
270 * tapi_response_cb callback;
273 * result = tel_disable_smart_assistant(handle, callback, user_data);
286 /*================================================================================================*/
288 int tel_disable_smart_assistant(TapiHandle *handle, tapi_response_cb callback, void* user_data);
291 * @brief This function is invoked to sync smart assistant area list.
293 * This function makes Dbus method call to Telephony Sever and returns immediate value.
294 * However it just means that the API request has been transfered to the CP successfully.
295 * The actual operation result is being delivered in the corresponding event asynchronously.
297 * @par Sync (or) Async:
298 * This is an Asynchronous API.
300 * @par Important Notes:
307 * - handle from tel_init().
309 * @param [in] callback
310 * - To register callback function for result.
312 * @param [in] user_data
313 * - user_data for user specification.
315 * @par Async Response Message:
319 * - Smart Assistant should be enabled.
324 * @return Return Type (int) \n
325 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
326 * - Refer #TapiResult_t for failure and error code
328 * @par Prospective Clients:
332 * #include <ITapiGps.h>
333 * TapiHandle *handle;
334 * tapi_response_cb callback;
336 * TelSmartAssistantAreaList_t area_list;
338 * area_list.count = 2;
339 * area_list.area[0].index = 1;
340 * area_list.area[0].mode_state = TAPI_SMART_ASSISTANT_MODE_STATE_START;
341 * area_list.area[1].index = 2;
342 * area_list.area[1].mode_state = TAPI_SMART_ASSISTANT_MODE_STATE_STOP;
344 * result = tel_sync_smart_assistant_area_list(handle, &area_list, callback, user_data);
357 /*================================================================================================*/
358 int tel_sync_smart_assistant_area_list(TapiHandle *handle, TelSmartAssistantAreaList_t *area_list, tapi_response_cb callback, void* user_data);
361 * @brief This function is invoked to delete smart assistant area list.
363 * This function makes Dbus method call to Telephony Sever and returns immediate value.
364 * However it just means that the API request has been transfered to the CP successfully.
365 * The actual operation result is being delivered in the corresponding event asynchronously.
367 * @par Sync (or) Async:
368 * This is an Asynchronous API.
370 * @par Important Notes:
377 * - handle from tel_init().
379 * @param [in] callback
380 * - To register callback function for result.
382 * @param [in] user_data
383 * - user_data for user specification.
385 * @par Async Response Message:
389 * - Smart Assistant should be enabled.
394 * @return Return Type (int) \n
395 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
396 * - Refer #TapiResult_t for failure and error code
398 * @par Prospective Clients:
402 * #include <ITapiGps.h>
403 * TapiHandle *handle;
404 * tapi_response_cb callback;
406 * TelSmartAssistantAreaList_t area_list;
408 * area_list.count = 2;
409 * area_list.area[0].index = 1;
410 * area_list.area[1].index = 2;
412 * result = tel_del_smart_assistant_area_list(handle, &area_list, callback, user_data);
425 /*================================================================================================*/
426 int tel_del_smart_assistant_area_list(TapiHandle *handle, TelSmartAssistantAreaList_t *area_list, tapi_response_cb callback, void* user_data);
429 * @brief This function is invoked to add smart assistant area.
431 * This function makes Dbus method call to Telephony Sever and returns immediate value.
432 * However it just means that the API request has been transfered to the CP successfully.
433 * The actual operation result is being delivered in the corresponding event asynchronously.
435 * @par Sync (or) Async:
436 * This is an Asynchronous API.
438 * @par Important Notes:
445 * - handle from tel_init().
447 * @param [in] callback
448 * - To register callback function for result.
450 * @param [in] user_data
451 * - user_data for user specification.
453 * @par Async Response Message:
457 * - Smart Assistant should be enabled.
462 * @return Return Type (int) \n
463 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
464 * - Refer #TapiResult_t for failure and error code
466 * @par Prospective Clients:
470 * #include <ITapiGps.h>
471 * TapiHandle *handle;
472 * tapi_response_cb callback;
474 * TelSmartAssistantArea_t area;
477 * area.mode_state = TAPI_SMART_ASSISTANT_MODE_STATE_START;
479 * result = tel_add_smart_assistant_area(handle, &area, callback, user_data);
492 /*================================================================================================*/
493 int tel_add_smart_assistant_area(TapiHandle *handle, TelSmartAssistantArea_t *area, tapi_response_cb callback, void* user_data);
496 * @brief This function is invoked to modify smart assistant area.
498 * This function makes Dbus method call to Telephony Sever and returns immediate value.
499 * However it just means that the API request has been transfered to the CP successfully.
500 * The actual operation result is being delivered in the corresponding event asynchronously.
502 * @par Sync (or) Async:
503 * This is an Asynchronous API.
505 * @par Important Notes:
512 * - handle from tel_init().
514 * @param [in] callback
515 * - To register callback function for result.
517 * @param [in] user_data
518 * - user_data for user specification.
520 * @par Async Response Message:
524 * - Smart Assistant should be enabled.
529 * @return Return Type (int) \n
530 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
531 * - Refer #TapiResult_t for failure and error code
533 * @par Prospective Clients:
537 * #include <ITapiGps.h>
538 * TapiHandle *handle;
539 * tapi_response_cb callback;
541 * TelSmartAssistantArea_t area;
544 * area.mode_state = TAPI_SMART_ASSISTANT_MODE_STATE_START;
546 * result = tel_modify_smart_assistant_area(handle, &area, callback, user_data);
559 /*================================================================================================*/
560 int tel_modify_smart_assistant_area(TapiHandle *handle, TelSmartAssistantArea_t *area, tapi_response_cb callback, void* user_data);
563 * @brief This function is invoked to send smart assistant aiding information to CP.
565 * This function makes Dbus method call to Telephony Sever and returns immediate value.
566 * However it just means that the API request has been transfered to the CP successfully.
567 * The actual operation result is being delivered in the corresponding event asynchronously.
569 * @par Sync (or) Async:
570 * This is an Asynchronous API.
572 * @par Important Notes:
579 * - handle from tel_init().
581 * @param [in] callback
582 * - To register callback function for result.
584 * @param [in] user_data
585 * - user_data for user specification.
587 * @par Async Response Message:
591 * - Smart Assistant should be enabled.
596 * @return Return Type (int) \n
597 * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
598 * - Refer #TapiResult_t for failure and error code
600 * @par Prospective Clients:
604 * #include <ITapiGps.h>
605 * TapiHandle *handle;
606 * tapi_response_cb callback;
608 * TelSmartAssistantInfo_t info;
611 * info.lpp_state = TAPI_SMART_ASSISTANT_LPP_STATE_START;
613 * result = tel_set_smart_assistant_info(handle, &info, callback, user_data);
626 /*================================================================================================*/
627 int tel_set_smart_assistant_info(TapiHandle *handle, TelSmartAssistantInfo_t *info, tapi_response_cb callback, void* user_data);
633 #endif /* _ITAPI_GPS_H_ */