Control iconify state according to resume/pause

[platform/core/appfw/appcore-widget.git] / include / widget_app.h

diff --git a/include/widget_app.h b/include/widget_app.h
index 4a2068e..9e309d2 100755 (executable)
--- a/include/widget_app.h
+++ b/include/widget_app.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 - 2016 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2015 - 2017 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
  * you may not use this file except in compliance with the License.
@@ -19,7 +19,6 @@
 #define __TIZEN_APPFW_WIDGET_APP_H__
 
 #include <tizen.h>
-#include <app_control.h>
 #include <app_common.h>
 #include <bundle.h>
 #include <widget_errno.h>
@@ -327,13 +326,20 @@ int widget_app_remove_event_handler(app_event_handler_h event_handler);
  * @brief Gets a widget instance id.
  * @since_tizen 2.3.1
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- * @remark You must not free returned Widget ID
+ * @remark You must not free returned widget instance id
+ * @remark The returned widget instance id is volatile. If the device reboots or the widget's process restarts, it will be changed.\n
+ *      So, you should not assume this value is a persistent one.
+ * @remark widget_service_trigger_update(), widget_service_change_period(), widget_service_get_content_of_widget_instance()\n
+ *      can be called with returned instance id.
  * @param[in] context The context for widget instance
- * @return Widget ID on success,
- *         otherwise NULL
+ * @return widget instance id on success,
+ *      otherwise NULL
  * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
  * @exception #WIDGET_ERROR_FAULT Unrecoverable error
  * @see get_last_result()
+ * @see widget_service_trigger_update()
+ * @see widget_service_change_period()
+ * @see widget_service_get_content_of_widget_instance()
  */
 const char *widget_app_get_id(widget_context_h context);
 
@@ -347,7 +353,7 @@ const char *widget_app_get_id(widget_context_h context);
  * @return The new widget class object,
  *         NULL on error
  * @exception #WIDGET_ERROR_NONE Successfully added
- * @exception #WIDGET_ERROR_INVALID_PARAMETER Not supported
+ * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
  * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
  * @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
  * @see get_last_result()
@@ -426,7 +432,7 @@ int widget_app_context_set_title(widget_context_h context, const char *title);
  * @return The new widget class object,
  *         NULL on error
  * @exception #WIDGET_ERROR_NONE Successfully added
- * @exception #WIDGET_ERROR_INVALID_PARAMETER Not supported
+ * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
  * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
  * @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
  * @see get_last_result()