Tizen Native API
8.0
|
This provides APIs for Place Service.
The Maps Place API allows to find places that are relevant to user discovery context.
Functions | |
int | maps_service_search_place (const maps_service_h maps, const maps_coordinates_h position, int distance, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id) TIZEN_DEPRECATED_API |
Queries a Place information by a coordinates position and a distance. The request is asynchronous. | |
int | maps_service_search_place_by_area (const maps_service_h maps, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id) TIZEN_DEPRECATED_API |
Queries a Place information by a coordinates boundary. The request is asynchronous. | |
int | maps_service_search_place_by_address (const maps_service_h maps, const char *address, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id) TIZEN_DEPRECATED_API |
Queries a Place information by a free-formed address string. The request is asynchronous. | |
int | maps_service_search_place_list (const maps_service_h maps, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_list_cb callback, void *user_data, int *request_id) TIZEN_DEPRECATED_API |
Queries a brief Place information by a coordinates boundary./n The request is asynchronous. | |
int | maps_service_get_place_details (const maps_service_h maps, const char *uri, maps_service_get_place_details_cb callback, void *user_data, int *request_id) TIZEN_DEPRECATED_API |
Queries a Detail Place information by a place uri. The request is asynchronous. | |
Typedefs | |
typedef bool(* | maps_service_search_place_cb )(maps_error_e error, int request_id, int index, int total, maps_place_h place, void *user_data) TIZEN_DEPRECATED_API |
Called for each result of Place Search request. | |
typedef void(* | maps_service_search_place_list_cb )(maps_error_e error, int request_id, int total, maps_place_list_h place_list, void *user_data) TIZEN_DEPRECATED_API |
Called for Place list of Place Search request. | |
typedef void(* | maps_service_get_place_details_cb )(maps_error_e error, int request_id, maps_place_h place, void *user_data) TIZEN_DEPRECATED_API |
Called for Place detail information of Place Search request. |
Typedef Documentation
typedef void(* maps_service_get_place_details_cb)(maps_error_e error, int request_id, maps_place_h place, void *user_data) TIZEN_DEPRECATED_API |
Called for Place detail information of Place Search request.
- Deprecated:
- Deprecated since 8.0.
The Maps Service invokes this callback when the Place detail data obtained from the specified uri.
If search is failed, place is NULL.
- Since :
- 3.0
- Remarks:
- The parameter place must be released using maps_place_destroy().
This error code will be reported.
MAPS_ERROR_NONE
MAPS_ERROR_OUT_OF_MEMORY
MAPS_ERROR_INVALID_PARAMETER
MAPS_ERROR_NOT_FOUND.
- Parameters:
-
[in] error The result of request [in] request_id The request ID [in] place The resulting Place data [in] user_data The user data passed from maps_service_get_place_details()
- Precondition:
- maps_service_get_place_details() will invoke this callback.
- See also:
- maps_service_get_place_details()
typedef bool(* maps_service_search_place_cb)(maps_error_e error, int request_id, int index, int total, maps_place_h place, void *user_data) TIZEN_DEPRECATED_API |
Called for each result of Place Search request.
- Deprecated:
- Deprecated since 8.0.
The Maps Service invokes this callback while iterating through the set of obtained Place data.
If search is failed, the value of total is 0 and place is NULL.
- Since :
- 2.4
- Remarks:
- The parameter place must be released using maps_place_destroy().
This error code will be reported.
MAPS_ERROR_NONE
MAPS_ERROR_OUT_OF_MEMORY
MAPS_ERROR_INVALID_PARAMETER
MAPS_ERROR_NOT_FOUND.
- Parameters:
-
[in] error The result of request [in] request_id The request ID [in] index The current index of place data in result set, start from 0 [in] total The total number of results [in] place The resulting Place data [in] user_data The user data passed from maps_service_search_place(), maps_service_search_place_by_area() or maps_service_search_place_by_address()
- Returns:
true
to continue with the next iteration of the loop,
false
to break out of the loop
- Precondition:
- maps_service_search_place(), maps_service_search_place_by_area() or maps_service_search_place_by_address() will invoke this callback.
typedef void(* maps_service_search_place_list_cb)(maps_error_e error, int request_id, int total, maps_place_list_h place_list, void *user_data) TIZEN_DEPRECATED_API |
Called for Place list of Place Search request.
- Deprecated:
- Deprecated since 8.0.
The Maps Service invokes this callback when the Place data obtained from the specified coordinates.
If search is failed, the value of total is 0 and place_list is NULL.
- Since :
- 3.0
- Remarks:
- The parameter place_list must be released using maps_place_list_destroy().
This error code will be reported.
MAPS_ERROR_NONE
MAPS_ERROR_OUT_OF_MEMORY
MAPS_ERROR_INVALID_PARAMETER
MAPS_ERROR_NOT_FOUND.
- Parameters:
-
[in] error The result of request [in] request_id The request ID [in] total The total number of results [in] place_list The resulting Place list data [in] user_data The user data passed from maps_service_search_place_list()
- Precondition:
- maps_service_search_place_list() will invoke this callback.
Function Documentation
int maps_service_get_place_details | ( | const maps_service_h | maps, |
const char * | uri, | ||
maps_service_get_place_details_cb | callback, | ||
void * | user_data, | ||
int * | request_id | ||
) |
Queries a Detail Place information by a place uri.
The request is asynchronous.
- Deprecated:
- Deprecated since 8.0.
This function obtains the Detail Place information for a specified place uri.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/mapservice
http://tizen.org/privilege/internet
http://tizen.org/privilege/network.get
- Remarks:
- To cancel the search request, use maps_service_cancel_request().
To check if Maps Provider is capable of Place Search and which Place preferences are supported, see the lists of capacities and preferences above.
- Parameters:
-
[in] maps The Maps Service handle [in] uri The interested place uri [in] callback The result callback [in] user_data The user data to be passed to the callback function [out] request_id The request ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_OUT_OF_MEMORY Out of memory MAPS_ERROR_INVALID_PARAMETER Invalid parameter MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available MAPS_ERROR_PERMISSION_DENIED Permission Denied MAPS_ERROR_NOT_SUPPORTED Not supported MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer MAPS_ERROR_INVALID_OPERATION Operation is not valid MAPS_ERROR_NOT_FOUND Result not found MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key MAPS_ERROR_RESOURCE_BUSY Places service busy MAPS_ERROR_CANCELED Places service aborted MAPS_ERROR_UNKNOWN Unknown error
- Precondition:
- Call maps_service_create() to create Maps Service and obtain its handle.
- uri is obtained from maps_service_search_place_list()
- Postcondition:
- It invokes maps_service_get_place_details_cb() to deliver obtained Place information.
int maps_service_search_place | ( | const maps_service_h | maps, |
const maps_coordinates_h | position, | ||
int | distance, | ||
const maps_place_filter_h | filter, | ||
maps_preference_h | preference, | ||
maps_service_search_place_cb | callback, | ||
void * | user_data, | ||
int * | request_id | ||
) |
Queries a Place information by a coordinates position and a distance.
The request is asynchronous.
- Deprecated:
- Deprecated since 8.0.
This function obtains the Place information for a specified distance around a given coordinates position.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/mapservice
http://tizen.org/privilege/internet
http://tizen.org/privilege/network.get
- Remarks:
- To cancel the search request, use maps_service_cancel_request().
To check if Maps Provider is capable of searching places, use maps_service_provider_is_service_supported() with MAPS_SERVICE_SEARCH_PLACE passed as service parameter.
Check available data features in the search result using maps_service_provider_is_data_supported() with values, listed in maps_service_data_e passed as data parameter.
- Parameters:
-
[in] maps The Maps Service handle [in] position The interested position [in] distance The search area distance [in] filter The filter handle [in] preference The place preference handle [in] callback The result callback [in] user_data The user data to be passed to the callback function [out] request_id The request ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_OUT_OF_MEMORY Out of memory MAPS_ERROR_INVALID_PARAMETER Invalid parameter MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available MAPS_ERROR_PERMISSION_DENIED Permission Denied MAPS_ERROR_NOT_SUPPORTED Not supported MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer MAPS_ERROR_INVALID_OPERATION Operation is not valid MAPS_ERROR_NOT_FOUND Result not found MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key MAPS_ERROR_RESOURCE_BUSY Places service busy MAPS_ERROR_CANCELED Places service aborted MAPS_ERROR_UNKNOWN Unknown error
- Precondition:
- Call maps_service_create() to create Maps Service and obtain its handle.
- Postcondition:
- It invokes maps_service_search_place_cb() to deliver obtained Place information.
int maps_service_search_place_by_address | ( | const maps_service_h | maps, |
const char * | address, | ||
const maps_area_h | boundary, | ||
const maps_place_filter_h | filter, | ||
maps_preference_h | preference, | ||
maps_service_search_place_cb | callback, | ||
void * | user_data, | ||
int * | request_id | ||
) |
Queries a Place information by a free-formed address string.
The request is asynchronous.
- Deprecated:
- Deprecated since 8.0.
This function obtains the Place information for a specified free-formed address string.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/mapservice
http://tizen.org/privilege/internet
http://tizen.org/privilege/network.get
- Remarks:
- boundary supports only circle type bounds for search.
To cancel the search request, use maps_service_cancel_request().
To check if Maps Provider is capable of searching places by free-formed address, use maps_service_provider_is_service_supported() with MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS passed as service parameter.
Check available data features in the search result using maps_service_provider_is_data_supported() with values, listed in maps_service_data_e passed as data parameter.
- Parameters:
-
[in] maps The Maps Service handle [in] address The interested address [in] boundary The interested area [in] filter The filter handle [in] preference The place preference handle [in] callback The result callback [in] user_data The user data to be passed to the callback function [out] request_id The request ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_OUT_OF_MEMORY Out of memory MAPS_ERROR_INVALID_PARAMETER Invalid parameter MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available MAPS_ERROR_PERMISSION_DENIED Permission Denied MAPS_ERROR_NOT_SUPPORTED Not supported MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer MAPS_ERROR_INVALID_OPERATION Operation is not valid MAPS_ERROR_NOT_FOUND Result not found MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key MAPS_ERROR_RESOURCE_BUSY Places service busy MAPS_ERROR_CANCELED Places service aborted MAPS_ERROR_UNKNOWN Unknown error
- Precondition:
- Call maps_service_create() to create Maps Service and obtain its handle.
- Postcondition:
- It invokes maps_service_search_place_cb() to deliver obtained Place information.
int maps_service_search_place_by_area | ( | const maps_service_h | maps, |
const maps_area_h | boundary, | ||
const maps_place_filter_h | filter, | ||
maps_preference_h | preference, | ||
maps_service_search_place_cb | callback, | ||
void * | user_data, | ||
int * | request_id | ||
) |
Queries a Place information by a coordinates boundary.
The request is asynchronous.
- Deprecated:
- Deprecated since 8.0.
This function obtains the Place information for a specified coordinates boundary.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/mapservice
http://tizen.org/privilege/internet
http://tizen.org/privilege/network.get
- Remarks:
- boundary is supporting only circle type bounds for search.
To cancel the search request, use maps_service_cancel_request().
To check if Maps Provider is capable of searching places by coordinates boundaries, use maps_service_provider_is_service_supported() with MAPS_SERVICE_SEARCH_PLACE_BY_AREA passed as service parameter.
Check available data features in the search result using maps_service_provider_is_data_supported() with values, listed in maps_service_data_e passed as data parameter.
- Parameters:
-
[in] maps The Maps Service handle [in] boundary The interested area [in] filter The filter handle [in] preference The place preference handle [in] callback The result callback [in] user_data The user data to be passed to the callback function [out] request_id The request ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_OUT_OF_MEMORY Out of memory MAPS_ERROR_INVALID_PARAMETER Invalid parameter MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available MAPS_ERROR_PERMISSION_DENIED Permission Denied MAPS_ERROR_NOT_SUPPORTED Not supported MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer MAPS_ERROR_INVALID_OPERATION Operation is not valid MAPS_ERROR_NOT_FOUND Result not found MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key MAPS_ERROR_RESOURCE_BUSY Places service busy MAPS_ERROR_CANCELED Places service aborted MAPS_ERROR_UNKNOWN Unknown error
- Precondition:
- Call maps_service_create() to create Maps Service and obtain its handle.
- Postcondition:
- It invokes maps_service_search_place_cb() to deliver obtained Place information.
int maps_service_search_place_list | ( | const maps_service_h | maps, |
const maps_area_h | boundary, | ||
const maps_place_filter_h | filter, | ||
maps_preference_h | preference, | ||
maps_service_search_place_list_cb | callback, | ||
void * | user_data, | ||
int * | request_id | ||
) |
Queries a brief Place information by a coordinates boundary./n The request is asynchronous.
- Deprecated:
- Deprecated since 8.0.
This function obtains the brief Place information for a specified coordinates boundary.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/mapservice
http://tizen.org/privilege/internet
http://tizen.org/privilege/network.get
- Remarks:
- To cancel the search request use maps_service_cancel_request().
To check if Maps Provider is capable of Place Search and which Place preferences are supported, see the lists of capacities and preferences above.
- Parameters:
-
[in] maps The Maps Service handle [in] boundary The interested area [in] filter The filter handle [in] preference The place preference handle [in] callback The result callback [in] user_data The user data to be passed to the callback function [out] request_id The request ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_OUT_OF_MEMORY Out of memory MAPS_ERROR_INVALID_PARAMETER Invalid parameter MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available MAPS_ERROR_PERMISSION_DENIED Permission Denied MAPS_ERROR_NOT_SUPPORTED Not supported MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer MAPS_ERROR_INVALID_OPERATION Operation is not valid MAPS_ERROR_NOT_FOUND Result not found MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key MAPS_ERROR_RESOURCE_BUSY Places service busy MAPS_ERROR_CANCELED Places service aborted MAPS_ERROR_UNKNOWN Unknown error
- Precondition:
- Call maps_service_create() to create Maps Service and obtain its handle.
- Postcondition:
- It invokes maps_service_search_place_list_cb() to deliver obtained Place information.