* @since_tizen 2.4
*/
typedef enum _maps_service_e {
- MAPS_SERVICE_GEOCODE, /** Indicates that
- maps_service_geocode() service is allowed */
- MAPS_SERVICE_GEOCODE_INSIDE_AREA, /** Indicates that
- maps_service_geocode_iside_area() service is allowed */
- MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS, /** Indicates that
- maps_service_geocode_by_structured_address() service is allowed */
- MAPS_SERVICE_REVERSE_GEOCODE, /** Indicates that
- maps_service_reverse_geocode() service is allowed */
- MAPS_SERVICE_SEARCH_PLACE, /** Indicates that
- maps_service_place() service is allowed */
- MAPS_SERVICE_SEARCH_PLACE_BY_AREA, /** Indicates that
+
+ MAPS_SERVICE_GEOCODE, /**< Indicates that maps_service_geocode()
+ service is allowed */
+
+ MAPS_SERVICE_GEOCODE_INSIDE_AREA, /**< Indicates that
+ maps_service_geocode_inside_area() service is allowed */
+
+ MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS, /**< Indicates that
+ maps_service_geocode_by_structured_address() service is
+ allowed */
+
+ MAPS_SERVICE_REVERSE_GEOCODE, /**< Indicates that
+ maps_service_reverse_geocode() service is allowed */
+
+ MAPS_SERVICE_SEARCH_PLACE, /**< Indicates that
+ maps_service_search_place() service is allowed */
+
+ MAPS_SERVICE_SEARCH_PLACE_BY_AREA, /**< Indicates that
maps_service_search_place_by_area() service is allowed */
- MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS, /** Indicates that
+
+ MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS, /**< Indicates that
maps_service_search_place_by_address() service is allowed */
- MAPS_SERVICE_SEARCH_ROUTE, /** Indicates that
- maps_service_search_route() service is allowed */
- MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS, /** Indicates that
+
+ MAPS_SERVICE_SEARCH_ROUTE, /**< Indicates that
+ maps_service_search_route() service is allowed */
+
+ MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS, /**< Indicates that
maps_service_search_route_waypoints() service is allowed */
- MAPS_SERVICE_CANCEL_REQUEST /** Indicates that
+ MAPS_SERVICE_CANCEL_REQUEST /**< Indicates that
maps_service_cancel_request() service is allowed */
} maps_service_e;
* @since_tizen 2.4
*/
typedef enum _maps_service_data_e {
- 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*/
+
+ MAPS_PLACE_ADDRESS, /**< Indicates the availability of address value
+ in the Place data */
+
+ MAPS_PLACE_RATING, /**< Indicates the availability of rating value in
+ the Place data */
+
+ MAPS_PLACE_CATEGORIES, /**< Indicates the availability of place category
+ list in the Place data */
+
+ MAPS_PLACE_ATTRIBUTES, /**< Indicates the availability of place
+ attribute list in the Place data */
+
+ MAPS_PLACE_CONTACTS, /**< Indicates the availability of place contact
+ list in the Place data */
+
+ MAPS_PLACE_EDITORIALS, /**< Indicates the availability of place
+ editorial list in the Place data */
+
+ MAPS_PLACE_REVIEWS, /**< Indicates the availability of place review list
+ in the Place data */
+
+ MAPS_PLACE_IMAGE, /**< Indicates the availability of place image in
+ Place the data */
+
+ MAPS_PLACE_SUPPLIER, /**< Indicates the availability of place supplier
+ link value in the Place data */
+
+ MAPS_PLACE_RELATED, /**< Indicates the availability of 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*/
+
} maps_service_data_e;
/**
* @privilege %http://tizen.org/privilege/mapservice \n
* %http://tizen.org/privilege/network.get
*
- * @remarks @a maps service handle must be released using maps_service_destroy().
+ * @remarks @a maps service handle must be released using
+ * maps_service_destroy().
* \n use maps_service_foreach_provider() to choose one of available Providers.
* \n use maps_service_set_provider_key() to set provider's key.
- * \n use use maps_service_set_preference() to set various options of Maps Provider.
- * \n use maps_service_provider_is_service_supported() and maps_service_provider_is_data_supported()
- * to check the Maps Provider's capabilities
+ * \n use use maps_service_set_preference() to set various options of Maps
+ * Provider.
+ * \n use maps_service_provider_is_service_supported() and
+ * maps_service_provider_is_data_supported() to check the Maps Provider's
+ * capabilities
*
* @param[in] maps_provider The name of Maps Provider
* @param[out] maps A handle of the new Maps Service on success
/**
* @brief Sets the Maps Key to be used in the requests of Maps Service.
- * @details This function sets the Maps Provider's Key which will be used in each Maps
- * Service request to Maps Provider.
+ * @details This function sets the Maps Provider's Key which will be used in
+ * each Maps Service request to Maps Provider.
* \n Maps key can be obtained with maps_service_get_provider_key().
* @since_tizen 2.4
* @remarks To get the @a provider_key, refer to corresponding Maps Provider
* documentation.
- * \n To get app_id and app_code of HERE, visit https://developer.here.com/, https://developer.here.com/rest-apis.
+ * \n To get app_id and app_code of HERE, visit https://developer.here.com/,
+ * https://developer.here.com/rest-apis.
*
* @param[in] maps The Maps Service handle
* @param[in] provider_key The Maps Key to be used
/**
* @brief Checks if the Maps Service supports a request.
- * @details This function checks if the Maps Service supports a specified request.
+ * @details This function checks if the Maps Service supports a specified
+ * request.
* @since_tizen 2.4
* @remarks @a maps_service_provider_is_service_supported is always synchronous
* function.
/**
* @brief Cancels the service request.
- * @details This function cancels the service request initiated by geocode,
+ * @details This function cancels the service request initiated by geocoder,
* route or place search.
* @since_tizen 2.4
* @privlevel public
void *user_data);
/**
- * @brief Gets the position coordinates for a given address. The request
- * is asynchronous.
+ * @brief Gets the position coordinates for a given address.
+ * \n The request is asynchronous.
* @details This function obtains position coordinates for a given free-formed
* address string.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding and which Geocode
- * preferences are supported, see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of Geocoding use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_GEOCODE passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The free-formed address
* @see maps_service_geocode_cb()
* @see maps_service_cancel_request()
* @see maps_service_reverse_geocode()
+ * @see maps_service_provider_is_service_supported()
*/
int maps_service_geocode(const maps_service_h maps, const char *address,
const maps_preference_h preference,
/**
* @brief Gets the position for a given address, within the specified
- * bounding box. The request is asynchronous.
+ * bounding box.
+ * \n The request is asynchronous.
* @details This function obtains position coordinates for a given free-formed
* address string within the specified bounding box.
* @since_tizen 2.4
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n Polygonal bounding box is not supported.
* \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding and which Geocode
- * preferences are supported, see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of Geocoding Inside Area use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_GEOCODE_INSIDE_AREA passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The free-formed address
* @see maps_service_geocode()
* @see maps_service_cancel_request()
* @see maps_service_reverse_geocode()
+ * @see maps_service_provider_is_service_supported()
*/
int maps_service_geocode_inside_area(const maps_service_h maps,
const char *address,
void *user_data, int *request_id);
/**
- * @brief Gets the position coordinates for a given address. The request
- * is asynchronous.
+ * @brief Gets the position coordinates for a given address.
+ * \n The request is asynchronous.
* @details This function obtains position coordinates for a given structured
* address.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding and which Geocode
- * preferences are supported see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of Geocoding by Structured Address use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The structured address
* @see maps_service_geocode_cb()
* @see maps_service_cancel_request()
* @see maps_service_reverse_geocode()
+ * @see maps_service_provider_is_service_supported()
*/
int maps_service_geocode_by_structured_address(const maps_service_h maps,
const maps_address_h address,
int *request_id);
/**
- * @brief Gets the address for a given position coordinates. The request
- * is asynchronous.
+ * @brief Gets the address for a given position coordinates.
+ * \n The request is asynchronous.
* @details This function obtains structured address information for a given
* position coordinates.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Reverse Geocoding and which
- * Reverse Geocode preferences are supported, see the lists of capacities and
- * preferences above.
+ * \n To check if Maps Provider is capable of Reverse Geocoding use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_REVERSE_GEOCODE passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees)
* @see maps_service_reverse_geocode_cb()
* @see maps_service_cancel_request()
* @see maps_service_geocode()
+ * @see maps_service_provider_is_service_supported()
*/
int maps_service_reverse_geocode(const maps_service_h maps, double latitude,
double longitude,
/**
* @brief Queries a Place information by a coordinates position and a
- * distance. The request is asynchronous.
+ * distance.
+ * \n The request is asynchronous.
* @details This function obtains the Place information for a specified distance
* around a given coordinates position.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search and which Place
- * preferences are supported, see the lists of capacities and preferences above.
- * \n The distance unit for searching places supports metric
- * but doesn't support imperial.
- * Even though applications set #maps_distance_unit_e using maps_preference_set_distance_unit(),
- * the unit of distance is meter.
+ * \n To check if Maps Provider is capable of Place Search use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_SEARCH_PLACE passed as @a service parameter.
+ * \n 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 @a data parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] position The interested position
* @see maps_service_search_place_by_address()
* @see maps_service_cancel_request()
* @see maps_service_search_place_cb()
+ * @see maps_service_provider_is_service_supported()
+ * @see maps_service_provider_is_data_supported()
*/
int maps_service_search_place(const maps_service_h maps,
const maps_coordinates_h position, int distance,
void *user_data, int *request_id);
/**
- * @brief Queries a Place information by a coordinates boundary. The
- * request is asynchronous.
+ * @brief Queries a Place information by a coordinates boundary.
+ * \n The request is asynchronous.
* @details This function obtains the Place information for a specified
* coordinates boundary.
* @since_tizen 2.4
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n @a boundary is supporting only circle type bounds for search.
* \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search and which Place
- * preferences are supported, see the lists of capacities and preferences above.
- * \n The distance unit for searching places doesn't support imperial but supports metric.
- * Even though applications set maps_distance_unit_e using maps_preference_set_distance_unit(),
- * the unit of radius of boundary is meter.
+ * \n To check if Maps Provider is capable of Place Search by coordinates
+ * boundaries, use maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_SEARCH_PLACE_BY_AREA passed as @a service parameter.
+ * \n 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 @a data parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] boundary The interested area
* @see maps_service_search_place_by_address()
* @see maps_service_cancel_request()
* @see maps_service_search_place_cb()
+ * @see maps_service_provider_is_service_supported()
+ * @see maps_service_provider_is_data_supported()
*/
int maps_service_search_place_by_area(const maps_service_h maps,
const maps_area_h boundary,
/**
* @brief Queries a Place information by a free-formed address string.
- * The request is asynchronous.
- * @details This function obtains the Place information for a specified free-
- * formed address string.
+ * \n The request is asynchronous.
+ * @details This function obtains the Place information for a specified
+ * free-formed address string.
* @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/mapservice \n
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n @a boundary is supporting only circle type bounds for search.
* \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search and which Place
- * preferences are supported, see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of Place Search by free-formed
+ * address use maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS passed as @a service parameter.
+ * \n 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 @a data parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The interested address
* @see maps_service_search_place_by_area()
* @see maps_service_cancel_request()
* @see maps_service_search_place_cb()
+ * @see maps_service_provider_is_service_supported()
+ * @see maps_service_provider_is_data_supported()
*/
int maps_service_search_place_by_address(const maps_service_h maps,
const char *address,
*
* @addtogroup CAPI_MAPS_ROUTE_MODULE
* @{
- * @brief This provides APIs for Rote Service
- * @details The Maps Route API provides ways to calculate a route that defines a
- * path between a start and a destination and may,
- * optionally, pass through specific intermediate locations.
+ * @brief This provides APIs for Route Service
+ * @details The Maps Route API provides functions to calculate a route that
+ * defines a path between a start and a destination and may, optionally, pass
+ * through specific intermediate locations.
*
*/
void *user_data);
/**
- * @brief Queries the Route from origin coordinate to a destination.
- * The request is asynchronous.
+ * @brief Queries the Route from origin coordinates to destination.
+ * \n The request is asynchronous.
* @details This function gets the Route information for a specified origin and
* destination coordinates.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Route Search and which Route
- * preferences are supported, see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of Route Search use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_SEARCH_ROUTE passed as @a service parameter.
+ * \n 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 @a data parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] origin The starting point
* @see maps_service_search_route_waypoints()
* @see maps_service_cancel_request()
* @see maps_service_search_route_cb()
+ * @see maps_service_provider_is_service_supported()
+ * @see maps_service_provider_is_data_supported()
*/
int maps_service_search_route(const maps_service_h maps,
const maps_coordinates_h origin,
void *user_data, int *request_id);
/**
- * @brief Queries the Route, passing through a specified way points. The
- * request is asynchronous.
+ * @brief Queries the Route, passing through a specified way points.
+ * \n The request is asynchronous.
* @details This function gets the Route information for the Route, passing
* through a specified set of way points.
* @since_tizen 2.4
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Route Search and which Route
- * preferences are supported, see the lists of capacities and preferences above.
+ * \n To check if Maps Provider is capable of searching the route, passing
+ * through the specified way points, use
+ * maps_service_provider_is_service_supported() with
+ * #MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS passed as @a service parameter.
+ * \n 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 @a data parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] waypoint_list The list of way points to go through
* @see maps_service_search_route()
* @see maps_service_cancel_request()
* @see maps_service_search_route_cb()
+ * @see maps_service_provider_is_service_supported()
+ * @see maps_service_provider_is_data_supported()
*/
int maps_service_search_route_waypoints(const maps_service_h maps,
const maps_coordinates_h *
projects / platform / core / api / maps-service.git / commitdiff