Tizen Native API
5.0
|
This provides enumerations of Maps API preferences. The Preferences are organized as a key-value table where available Preference keys are following strings: * Place search preferences.
Functions | |
int | maps_preference_create (maps_preference_h *preference) |
Creates a new maps preference handle. | |
int | maps_preference_destroy (maps_preference_h preference) |
Destroys the maps preference handle and releases all its resources. | |
int | maps_preference_clone (const maps_preference_h origin, maps_preference_h *cloned) |
Clones the maps preference handle. | |
int | maps_preference_get_distance_unit (const maps_preference_h preference, maps_distance_unit_e *unit) |
Gets the distance unit. | |
int | maps_preference_get_language (const maps_preference_h preference, char **language) |
Gets the language. | |
int | maps_preference_get_max_results (const maps_preference_h preference, int *max_results) |
Gets the max amount of results. | |
int | maps_preference_get_country_code (const maps_preference_h preference, char **country_code) |
Gets the country code. | |
int | maps_preference_get_route_optimization (const maps_preference_h preference, maps_route_optimization_e *optimization) |
Gets the route optimization. | |
int | maps_preference_get_route_transport_mode (const maps_preference_h preference, maps_route_transport_mode_e *transport_mode) |
Gets the route transport mode. | |
int | maps_preference_get_route_feature_weight (const maps_preference_h preference, maps_route_feature_weight_e *feature_weight) |
Gets the route feature weight. | |
int | maps_preference_get_route_feature (const maps_preference_h preference, maps_route_feature_e *feature) |
Gets the route feature. | |
int | maps_preference_get_route_alternatives_enabled (const maps_preference_h preference, bool *enable) |
Gets the enable status of alternative routes. | |
int | maps_preference_get (const maps_preference_h preference, const char *key, char **value) |
Gets the maps preference value by key. | |
int | maps_preference_foreach_property (const maps_preference_h preference, maps_preference_properties_cb callback, void *user_data) |
Retrieves all maps properties. | |
int | maps_preference_set_distance_unit (maps_preference_h preference, const maps_distance_unit_e unit) |
Sets the maps distance unit. | |
int | maps_preference_set_language (maps_preference_h preference, const char *language) |
Sets the maps language. | |
int | maps_preference_set_max_results (maps_preference_h preference, const int max_results) |
Sets the max amount of results. | |
int | maps_preference_set_country_code (maps_preference_h preference, const char *country_code) |
Sets the maps country code. | |
int | maps_preference_set_route_optimization (maps_preference_h preference, const maps_route_optimization_e optimization) |
Sets the route optimization. | |
int | maps_preference_set_route_transport_mode (maps_preference_h preference, const maps_route_transport_mode_e transport_mode) |
Sets the route transport mode. | |
int | maps_preference_set_route_feature_weight (maps_preference_h preference, const maps_route_feature_weight_e feature_weight) |
Sets the route feature weight. | |
int | maps_preference_set_route_feature (maps_preference_h preference, const maps_route_feature_e feature) |
Sets the route feature. | |
int | maps_preference_set_route_alternatives_enabled (maps_preference_h preference, bool enable) |
Sets the enable status of alternative routes. | |
int | maps_preference_set_property (maps_preference_h preference, const char *key, const char *value) |
Sets the preference value by key. | |
Typedefs | |
typedef void * | maps_preference_h |
The Maps Preference handle. | |
typedef enum _maps_distance_unit_e | maps_distance_unit_e |
Enumeration for allowed distance units. | |
typedef enum _maps_route_optimization_e | maps_route_optimization_e |
Enumeration for allowed route optimization option. | |
typedef enum _maps_route_transport_mode_e | maps_route_transport_mode_e |
Enumeration for preferable route types. | |
typedef enum _maps_route_feature_weight_e | maps_route_feature_weight_e |
Enumeration for route feature weights. | |
typedef enum _maps_route_request_feature_e | maps_route_feature_e |
Enumeration for route features. | |
typedef bool(* | maps_preference_properties_cb )(int index, int total, char *key, char *value, void *user_data) |
Called when requesting the list of Maps Properties. | |
Defines | |
#define | MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE" |
Definition for the name of the preference indicating place type while searching the place. | |
#define | MAPS_PLACE_FILTER_SORT_BY "MAPS_PLACE_FILTER_SORT_BY" |
Definition for the name of the preference indicating sorting key while searching the place. | |
#define | MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID "MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID" |
Definition for the name of the preference indicating free-form address to avoid while computing the route. | |
#define | MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID "MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID" |
Definition for the name of the preference indicating structured address to avoid while computing the route. | |
#define | MAPS_ROUTE_CIRCLE_AREA_TO_AVOID "MAPS_ROUTE_CIRCLE_AREA_TO_AVOID" |
Definition for the name of the preference indicating circular geographical area to avoid while computing the route. | |
#define | MAPS_ROUTE_RECT_AREA_TO_AVOID "MAPS_ROUTE_RECT_AREA_TO_AVOID" |
Definition for the name of the preference indicating rectangular geographical area to avoid while computing the route. | |
#define | MAPS_ROUTE_GEOMETRY_BOUNDING_BOX "MAPS_ROUTE_GEOMETRY_BOUNDING_BOX" |
Definition for the name of the preference indicating that route should be computed within a specified bounding box. | |
#define | MAPS_ROUTE_GEOMETRY_RETRIEVAL "MAPS_ROUTE_GEOMETRY_RETRIEVAL" |
Definition for the name of the preference indicating that geometry parameters should be retrieved while route processing. | |
#define | MAPS_ROUTE_INSTRUCTION_GEOMETRY "MAPS_ROUTE_INSTRUCTION_GEOMETRY" |
Definition for the name of the preference indicating that route should be computed with geometry instructions. | |
#define | MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX "MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX" |
Definition for the name of the preference indicating that route should be computed with bounding box instructions. | |
#define | MAPS_ROUTE_INSTRUCTION_RETRIEVAL "MAPS_ROUTE_INSTRUCTION_RETRIEVAL" |
Definition for the name of the preference indicating that route should be computed correspondingly to retrieval instructions. | |
#define | MAPS_ROUTE_REALTIME_TRAFFIC "MAPS_ROUTE_REALTIME_TRAFFIC" |
Definition for the name of the preference indicating that route should be computed in accordance to real time traffic. |
#define MAPS_PLACE_FILTER_SORT_BY "MAPS_PLACE_FILTER_SORT_BY" |
Definition for the name of the preference indicating sorting key while searching the place.
#define MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE" |
Definition for the name of the preference indicating place type while searching the place.
#define MAPS_ROUTE_CIRCLE_AREA_TO_AVOID "MAPS_ROUTE_CIRCLE_AREA_TO_AVOID" |
Definition for the name of the preference indicating circular geographical area to avoid while computing the route.
#define MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID "MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID" |
Definition for the name of the preference indicating free-form address to avoid while computing the route.
#define MAPS_ROUTE_GEOMETRY_BOUNDING_BOX "MAPS_ROUTE_GEOMETRY_BOUNDING_BOX" |
Definition for the name of the preference indicating that route should be computed within a specified bounding box.
#define MAPS_ROUTE_GEOMETRY_RETRIEVAL "MAPS_ROUTE_GEOMETRY_RETRIEVAL" |
Definition for the name of the preference indicating that geometry parameters should be retrieved while route processing.
#define MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX "MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX" |
Definition for the name of the preference indicating that route should be computed with bounding box instructions.
#define MAPS_ROUTE_INSTRUCTION_GEOMETRY "MAPS_ROUTE_INSTRUCTION_GEOMETRY" |
Definition for the name of the preference indicating that route should be computed with geometry instructions.
#define MAPS_ROUTE_INSTRUCTION_RETRIEVAL "MAPS_ROUTE_INSTRUCTION_RETRIEVAL" |
Definition for the name of the preference indicating that route should be computed correspondingly to retrieval instructions.
#define MAPS_ROUTE_REALTIME_TRAFFIC "MAPS_ROUTE_REALTIME_TRAFFIC" |
Definition for the name of the preference indicating that route should be computed in accordance to real time traffic.
#define MAPS_ROUTE_RECT_AREA_TO_AVOID "MAPS_ROUTE_RECT_AREA_TO_AVOID" |
Definition for the name of the preference indicating rectangular geographical area to avoid while computing the route.
#define MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID "MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID" |
Definition for the name of the preference indicating structured address to avoid while computing the route.
typedef enum _maps_distance_unit_e maps_distance_unit_e |
Enumeration for allowed distance units.
This enumeration represents allowed distance units used in Maps Services.
typedef void* maps_preference_h |
The Maps Preference handle.
The Maps Preference handle can be obtained via call of maps_preference_create().
To release the handle use maps_preference_destroy().
To clone the handle use maps_preference_clone().
typedef bool(* maps_preference_properties_cb)(int index, int total, char *key, char *value, void *user_data) |
Called when requesting the list of Maps Properties.
This callback is invoked while iterating through the list of Maps Properties.
[in] | index | The current index of property |
[in] | total | The total amount of properties |
[in] | key | The key of property |
[in] | value | The value of property |
[in] | user_data | The user data passed from maps_preference_foreach_property() |
true
to continue with the next iteration of the loop,false
to break out of the loop typedef enum _maps_route_request_feature_e maps_route_feature_e |
Enumeration for route features.
This enumeration represents allowed route features used in Route Service.
typedef enum _maps_route_feature_weight_e maps_route_feature_weight_e |
Enumeration for route feature weights.
This enumeration represents allowed route feature weights used in Route Service.
typedef enum _maps_route_optimization_e maps_route_optimization_e |
Enumeration for allowed route optimization option.
This enumeration represents allowed route optimization option used in Route Service.
typedef enum _maps_route_transport_mode_e maps_route_transport_mode_e |
Enumeration for preferable route types.
This enumeration represents allowed route types used in Route Service.
Enumeration for allowed distance units.
This enumeration represents allowed distance units used in Maps Services.
Enumeration for route feature weights.
This enumeration represents allowed route feature weights used in Route Service.
Enumeration for allowed route optimization option.
This enumeration represents allowed route optimization option used in Route Service.
Enumeration for route features.
This enumeration represents allowed route features used in Route Service.
Enumeration for preferable route types.
This enumeration represents allowed route types used in Route Service.
int maps_preference_clone | ( | const maps_preference_h | origin, |
maps_preference_h * | cloned | ||
) |
Clones the maps preference handle.
This function clones the maps preference handle origin and all its resources.
[in] | origin | The original preference handle |
[out] | cloned | A cloned preference handle |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_OUT_OF_MEMORY | Out of memory |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_create | ( | maps_preference_h * | preference | ) |
Creates a new maps preference handle.
This function creates a new maps preference handle and allocates all needed resources.
[out] | preference | A newly created preference handle |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_OUT_OF_MEMORY | Out of memory |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_destroy | ( | maps_preference_h | preference | ) |
Destroys the maps preference handle and releases all its resources.
This function destroys the maps preference handle and releases all its resources.
[in] | preference | The preference handle |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_foreach_property | ( | const maps_preference_h | preference, |
maps_preference_properties_cb | callback, | ||
void * | user_data | ||
) |
Retrieves all maps properties.
This function retrieves all maps properties.
[in] | preference | The preference handle |
[in] | callback | The callback function to invoke |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_FOUND | Result not found |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get | ( | const maps_preference_h | preference, |
const char * | key, | ||
char ** | value | ||
) |
Gets the maps preference value by key.
This function gets the maps preference value by key.
[in] | preference | The preference handle |
[in] | key | The preference key |
[out] | value | The preference value |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_country_code | ( | const maps_preference_h | preference, |
char ** | country_code | ||
) |
Gets the country code.
This function gets the country code.
[in] | preference | The preference handle |
[out] | country_code | The country code |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_distance_unit | ( | const maps_preference_h | preference, |
maps_distance_unit_e * | unit | ||
) |
Gets the distance unit.
This function gets the maps distance unit.
[in] | preference | The preference handle |
[out] | unit | The distance unit |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_language | ( | const maps_preference_h | preference, |
char ** | language | ||
) |
Gets the language.
This function gets the maps language.
[in] | preference | The preference handle |
[out] | language | The language |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_max_results | ( | const maps_preference_h | preference, |
int * | max_results | ||
) |
Gets the max amount of results.
This function gets the max amount of results.
[in] | preference | The preference handle |
[out] | max_results | The max amount of results |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_route_alternatives_enabled | ( | const maps_preference_h | preference, |
bool * | enable | ||
) |
Gets the enable status of alternative routes.
This function retrieves the enable status of alternative route.
[in] | preference | The preference handle |
[out] | enable | The enable status |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_route_feature | ( | const maps_preference_h | preference, |
maps_route_feature_e * | feature | ||
) |
Gets the route feature.
This function gets the route feature.
[in] | preference | The preference handle |
[out] | feature | The feature |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_route_feature_weight | ( | const maps_preference_h | preference, |
maps_route_feature_weight_e * | feature_weight | ||
) |
Gets the route feature weight.
This function gets the route feature weight.
[in] | preference | The preference handle |
[out] | feature_weight | The feature weight |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_route_optimization | ( | const maps_preference_h | preference, |
maps_route_optimization_e * | optimization | ||
) |
Gets the route optimization.
This function gets the route optimization.
[in] | preference | The preference handle |
[out] | optimization | The route optimization |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_get_route_transport_mode | ( | const maps_preference_h | preference, |
maps_route_transport_mode_e * | transport_mode | ||
) |
Gets the route transport mode.
This function gets the route transport mode.
[in] | preference | The preference handle |
[out] | transport_mode | The transport mode |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_country_code | ( | maps_preference_h | preference, |
const char * | country_code | ||
) |
Sets the maps country code.
This function sets the maps country code.
[in] | preference | The preference handle |
[in] | country_code | The maps country code |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_distance_unit | ( | maps_preference_h | preference, |
const maps_distance_unit_e | unit | ||
) |
Sets the maps distance unit.
This function sets the maps distance unit.
[in] | preference | The preference handle |
[in] | unit | The distance unit |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_language | ( | maps_preference_h | preference, |
const char * | language | ||
) |
Sets the maps language.
This function sets the maps language.
[in] | preference | The preference handle |
[in] | language | The maps language. A language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. Each language tag is composed of one or more "subtags" separated by hyphens (-). Each subtag is composed of basic Latin letters or digits only. For example, "ko-KR" for Korean, "en-US" for American English. |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_max_results | ( | maps_preference_h | preference, |
const int | max_results | ||
) |
Sets the max amount of results.
This function sets the max amount of results.
[in] | preference | The preference handle |
[in] | max_results | The max amount of results |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_property | ( | maps_preference_h | preference, |
const char * | key, | ||
const char * | value | ||
) |
Sets the preference value by key.
This function sets the preference value assigned with a specified key.
[in] | preference | The preference handle |
[in] | key | The key |
[in] | value | The value |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_route_alternatives_enabled | ( | maps_preference_h | preference, |
bool | enable | ||
) |
Sets the enable status of alternative routes.
This function sets the alternative routes status.
[in] | preference | The preference handle |
[in] | enable | The value to set |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_route_feature | ( | maps_preference_h | preference, |
const maps_route_feature_e | feature | ||
) |
Sets the route feature.
This function sets the route feature.
[in] | preference | The preference handle |
[in] | feature | The route feature |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_route_feature_weight | ( | maps_preference_h | preference, |
const maps_route_feature_weight_e | feature_weight | ||
) |
Sets the route feature weight.
This function sets the route feature weight.
[in] | preference | The preference handle |
[in] | feature_weight | The route feature weight |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_route_optimization | ( | maps_preference_h | preference, |
const maps_route_optimization_e | optimization | ||
) |
Sets the route optimization.
This function sets the route optimization.
[in] | preference | The preference handle |
[in] | optimization | The route optimization |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |
int maps_preference_set_route_transport_mode | ( | maps_preference_h | preference, |
const maps_route_transport_mode_e | transport_mode | ||
) |
Sets the route transport mode.
This function sets the route transport mode.
[in] | preference | The preference handle |
[in] | transport_mode | The route transport mode |
0
on success, otherwise a negative error value MAPS_ERROR_NONE | Successful |
MAPS_ERROR_INVALID_PARAMETER | Invalid parameter |
MAPS_ERROR_NOT_SUPPORTED | Not supported |