#endif
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
+ * @ingroup CAPI_NETWORK_FRAMEWORK
+ * @addtogroup CAPI_NETWORK_UA_MODULE
+ * @{
+ */
+
+/**
* @brief Max. MAC address length.
* @since_tizen 6.5
*/
#define UA_MAC_ADDRESS_STRING_LEN 18
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. IPv4 address length.
* @since_tizen 6.5
*/
#define UA_IPV4_ADDRESS_STRING_LEN 16
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. IP address length (e.g. IPv6).
* @since_tizen 6.5
*/
#define UA_IP_ADDRESS_MAX_STRING_LEN 50
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. device ID length (e.g. UUID).
* @since_tizen 6.5
*/
#define UA_MOBILE_ID_STRING_LEN 50
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. user name length.
* @since_tizen 6.5
*/
#define UA_USER_NAME_MAX_STRING_LEN 50
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. user account length.
* @since_tizen 6.5
*/
#define UA_USER_ACCOUNT_MAX_STRING_LEN 70
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Device scan time multiplier.
* @since_tizen 6.5
*/
#define UA_SCAN_TIME_MULTIPLIER 10
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Max. service name length.
* @since_tizen 6.5
*/
#define UA_MAX_SERVICE_LEN 50
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Window step multiplier.
* @details Detection window step is 5 seconds.
* @since_tizen 6.5
#define UA_DETECTION_WINDOW_STEP 5
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Detection cycle multiplier.
* @details Detection cycle step is 60 seconds.
* @since_tizen 6.5
#define UA_DETECTION_CYCLE_STEP 60
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
+ * @brief Default location callback period (in msec).
+ * @since_tizen 6.5
+ */
+#define UA_LOCATION_PERIOD_DEFAULT 1000
+
+/**
+ * @brief Wifi location sensor.
+ * @since_tizen 6.5
+ */
+#define UA_SENSOR_WIFI_LOCATION 0x00000040
+
+/**
+ * @brief Wifi location mac type.
+ * @since_tizen 6.5
+ */
+#define UA_MAC_TYPE_WIFI_LOCATION 0x10
+
+/**
+ * @brief UWB sensor.
+ * @since_tizen 6.5
+ */
+#define UA_SENSOR_UWB 0x00000080
+
+/**
+ * @brief UWB mac type.
+ * @since_tizen 6.5
+ */
+#define UA_MAC_TYPE_UWB 0x20
+
+
+/**
* @brief Enumeration for UA framework error codes.
* @since_tizen 6.5
*/
} ua_error_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for UA framework supported sensors.
* @since_tizen 6.5
*/
} ua_sensor_type_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for UA framework user detection modes.
* @since_tizen 6.5
*/
} ua_detection_mode_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for User device Operating Systems.
* @since_tizen 6.5
*/
} ua_os_type_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for User device MAC address types.
* @since_tizen 6.5
*/
} ua_mac_type_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for active scan type.
* @since_tizen 6.5
*/
} ua_active_scan_type_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Enumeration for sensor status report.
* @since_tizen 6.5
*/
} ua_sensor_report_e;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief The handle of sensor information.
* @since_tizen 6.5
*/
typedef void *ua_sensor_h;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief The handle of user presence/absence monitor.
* @since_tizen 6.5
*/
typedef void *ua_monitor_h;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief The handle of user information.
* @since_tizen 6.5
*/
typedef void *ua_user_h;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief The handle of service information.
* @since_tizen 6.5
*/
typedef void *ua_service_h;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief The handle of device information.
* @since_tizen 6.5
*/
typedef void *ua_device_h;
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
+ * @brief The handle of location information.
+ * @since_tizen 6.5
+ */
+typedef void *ua_location_h;
+
+/**
* @brief Callback to be invoked if a sensor status changed (presence <-> absence)
* immediately during detection operation.
* @since_tizen 6.5
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to get all sensors for a handle.
* @since_tizen 6.5
*
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to be invoked on completion scan for each device one by one.
* @since_tizen 6.5
*
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to be invoked on detection of user presence.
+ * @details Following error codes can be delivered:
+ * #UA_ERROR_NONE Successful.
+ * #UA_ERROR_OPERATION_FAILED Operation failed
* @since_tizen 6.5
*
* @remarks The @a monitor handle should not be released.
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * @details Following error codes can be delivered:
- * #UA_ERROR_NONE Successful.
- * #UA_ERROR_OPERATION_FAILED Operation failed
- *
* @param[in] monitor The monitor handle
* @param[in] sensor_type Sensor type, In case monitor has more than one sensor and detection
* mode is not #UA_DETECT_MODE_ANY_SENSOR, sensor will be set to last sensor which
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to be invoked on detection of user absence.
+ * @details Following error codes can be delivered:
+ * #UA_ERROR_NONE Successful.
+ * #UA_ERROR_OPERATION_FAILED Operation failed
* @since_tizen 6.5
*
* @remarks The @a monitor handle should not be released.
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * @details Following error codes can be delivered:
- * #UA_ERROR_NONE Successful.
- * #UA_ERROR_OPERATION_FAILED Operation failed
- *
* @param[in] monitor The monitor handle with which absence detection start was invoked.
* @param[in] service The service handle with which absence detection start was invoked.
* @param[in] sensor_type Sensor type by which absence was detected.
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to get all registered devices one by one.
* @since_tizen 6.5
*
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to get all service handles.
* @since_tizen 6.5
*
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to get the user handle added to the service.
* @since_tizen 6.5
*
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Callback to be invoked when adding a new device to UA is finished.
+ * @details Following error codes can be delivered:
+ * #UA_ERROR_NONE Successful.
+ * #UA_ERROR_OPERATION_FAILED Operation failed
* @since_tizen 6.5
*
* @remarks The @a device handle should not be released.
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * @details Following error codes can be delivered:
- * #UA_ERROR_NONE Successful.
- * #UA_ERROR_OPERATION_FAILED Operation failed
- *
* @param[in] device The added device's handle
* @param[in] user_data The user data passed in ua_user_add_device()
*
ua_device_h device,
void *user_data);
+/**
+ * @brief Callback to be invoked on detection of user and device location.
+ * It is invoked once for each user/device in location callback.
+ * Callback period can be set by ua_monitor_set_location_period().
+ * @details Following error codes can be delivered:
+ * #UA_ERROR_NONE Successful.
+ * #UA_ERROR_OPERATION_FAILED Operation failed
+ * @since_tizen 6.5
+ *
+ * @remarks The @a monitor handle should not be released and can be used only in the callback.
+ * @remarks The @a service handle should not be released and can be used only in the callback.
+ * @remarks The @a sensor handle should not be released and can be used only in the callback.
+ * @remarks The @a device handle should not be released and can be used only in the callback.
+ * @remarks The @a user handle should not be released and can be used only in the callback.
+ * @remarks The @a location handle should not be released and can be used only in the callback.
+ *
+ * @param[in] result The result error code of the requested operation.
+ * result is #UA_ERROR_NONE on success, otherwise appropriate error value.
+ * @param[in] monitor The monitor handle
+ * @param[in] service The service handle with which location detection start was invoked.
+ * @param[in] sensor_type Sensor type
+ * @param[in] sensor The handle of the sensor which reported user/device location.
+ * @param[in] device The device handle on which sensor is detected.
+ * @param[in] user The user handle on which sensor is detected.
+ * @param[in] location The location handle.
+ * @param[in] user_data The user data passed in ua_monitor_start_location_detection()
+ *
+ * @see ua_monitor_set_location_period()
+ * @see ua_monitor_start_location_detection()
+ */
+typedef void (*ua_location_detected_cb)(
+ ua_error_e result,
+ ua_monitor_h monitor,
+ ua_service_h service,
+ ua_sensor_type_e sensor_type,
+ ua_sensor_h sensor,
+ ua_device_h device,
+ ua_user_h user,
+ ua_location_h location,
+ void *user_data);
+
/**
* @}
*/
/**
* @ingroup CAPI_NETWORK_FRAMEWORK
- * @addtogroup CAPI_NETWORK_UA_MODULE User Awareness
+ * @addtogroup CAPI_NETWORK_UA_MODULE
* @{
*/
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Initializes the user awareness framework.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_ALREADY_DONE Already initialized
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_deinitialize()
*/
int ua_initialize(void);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief De-initializes the user awareness framework.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
* @retval #UA_ERROR_ALREADY_DONE Already initialized
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_initialize()
*/
int ua_deinitialize(void);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Retrieves handles of all added services.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_cb()
*/
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets default service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_get_name()
* @see ua_service_create()
ua_service_h *service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets service handle by service name for added service.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter or if service with such name does not exist.
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
*/
ua_service_h *service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Creates the ua monitor's handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_destroy()
*/
ua_monitor_h *monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Destroys the ua monitor's handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_create()
*/
ua_monitor_h monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds sensors to UA monitor for which monitoring is to be done.
- * Availability of sensors to be added can be checked using ua_monitor_is_sensor_available()
+ * Availability of sensors to be added can be checked using ua_monitor_is_sensor_available().
* @since_tizen 6.5
* @remarks If you want to add the BLE sensor,
* you should add privilege %http://tizen.org/privilege/bluetooth.
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter or sensor not available to add
* @retval #UA_ERROR_NOT_PERMITTED Operation not permitted
* @retval #UA_ERROR_NOT_READY Resource not ready
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_remove_sensor()
* @see ua_monitor_foreach_sensor()
ua_sensor_type_e sensor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes sensors from UA monitor.
* @since_tizen 6.5
* @remarks If you want to remove the BLE sensor,
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter or sensor not available to remove
* @retval #UA_ERROR_NOT_PERMITTED Operation not permitted
* @retval #UA_ERROR_NOT_READY Resource not ready
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_add_sensor()
* @see ua_monitor_foreach_sensor()
ua_sensor_type_e sensor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Retrieves all sensors present in UA monitor.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_add_sensor()
* @see ua_monitor_remove_sensor()
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Checks if sensor is available or not.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_monitor_is_sensor_available(
bool *available);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets sensor status changed callback. Callback to be invoked
* when sensor status changes from 'PRESENCE' to 'ABSENCE' or vice-versa.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_monitor_set_sensor_status_changed_cb(
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Unsets sensor status changed callback.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_set_sensor_status_changed_cb()
*/
ua_monitor_h monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Starts scan of registered devices.
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see UA_SCAN_TIME_MULTIPLIER
* @see ua_scan_completed_cb()
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Stops ua_monitor_start_scan().
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_scan()
*/
int ua_monitor_stop_scan(ua_monitor_h monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Starts user presence detection.
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_presence_detected_cb()
* @see ua_monitor_stop_presence_detection()
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Stops user presence detection.
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_presence_detection()
*/
ua_monitor_h monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Starts user absence detection.
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_absence_detected_cb()
* @see ua_monitor_stop_absence_detection()
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Stops user absence detection.
* @since_tizen 6.5
* @privlevel public
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_absence_detection()
*/
ua_monitor_h monitor);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
+ * @brief Sets the location callback period in milli-seconds.
+ * If location period is not set, it will be automatically
+ * set to #UA_LOCATION_PERIOD_DEFAULT.
+ * @since_tizen 6.5
+ *
+ * @param[in] monitor The monitor handle
+ * @param[in] location_period location period (0 to UINT_MAX)
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ */
+int ua_monitor_set_location_period(
+ ua_monitor_h monitor, unsigned int location_period);
+
+/**
+ * @brief Starts user location detection.
+ * @since_tizen 6.5
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to start BLE location detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * If you want to start Wi-Fi location detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
+ *
+ * @param[in] monitor The monitor handle
+ * @param[in] service The service handle. If service is NULL then monitor will start for default service.
+ * @param[in] callback Callback to be invoked after device location detection.
+ * @param[in] user_data The user data to be passed when callback is called.
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_NOW_IN_PROGRESS Operation now in progress
+ * @retval #UA_ERROR_NO_DATA No sensor available
+ * @retval #UA_ERROR_OPERATION_FAILED Operation failed
+ * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ *
+ * @see ua_location_detected_cb()
+ * @see ua_monitor_set_location_period()
+ * @see ua_monitor_stop_location_detection()
+ */
+int ua_monitor_start_location_detection(
+ ua_monitor_h monitor,
+ ua_service_h service,
+ ua_location_detected_cb callback,
+ void *user_data);
+
+/**
+ * @brief Stops user location detection.
+ * @since_tizen 6.5
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/location
+ * @remarks If you want to stop BLE location detection,
+ * you should add privilege %http://tizen.org/privilege/bluetooth.
+ * If you want to stop Wi-Fi location detection,
+ * you should add privilege %http://tizen.org/privilege/network.get.
+ *
+ * @param[in] monitor UA monitor's handle
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
+ * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
+ * @retval #UA_ERROR_OPERATION_FAILED Operation failed
+ * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ *
+ * @see ua_monitor_start_location_detection()
+ */
+int ua_monitor_stop_location_detection(
+ ua_monitor_h monitor);
+
+/**
* @brief Creates the user handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_destroy()
*/
ua_user_h *user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Destroys the user handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_create()
*/
ua_user_h user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds the user. Added user is stored in the database
* and is also available after the application restarts.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_ALREADY_REGISTERED Already Registered
*
* @see ua_user_remove()
int ua_user_add(ua_user_h user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes the user.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_add()
*/
int ua_user_remove(ua_user_h user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets account info for user handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_create()
*/
int ua_user_get_account(ua_user_h user, char **account);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds device for a user. This information is stored in database
* and is also available after the application restarts.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_remove_device()
* @see ua_user_device_added_cb()
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes the device handle for a user handle.
* @since_tizen 6.5
* @remarks If you want to remove the BLE device,
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_RESOURCE_BUSY Remove done. but another service uses this device.
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_add_device()
*/
ua_device_h device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Retrieves the device handle of all the registered devices for a specific user.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_registered_device_cb()
*/
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Creates the service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_destroy()
*/
ua_service_h *service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Destroys the service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
*/
ua_service_h service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds the service. Added service is stored in database
* and is also available after the application restarts.
* @since_tizen 6.5
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_remove()
*/
ua_service_h service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Updates the properties for the added service.
* To update a property of a service its respective setter functions
* should be called and then followed by the call of ua_service_update().
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
* @see ua_service_remove()
ua_service_h service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes the service.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_add()
*/
ua_service_h service);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets name info for service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
*/
char **name);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets detection threshold for service handle.
* If the service has already been added, this call should be followed by
* the call of ua_service_update() to reflect the modifications.
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_service_set_detection_threshold(
unsigned int absence_threshold);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets detection threshold for service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_set_detection_threshold()
*/
unsigned int *absence_threshold);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets name info for service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_service_get_user_by_account(ua_service_h service,
const char* account, ua_user_h *user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds a user for a specific service.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_remove_user()
*/
ua_user_h user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes the user for the specific service handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_add_user()
*/
ua_user_h user);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Triggers callback for every user of a specific service.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_user_cb()
*/
void *user_data);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Creates the device handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_destroy()
*/
ua_device_h *device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Destroys the device handle.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_create()
*/
ua_device_h device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device type info from the device.
* @since_tizen 6.5
*
ua_mac_type_e *mac_type);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets device's operating system info.
* If the device has already been added, this call should be followed by
* the call of ua_device_update() to reflect the modifications.
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_os_info()
*/
ua_os_type_e os);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device's operating system info.
* @since_tizen 6.5
*
ua_os_type_e *os_info);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device's MAC address.
* @since_tizen 6.5
*
char **mac_address);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device ID of device, which was set while creating the device handle.
* @since_tizen 6.5
*
char **device_id);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets device's Wi-Fi BSSID.
* If the device has already been added, this call should be followed by
* the call of ua_device_update() to reflect the modifications.
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_wifi_bssid()
*/
const char *bssid);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device's Wi-Fi BSSID.
* @since_tizen 6.5
*
ua_device_h device,
char **bssid);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Sets device's Wi-Fi IPv4 address.
* If the device has already been added, this call should be followed by
* the call of ua_device_update() to reflect the modifications.
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
- * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_wifi_ipv4_address()
*/
const char *ipv4_address);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device's Wi-Fi IPv4 address.
* @since_tizen 6.5
*
char **ipv4_address);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets last presence time for device handle.
* @since_tizen 6.5
*
unsigned long long *last_seen);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets whether pairing is required for the user device.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_create()
*/
bool *pairing_required);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Updates the properties for the added device.
* To update a property of a device its respective setter functions
* should be called and then followed by the call of ua_device_update().
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_set_os_info()
* @see ua_device_set_wifi_ipv4_address()
ua_device_h device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device handle by MAC address.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_device_get_by_mac_address(
ua_device_h *device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets device handle by device ID.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_device_get_by_device_id(
ua_device_h *device);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets sensor's status report.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_status(
ua_sensor_report_e *report);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets sensor's timestamp.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_timestamp(
unsigned long long *timestamp);
/**
- * @ingroup CAPI_NETWORK_UA_MODULE
* @brief Gets sensor's type.
* @since_tizen 6.5
*
*
* @return 0 on success, otherwise a negative error value
* @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
- * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_type(
ua_sensor_h sensor,
ua_sensor_type_e *type);
+/**
+ * @brief Gets the distance for the location handle.
+ * @since_tizen 6.5
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/location
+ *
+ * @param[in] location The location handle for location information.
+ * @param[out] distance distance of the detected device and user.
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ */
+int ua_location_get_distance(ua_location_h location, int *distance);
+
+/**
+ * @brief Gets the position for the location handle.
+ * @since_tizen 6.5
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/location
+ *
+ * @param[in] location The location handle for location information.
+ * @param[out] x x-coordinate of the location.
+ * @param[out] y y-coordinate of the location.
+ * @param[out] z z-coordinate of the location.
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #UA_ERROR_NONE Successful
+ * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ */
+int ua_location_get_position(ua_location_h location,
+ int *x, int *y, int *z);
+
/**
* @}
*/