kiosk.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_KIOSK_H
#define LIBMDM_MDM_KIOSK_H

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

#ifdef __cplusplus
extern "C" {
#endif


mdm_result_t knox_mdm_set_allow_hardware_key(const char *key_name, mdm_status_t allow);

mdm_status_t knox_mdm_get_allow_hardware_key(const char *key_name);

/*
 * @brief API to enable or disable changes to the watch face.
 *
 * @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 allow or block the end user from changing the watch face.
 * For example, If watch face change is restricted then the end user can't change the current watch face.
 *
 * @remark
 * Restriction of changing watch face #mdm_status_t is written to #MDM_POLICY_ON_WATCHFACE notification file.
 * You can register a callback for this event using #mdm_register_policy_receiver.
 *
 * @code{.c}
    mdm_result_t ret = mdm_get_service();

    if ( ret == MDM_RESULT_SUCCESS) {
        ret = knox_mdm_set_allow_watchface_changes(MDM_RESTRICTED);

        if ( ret == MDM_RESULT_SUCCESS) {
            // watch face changes are forbidden
        }
    }
    mdm_release_service();
 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.kiosk
 *
 * @param[in] allow    Can be set to #MDM_ALLOWED (watch face change is allowed) or #MDM_RESTRICTED (watch face
 *                     change is not allowed). By default watch face change is allowed.
 * @return  #mdm_result_t : MDM_RESULT_SUCCESS upon successful configuration of end user permission to change the watch
 face, 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.
 *
 * @par Permission:
 * Usage of this API is restricted to registered clients only.
 *
 * @see knox_mdm_get_allow_watchface_change
 *
 */
mdm_result_t knox_mdm_set_allow_watchface_change(mdm_status_t allow);

/*
 * @brief API to check if end users are allowed to change the watch face.
 *
 * @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 modifications to the device watch face changes.
 *
 * @code{.c}
    mdm_result_t ret = mdm_get_service();

    if ( ret == MDM_RESULT_SUCCESS) {
        mdm_status status = knox_mdm_get_allow_watchface_changes();

        if ( status != MDM_STATUS_ERROR ) {
            if ( status == MDM_ALLOWED ) {
                // watch face change is allowed
            } else {
                // watch face change is restricted
            }
        } else {
            // error has occurred
        }
    }
    mdm_release_service();
 * @endcode
 *
 * @privlevel public
 * @privilege %http://developer.samsung.com/tizen/privilege/mdm.kiosk
 *
 * @return #mdm_status_t : Whether watchface change is allowed
 *
 * @retval #MDM_ALLOWED User can change watch face.
 * @retval #MDM_RESTRICTED Usear cannot change watch face.
 * @retval #MDM_STATUS_ERROR Error
 *
 * @par Permission:
 * Usage of this API is restricted to registered clients only.
 *
 * @see knox_mdm_set_allow_watchface_change
 *
 */
mdm_status_t knox_mdm_get_allow_watchface_change(void);


/* --------------------------------------------------------------------------------------------------------
 *                                        HIDDEN DOCUMENTATION
 * --------------------------------------------------------------------------------------------------------
 *
 * Hidden documentation won't be generated by doxygen unless
 * KIOSK_COMMON section is added to the ENABLED_SECTIONS
 * in the Doxygen configuration file.
 */

/*
 * THIS is DEPRECATED. Left for compatibility reason.
 * Do NOT USE THIS.
 */
mdm_status_t mdm_get_allow_watchface_change(void);

const char *mdm_get_key_name(int key);

mdm_result_t mdm_set_enable_kiosk_mode(const char *p_package_name);

mdm_result_t mdm_set_disable_kiosk_mode(void);

mdm_status_t mdm_is_kiosk_mode_enabled(void);

mdm_data_t *mdm_get_kiosk_home_package(void);

mdm_result_t mdm_set_hide_system_bar(mdm_status_t hide);

mdm_status_t mdm_is_system_bar_hidden(void);

mdm_result_t mdm_set_wipe_recent_tasks(void);

mdm_result_t mdm_set_allow_task_manager(mdm_status_t allow);

mdm_status_t mdm_is_task_manager_allowed(void);

mdm_data_t *mdm_get_hardware_key_list(void);

mdm_data_t *mdm_set_allow_hardware_keys(int *p_hw_key_id, int keys_count, mdm_status_t allow);

mdm_status_t mdm_is_hardware_key_allowed(int p_hw_key_id);

mdm_data_t *mdm_get_all_blocked_hardware_keys(void);

mdm_result_t mdm_clear_all_notification(void);

mdm_result_t mdm_set_hide_navigation_bar(mdm_status_t hide);

mdm_result_t mdm_set_hide_status_bar(mdm_status_t hide);

mdm_status_t mdm_is_navigation_bar_hidden(void);

mdm_status_t mdm_is_status_bar_hidden(void);

/* -----------------------------------------------------------------------------------------------------------------
 * END OF HIDDEN DOCUMENTATION
 * -----------------------------------------------------------------------------------------------------------------
 */


#ifdef __cplusplus
}
#endif

#endif // LIBMDM_MDM_KIOSK_H