src/api/maps_route_segment_private.h

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __MAPS_ROUTE_SEGMENT_PRIVATE_H__
  18 #define __MAPS_ROUTE_SEGMENT_PRIVATE_H__
  19
  20 #include <maps_service.h>
  21 #include <maps_extra_types.h>
  22
  23 /**
  24  * @ingroup     CAPI_MAPS_ROUTE_MODULE
  25  * @defgroup CAPI_MAPS_ROUTE_SEGMENT_MODULE Segment
  26  *
  27  * @file maps_route_segment_private.h
  28  * @brief This file contains the functions related to Route Segment information.
  29  * @addtogroup CAPI_MAPS_ROUTE_SEGMENT_MODULE
  30  * @{
  31  * @brief This provides APIs related to Place Segment information, used in Route
  32  * Search.
  33  */
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /**
  40  * @deprecated Deprecated since 8.0.
  41  * @internal
  42  * @brief       Checks if a segment data feature is supported.
  43  * @details This function checks if a segment data feature is supported.
  44  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  45  *
  46  * @param[in]   segment         The handle to segment
  47  * @param[in]   data            The feature to be checked
  48  * @param[out]  supported       Is the feature supported
  49  * @return      0 on success, otherwise a negative error value
  50  * @retval      #MAPS_ERROR_NONE Successful
  51  * @retval      #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  52  *
  53  * @pre @a segment is created using maps_route_segment_create().
  54  *
  55  * @see maps_route_segment_create()
  56  */
  57 int _maps_route_segment_is_data_supported(const maps_route_segment_h segment,
  58                                           maps_service_data_e data,
  59                                           bool *supported) TIZEN_DEPRECATED_API;
  60
  61 /**
  62  * @deprecated Deprecated since 8.0.
  63  * @internal
  64  * @brief       Sets the supported segment data features.
  65  * @details This function sets the supported segment data features.
  66  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  67  *
  68  * @param[in]   segment         The handle to segment
  69  * @param[in]   supported_data  The supported segment data features
  70  * @return      0 on success, otherwise a negative error value
  71  * @retval      #MAPS_ERROR_NONE Successful
  72  * @retval      #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  73  *
  74  * @pre @a segment is created using maps_route_segment_create().
  75  *
  76  * @see maps_route_segment_create()
  77  */
  78 int _maps_route_segment_set_supported_data(maps_route_segment_h segment,
  79                                            const maps_int_hashtable_h supported_data) TIZEN_DEPRECATED_API;
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84 /**
  85  * @}
  86  */
  87 #endif                          /* __MAPS_ROUTE_SEGMENT_PRIVATE_H__ */