* @remarks @b Header @b %file: @b \#include @b <FApp.h> @n
* @b Library : @b osp-appfw
*
- * The %App namespace contains the classes for application development, including application life-cycle management, usage of
+ * The %App namespace contains classes for application development, including application life-cycle management, usage of
* functionality exported by other applications through AppControl, and access to application registry and resources. Tizen
* also provides various macros for debugging purposes.
* @n
* The application manager supports normal and conditional application launch, and application control search and launch.
* It looks up the specific application control from the application control registry and creates an application control instance.
* @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
, <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
+ * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
and <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
class _OSP_EXPORT_ AppManager
: public Tizen::Base::Object
static Tizen::Base::Collection::IList* FindAppControlsN(const Tizen::Base::String* pOperationId, const Tizen::Base::String* pCategory, const Tizen::Base::String* pDataType, const Tizen::Base::String* pUriPattern);
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Starts the application control if there is only one application control that matches the specified URI, operation ID, and data type. @n
* If there are more than one application controls, the one that the user selects is started.
*
* String operationId = L"http://tizen.org/appcontrol/operation/call";
* StartAppControl(L"tel:1234567890", &operationId, null, null);
* @endcode
- * @endif
+ * @endif
*/
static result StartAppControl(const Tizen::Base::String& uriData, const Tizen::Base::String* pOperationId, const Tizen::Base::String* pDataType, IAppControlListener* pListener);
* @param[in] providerId The provider ID
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found.
- * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @param[in] providerId The provider ID
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found.
- * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* @if OSPDEPREC
- * Launches the default application with given @c appId. @n
+ * Launches the default application with the given @c appId. @n
* The launch arguments are given as App::OnUserEventReceivedN() or can be obtained by
* invoking App::GetAppArgumentListN(), especially within App::OnAppInitializing().
*
result LaunchApplication(const AppId& appId, const Tizen::Base::Collection::IList* pArguments, LaunchOption option = LAUNCH_OPTION_DEFAULT);
/**
- * Launches the default application with given @c appId.
+ * Launches the default application with the given @c appId.
*
* @since 2.0
* @privlevel public
* @param[in] appId The application's ID to execute
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The application is not installed or not running.
+ * @exception E_OBJ_NOT_FOUND The application is either not installed or is not running.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result TerminateApplication(const AppId& appId);
* @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception.
* @remarks The launch period requires more consideration because an inappropriate short period value may lead
* to an adverse effect on the device battery.
- * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication()
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*
* @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * @remarks The newly introduced launch condition does not work on the previous SDK version and the E_INVALID_CONDITION exception is returned.
+ * @remarks The newly introduced launch condition does not work on the previous SDK version and the @c E_INVALID_CONDITION exception is returned.
* @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception.
* @remarks The launch period requires more consideration because an inappropriate short period value may lead
* to an adverse effect on the device battery.
- * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, const Tizen::Base::String& value);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, int value);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, double value);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, const Tizen::Base::String& value);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, int value);
* @param[in] key A key corresponding to the value
* @param[in] value A floating point value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
- * @remarks In order to save the value in the persistent storage, the AppRegistry::Save() method must be called.
+ * @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, double value);
* @file FAppApplication.h
* @brief This is the header file for the deprecated %Application class.
*
- *This header file is for the deprecated %Application class.
+ * This header file is for the deprecated %Application class.
*/
#ifndef _FAPP_APPLICATION_H_
* @interface IAppControlEventListener
* @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl result events.
*
-* @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
* The %IAppControlEventListener interface defines a listener for the AppControl result events.
*
* @brief <i> [Deprecated] </i>
*
- * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
* @endif
*/
*
* @brief <i> [Deprecated] </i>
*
- * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
* @param[in] providerId The provider ID
* @interface IAppControlListener
* @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl start and result events.
*
- * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
* The %IAppControlListener interface defines a listener for the AppControl start and result events.
{
public:
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i>[Deprecated]</i>
*
- * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
* @endif
*/
*
* @brief <i>[Deprecated]</i>
*
- * @deprecated This class is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
* @param[in] pAppControl A pointer to the AppControl instance that is started
* @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method invoked only for the implicit AppControl resolution.
+ * @remarks This method is invoked only for the implicit AppControl resolution.
* @see AppControl
* @see AppControl::FindAndStart()
*/
*
* The %IAppLaunchConditionEventListener interface defines a listener for the AppLaunchCondition events.
* @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
, <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
+* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>
and <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
*/
class _OSP_EXPORT_ IAppLaunchConditionEventListener
: virtual public Tizen::Base::Runtime::IEventListener
result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId);
/**
- * Removes the value associated with the specified @c key, from a key-values map owned by MAP-type data control provider.
+ * Removes the value associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n
* The %RemoveValue() method is asynchronous.
* For receiving the response from data control provider, set the listener
* with MapDataControl::SetMapDataControlResponseListener(). @n
* @return An error code
* @param[in] dataId A string for identifying specific data, usually a registry section to remove from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to removed
- * @param[in] value A value to removed
+ * @param[in] key A key of the value to remove
+ * @param[in] value A value to remove
* @param[out] reqId The ID of the request
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed as yet.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The method returns @c E_SUCCESS when there is no outstanding notification.
+ * @remarks This method returns @c E_SUCCESS when there is no outstanding notification.
* @endif
*/
result RemoveOngoingActivityNotification(void);
/**
* @if OSPDEPREC
- * Removes the notification message for ongoing activity on behalf of the specified application.
+ * Removes the notification message for the ongoing activity on behalf of the specified application.
*
* @brief <i> [Deprecated] </i>
*
* @b Library : @b osp-appfw
*
* The %Package namespace contains classes and interfaces for information of packages and management of its installation or uninstallation.
+ *
+ * The following diagram illustrates the relationships between the classes belonging to the %Package namespace.
* @image html app_package_namespace_classdiagram.png
*/
// This method is for internal use only.
// Using this method can cause behavioral, security-related, and consistency-related issues in the application.
//
- // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.0
//
// This method is for internal use only.
// Using this method can cause behavioral, security-related, and consistency-related issues in the application.
//
- // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.0
//
// This method is for internal use only.
// Using this method can cause behavioral, security-related, and consistency-related issues in the application.
//
- // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.0
//
//
/**
- * @file FAppPkgIPackageUninstallationResponseListener.h
+ * @file FAppPkgIPackageUninstallationResponseListener.h
* @brief This is the header file for the %IPackageUninstallationResponseListener interface.
*
* This header file contains the declarations of the %IPackageUninstallationResponseListener interface.
* Called when a package uninstallation is completed. @n
* The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false.
*
- *@since 2.0
+ * @since 2.0
*
* @param[in] packageId The package ID
* @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n
/**
* @file FAppService.h
- * @brief This is the header file of the deprecated %Service class.
+ * @brief This is the header file for the deprecated %Service class.
*
* This header file contains the declarations of the deprecated %Service class.
*/
static ServiceApp* GetInstance(void);
/**
- * Executes an application implemented by inheriting this class.
- * This method must be called from the entry method - OspMain(), which is generated by IDE.
+ * Executes an application implemented by inheriting this class. @n
+ * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE.
*
* @since 2.0
*
enum AppUiState
{
APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible on foreground */
- APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window such as a system pop-up */
+ APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window, such as a system pop-up */
APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application or an application control */
};
*
* The %UiApp class is the base class of a %Tizen native UI application.
* A %Tizen native UI application must inherit from the %UiApp class. This class provides the basic features necessary to define the
- * Tizen native UI application.
+ * %Tizen native UI application.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_namespace.htm">App Guide</a> and <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/application_model.htm">Native Application Model</a>.
*
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The frame has not been properly initialized.
- * @exception E_OBJ_NOT_FOUND Frame is not found.
+ * @exception E_OBJ_NOT_FOUND The frame is not found.
*/
IAppFrame* GetAppFrame(void) const;
projects / platform / framework / native / appfw.git / commitdiff