include/maps_place_attribute.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
  18 #ifndef __MAPS_PLACE_ATTRIBUTE_H__
  19 #define __MAPS_PLACE_ATTRIBUTE_H__
  20
  21 #include <tizen.h>
  22
  23 /**
  24  * @ingroup CAPI_MAPS_PLACE_MODULE
  25  * @defgroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE Attribute
  26  * @file maps_place_attribute.h
  27  * @brief This file contains the functions related to Place Attributes information.
  28  * @addtogroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE
  29  * @{
  30  * @brief This provides APIs related to Place Attributes information, used in Place Discovery and Search.
  31  */
  32
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38
  39 /**
  40  * @deprecated Deprecated since 8.0.
  41  * @brief The Place Attribute handle.
  42  * @details The handle of Place Attribute instance.
  43  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  44  * @remarks To release the handle use maps_place_attribute_destroy().\n
  45  *          To clone the handle use maps_place_attribute_clone().
  46  * @see maps_place_attribute_destroy()
  47  * @see maps_place_attribute_clone()
  48  */
  49 typedef void *maps_place_attribute_h;
  50
  51
  52 /*----------------------------------------------------------------------------*/
  53
  54
  55 /**
  56  * @deprecated Deprecated since 8.0.
  57  * @brief Destroys the place attribute handle and releases all its resources.
  58  * @details This function destroys the place attribute handle and releases all its resources.
  59  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  60  * @param[in] attribute The place attribute handle to destroy
  61  * @return @c 0 on success,
  62  *         otherwise a negative error value
  63  * @retval #MAPS_ERROR_NONE Successful
  64  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  65  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  66  * @see maps_place_attribute_clone()
  67  */
  68 int maps_place_attribute_destroy(maps_place_attribute_h attribute) TIZEN_DEPRECATED_API;
  69
  70
  71 /**
  72  * @deprecated Deprecated since 8.0.
  73  * @brief Clones the place attribute handle.
  74  * @details This function clones the place attribute handle @a origin and all its resources.
  75  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  76  * @remarks @a cloned must be released using maps_place_attribute_destroy().
  77  * @param[in] origin The original place attribute handle
  78  * @param[out] cloned A cloned place attribute handle
  79  * @return @c 0 on success,
  80  *         otherwise a negative error value
  81  * @retval #MAPS_ERROR_NONE Successful
  82  * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
  83  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  84  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  85  * @see maps_place_attribute_destroy()
  86  */
  87 int maps_place_attribute_clone(const maps_place_attribute_h origin, maps_place_attribute_h *cloned) TIZEN_DEPRECATED_API;
  88
  89
  90 /*----------------------------------------------------------------------------*/
  91
  92
  93 /**
  94  * @deprecated Deprecated since 8.0.
  95  * @brief Gets the place attribute ID.
  96  * @details This function gets the place attribute ID.
  97  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  98  * @remarks @a id must be released using free().
  99  * @param[in] attribute The handle to place attribute
 100  * @param[out] id The place attribute ID
 101  * @return @c 0 on success,
 102  *         otherwise a negative error value
 103  * @retval #MAPS_ERROR_NONE Successful
 104  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 105  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 106  */
 107 int maps_place_attribute_get_id(const maps_place_attribute_h attribute, char **id) TIZEN_DEPRECATED_API;
 108
 109
 110 /**
 111  * @deprecated Deprecated since 8.0.
 112  * @brief Gets the place attribute label.
 113  * @details This function gets the place attribute label.
 114  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 115  * @remarks @a label must be released using free().
 116  * @param[in] attribute The handle to place attribute
 117  * @param[out] label The place attribute label
 118  * @return @c 0 on success,
 119  *         otherwise a negative error value
 120  * @retval #MAPS_ERROR_NONE Successful
 121  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 122  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 123  */
 124 int maps_place_attribute_get_label(const maps_place_attribute_h attribute, char **label) TIZEN_DEPRECATED_API;
 125
 126
 127 /**
 128  * @deprecated Deprecated since 8.0.
 129  * @brief Gets the place attribute text.
 130  * @details This function gets the place attribute text.
 131  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 132  * @remarks @a text must be released using free().
 133  * @param[in] attribute The handle to place attribute
 134  * @param[out] text The place attribute text
 135  * @return @c 0 on success,
 136  *         otherwise a negative error value
 137  * @retval #MAPS_ERROR_NONE Successful
 138  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 139  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 140  */
 141 int maps_place_attribute_get_text(const maps_place_attribute_h attribute, char **text) TIZEN_DEPRECATED_API;
 142
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147 /**
 148  * @}
 149  */
 150 #endif /* __MAPS_PLACE_ATTRIBUTE_H__ */