location.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.
 */

/*
 *@brief    This file serves as interface between the Application and MDM server daemon.
 */

#ifndef LIBMDM_MDM_LOCATION_H
#define LIBMDM_MDM_LOCATION_H

#include <stdbool.h>
#include <stdio.h>
#include "mdm_client_type.h"

#ifdef __cplusplus
extern "C" {
#endif

mdm_result_t mdm_start_gps(bool start);


mdm_status_t mdm_is_gps_on(void);

/*
 * @brief Function to allow or restrict end user permission to change GPS settings.
 *
 * @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 set end user permission to access GPS settings. The API call blocks changes from any sources when
 restriction is enabled.
 *
 * @remark
 * GPS change restriction #mdm_status_t is written to #MDM_POLICY_ON_GPS_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_gps_change(MDM_RESTRICTED);
    if(result == MDM_RESULT_SUCCESS) {
        // Success
        ...
    } else {
        // Error
        ...
    }
 * @endcode
 * @param[in] status #MDM_RESTRICTED — End users are not allowed to change GPS settings.
 *           \n #MDM_ALLOWED — End users are allowed to change GPS settings.
 *
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.wifi
 *
 * @return #mdm_result_t : MDM_RESULT_SUCCESS upon successful configuration of end user permission to access GPS
 settings, or an error code from the values listed below upon failure.
 *
 * @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_gps_change
 */
mdm_result_t knox_mdm_set_allow_gps_change(const mdm_status_t status);

/*
 * @brief Function checks if the end user is allowed to make changes to GPS settings.
 *
 * @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 are allowed to make changes to GPS settings.
 *
 * @code{.c}
    mdm_status_t status = knox_mdm_get_allow_gps_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      End users are not allowed to change GPS settings.
 * @retval #MDM_ALLOWED         End users are allowed to change GPS settings.
 * @retval #MDM_STATUS_ERROR    On any error.
 *
 * @see knox_mdm_set_allow_gps_change
 */
mdm_status_t knox_mdm_get_allow_gps_change(void);

#ifdef __cplusplus
}
#endif

#endif // LIBMDM_MDM_LOCATION_H