This Geofence Manager API provides service related to geofence(geo-fence).

Required Header

#include <geofence_manager.h>

Overview

This Geofence Manager API provides service related to geofence(geo-fence). A geofence is a virtual perimeter for a real-world geographic area. This API provides functions to set geofence with geopoint, MAC address of Wi-Fi, and Bluetooth address. And notifications on events like changing in service status are provided. There are two kinds of places and fences:

Public places and fences that are created by MyPlace app can be used by all apps.
Private places and fences that are created by specified app can be used by the same app. Notifications can be received about the following events:
Zone in when a device enters a specific area
Zone out when a device exits a specific area
Results and errors for each event requested to geofence module The Geofence manager has the following properties:
geofence type
status
'Service state change' callback The geofence type property of geofence manager (geofence_type_e) specifies the type of virtual perimeter. The status property describes the current state and duration of a geofence. State (geofence_state_e) can be uncertain, in, or out.

Related Features

This API is related with the following features:

http://tizen.org/feature/location
http://tizen.org/feature/location.geofence
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.

Since :: 2.4

Functions
int	geofence_manager_is_supported (bool *supported)
	Checks whether the geofence manager is available or not.
int	geofence_manager_create (geofence_manager_h *manager)
	Creates a new geofence manager.
int	geofence_manager_destroy (geofence_manager_h manager)
	Releases the geofence manager.
int	geofence_manager_start (geofence_manager_h manager, int geofence_id)
	Starts the geofencing service.
int	geofence_manager_stop (geofence_manager_h manager, int geofence_id)
	Stops the geofenceing service.
int	geofence_manager_add_place (geofence_manager_h manager, const char place_name, int place_id)
	Creates a new place for geofencing service.
int	geofence_manager_update_place (geofence_manager_h manager, int place_id, const char *place_name)
	Updates the place name of a given place ID.
int	geofence_manager_remove_place (geofence_manager_h manager, int place_id)
	Removes the specific place for geofencing service.
int	geofence_manager_add_fence (geofence_manager_h manager, const geofence_h fence, int *geofence_id)
	Adds a geofence for a given geofence manager.
int	geofence_manager_remove_fence (geofence_manager_h manager, int geofence_id)
	Removes a geofence with a given geofence ID.
int	geofence_manager_set_geofence_state_changed_cb (geofence_manager_h manager, geofence_state_changed_cb callback, void *user_data)
	Registers a callback function to be invoked when a device enters or exits the specific geofence.
int	geofence_manager_unset_geofence_state_changed_cb (geofence_manager_h manager)
	Unregisters the callback function.
int	geofence_manager_set_geofence_event_cb (geofence_manager_h manager, geofence_event_cb callback, void *user_data)
	Registers a callback function to be invoked when a response comes.
int	geofence_manager_unset_geofence_event_cb (geofence_manager_h manager)
	Unregisters the callback function.
int	geofence_manager_set_geofence_proximity_state_changed_cb (geofence_manager_h manager, geofence_proximity_state_changed_cb callback, void *user_data)
	Registers a callback function to be invoked when a proximity state of device is changed.
int	geofence_manager_unset_geofence_proximity_state_changed_cb (geofence_manager_h manager)
	Unregisters the callback function.
int	geofence_manager_foreach_geofence_list (geofence_manager_h manager, geofence_manager_fence_cb callback, void *user_data)
	Retrieves a list of fences registered in the specified geofence manager.
int	geofence_manager_foreach_place_geofence_list (geofence_manager_h manager, int place_id, geofence_manager_fence_cb callback, void *user_data)
	Retrieves a list of fences registered in the specified place.
int	geofence_manager_foreach_place_list (geofence_manager_h manager, geofence_manager_place_cb callback, void *user_data)
	Retrieves a list of places registered in the specified geofence manager.
int	geofence_manager_get_place_name (geofence_manager_h manager, int place_id, char **place_name)
	Gets the name of place.
Typedefs
typedef void(*	geofence_state_changed_cb )(int geofence_id, geofence_state_e state, void *user_data)
	Called when a device enters or exits the given geofence.
typedef void(*	geofence_proximity_state_changed_cb )(int geofence_id, geofence_proximity_state_e state, geofence_proximity_provider_e provider, void *user_data)
	Called when a proximity state of device is changed.
typedef void(*	geofence_event_cb )(int place_id, int geofence_id, geofence_manager_error_e error, geofence_manage_e manage, void *user_data)
	Called when the some event occurs in geofence and place such as add, update, etc..
typedef bool(*	geofence_manager_fence_cb )(int geofence_id, geofence_h fence, int fence_index, int fence_cnt, void *user_data)
	Called when the fence list is requested.
typedef bool(*	geofence_manager_place_cb )(int place_id, const char place_name, int place_index, int place_cnt, void user_data)
	Called when the place list is requested.
typedef struct geofence_manager_s *	geofence_manager_h
	The geofence manager handle.
typedef struct geofence_s *	geofence_h
	The geofence handle.
typedef struct geofence_status_s *	geofence_status_h
	The geofence status handle.

Typedef Documentation

typedef void(* geofence_event_cb)(int place_id, int geofence_id, geofence_manager_error_e error, geofence_manage_e manage, void *user_data)

Called when the some event occurs in geofence and place such as add, update, etc..

The events of public geofence is also received if there are public geofences.

Since :: 2.4

Remarks:: The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.

Parameters:

[in]	place_id	The place ID
[in]	geofence_id	The specified geofence ID
[in]	error	The error code for the particular action
[in]	manage	The result code for the particular place and geofence management
[in]	user_data	The user data passed from callback registration function

Precondition:: geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_event_cb()

See also:: geofence_manage_e; geofence_manager_start(); geofence_manager_set_geofence_event_cb()

typedef struct geofence_s* geofence_h

The geofence handle.

Since :: 2.4

typedef bool(* geofence_manager_fence_cb)(int geofence_id, geofence_h fence, int fence_index, int fence_cnt, void *user_data)

Called when the fence list is requested.

Since :: 2.4

Parameters:

[in]	geofence_id	The geofence ID
[in]	fence	The fence handle
[in]	fence_index	The index number of the fences in the list
[in]	fence_cnt	The total number of fences that exists for the requester
[in]	user_data	The user data passed from callback registration function

Returns:: true to continue iterating, otherwise false

Precondition:: geofence_manager_foreach_geofence_list() and geofence_manager_foreach_place_geofence_list() will invoke this callback if you specify this callback using geofence_manager_foreach_geofence_list().

See also:: geofence_manager_foreach_geofence_list(); geofence_manager_foreach_place_geofence_list(); geofence_manager_add_fence()

typedef struct geofence_manager_s* geofence_manager_h

The geofence manager handle.

Since :: 2.4

typedef bool(* geofence_manager_place_cb)(int place_id, const char *place_name, int place_index, int place_cnt, void *user_data)

Called when the place list is requested.

Since :: 2.4

Parameters:

[in]	place_id	The current place ID
[in]	place_name	The current place name
[in]	place_index	The index number of the places in the list
[in]	place_cnt	The total number of places that exists for the requester
[in]	user_data	The user data passed from callback registration function

Returns:: true to continue iterating, otherwise false

Precondition:: geofence_manager_foreach_place_list() will invoke this callback if you specify this callback using geofence_manager_foreach_place_list().

See also:: geofence_manager_foreach_place_list(); geofence_manager_add_place()

typedef void(* geofence_proximity_state_changed_cb)(int geofence_id, geofence_proximity_state_e state, geofence_proximity_provider_e provider, void *user_data)

Called when a proximity state of device is changed.

Since :: 3.0

Parameters:

[in]	geofence_id	The specified geofence ID
[in]	state	The proximity state
[in]	provider	The proximity provider
[in]	user_data	The user data passed from callback registration function

Precondition:: geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_proximity_state_changed_cb().

See also:: geofence_proximity_state_e; geofence_proximity_provider_e; geofence_manager_start(); geofence_manager_set_geofence_proximity_state_changed_cb()

typedef void(* geofence_state_changed_cb)(int geofence_id, geofence_state_e state, void *user_data)

Called when a device enters or exits the given geofence.

Since :: 2.4

Parameters:

[in]	geofence_id	The specified geofence ID
[in]	state	The geofence state
[in]	user_data	The user data passed from callback registration function

Precondition:: geofence_manager_start() will invoke this callback if you register this callback using geofence_manager_set_geofence_state_changed_cb().

See also:: geofence_state_e; geofence_manager_start(); geofence_manager_set_geofence_state_changed_cb()

typedef struct geofence_status_s* geofence_status_h

The geofence status handle.

Since :: 2.4

Enumeration Type Documentation

enum geofence_manage_e

Enumeration for geofence management events.

Since :: 2.4

Enumerator:

GEOFENCE_MANAGE_FENCE_ADDED	Geofence is added
GEOFENCE_MANAGE_FENCE_REMOVED	Geofence is removed
GEOFENCE_MANAGE_FENCE_STARTED	Geofencing is started
GEOFENCE_MANAGE_FENCE_STOPPED	Geofencing is stopped
GEOFENCE_MANAGE_PLACE_ADDED	Place is added
GEOFENCE_MANAGE_PLACE_REMOVED	Place is removed
GEOFENCE_MANAGE_PLACE_UPDATED	Place is updated
GEOFENCE_MANAGE_SETTING_ENABLED	Setting for geofencing is enabled
GEOFENCE_MANAGE_SETTING_DISABLED	Setting for geofencing is disabled

enum geofence_manager_error_e

Enumeration for Geofence manager of error code.

Since :: 2.4

Enumerator:

GEOFENCE_MANAGER_ERROR_NONE	Success
GEOFENCE_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	Permission denied
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Geofence Manager is not initialized
GEOFENCE_MANAGER_ERROR_INVALID_ID	Invalid geofence ID
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurs
GEOFENCE_MANAGER_ERROR_ALREADY_STARTED	Geofencing is already started
GEOFENCE_MANAGER_ERROR_TOO_MANY_GEOFENCE	Too many geofence
GEOFENCE_MANAGER_ERROR_IPC	Error in GPS, Wi-Fi, or BT
GEOFENCE_MANAGER_ERROR_DATABASE	DB error in the server side
GEOFENCE_MANAGER_ERROR_PLACE_ACCESS_DENIED	Access to specified place is denied
GEOFENCE_MANAGER_ERROR_GEOFENCE_ACCESS_DENIED	Access to specified geofence is denied

enum geofence_proximity_provider_e

Enumeration for the provider of proximity.

Since :: 3.0

Enumerator:

GEOFENCE_PROXIMITY_PROVIDER_LOCATION	Proximity is specified by geospatial coordinate
GEOFENCE_PROXIMITY_PROVIDER_WIFI	Proximity is specified by Wi-Fi access point
GEOFENCE_PROXIMITY_PROVIDER_BLUETOOTH	Proximity is specified by Bluetooth device
GEOFENCE_PROXIMITY_PROVIDER_BLE	Proximity is specified by Bluetooth low energy device
GEOFENCE_PROXIMITY_PROVIDER_SENSOR	Proximity is specified by Sensor

enum geofence_proximity_state_e

Enumeration for the state of proximity.

Since :: 3.0

Enumerator:

GEOFENCE_PROXIMITY_STATE_UNCERTAIN	Uncertain state of proximity
GEOFENCE_PROXIMITY_STATE_FAR	Far state of proximity
GEOFENCE_PROXIMITY_STATE_NEAR	Near state of proximity
GEOFENCE_PROXIMITY_STATE_IMMEDIATE	Immediate state of proximity

enum geofence_state_e

Enumeration for the state of geofence manager.

Since :: 2.4

Enumerator:

GEOFENCE_STATE_UNCERTAIN	Uncertain state of geofence
GEOFENCE_STATE_IN	Geofence In state
GEOFENCE_STATE_OUT	Geofence Out state

enum geofence_type_e

Enumeration for geofence type.

Since :: 2.4

Enumerator:

GEOFENCE_TYPE_GEOPOINT	Geofence is specified by geospatial coordinate
GEOFENCE_TYPE_WIFI	Geofence is specified by Wi-Fi access point
GEOFENCE_TYPE_BT	Geofence is specified by Bluetooth device

Function Documentation

int geofence_manager_add_fence	(	geofence_manager_h	manager,
		const geofence_h	fence,
		int *	geofence_id
	)

Adds a geofence for a given geofence manager.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	fence	The geofence handle
[out]	geofence_id	The geofence ID handle to be newly created on success

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred

See also:: geofence_manager_remove_fence(); geofence_create_geopoint(); geofence_create_bluetooth(); geofence_create_wifi(); geofence_manager_start()

int geofence_manager_add_place	(	geofence_manager_h	manager,
		const char *	place_name,
		int *	place_id
	)

Creates a new place for geofencing service.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	place_name	A place name to be created
[out]	place_id	The place ID to be newly created on success

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred

See also:: geofence_manager_update_place(); geofence_manager_remove_place()

int geofence_manager_create ( geofence_manager_h * manager )

Creates a new geofence manager.

Since :: 2.4

Remarks:: The manager must be released using geofence_manager_destroy().
Since 3.0, http://tizen.org/privilege/location privilege is not required.

Parameters:

[out] manager A geofence manager handle to be newly created on success

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred

See also:: geofence_manager_destroy()

int geofence_manager_destroy ( geofence_manager_h manager )

Releases the geofence manager.

Since :: 2.4

Remarks:: Since 3.0, http://tizen.org/privilege/location privilege is not required.

Parameters:

[in] manager The geofence manager handle

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred

Precondition:: geofence_manager_stop() is called before.

See also:: geofence_manager_create(); geofence_manager_stop()

int geofence_manager_foreach_geofence_list	(	geofence_manager_h	manager,
		geofence_manager_fence_cb	callback,
		void *	user_data
	)

Retrieves a list of fences registered in the specified geofence manager.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	callback	The callback function to deliver each fence
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_DATABASE	Database error

Postcondition:: This function invokes geofence_manager_fence_cb().

See also:: geofence_manager_fence_cb(); geofence_manager_add_fence()

int geofence_manager_foreach_place_geofence_list	(	geofence_manager_h	manager,
		int	place_id,
		geofence_manager_fence_cb	callback,
		void *	user_data
	)

Retrieves a list of fences registered in the specified place.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	place_id	The place ID
[in]	callback	The callback function to deliver each fence of the specified place
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_DATABASE	Database error
GEOFENCE_MANAGER_ERROR_PLACE_ACCESS_DENIED	Access to specified place is denied

Postcondition:: This function invokes geofence_manager_fence_cb().

See also:: geofence_manager_fence_cb(); geofence_manager_add_place()

int geofence_manager_foreach_place_list	(	geofence_manager_h	manager,
		geofence_manager_place_cb	callback,
		void *	user_data
	)

Retrieves a list of places registered in the specified geofence manager.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	callback	The callback function to deliver each place of the specified geofence manager
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_DATABASE	Database error

Postcondition:: This function invokes geofence_manager_place_cb().

See also:: geofence_manager_place_cb(); geofence_manager_add_place()

int geofence_manager_get_place_name	(	geofence_manager_h	manager,
		int	place_id,
		char **	place_name
	)

Gets the name of place.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Remarks:: The place_name must be released using free().

Parameters:

[in]	manager	The geofence manager handle
[in]	place_id	The place ID
[out]	place_name	The name of the place

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_INVALID_ID	Invalid geofence ID
GEOFENCE_MANAGER_ERROR_DATABASE	Database error
GEOFENCE_MANAGER_ERROR_PLACE_ACCESS_DENIED	Access to specified place is denied

See also:: geofence_manager_add_place(); geofence_manager_update_place()

int geofence_manager_is_supported ( bool * supported )

Checks whether the geofence manager is available or not.

Since :: 2.4

Parameters:

[out] supported true if geofence service is supported, otherwise false

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: geofence_manager_create()

int geofence_manager_remove_fence	(	geofence_manager_h	manager,
		int	geofence_id
	)

Removes a geofence with a given geofence ID.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	geofence_id	The specified geofence ID

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred
GEOFENCE_MANAGER_ERROR_GEOFENCE_ACCESS_DENIED	Access to specified geofence is denied

Precondition:: geofence_manager_stop() is called before.

See also:: geofence_manager_add_fence()

int geofence_manager_remove_place	(	geofence_manager_h	manager,
		int	place_id
	)

Removes the specific place for geofencing service.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Remarks:: The place must have no geofences.

Parameters:

[in]	manager	The geofence manager handle
[in]	place_id	The specified place ID

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred
GEOFENCE_MANAGER_ERROR_PLACE_ACCESS_DENIED	Access to specified place is denied

Precondition:: geofence_manager_remove_fence() in all geofence is called before.

See also:: geofence_manager_add_place(); geofence_manager_update_place()

int geofence_manager_set_geofence_event_cb	(	geofence_manager_h	manager,
		geofence_event_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when a response comes.

Since :: 2.4

Parameters:

[in]	manager	The geofence manager handle
[in]	callback	The callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes geofence_event_cb().

See also:: geofence_manager_unset_geofence_event_cb()

int geofence_manager_set_geofence_proximity_state_changed_cb	(	geofence_manager_h	manager,
		geofence_proximity_state_changed_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when a proximity state of device is changed.

The proximity state is measured from registered position regardless of the geofence boundary.

Since :: 3.0

Parameters:

[in]	manager	The geofence manager handle
[in]	callback	The callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes geofence_proximity_state_changed_cb().

See also:: geofence_manager_unset_geofence_proximity_state_changed_cb()

int geofence_manager_set_geofence_state_changed_cb	(	geofence_manager_h	manager,
		geofence_state_changed_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when a device enters or exits the specific geofence.

Since :: 2.4

Parameters:

[in]	manager	The geofence manager handle
[in]	callback	The callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes geofence_state_changed_cb().

See also:: geofence_manager_unset_geofence_state_changed_cb(); geofence_state_changed_cb()

int geofence_manager_start	(	geofence_manager_h	manager,
		int	geofence_id
	)

Starts the geofencing service.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Remarks:: There is no limit on number of geofence managers for which this function called Calling this function invokes a location service event. When the location service is enabled, the service state change callback (set using geofence_manager_set_geofence_state_changed_cb()) notifies the user with geofence ID as the 1st argument, geofence zone state(GEOFENCE_STATE_IN and GEOFENCE_STATE_OUT) as the 2nd argument, and the service starts.

Parameters:

[in]	manager	The geofence manager handle
[in]	geofence_id	The specified geofence ID

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred
GEOFENCE_MANAGER_ERROR_GEOFENCE_ACCESS_DENIED	Access to specified geofence is denied

See also:: geofence_manager_stop(); geofence_manager_add_fence(); geofence_manager_set_geofence_state_changed_cb()

int geofence_manager_stop	(	geofence_manager_h	manager,
		int	geofence_id
	)

Stops the geofenceing service.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Remarks:: This function initiates the process of stopping the service. You can stop and start the geofence manager as needed.

Parameters:

[in]	manager	The geofence manager handle
[in]	geofence_id	The specified geofence ID

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred
GEOFENCE_MANAGER_ERROR_GEOFENCE_ACCESS_DENIED	Access to specified geofence is denied

See also:: geofence_manager_start()

int geofence_manager_unset_geofence_event_cb ( geofence_manager_h manager )

Unregisters the callback function.

Since :: 2.4

Parameters:

[in] manager The geofence manager handle

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: geofence_event_cb()

int geofence_manager_unset_geofence_proximity_state_changed_cb ( geofence_manager_h manager )

Unregisters the callback function.

Since :: 3.0

Parameters:

[in] manager The geofence manager handle

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: geofence_manager_set_geofence_proximity_state_changed_cb()

int geofence_manager_unset_geofence_state_changed_cb ( geofence_manager_h manager )

Unregisters the callback function.

Since :: 2.4

Parameters:

[in] manager The geofence manager handle

Returns:: 0 on success, otherwise a negative error value

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: geofence_state_changed_cb()

int geofence_manager_update_place	(	geofence_manager_h	manager,
		int	place_id,
		const char *	place_name
	)

Updates the place name of a given place ID.

Since :: 2.4

Privilege Level:: public

Privilege:: http://tizen.org/privilege/location

Parameters:

[in]	manager	The geofence manager handle
[in]	place_id	The specified place ID
[in]	place_name	A new place name of the place ID

Return values:

GEOFENCE_MANAGER_ERROR_NONE	Successful
GEOFENCE_MANAGER_ERROR_INVALID_PARAMETER	Illegal argument
GEOFENCE_MANAGER_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this function
GEOFENCE_MANAGER_ERROR_NOT_SUPPORTED	Not supported
GEOFENCE_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
GEOFENCE_MANAGER_ERROR_EXCEPTION	Exception occurred
GEOFENCE_MANAGER_ERROR_PLACE_ACCESS_DENIED	Access to specified place is denied

See also:: geofence_manager_add_place(); geofence_manager_remove_place()

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation