knox_custom_system_manager.h

/*
 * libknoxcustom
 * Copyright ⓒ Samsung Electronics, Co., Ltd. All rights reserved.
 *
 * This software contains confidential and proprietary information
 * of Samsung Electronics Co., Ltd.
 * The user of this software agrees not to disclose, disseminate or copy such
 * Confidential Information and shall use the software only in accordance with
 * the terms of the license agreement the user entered into with Samsung.
 */


#ifndef __KNOX_CUSTOM_SYSTEM_MANAGER_H__
#define __KNOX_CUSTOM_SYSTEM_MANAGER_H__

#include "knox_custom_client_type.h"
#ifdef __cplusplus
extern "C"
{
#endif

#ifndef DOXYGEN_SKIP_EMERGENCY_CALL

typedef enum {
   KNOX_CUSTOM_EMERGENCY_FLAG_OFF = 0,        
   KNOX_CUSTOM_EMERGENCY_FLAG_ON,           
} knox_custom_emergency_flag_mode;

typedef enum {
   KNOX_CUSTOM_EMERGENCY_NUMBER_WHITELIST_ADD = 0,        /* Add emergency number */
   KNOX_CUSTOM_EMERGENCY_NUMBER_WHITELIST_REMOVE ,        /* Delete emergency number */
   KNOX_CUSTOM_EMERGENCY_NUMBER_WHITELIST_REMOVE_ALL,      /* Delete all emergency number */
} knox_custom_emergency_number_whitelist_mode;

typedef enum {
   KNOX_CUSTOM_EMERGENCY_NUMBER_WHITELIST_FALSE = 0,        
   KNOX_CUSTOM_EMERGENCY_NUMBER_WHITELIST_TRUE,             
} knox_custom_emergency_number_whitelist_state;
#endif /* DOXYGEN_SKIP_EMERGENCY_CALL */

typedef enum {
   KNOX_CUSTOM_AUTO_CALL_ANSWERING_MODE_OFF = 0,        
   KNOX_CUSTOM_AUTO_CALL_ANSWERING_MODE_ON,           
} knox_custom_auto_call_answering_mode;

typedef enum {
   KNOX_CUSTOM_AUTO_CALL_ANSWERING_NUMBER_WHITELIST_ADD = 0,        /* Add auto call answering number */
   KNOX_CUSTOM_AUTO_CALL_ANSWERING_NUMBER_WHITELIST_REMOVE,        /* Delete auto call answering number */
   KNOX_CUSTOM_AUTO_CALL_ANSWERING_NUMBER_WHITELIST_REMOVE_ALL,      /* Delete all auto call answering number */
} knox_custom_auto_call_answering_number_whitelist_mode;

typedef enum {
   KNOX_CUSTOM_CLEAR_BOOT_ANIMATION = 1,          /* Clear Boot Animation */
   KNOX_CUSTOM_CLEAR_SHUTDOWN_ANIMATION,          /* Clear Shutdown Animation */
   KNOX_CUSTOM_CLEAR_ALL_ANIMATION,               /* Clear Both Boot and Shutdown Animation */
} knox_custom_clear_animation_mode;

typedef enum {
   KNOX_CUSTOM_COOL_DOWN_MODE_INIT = 0,       
   KNOX_CUSTOM_COOL_DOWN_MODE_RELEASE,        
   KNOX_CUSTOM_COOL_DOWN_MODE_WARNING_ACTION, 
   KNOX_CUSTOM_COOL_DOWN_MODE_LIMIT_ACTION,   
   KNOX_CUSTOM_COOL_DOWN_MODE_SHUTDOWN,       
} knox_custom_cool_down_mode;

/*
 * @brief Cool down changed callback function pointer
 * @since_Knox_wearable 2.3.1
 * @since_tizen 4.0.0.4
 * @see   knox_custom_set_cool_down_mode_changed_cb
 *
 * @param[in] mode  Cool down mode
 * @param[in] user_data  User data
 *
 */
typedef void (*knox_custom_cool_down_mode_changed_cb)(knox_custom_cool_down_mode mode, void *user_data);

knox_result_t knox_custom_set_back_key_longpress(const char *appid);

knox_result_t knox_custom_set_enable_hid_state(void);

knox_result_t knox_custom_set_home_key_doublepress(const char * package_name, const char * app_id);

knox_custom_data_t * knox_custom_get_home_key_doublepress (void);

knox_result_t knox_custom_set_boot_animation(const char * animation_path);

knox_result_t knox_custom_set_shutdown_animation(const char * animation_path);

knox_result_t knox_custom_clear_animation(knox_custom_clear_animation_mode mode);

#ifndef DOXYGEN_SKIP_EMERGENCY_CALL

knox_result_t knox_custom_set_emergency_flag(knox_custom_emergency_flag_mode mode);

knox_result_t knox_custom_get_emergency_flag(knox_custom_emergency_flag_mode * mode);

knox_result_t knox_custom_set_emergency_number_whitelist(const char * numberlist, knox_custom_emergency_number_whitelist_mode mode);

knox_custom_data_t * knox_custom_get_emergency_number_whitelist(void);

knox_result_t knox_custom_is_emergency_number_whitelist(const char * emergency_number, knox_custom_emergency_number_whitelist_state * state);
#endif /* DOXYGEN_SKIP_EMERGENCY_CALL */

knox_result_t knox_custom_set_auto_call_answering_mode(knox_custom_auto_call_answering_mode mode);

knox_result_t knox_custom_get_auto_call_answering_mode(knox_custom_auto_call_answering_mode * mode);

knox_result_t knox_custom_set_auto_call_answering_number_whitelist(const char * numberlist, knox_custom_auto_call_answering_number_whitelist_mode mode);

knox_custom_data_t * knox_custom_get_auto_call_answering_number_whitelist(void);

knox_result_t knox_custom_is_incoming_call_number_in_whitelist(const char * incoming_call_number, knox_custom_status_t * status);

knox_result_t knox_custom_create_dump_state_log(void);

knox_result_t knox_custom_read_cool_down_mode(knox_custom_cool_down_mode *mode);

/*
 * @brief API to set callback function called when cool down mode is changed
 *
 * @since_Knox_wearable 2.3.1
 *
 * @since_tizen 4.0.0.4
 *
 * @feature %http://developer.samsung.com/tizen/feature/knox.custom
 *
 * @par Usage:
 * The admin can use this API to get the cool down mode.
 *
 * @code{.c}
    //callback function
    void cool_down_mode_changed(knox_custom_cool_down_mode mode, void *user_data)
    {
        //do something with new state
    }
    ...
    knox_result_t ret;
    //set callback
    ret = knox_custom_set_cool_down_mode_changed_cb(cool_down_mode_changed, NULL);
    if (ret == KNOX_RESULT_SUCCESS) {
        printf("Callback set success!");
    } else {
        printf("Failed to set callback!");
    }
 * @endcode
 *
 * @privlevel public
 *
 * @privilege %http://developer.samsung.com/tizen/privilege/knoxcustom.system
 *
 * @param[in] callback          Callback function
 * @param[in] user_data         User data that is passed to the callback function
 *
 * @note Only one callback function can be set at the same time
 *
 * @retval #KNOX_RESULT_SUCCESS Successful
 * @retval #KNOX_RESULT_FAIL General failure
 * @retval #KNOX_RESULT_NOT_SUPPORTED Not supported
 * @retval #KNOX_RESULT_INVALID_PARAM Invalid parameter
 * @retval #KNOX_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @return #KNOX_RESULT_SUCCESS on success, other values on fail.
 *
 * @see knox_custom_read_cool_down_mode, knox_custom_unset_cool_down_mode_changed_cb
 */
knox_result_t knox_custom_set_cool_down_mode_changed_cb(knox_custom_cool_down_mode_changed_cb callback, void *user_data);

/*
 * @brief API to remove callback function called when cool down mode is changed
 *
 * @since_Knox_wearable 2.3.1
 *
 * @since_tizen 4.0.0.4
 *
 * @feature %http://developer.samsung.com/tizen/feature/knox.custom
 *
 * @par Usage:
 * The admin can use this API to get the cool down mode.
 *
 * @code{.c}
    knox_result_t ret;
    //set callback
    ret = knox_custom_unset_cool_down_mode_changed_cb();
    if (ret == KNOX_RESULT_SUCCESS) {
        printf("Callback unset success!");
    } else {
        printf("Failed to unset callback!");
    }
 * @endcode
 *
 * @privlevel public
 *
 * @privilege %http://developer.samsung.com/tizen/privilege/knoxcustom.system
 *
 * @retval #KNOX_RESULT_SUCCESS Successful
 * @retval #KNOX_RESULT_FAIL General failure
 * @retval #KNOX_RESULT_NOT_SUPPORTED Not supported
 * @retval #KNOX_RESULT_INVALID_PARAM Invalid parameter
 * @retval #KNOX_RESULT_ACCESS_DENIED The application does not have the privilege to call this function.
 *
 * @return #KNOX_RESULT_SUCCESS on success, other values on fail.
 *
 * @see knox_custom_read_cool_down_mode, knox_custom_set_cool_down_mode_changed_cb
 */
knox_result_t knox_custom_unset_cool_down_mode_changed_cb(void);

#ifdef __cplusplus
}
#endif

#endif