Enumerations of maps features available in the Maps Service.

Since :

2.4

Enumerations of maps requests available in the Maps Service.

Since :

2.4

The Maps Service handle.

The Maps Service handle can be created by calling of maps_service_create().
To release the handle use maps_service_destroy().

Since :

2.4

See also:

maps_service_create()

maps_service_destroy()

Called when requesting available Maps Providers.

A Maps Service invokes this callback iteratively as long as available Maps Providers exist.

Since :

2.4

Remarks:

The string maps_provider must be released using free().

Parameters:

[in]	maps_provider	The info of Maps Provider
[in]	user_data	The user data passed from maps_service_foreach_provider()

Returns:

true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:

maps_service_foreach_provider() will invoke this callback.

See also:

maps_service_foreach_provider()

maps_service_create()

Enumerations of maps features available in the Maps Service.

Since :

2.4

Enumerator:

MAPS_PLACE_ADDRESS	Indicates the address value in the Place data
MAPS_PLACE_RATING	Indicates the rating value in the Place data
MAPS_PLACE_CATEGORIES	Indicates the place category list in the Place data
MAPS_PLACE_ATTRIBUTES	Indicates the place attribute list in the Place data
MAPS_PLACE_CONTACTS	Indicates the place contact list in the Place data
MAPS_PLACE_EDITORIALS	Indicates the place editorial list in the Place data
MAPS_PLACE_REVIEWS	Indicates the place review list in the Place data
MAPS_PLACE_IMAGE	Indicates the place image in Place the data
MAPS_PLACE_SUPPLIER	Indicates the place supplier link value in the Place data
MAPS_PLACE_RELATED	Indicates the related place link in the Place data
MAPS_ROUTE_PATH	Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates)
MAPS_ROUTE_SEGMENTS_PATH	Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a Path
MAPS_ROUTE_SEGMENTS_MANEUVERS	Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a list of Maneuvers

Enumerations of maps requests available in the Maps Service.

Since :

2.4

Enumerator:

MAPS_SERVICE_GEOCODE_INSIDE_AREA	Indicates that maps_service_geocode() service is allowed
MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS	Indicates that maps_service_geocode_iside_area() service is allowed
MAPS_SERVICE_REVERSE_GEOCODE	Indicates that maps_service_geocode_by_structured_address() service is allowed
MAPS_SERVICE_SEARCH_PLACE	Indicates that maps_service_reverse_geocode() service is allowed
MAPS_SERVICE_SEARCH_PLACE_BY_AREA	Indicates that maps_service_place() service is allowed
MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS	Indicates that maps_service_search_place_by_area() service is allowed
MAPS_SERVICE_SEARCH_ROUTE	Indicates that maps_service_search_place_by_address() service is allowed
MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS	Indicates that maps_service_search_route() service is allowed
MAPS_SERVICE_CANCEL_REQUEST	Indicates that maps_service_search_route_waypoints() service is allowed Indicates that maps_service_cancel_request() service is allowed

Cancels the service request.

This function cancels the service request initiated by geocode, route or place search.

Since :

2.4

Privilege Level:

public

Privilege:

http://tizen.org/privilege/mapservice

Parameters:

[in]	maps	The Maps Service handle
[in]	request_id	The id of request

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NETWORK_UNREACHABLE	Network connection failed
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_UNKNOWN	Unknown error

Precondition:

request_id is obtained from one of followings: * maps_service_geocode() * maps_service_geocode_inside_area() * maps_service_geocode_by_structured_address() * maps_service_reverse_geocode() * maps_service_search_place() * maps_service_search_place_by_area() * maps_service_search_place_by_address() * maps_service_search_route() * maps_service_search_route_waypoints()

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_geocode()

maps_service_geocode_inside_area()

maps_service_geocode_by_structured_address()

maps_service_reverse_geocode()

maps_service_search_place()

maps_service_search_place_by_area()

maps_service_search_place_by_address()

maps_service_search_route()

maps_service_search_route_waypoints()

Creates a new Maps Service and assigns it with a handle.

While Maps Service is being created, a Maps Provider is initialized and linked with Maps Service handle.
A Maps Service handle is used to query Maps Provider performing services, such as Geocoding, Searching Places and Routing.

Since :

2.4

Privilege Level:

public

Privilege:

http://tizen.org/privilege/mapservice
http://tizen.org/privilege/network.get

Remarks:

maps service handle must be released using maps_service_destroy().
use maps_service_foreach_provider() to choose one of available Providers.
use maps_service_set_provider_key() to set provider's key.
use use maps_service_set_preference() to set various options of Maps Provider.
use maps_service_provider_is_service_supported() and maps_service_provider_is_data_supported() to check the Maps Provider's capabilities

Parameters:

[in]	maps_provider	The name of Maps Provider
[out]	maps	A handle of the new Maps Service on success

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_NOT_SUPPORTED	Not supported
MAPS_ERROR_PERMISSION_DENIED	Permission Denied

Precondition:

Call maps_service_foreach_provider() to get a available Maps Providers.

See also:

maps_service_foreach_provider()

maps_service_destroy()

maps_service_geocode()

maps_service_geocode_inside_area()

maps_service_reverse_geocode()

maps_service_search_place()

maps_service_search_place_by_area()

maps_service_search_place_by_address()

maps_service_search_route()

maps_service_search_route_waypoints()

maps_service_set_provider_key()

maps_service_set_preference()

maps_service_provider_is_service_supported()

maps_service_provider_is_data_supported()

Destroys the Maps Service handle and releases all its resources.

This function releases all used resources of the Maps Service and Maps Provider.

Since :

2.4

Privilege Level:

public

Privilege:

http://tizen.org/privilege/mapservice

Parameters:

[in]

maps

The Maps Service handle to destroy

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_create()

Gets available Maps Providers.

This function delivers available Maps Providers via maps_service_provider_info_cb() callback.

Since :

2.4

Parameters:

[in]	callback	The callback function to receive available Maps Providers information
[out]	user_data	The user data to be passed to the callback function

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_FOUND	Result not found

Postcondition:

This function invokes maps_service_provider_info_cb() to deliver Maps Provider information.

See also:

maps_service_provider_info_cb()

maps_service_create()

Gets the Maps Preference.

This function gets the Maps Preferences which are used in each Maps Service request to Maps Provider.
Preferences can be set with maps_service_set_preference().

Since :

2.4

Remarks:

preference must be released using maps_preference_destroy().
maps_service_get_preference is always synchronous function.

Parameters:

[in]	maps	The handle of Maps Service
[out]	preference	The handle of Maps Preference

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_set_preference()

maps_service_create()

Gets the Maps Key which is to be used in the Maps Service requests.

This function gets the Maps Key which is to be used in each Maps Service request to Maps Provider.
Maps key can be set with maps_service_set_provider_key().

Since :

2.4

Remarks:

The string provider_key must be released using free().
maps_service_get_provider_key is always synchronous function.

Parameters:

[in]	maps	The Maps Service handle
[out]	provider_key	The Maps Key

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_set_provider_key()

maps_service_create()

Checks if the Maps Service supports a data feature.

This function checks if the Maps Service supports a specified data feature.

Since :

2.4

Remarks:

maps_service_provider_is_data_supported is always synchronous function.

Parameters:

[in]	maps	The handle of Maps Service
[in]	data	The data feature to be checked
[out]	supported	Is the data feature supported

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful, the data feature is supported
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_create()

Checks if the Maps Service supports a request.

This function checks if the Maps Service supports a specified request.

Since :

2.4

Remarks:

maps_service_provider_is_service_supported is always synchronous function.

Parameters:

[in]	maps	The handle of Maps Service
[in]	service	The service to be checked
[out]	supported	Is the service supported

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful, the service is supported
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_create()

Sets the Maps Preference.

This function sets the Maps Preferences which are used in each Maps Service request to Maps Provider.

Since :

2.4

Parameters:

[in]	maps	The handle of Maps Service
[in]	preference	The handle of Maps Preference

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported
MAPS_ERROR_PERMISSION_DENIED	Permission Denied

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_get_preference()

maps_service_create()

Sets the Maps Key to be used in the requests of Maps Service.

This function sets the Maps Provider's Key which will be used in each Maps Service request to Maps Provider.
Maps key can be obtained with maps_service_get_provider_key().

Since :

2.4

Remarks:

To get the provider_key, refer to corresponding Maps Provider documentation.
To get app_id and app_code of HERE, visit https://developer.here.com/, https://developer.here.com/rest-apis.

Parameters:

[in]	maps	The Maps Service handle
[in]	provider_key	The Maps Key to be used In case of combining two more strings, use slash("/") as a delimiter. e.g. For HERE "app_id/app_code"

Returns:

0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:

Call maps_service_create() to create Maps Service and get its handle.

See also:

maps_service_create()

maps_service_get_provider_key()