From: Priya Kohli Date: Tue, 26 Sep 2023 08:46:58 +0000 (+0530) Subject: Deprecating geofence-manager module X-Git-Tag: accepted/tizen/8.0/unified/20231014.183205^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Faccepted%2Ftizen_8.0_unified;p=platform%2Fcore%2Fapi%2Fgeofence-manager.git Deprecating geofence-manager module Change-Id: I71e9c6549a93aa209921286ea14724ae6117f98e Signed-off-by: Priya Kohli (cherry picked from commit 844f6c91ce83fceb73316aeb0bd388a4f425fe08) --- diff --git a/doc/geofence-manager-doc.h b/doc/geofence-manager-doc.h index f8165b2..045f144 100644 --- a/doc/geofence-manager-doc.h +++ b/doc/geofence-manager-doc.h @@ -20,7 +20,7 @@ /** * @ingroup CAPI_LOCATION_FRAMEWORK - * @defgroup CAPI_GEOFENCE_MANAGER_MODULE Geofence Manager + * @defgroup CAPI_GEOFENCE_MANAGER_MODULE Geofence Manager (Deprecated) * @brief This Geofence Manager API provides service related to geofence(geo-fence). * @section CAPI_GEOFENCE_MANAGER_MODULE_HEADER Required Header * \#include diff --git a/include/geofence_manager.h b/include/geofence_manager.h index 147a93e..29ea845 100644 --- a/include/geofence_manager.h +++ b/include/geofence_manager.h @@ -19,7 +19,7 @@ #include - +#include #ifdef __cplusplus extern "C" { @@ -33,6 +33,7 @@ extern "C" { /** + * @deprecated Deprecated since 8.0. * @brief Called when a device enters or exits the given geofence. * @since_tizen 2.4 * @param[in] geofence_id The specified geofence ID @@ -47,6 +48,7 @@ typedef void(*geofence_state_changed_cb)(int geofence_id, geofence_state_e state /** + * @deprecated Deprecated since 8.0. * @brief Called when a proximity state of device is changed. * @since_tizen 3.0 * @param[in] geofence_id The specified geofence ID @@ -63,6 +65,7 @@ typedef void(*geofence_proximity_state_changed_cb)(int geofence_id, geofence_pro /** + * @deprecated Deprecated since 8.0. * @brief Called when the some event occurs in geofence and place such as add, update, etc.. * @details The events of public geofence is also received if there are public geofences. * @since_tizen 2.4 @@ -81,6 +84,7 @@ typedef void(*geofence_event_cb)(int place_id, int geofence_id, geofence_manager /** + * @deprecated Deprecated since 8.0. * @brief Called when the fence list is requested. * @since_tizen 2.4 * @param[in] geofence_id The geofence ID @@ -99,6 +103,7 @@ typedef bool(*geofence_manager_fence_cb)(int geofence_id, geofence_h fence, int /** + * @deprecated Deprecated since 8.0. * @brief Called when the place list is requested. * @since_tizen 2.4 * @param[in] place_id The current place ID @@ -116,6 +121,7 @@ typedef bool(*geofence_manager_place_cb)(int place_id, const char *place_name, i /** + * @deprecated Deprecated since 8.0. * @brief Checks whether the geofence manager is available or not. * @since_tizen 2.4 * @param[out] supported @c true if geofence service is supported, @@ -126,10 +132,11 @@ typedef bool(*geofence_manager_place_cb)(int place_id, const char *place_name, i * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_manager_create() */ -int geofence_manager_is_supported(bool *supported); +int geofence_manager_is_supported(bool *supported) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Creates a new geofence manager. * @since_tizen 2.4 * @remarks The manager must be released using geofence_manager_destroy().\n @@ -146,10 +153,11 @@ int geofence_manager_is_supported(bool *supported); * @retval #GEOFENCE_MANAGER_ERROR_EXCEPTION Exception occurred * @see geofence_manager_destroy() */ -int geofence_manager_create(geofence_manager_h *manager); +int geofence_manager_create(geofence_manager_h *manager) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Releases the geofence manager. * @since_tizen 2.4 * @remarks Since 3.0, %http://tizen.org/privilege/location privilege is not required. @@ -165,10 +173,11 @@ int geofence_manager_create(geofence_manager_h *manager); * @see geofence_manager_create() * @see geofence_manager_stop() */ -int geofence_manager_destroy(geofence_manager_h manager); +int geofence_manager_destroy(geofence_manager_h manager) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Starts the geofencing service. * @since_tizen 2.4 * @privlevel public @@ -191,10 +200,11 @@ int geofence_manager_destroy(geofence_manager_h manager); * @see geofence_manager_add_fence() * @see geofence_manager_set_geofence_state_changed_cb() */ -int geofence_manager_start(geofence_manager_h manager, int geofence_id); +int geofence_manager_start(geofence_manager_h manager, int geofence_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Stops the geofencing service. * @since_tizen 2.4 * @privlevel public @@ -214,10 +224,11 @@ int geofence_manager_start(geofence_manager_h manager, int geofence_id); * @retval #GEOFENCE_MANAGER_ERROR_GEOFENCE_ACCESS_DENIED Access to specified geofence is denied * @see geofence_manager_start() */ -int geofence_manager_stop(geofence_manager_h manager, int geofence_id); +int geofence_manager_stop(geofence_manager_h manager, int geofence_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Creates a new place for geofencing service. * @since_tizen 2.4 * @privlevel public @@ -234,10 +245,11 @@ int geofence_manager_stop(geofence_manager_h manager, int geofence_id); * @see geofence_manager_update_place() * @see geofence_manager_remove_place() */ -int geofence_manager_add_place(geofence_manager_h manager, const char *place_name, int *place_id); +int geofence_manager_add_place(geofence_manager_h manager, const char *place_name, int *place_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Updates the place name of a given place ID. * @since_tizen 2.4 * @privlevel public @@ -255,10 +267,11 @@ int geofence_manager_add_place(geofence_manager_h manager, const char *place_nam * @see geofence_manager_add_place() * @see geofence_manager_remove_place() */ -int geofence_manager_update_place(geofence_manager_h manager, int place_id, const char *place_name); +int geofence_manager_update_place(geofence_manager_h manager, int place_id, const char *place_name) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Removes the specific place for geofencing service. * @since_tizen 2.4 * @privlevel public @@ -277,10 +290,11 @@ int geofence_manager_update_place(geofence_manager_h manager, int place_id, cons * @see geofence_manager_add_place() * @see geofence_manager_update_place() */ -int geofence_manager_remove_place(geofence_manager_h manager, int place_id); +int geofence_manager_remove_place(geofence_manager_h manager, int place_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Adds a geofence for a given geofence manager. * @since_tizen 2.4 * @privlevel public @@ -302,10 +316,11 @@ int geofence_manager_remove_place(geofence_manager_h manager, int place_id); * @see geofence_create_wifi() * @see geofence_manager_start() */ -int geofence_manager_add_fence(geofence_manager_h manager, const geofence_h fence, int *geofence_id); +int geofence_manager_add_fence(geofence_manager_h manager, const geofence_h fence, int *geofence_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Removes a geofence with a given geofence ID * @since_tizen 2.4 * @privlevel public @@ -324,10 +339,11 @@ int geofence_manager_add_fence(geofence_manager_h manager, const geofence_h fenc * @pre geofence_manager_stop() is called before. * @see geofence_manager_add_fence() */ -int geofence_manager_remove_fence(geofence_manager_h manager, int geofence_id); +int geofence_manager_remove_fence(geofence_manager_h manager, int geofence_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Registers a callback function to be invoked when a device enters or exits the specific geofence. * @since_tizen 2.4 * @param[in] manager The geofence manager handle @@ -342,10 +358,11 @@ int geofence_manager_remove_fence(geofence_manager_h manager, int geofence_id); * @see geofence_manager_unset_geofence_state_changed_cb() * @see geofence_state_changed_cb() */ -int geofence_manager_set_geofence_state_changed_cb(geofence_manager_h manager, geofence_state_changed_cb callback, void *user_data); +int geofence_manager_set_geofence_state_changed_cb(geofence_manager_h manager, geofence_state_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Unregisters the callback function. * @since_tizen 2.4 * @param[in] manager The geofence manager handle @@ -356,10 +373,11 @@ int geofence_manager_set_geofence_state_changed_cb(geofence_manager_h manager, g * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_state_changed_cb() */ -int geofence_manager_unset_geofence_state_changed_cb(geofence_manager_h manager); +int geofence_manager_unset_geofence_state_changed_cb(geofence_manager_h manager) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Registers a callback function to be invoked when a response comes. * @since_tizen 2.4 * @param[in] manager The geofence manager handle @@ -373,10 +391,11 @@ int geofence_manager_unset_geofence_state_changed_cb(geofence_manager_h manager) * @post This function invokes geofence_event_cb(). * @see geofence_manager_unset_geofence_event_cb() */ -int geofence_manager_set_geofence_event_cb(geofence_manager_h manager, geofence_event_cb callback, void *user_data); +int geofence_manager_set_geofence_event_cb(geofence_manager_h manager, geofence_event_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Unregisters the callback function. * @since_tizen 2.4 * @param[in] manager The geofence manager handle @@ -387,10 +406,11 @@ int geofence_manager_set_geofence_event_cb(geofence_manager_h manager, geofence_ * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_event_cb() */ -int geofence_manager_unset_geofence_event_cb(geofence_manager_h manager); +int geofence_manager_unset_geofence_event_cb(geofence_manager_h manager) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Registers a callback function to be invoked when a proximity state of device is changed. * @details The proximity state is measured from registered position regardless of the geofence boundary. * @since_tizen 3.0 @@ -405,10 +425,11 @@ int geofence_manager_unset_geofence_event_cb(geofence_manager_h manager); * @post This function invokes geofence_proximity_state_changed_cb(). * @see geofence_manager_unset_geofence_proximity_state_changed_cb() */ -int geofence_manager_set_geofence_proximity_state_changed_cb(geofence_manager_h manager, geofence_proximity_state_changed_cb callback, void *user_data); +int geofence_manager_set_geofence_proximity_state_changed_cb(geofence_manager_h manager, geofence_proximity_state_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Unregisters the callback function. * @since_tizen 3.0 * @param[in] manager The geofence manager handle @@ -419,10 +440,11 @@ int geofence_manager_set_geofence_proximity_state_changed_cb(geofence_manager_h * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_manager_set_geofence_proximity_state_changed_cb() */ -int geofence_manager_unset_geofence_proximity_state_changed_cb(geofence_manager_h manager); +int geofence_manager_unset_geofence_proximity_state_changed_cb(geofence_manager_h manager) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Retrieves a list of fences registered in the specified geofence manager. * @since_tizen 2.4 * @privlevel public @@ -441,10 +463,11 @@ int geofence_manager_unset_geofence_proximity_state_changed_cb(geofence_manager_ * @see geofence_manager_fence_cb() * @see geofence_manager_add_fence() */ -int geofence_manager_foreach_geofence_list(geofence_manager_h manager, geofence_manager_fence_cb callback, void *user_data); +int geofence_manager_foreach_geofence_list(geofence_manager_h manager, geofence_manager_fence_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Retrieves a list of fences registered in the specified place. * @since_tizen 2.4 * @privlevel public @@ -465,10 +488,11 @@ int geofence_manager_foreach_geofence_list(geofence_manager_h manager, geofence_ * @see geofence_manager_fence_cb() * @see geofence_manager_add_place() */ -int geofence_manager_foreach_place_geofence_list(geofence_manager_h manager, int place_id, geofence_manager_fence_cb callback, void *user_data); +int geofence_manager_foreach_place_geofence_list(geofence_manager_h manager, int place_id, geofence_manager_fence_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Retrieves a list of places registered in the specified geofence manager. * @since_tizen 2.4 * @privlevel public @@ -487,10 +511,11 @@ int geofence_manager_foreach_place_geofence_list(geofence_manager_h manager, int * @see geofence_manager_place_cb() * @see geofence_manager_add_place() */ -int geofence_manager_foreach_place_list(geofence_manager_h manager, geofence_manager_place_cb callback, void *user_data); +int geofence_manager_foreach_place_list(geofence_manager_h manager, geofence_manager_place_cb callback, void *user_data) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 8.0. * @brief Gets the name of place. * @since_tizen 2.4 * @privlevel public @@ -511,7 +536,7 @@ int geofence_manager_foreach_place_list(geofence_manager_h manager, geofence_man * @see geofence_manager_add_place() * @see geofence_manager_update_place() */ -int geofence_manager_get_place_name(geofence_manager_h manager, int place_id, char **place_name); +int geofence_manager_get_place_name(geofence_manager_h manager, int place_id, char **place_name) TIZEN_DEPRECATED_API; /** @@ -548,7 +573,7 @@ int geofence_manager_get_place_name(geofence_manager_h manager, int place_id, ch * @see geofence_create_wifi() * @see geofence_destroy() */ -int geofence_create_geopoint(int place_id, double latitude, double longitude, int radius, const char *address, geofence_h *fence); +int geofence_create_geopoint(int place_id, double latitude, double longitude, int radius, const char *address, geofence_h *fence) TIZEN_DEPRECATED_API; /** @@ -572,7 +597,7 @@ int geofence_create_geopoint(int place_id, double latitude, double longitude, in * @see geofence_create_wifi() * @see geofence_destroy() */ -int geofence_create_bluetooth(int place_id, const char *bssid, const char *ssid, geofence_h *fence); +int geofence_create_bluetooth(int place_id, const char *bssid, const char *ssid, geofence_h *fence) TIZEN_DEPRECATED_API; /** @@ -596,7 +621,7 @@ int geofence_create_bluetooth(int place_id, const char *bssid, const char *ssid, * @see geofence_create_bluetooth() * @see geofence_destroy() */ -int geofence_create_wifi(int place_id, const char *bssid, const char *ssid, geofence_h *fence); +int geofence_create_wifi(int place_id, const char *bssid, const char *ssid, geofence_h *fence) TIZEN_DEPRECATED_API; /** @@ -614,7 +639,7 @@ int geofence_create_wifi(int place_id, const char *bssid, const char *ssid, geof * @see geofence_create_bluetooth() * @see geofence_create_wifi() */ -int geofence_destroy(geofence_h fence); +int geofence_destroy(geofence_h fence) TIZEN_DEPRECATED_API; /** @@ -631,7 +656,7 @@ int geofence_destroy(geofence_h fence); * @see geofence_get_radius() * @see geofence_get_bssid() */ -int geofence_get_type(geofence_h fence, geofence_type_e *type); +int geofence_get_type(geofence_h fence, geofence_type_e *type) TIZEN_DEPRECATED_API; /** @@ -648,7 +673,7 @@ int geofence_get_type(geofence_h fence, geofence_type_e *type); * @see geofence_create_bluetooth() * @see geofence_create_wifi() */ -int geofence_get_place_id(geofence_h fence, int *place_id); +int geofence_get_place_id(geofence_h fence, int *place_id) TIZEN_DEPRECATED_API; /** @@ -668,7 +693,7 @@ int geofence_get_place_id(geofence_h fence, int *place_id); * @see geofence_get_type() * @see geofence_create_geopoint() */ -int geofence_get_latitude(geofence_h fence, double *latitude); +int geofence_get_latitude(geofence_h fence, double *latitude) TIZEN_DEPRECATED_API; /** @@ -688,7 +713,7 @@ int geofence_get_latitude(geofence_h fence, double *latitude); * @see geofence_get_type() * @see geofence_create_geopoint() */ -int geofence_get_longitude(geofence_h fence, double *longitude); +int geofence_get_longitude(geofence_h fence, double *longitude) TIZEN_DEPRECATED_API; /** @@ -708,7 +733,7 @@ int geofence_get_longitude(geofence_h fence, double *longitude); * @see geofence_get_type() * @see geofence_create_geopoint() */ -int geofence_get_radius(geofence_h fence, int *radius); +int geofence_get_radius(geofence_h fence, int *radius) TIZEN_DEPRECATED_API; /** @@ -728,7 +753,7 @@ int geofence_get_radius(geofence_h fence, int *radius); * @see geofence_get_type() * @see geofence_create_geopoint() */ -int geofence_get_address(geofence_h fence, char **address); +int geofence_get_address(geofence_h fence, char **address) TIZEN_DEPRECATED_API; /** @@ -747,7 +772,7 @@ int geofence_get_address(geofence_h fence, char **address); * @see geofence_create_wifi() * @see geofence_get_ssid() */ -int geofence_get_bssid(geofence_h fence, char **bssid); +int geofence_get_bssid(geofence_h fence, char **bssid) TIZEN_DEPRECATED_API; /** @@ -766,7 +791,7 @@ int geofence_get_bssid(geofence_h fence, char **bssid); * @see geofence_create_wifi() * @see geofence_get_bssid() */ -int geofence_get_ssid(geofence_h fence, char **ssid); +int geofence_get_ssid(geofence_h fence, char **ssid) TIZEN_DEPRECATED_API; /** @@ -786,7 +811,7 @@ int geofence_get_ssid(geofence_h fence, char **ssid); * @see geofence_manager_start() * @see geofence_manager_stop() */ -int geofence_status_create(int geofence_id, geofence_status_h *status); +int geofence_status_create(int geofence_id, geofence_status_h *status) TIZEN_DEPRECATED_API; /** @@ -802,7 +827,7 @@ int geofence_status_create(int geofence_id, geofence_status_h *status); * @see geofence_status_get_state() * @see geofence_status_get_duration() */ -int geofence_status_destroy(geofence_status_h status); +int geofence_status_destroy(geofence_status_h status) TIZEN_DEPRECATED_API; /** @@ -817,7 +842,7 @@ int geofence_status_destroy(geofence_status_h status); * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_status_get_duration() */ -int geofence_status_get_state(geofence_status_h status, geofence_state_e *state); +int geofence_status_get_state(geofence_status_h status, geofence_state_e *state) TIZEN_DEPRECATED_API; /** @@ -832,7 +857,7 @@ int geofence_status_get_state(geofence_status_h status, geofence_state_e *state) * @retval #GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED Not supported * @see geofence_status_get_state() */ -int geofence_status_get_duration(geofence_status_h status, int *seconds); +int geofence_status_get_duration(geofence_status_h status, int *seconds) TIZEN_DEPRECATED_API; /** diff --git a/include/geofence_type.h b/include/geofence_type.h index d30f1a4..db119af 100644 --- a/include/geofence_type.h +++ b/include/geofence_type.h @@ -35,6 +35,7 @@ extern "C" { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for Geofence manager of error code. * @since_tizen 2.4 */ @@ -57,6 +58,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for the state of geofence manager. * @since_tizen 2.4 */ @@ -68,6 +70,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for the state of proximity. * @since_tizen 3.0 */ @@ -80,6 +83,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for the provider of proximity. * @since_tizen 3.0 */ @@ -93,6 +97,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for geofence type. * @since_tizen 2.4 */ @@ -104,6 +109,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief Enumeration for geofence management events. * @since_tizen 2.4 */ @@ -123,6 +129,7 @@ typedef enum { /** + * @deprecated Deprecated since 8.0. * @brief The geofence manager handle. * @since_tizen 2.4 */ @@ -130,6 +137,7 @@ typedef struct geofence_manager_s *geofence_manager_h; /** + * @deprecated Deprecated since 8.0. * @brief The geofence handle. * @since_tizen 2.4 */ @@ -137,6 +145,7 @@ typedef struct geofence_s *geofence_h; /** + * @deprecated Deprecated since 8.0. * @brief The geofence status handle. * @since_tizen 2.4 */