bluetooth.h

/*
 * Copyright (c) 2000-2017 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * PROPRIETARY/CONFIDENTIAL
 *
 * This software is the confidential and proprietary information of
 * SAMSUNG ELECTRONICS ("Confidential Information").
 * You shall not disclose such Confidential Information and shall
 * use it only in accordance with the terms of the license agreement
 * you entered into with SAMSUNG ELECTRONICS.
 * SAMSUNG make no representations or warranties about the suitability
 * of the software, either express or implied, including but not
 * limited to the implied warranties of merchantability, fitness for
 * a particular purpose, or non-infringement.
 * SAMSUNG shall not be liable for any damages suffered by licensee as
 * a result of using, modifying or distributing this software or its derivatives.
 */

#ifndef LIBMDM_MDM_BLUETOOTH_H
#define LIBMDM_MDM_BLUETOOTH_H

#include "mdm_client_type.h"

typedef enum {
    MDM_BT_ERROR = -1,     
    MDM_BT_ALLOWED,        
    MDM_BT_HANDSFREE_ONLY, 
    MDM_BT_RESTRICTED      
} mdm_bt_allow_t;

typedef enum {
    MDM_BT_MODE_CHANGED = 0,      
    MDM_BT_OUTGOING_CALL_CHANGED, 
    /* profile changed */
    MDM_BT_A2DP_PROFILE_CHANGED,               
    MDM_BT_AVRCP_PROFILE_CHANGED,              
    MDM_BT_BPP_PROFILE_CHANGED,                
    MDM_BT_DUN_PROFILE_CHANGED,                
    MDM_BT_FTP_PROFILE_CHANGED,                
    MDM_BT_HFP_PROFILE_CHANGED,                
    MDM_BT_HSP_PROFILE_CHANGED,                
    MDM_BT_PBAP_PROFILE_CHANGED,               
    MDM_BT_SAP_PROFILE_CHANGED,                
    MDM_BT_SPP_PROFILE_CHANGED,                
    MDM_BT_DESKTOP_CONNECTIVITY_STATE_CHANGED, 
    MDM_BT_DISCOVERABLE_STATE_CHANGED,         
    MDM_BT_PARINIG_STATE_CHANGED,              
    MDM_BT_LIMITED_DISCOVERABLE_STATE_CHANGED, 
    MDM_BT_DATA_TRANSFER_CHANGED,              
    MDM_BT_DEVICE_RESTRICTION_CHANGED, 
    MDM_BT_UUID_RESTRICTION_CHANGED    
} mdm_bt_policy_changed_t;

typedef enum {
    MDM_BT_PROFILE_NONE = 0, 
    BLUETOOTH_A2DP_PROFILE,  
    BLUETOOTH_AVRCP_PROFILE, 
    BLUETOOTH_BPP_PROFILE,   
    BLUETOOTH_DUN_PROFILE, 
    BLUETOOTH_FTP_PROFILE, 
    BLUETOOTH_HFP_PROFILE, 
    BLUETOOTH_HSP_PROFILE, 
    BLUETOOTH_PBAP_PROFILE, 
    BLUETOOTH_SAP_PROFILE, 
    BLUETOOTH_SPP_PROFILE, 
    BLUETOOTH_PROFILE_END
} mdm_bt_profile_t;

typedef enum {
    KNOX_MDM_MOBILE_WEARABLE_STATUS_WPC = 1, 
    KNOX_MDM_MOBILE_WEARABLE_STATUS_STANDALONE, 
    KNOX_MDM_MOBILE_WEARABLE_STATUS_CONNECTED   
} knox_mdm_mobile_wearable_status_t;

#ifdef __cplusplus
extern "C" {
#endif

/*
 * @brief API to start the discovery process of remote Bluetooth devices.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * The discovery process usually involves an inquiry scan of about 12 seconds,
 * followed by a page scan of each new device to retrieve its Bluetooth name.
 * This is an asynchronous call that returns immediately.
 * If Bluetooth state is not On, this API will return @c #MDM_RESULT_FAIL.
 *
 * @code{.c}

     mdm_result_t ret = mdm_start_bluetooth_discovery();
     if (ret == MDM_RESULT_SUCCESS){
        // Started Bluetooth discovery
     } else {
        // Failed to start Bluetooth discovery
     }

 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.bluetooth
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS on success, an error code on error
 *
 * @retval #MDM_RESULT_SUCCESS Successful
 * @retval #MDM_RESULT_FAIL General failure
 * @retval #MDM_RESULT_NOT_SUPPORTED Not supported
 * @retval #MDM_RESULT_INVALID_PARAM Invalid parameter
 * @retval #MDM_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @par Permission:
 * This API is restricted to registered clients only.
 *
 * @see mdm_cancel_bluetooth_discovery()
 *
 */
mdm_result_t mdm_start_bluetooth_discovery(void);

/*
 * @brief API to cancel the current discovery process of Bluetooth remote devices.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * Because discovery is a heavyweight procedure for the Bluetooth adapter,
 * this method should always be called before attempting to connect to a remote
 * device.
 * If Bluetooth state is Off, this API returns @c #MDM_RESULT_FAIL.
 *
 * @code{.c}

     mdm_result_t ret = mdm_cancel_bluetooth_discovery();
     if (ret == MDM_RESULT_SUCCESS){
        // success
     } else {
        // fail to cancel Bluetooth discovery
     }

 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.bluetooth
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS on success, an error code on error
 *
 * @retval #MDM_RESULT_SUCCESS Successful
 * @retval #MDM_RESULT_FAIL General failure
 * @retval #MDM_RESULT_NOT_SUPPORTED Not supported
 * @retval #MDM_RESULT_INVALID_PARAM Invalid parameter
 * @retval #MDM_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @par Permission:
 * This API is restricted to registered clients only.
 *
 * @see mdm_start_bluetooth_discovery()
 *
 */
mdm_result_t mdm_cancel_bluetooth_discovery(void);

mdm_data_t *mdm_get_bluetooth_bonded_device_list(void);


mdm_result_t mdm_set_allow_bluetooth_mode(mdm_bt_allow_t state);

mdm_bt_allow_t mdm_get_allow_bluetooth_mode(void);

mdm_result_t mdm_set_allow_bluetooth_outgoing_call(mdm_status_t value);

mdm_status_t mdm_get_allow_bluetooth_outgoing_call(void);

mdm_result_t mdm_set_bluetooth_profile_state(mdm_status_t state, mdm_bt_profile_t profile);

mdm_status_t mdm_get_bluetooth_profile_state(mdm_bt_profile_t profile);

/*
 * @brief API to set whether to allow Bluetooth connections from computers.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * Admins can use this API to block Bluetooth connections between the
 * device and computers (desktops or laptops).
 * Calling this API blocks all connections to the device from any type of
 * computer via Bluetooth.
 *
 * @remark
 * Bluetooth status #mdm_bt_policy_changed_t is written to #MDM_POLICY_ON_BT notification file.
 * You can register a callback for this event using #mdm_register_policy_receiver.
 *
 * @code{.c}

     mdm_result_t ret = mdm_set_bluetooth_desktop_connectivity_state(MDM_ALLOWED);
     if (ret == MDM_RESULT_SUCCESS){
        // success
     }
     else{
        // fail
     }

 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.bluetooth
 *
 * @param[in] value   Whether to allow Bluetooth connections with computers. Set
 *                    to @c #MDM_ALLOWED to allow these connections, or @c
 *                    #MDM_RESTRICTED to block these connections.
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS on success, an error code on error
 *
 * @retval #MDM_RESULT_SUCCESS Successful
 * @retval #MDM_RESULT_FAIL General failure
 * @retval #MDM_RESULT_NOT_SUPPORTED Not supported
 * @retval #MDM_RESULT_INVALID_PARAM Invalid parameter
 * @retval #MDM_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @par Permission:
 * This API is restricted to registered clients only.
 *
 * @see mdm_get_bluetooth_desktop_connectivity_state()
 *
 */
mdm_result_t mdm_set_bluetooth_desktop_connectivity_state(mdm_status_t value);

/*
 * @brief API to check whether Bluetooth connections with computers are allowed.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * An admin can use this API to check if it is possible to connect to a
 * computer via Bluetooth.
 *
 *
 * @code{.c}

    mdm_status_t ret = mdm_get_bluetooth_desktop_connectivity_state();
    if (ret == MDM_ALLOWED) {
        // allowed
    } else if (ret == MDM_RESTRICTED) {
        // restricted
    } else (ret == MDM_STATUS_ERROR){
        // error
    }

 * @endcode
 *
 * @return mdm_status_t : Whether Bluetooth connections with computers are allowed.
 *
 * @retval #MDM_ALLOWED Connections are allowed
 * @retval #MDM_RESTRICTED Otherwise
 *
 * @see mdm_set_bluetooth_desktop_connectivity_state()
 *
 */
mdm_status_t mdm_get_bluetooth_desktop_connectivity_state(void);

mdm_result_t mdm_set_bluetooth_discoverable_state(mdm_status_t value);

mdm_status_t mdm_get_bluetooth_discoverable_state(void);

mdm_result_t mdm_set_bluetooth_pairing_state(mdm_status_t value);

mdm_status_t mdm_get_bluetooth_pairing_state(void);

/*
 * @brief API to set whether to allow limited discoverable mode.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * An admin can use this API to silently allow or restrict limited
 * discoverable mode.
 * If limited discoverable mode is restricted, Bluetooth will always be in
 * discoverable mode when turned on.
 * By default, the device is in limited discoverable mode (that is, the device
 * can be discovered by other devices for limited period of time).
 *
 * @remark
 * Bluetooth status #mdm_bt_policy_changed_t is written to #MDM_POLICY_ON_BT notification file.
 * You can register a callback for this event using #mdm_register_policy_receiver.
 *
 * @code{.c}

     mdm_result_t ret = mdm_set_bluetooth_limited_discoverable_state(MDM_ALLOWED);
     if (ret == MDM_RESULT_SUCCESS){
        // success
     } else {
        // fail
     }

 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.bluetooth
 *
 * @param[in] value   Whether to allow Bluetooth limited discoverable mode. Set
 *                    to @c #MDM_ALLOWED to allow limited discovery, or
 *                    @c #MDM_RESTRICTED to set it to restricted.
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS on success, an error code on error
 *
 * @retval #MDM_RESULT_SUCCESS Successful
 * @retval #MDM_RESULT_FAIL General failure
 * @retval #MDM_RESULT_NOT_SUPPORTED Not supported
 * @retval #MDM_RESULT_INVALID_PARAM Invalid parameter
 * @retval #MDM_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @par Permission:
 * This API is restricted to registered clients only.
 *
 * @see mdm_get_bluetooth_limited_discoverable_state()
 *
 */
mdm_result_t mdm_set_bluetooth_limited_discoverable_state(mdm_status_t value);

/*
 * @brief API to check whether limited discoverable mode is allowed.
 *
 * @since_mdm 1.0.0
 *
 * @since_tizen 2.3.2.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * An admin can use this API to check whether limited discoverable mode is allowed.
 * If limited discoverable mode is restricted, Bluetooth will always be in discoverable mode when turned on.
 * By default, this API returns allowed, and device is in limited discoverable mode (i.e., device can be discovered by
 other devices for a limited period of time).
 *
 * @code{.c}

    mdm_status_t ret = mdm_get_bluetooth_limited_discoverable_state();
    if (ret == MDM_ALLOWED) {
        // allowed
    } else if (ret == MDM_RESTRICTED) {
        // restricted
    } else (ret == MDM_STATUS_ERROR){
        // error
    }

 * @endcode
 *
 * @return #mdm_status_t : Whether Bluetooth limited discoverable mode is allowed.
 *
 * @retval #MDM_ALLOWED Allowed
 * @retval #MDM_RESTRICTED Restricted
 *
 * @see mdm_set_bluetooth_limited_discoverable_state()
 *
 */
mdm_status_t mdm_get_bluetooth_limited_discoverable_state(void);

mdm_result_t mdm_set_bluetooth_data_transfer_state(mdm_status_t value);

mdm_status_t mdm_get_bluetooth_data_transfer_state(void);

mdm_result_t mdm_add_bluetooth_uuids_to_whitelist(GList *uuids);

mdm_result_t mdm_remove_bluetooth_uuids_from_whitelist(GList *uuids);

mdm_result_t mdm_clear_bluetooth_uuids_from_whitelist(void);

mdm_data_t *mdm_get_bluetooth_uuids_from_whitelist(void);

mdm_result_t mdm_add_bluetooth_uuids_to_blacklist(GList *uuids);

mdm_result_t mdm_remove_bluetooth_uuids_from_blacklist(GList *uuids);

mdm_result_t mdm_clear_bluetooth_uuids_from_blacklist(void);

mdm_data_t *mdm_get_bluetooth_uuids_from_blacklist(void);

mdm_result_t mdm_activate_bluetooth_uuid_restriction(mdm_status_t value);

mdm_status_t mdm_is_bluetooth_uuid_restriction_active(void);

mdm_result_t mdm_add_bluetooth_devices_to_whitelist(GList *devices);

mdm_result_t mdm_remove_bluetooth_devices_from_whitelist(GList *devices);

mdm_result_t mdm_clear_bluetooth_devices_from_whitelist(void);

mdm_data_t *mdm_get_bluetooth_devices_from_whitelist(void);

mdm_result_t mdm_add_bluetooth_devices_to_blacklist(GList *devices);

mdm_result_t mdm_remove_bluetooth_devices_from_blacklist(GList *devices);

mdm_result_t mdm_clear_bluetooth_devices_from_blacklist(void);

mdm_data_t *mdm_get_bluetooth_devices_from_blacklist(void);

mdm_result_t mdm_activate_bluetooth_device_restriction(mdm_status_t value);

mdm_status_t mdm_is_bluetooth_device_restriction_active(void);

mdm_result_t knox_mdm_get_mobile_wearable_connection_status(knox_mdm_mobile_wearable_status_t *status);

/*
 * @brief Function to block end users from modifying Bluetooth configurations.
 *
 * @since_mdm 2.2.0
 *
 * @since_tizen 3.0.0.1
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * Use this API to restrict end users from modifying Bluetooth configurations.
 * \n NOTE — This API call blocks change from any source.
 *
 * @remark
 * Policy value is written to #MDM_POLICY_ON_BT_CHANGE notification file.
 * You can register a callback for this event using #mdm_register_policy_receiver.
 *
 * @code{.c}
    mdm_result_t result = knox_mdm_set_allow_bluetooth_change(MDM_RESTRICTED);
    if(result == MDM_RESULT_SUCCESS) {
        // Success
        ...
    } else {
        // Error
        ...
    }
 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.bluetooth
 *
 * @param[in] status #MDM_RESTRICTED — Restricts the end user from modifying Bluetooth settings.
 *           \n #MDM_ALLOWED — Allows the end user to modify Bluetooth settings.
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS on success, an error code on error
 *
 * @retval #MDM_RESULT_SUCCESS Successful
 * @retval #MDM_RESULT_FAIL General failure
 * @retval #MDM_RESULT_NOT_SUPPORTED Not supported
 * @retval #MDM_RESULT_INVALID_PARAM Invalid parameter
 * @retval #MDM_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @see knox_mdm_get_allow_bluetooth_change
 */
mdm_result_t knox_mdm_set_allow_bluetooth_change(const mdm_status_t status);

/*
 * @brief Function to check if end users have permission to change Bluetooth configurations.
 *
 * @since_mdm 2.2.0
 *
 * @since_tizen 3.0.0.1
 *
 * @feature %http://developer.samsung.com/tizen/feature/mdm
 *
 * @par Usage:
 * Use this API to check if end users have permission to change Bluetooth configurations.
 *
 * @code{.c}
    mdm_status_t status = mdm_get_allow_bluetooth_change();
    if(result == MDM_RESTRICTED) {
        // Changes are blocked
        ...
    } else if(result == MDM_ALLOWED) {
        // Changes are allowed
        ...
    }
    else
    {
        // ERROR
        ...
    }
 * @endcode
 *
 * @return #mdm_status_t : The current prevention status.
 *
 * @retval #MDM_RESTRICTED – The end user is restricted from modifying Bluetooth configurations.
 * @retval #MDM_ALLOWED – The end user is allowed to modify Bluetooth configuratons.
 * @retval #MDM_STATUS_ERROR – any error.
 *
 * @see knox_mdm_set_allow_bluetooth_change
 */
mdm_status_t knox_mdm_get_allow_bluetooth_change(void);

#ifdef __cplusplus
}
#endif

#endif // LIBMDM_MDM_BLUETOOTH_H