knox_custom.h

/*
 * libknoxcustom
 * Copyright (c) 2012 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_H__
#define __KNOX_CUSTOM_H__

#include "knoxcustom/knox_custom_device_manager.h"
#include "knoxcustom/knox_custom_prokiosk_manager.h"
#include "knoxcustom/knox_custom_settings_manager.h"
#include "knoxcustom/knox_custom_system_manager.h"


#ifdef __cplusplus
extern "C" {
#endif

knox_result_t knox_custom_get_service(void);

int knox_custom_get_service_ext(const char * pkg_name);

knox_result_t knox_custom_release_service(void);

int knox_custom_register_client(const char * pkg_name);

int knox_custom_deregister_client(const char * pkg_name);

/*
 * @brief API to check if KnoxCustom client is registered.
 *
 * @since_Knox_wearable 2.3.0
 *
 * @since_tizen 4.0.0.3
 *
 * @feature %http://developer.samsung.com/tizen/feature/knox.custom
 *
 * @par Usage:
 * This API returns registration status of a client.
 *
 * @note This call does not require calling #knox_custom_get_service().
 *
 * @code{.c}

    knox_custom_status_t status = knox_custom_is_client_registered("com.3rdparty.knox_custom_client");
    if (status != KNOX_CUSTOM_TRUE)
    {
        knox_custom_result_t ret = knox_custom_register_client("com.3rdparty.knox_custom_client");
        if (ret == KNOX_CUSTOM_RESULT_SUCCESS)
        {
            ret = knox_custom_get_service();
            if (ret == KNOX_CUSTOM_RESULT_SUCCESS)
            {
                // Calling KnoxCustom APIs.
            }
            knox_custom_release_service();
        }
    }

 * @endcode
 *
 * @param[in] pkg_name The package name of the KnoxCustom client.
 *
 * @return #knox_custom_status_t : Whether client is registered
 *
 * @retval #KNOX_CUSTOM_TRUE            Client is registered
 * @retval #KNOX_CUSTOM_FALSE           Client is not registred
 * @retval #KNOX_CUSTOM_STATUS_ERROR    Error
 *
 * @see knox_custom_register_client, knox_custom_deregister_client
 */
knox_custom_status_t knox_custom_is_client_registered(const char *pkg_name);

void knox_custom_free_data(knox_custom_data_t *data);


#ifdef __cplusplus
}
#endif

#endif /* __KNOX_CUSTOM_H__ */