include/component_manager_extension.h

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_APPFW_COMPONENT_MANAGER_EXTENSION_H
  18 #define __TIZEN_APPFW_COMPONENT_MANAGER_EXTENSION_H
  19
  20 #include <tizen.h>
  21
  22 #include <component_manager.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * @file component_manager_extension.h
  30  */
  31
  32 /**
  33  * @addtogroup CAPI_COMPONENT_MANAGER_MODULE
  34  * @{
  35  */
  36
  37 /**
  38  * @brief Pauses the component.
  39  * @since_tizen 5.5
  40  * @privlevel public
  41  * @privilege %http://tizen.org/privilege/appmanager.launch
  42  *
  43  * @param[in]   handle          The component context handle
  44  * @return      @c 0 on success,
  45  *              otherwise a negative error value
  46  * #retval COMPONENT_MANAGER_ERROR_NONE Successful
  47  * #retval COMPONENT_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  48  * #retval COMPONENT_MANAGER_ERROR_IO_ERROR I/O error
  49  * #retval COMPONENT_MANAGER_ERROR_NO_SUCH_COMP No such component
  50  * #retval COMPONENT_MANAGER_ERROR_PERMISSION_DENIED Permission denied
  51  */
  52 int component_manager_pause_component(component_context_h handle);
  53
  54 /**
  55  * @brief Terminates the running component.
  56  * @since_tizen 5.5
  57  * @privlevel public
  58  * @privilege %http://tizen.org/privilege/appmanager.kill
  59  *
  60  * @param[in]   handle          The component context handle
  61  * @return      @c 0 on success,
  62  *              otherwise a negative error value
  63  * #retval COMPONENT_MANAGER_ERROR_NONE Successful
  64  * #retval COMPONENT_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  65  * #retval COMPONENT_MANAGER_ERROR_IO_ERROR I/O error
  66  * #retval COMPONENT_MANAGER_ERROR_NO_SUCH_COMP No such component
  67  * #retval COMPONENT_MANAGER_ERROR_PERMISSION_DENIED Permission denied
  68  */
  69 int component_manager_terminate_component(component_context_h handle);
  70
  71 /**
  72  * @}
  73  */
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif /* __TIZEN_APPFW_COMPONENT_MANAGER_EXTENSION_H */