* @final This class is not intended for extension.
*
* The %AppManager class manages all the applications.
- * The application manager supports normal and conditional application launch, and application control search and launch.
+ * The application manager supports both normal and conditional application launch as well as 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>
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>.
+ *
+ * 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>.
*/
class _OSP_EXPORT_ AppManager
: public Tizen::Base::Object
*/
enum LaunchOption
{
- LAUNCH_OPTION_DEFAULT /**< The launch option: default */
+ LAUNCH_OPTION_DEFAULT /**< The default launch option */
};
/**
*
* @since 2.0
*
- * @return A pointer to the newly created AppControl instance if a matched %AppControl is found, @n
- * else @c null
+ * @return A pointer to the newly created AppControl instance, if a matched %AppControl is found, @n
+ * else @c null if it fails
* @param[in] appId The application ID
* @param[in] operationId The operation ID
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_SYSTEM A system error has occurred. @n
- * Either the file operation or the DB operation has failed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks %Tizen platform defines platform-defined alias for application ID and this aliased application ID
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - Either the file operation or the DB operation has failed.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The %Tizen platform defines a platform-defined alias for the application ID and this aliased application ID
* can be used to find the AppControl. For more information, see
* <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">here</a>.
*
static AppControl* FindAppControlN(const AppId& appId, const Tizen::Base::String& operationId);
/**
- * Finds a list of AppControl instances that matches the specified operation ID, category,
+ * Finds a list of AppControl instances that match the specified operation ID, category,
* data type, and URI pattern.
*
* @since 2.0
*
- * @return A pointer to the list of the AppControl instances that matches the specified operation ID, category, URI, and data type, @n
- * else @c null if it fails
- * @param[in] pOperationId The operation ID
- * @param[in] pCategory The application category
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pUriPattern The URI pattern
+ * @return A pointer to the list of the AppControl instances that match the specified operation ID, category, URI, and data type, @n
+ * else @c null if it fails
+ * @param[in] pOperationId The operation ID
+ * @param[in] pCategory The application category
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pUriPattern The URI pattern
*
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null.
- * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396).
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null.
+ * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396).
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_SYSTEM A system error has occurred. @n
- * Either the file operation or the DB operation has failed.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - Either the file operation or the DB operation has failed.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
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
* 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.
+ * If there are more than one application controls, then the user selected one is started.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener.
* Instead of using this method, use AppControl::FindAndStart().
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] uriData The URI that has a maximum size of @c 1024 bytes
- * @param[in] pOperationId The operation ID
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used for the @c dataType when specifying the file extension.
- * @param[in] pListener A listener that gets notified when the resolved application control has started
- * @exception E_SUCCESS The method is successful.
- * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit.
+ * @param[in] uriData The URI that has a maximum size of @c 1024 bytes
+ * @param[in] pOperationId The operation ID
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used for the @c dataType while specifying the file extension.
+ * @param[in] pListener The listener that gets notified when the resolved application control is started
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit.
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_IN_PROGRESS The target application control is in progress.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_IN_PROGRESS The target application control is in progress.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*
* @see App::GetAppArgumentListN()
* @see FindAppControlN()
/**
* @if OSPDEPREC
* Starts the application control if there is only one application control that matches the specified operation ID, category, URI, and data type. @n
- * If there are more than one application controls, the one that the user selects is started.
+ * If there are more than one application controls, then the user selected one is started.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener.
* Instead of using this method, use AppControl::FindAndStart().
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] pOperationId The operation ID
- * @param[in] pCategory The application control category
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pUriPattern A URI pattern which is used for application control resolution and delivered as the argument
- * @param[in] pDataList The data list that is delivered to the resolved application control @n
- * It has a maximum size of @c 1024 bytes.
- * @param[in] pListener A listener that gets notified when the resolved application control has started
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null.
- * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
+ * @return An error code
+ * @param[in] pOperationId The operation ID
+ * @param[in] pCategory The application control category
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pUriPattern The URI pattern which is used for the application control resolution and is delivered as an argument
+ * @param[in] pDataList The data list that is delivered to the resolved application control @n
+ * It has a maximum size of @c 1024 bytes.
+ * @param[in] pListener The listener that gets notified when the resolved application control is started
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null.
+ * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
* @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_IN_PROGRESS The target application control is in progress.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @exception E_IN_PROGRESS The target application control is in progress.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks For delivered launch arguments, see App::GetAppArgumentListN().
- * @see App::GetAppArgumentListN()
* @see FindAppControlsN()
* @see AppControl::Start()
* @endif
*
* @since 2.0
*
- * @return A pointer to the SqlDataControl instance if a matching data control is found, @n
- * else @c null
+ * @return A pointer to the SqlDataControl instance, if a matching data control is found, @n
+ * else @c null if it fails
* @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 Access is denied due to insufficient permission.
+ * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found.
+ * @exception E_ILLEGAL_ACCESS The 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.
*
* @since 2.0
*
- * @return A pointer to the MapDataControl instance if a matching data control is found, @n
- * else @c null
+ * @return A pointer to the MapDataControl instance, if a matching data control is found, @n
+ * else @c null if it fails
* @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 Access is denied due to insufficient permission.
+ * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found.
+ * @exception E_ILLEGAL_ACCESS The 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.
static MapDataControl* GetMapDataControlN(const Tizen::Base::String& providerId);
/**
- * Gets the path of the read-only shared directory exported by an other application specified with an application ID.
+ * Gets the path of the read-only shared directory exported by another application specified with an application ID.
*
* @since 2.0
*
* else an empty string if an exception occurs
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The expected shared directory cannot be found
- * because the application specified with @c appId cannot be installed.
+ * @exception E_APP_NOT_INSTALLED The expected shared directory has not been found
+ * because the application specified by @c appId cannot be installed.
* @remarks
- * - The returned path can be invalid when the application with specified with @c appId is uninstalled.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - The returned path can be invalid when the application specified by @c appId is uninstalled.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::String GetAppSharedPath(const AppId& appId);
/**
- * Gets the application manager instance.
+ * Gets a pointer to the %AppManager instance.
*
* @since 2.0
*
/**
* @if OSPDEPREC
* 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().
+ * The launch arguments are given by the App::OnUserEventReceivedN() method or can be obtained by
+ * invoking the App::GetAppArgumentListN() method, especially within App::OnAppInitializing().
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because sending argument with %LaunchApplication() is not recommended. @n
- * Instead of using this method, use %LaunchApplication() without launch arguments or AppControl::Start().
- * @since 2.0
+ * @deprecated This method is deprecated because sending arguments through the %LaunchApplication() method is not recommended. @n
+ * Instead of using this method, use the %LaunchApplication() method without launch arguments or AppControl::Start().
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application to execute
* @param[in] pArguments A pointer to the list of string arguments that has a maximum size of @c 1024 bytes
* @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_INVALID_ARG The specified @c appId is empty.
- * @exception E_OBJ_NOT_FOUND The target application is not installed.
+ * @exception E_OBJ_NOT_FOUND The target application has not been installed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_MAX_EXCEEDED The size of @c appId or @c pArguments has exceeded the maximum limit.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
* @endif
*/
result LaunchApplication(const AppId& appId, const Tizen::Base::Collection::IList* pArguments, LaunchOption option = LAUNCH_OPTION_DEFAULT);
/**
* Launches the default application with the given @c appId.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application to execute
* @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The target application is not installed.
+ * @exception E_APP_NOT_INSTALLED The target application has not been installed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
*/
result LaunchApplication(const AppId& appId, LaunchOption option = LAUNCH_OPTION_DEFAULT);
* @privilege %http://tizen.org/privilege/appmanager.kill @n
* (%http://tizen.org/privilege/application.kill is deprecated.)
*
- * @return An error code
- * @param[in] appId The application's ID to execute
+ * @return An error code
+ * @param[in] appId The ID of the application 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 either not installed or is not running.
+ * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred:
+ * - The application is not installed.
+ * - The application is not running.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result TerminateApplication(const AppId& appId);
/**
- * Checks whether an application is running.
+ * Checks whether the application is running.
*
* @since 2.0
*
- * @return @c true if the application is running, @n
- * else @c false
- * @param[in] appId The installed application ID
+ * @return @c true if the application is running, @n
+ * else @c false
+ * @param[in] appId The installed application's ID
*/
bool IsRunning(const AppId& appId) const;
/**
- * Gets a list of running applications at the time of invocation.
+ * Gets the list of running applications at the time of the invocation.
*
* @since 2.0
*
- * @return A pointer to the running state application list (AppId), @n
- * else @c null if an error occurs
+ * @return A pointer to the running state application list (AppId), @n
+ * else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
* Registers an application with a specific condition and launches it if the condition is met. @n
- * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
+ * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
- * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition
+ * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition
*
* @return An error code
* @param[in] condition The launch condition for the application @n
- * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
- * For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
- * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
- <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
- <td>The specified condition is the local due time.</td></tr>
- <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
- <td>The specific condition is the time period after due time.</td></tr>
- <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
- <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
- <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
- communication input command.</td></tr>
- <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
- </td></tr></table> @n
-
- *
- * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n
- * The parameter can also contain @c null. @n
- * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
- * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
- * @exception E_INVALID_FORMAT The specified condition format is invalid.
- * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
- * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
- *
- * @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 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 the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
- * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
+ * For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
+ * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
+ * <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
+ * <td>The specified condition is the local due time.</td></tr>
+ * <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
+ * <td>The specified condition is the time period after the due time.</td></tr>
+ * <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
+ * <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
+ * <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
+ * communication input command.</td></tr>
+ * <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
+ * </td></tr></table> @n
+ *
+ *
+ * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n
+ * This parameter can also contain @c null. @n
+ * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
+ * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
+ * @exception E_INVALID_FORMAT The specified condition format is invalid.
+ * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
+ * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
+ *
+ * @remarks
+ * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the
+ * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the
+ * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned.
+ * - Registering the same launch condition overwrites the previous launch argument without throwing an exception.
+ * - The launch period requires more consideration because an inappropriate short period value may lead to an adverse effect on the device battery.
+ * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication(const AppId&, LaunchOption);
/**
* Unregisters the previously registered launch condition.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @exception E_SUCCESS Either of the following conditions has occurred:
+ * @exception E_SUCCESS Either of the following conditions has occurred:
* - The method is successful.
* - There is no registered launch condition.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see RegisterAppLaunch()
* @see IsAppLaunchRegistered()
*/
* @return An error code
* @param[in] condition The launch condition for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified launch condition is not found.
+ * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
result UnregisterAppLaunch(const Tizen::Base::String& condition);
/**
- * Checks whether a launch condition is registered for the application.
+ * Checks whether the launch condition is registered for the application.
*
* @since 2.0
*
- * @return @c true if a condition is already registered to the application invoking this method, @n
+ * @return @c true if the condition is already registered for the application, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
bool IsAppLaunchRegistered(void) const;
/**
- * Registers the specified application with a specific condition and launches it if the condition is met. @n
- * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
- * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN().
+ * Registers the specified application with the specified condition and launches it if the condition is met. @n
+ * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
*
* @since 2.0
* @privlevel partner
* @privilege %http://tizen.org/privilege/appmanager.launch
- * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition
+ * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'", or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition
*
* @return An error code
* @param[in] appId The ID of the application registered for launch
* @param[in] condition The launch condition for the application @n
* The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n
* For more information on the condition formats, see <a href="../org.tizen.native.appprogramming/html/guide/app/registering_launch_condition.htm">Registering a Launch Condition</a>.
- * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
- <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
- <td>The specified condition is the local due time.</td></tr>
- <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
- <td>The specific condition is the time period after due time.</td></tr>
- <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
- <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
- <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
- communication input command.</td></tr>
- <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
- </td></tr></table> @n
-
- *
- * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n
- * The parameter can also contain @c null. @n
- * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
- * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
- * @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
- * @exception E_INVALID_FORMAT The specified condition format is invalid.
- * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
- *
- * @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 @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 the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
- * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * <table><tr><th>Condition Format</th><th>Meaning</th></tr>
+ * <tr><td>L"DateTime='mm/dd/yyyy hh:mm:ss'"</td>
+ * <td>The specified condition is the local due time.</td></tr>
+ * <tr><td>L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"</td>
+ * <td>The specified condition is the time period after the due time.</td></tr>
+ * <tr><td>L"WeeklyTime='EEE HH:mm:ss'"</td>
+ * <td>The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example: <br>i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"<br> To specify the day of the week, it must be in one of the following supported string format: <br>Mon: Monday<br>Tue: Tuesday<br>Wed: Wednesday<br>Thu: Thursday<br>Fri: Friday<br>Sat: Saturday<br>Sun: Sunday</td></tr>
+ * <tr><td>L"Serial='command'"</td><td>The specified condition is a serial
+ * communication input command.</td></tr>
+ * <tr><td>L"NFC='command'"</td><td>The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data.
+ * </td></tr></table> @n
+ *
+ *
+ * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n
+ * The parameter can also contain @c null. @n
+ * For more information on the arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
+ * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes).
+ * @exception E_INVALID_FORMAT The specified condition format is invalid.
+ * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>. @b Since: @b 2.1
+ *
+ * @remarks
+ * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the
+ * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the
+ * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method.
+ * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned.
+ * - Registering the same launch condition overwrites the previous launch argument without throwing an exception.
+ * - The launch period requires more consideration because an inappropriate short period value may lead
+ * to an adverse effect on the device battery.
+ * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
* @see UnregisterAppLaunch()
* @see IsAppLaunchRegistered()
* @see LaunchApplication(const AppId&, LaunchOption);
- * @see IAppLaunchConditionEventListener::OnAppLaunchConditionMetN()
* @see Tizen::Base::DateTime::ToString()
* @see Tizen::Io::SerialPort
*/
* @privilege %http://tizen.org/privilege/appmanager.launch
*
* @return An error code
- * @param[in] appId The application ID
+ * @param[in] appId The application ID
* @param[in] pCondition The launch condition to unregister @n
* If the parameter contains @c null, all the conditions are unregistered.
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified launch condition is not found.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @privlevel partner
* @privilege %http://tizen.org/privilege/appmanager.launch
*
- * @return @c true if a condition is already registered to the specified application with the specified condition, @n
+ * @return @c true if the condition is already registered for the specified application with the specified condition, @n
* else @c false
- * @param[in] appId The application ID
- * @param[in] pCondition The launch condition to register for the specified @c appId @n
- * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId.
+ * @param[in] appId The application ID
+ * @param[in] pCondition The launch condition to register for the specified @c appId @n
+ * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId.
* @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener The listener to receive the checkpoint event
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already set.
- * @exception E_SYSTEM A system error has occurred.
+ * @return An error code
+ * @param[in] listener The listener to receive the checkpoint event
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already set.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
result SetCheckpointEventListener(IAppCheckpointEventListener& listener);
/**
* @if OSPDEPREC
* Sends the result list for the application control request. @n
- * The client can get the result list by implementing IAppControlEventListener::OnAppControlCompleted().
+ * The client gets the result list by implementing the IAppControlEventListener::OnAppControlCompleted() method.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because a new method has been added. @n
- * Instead of using this method, use AppControlProviderManager::SendAppControlResult().
+ * Instead of using this method, use AppControlProviderManager::SendAppControlResult().
* @since 2.0
*
* @return An error code
- * @param[in] appControlRequestId The application control request ID @n
- * The application control request ID is given as an argument for
- * App::GetAppArgumentListN() or App::OnUserEventReceivedN().
- * @param[in] pResultList The list of the result strings of the application control
+ * @param[in] appControlRequestId The application control request ID @n
+ * The application control request ID is given as an argument to the
+ * App::GetAppArgumentListN() method or the App::OnUserEventReceivedN() method.
+ * @param[in] pResultList The list of the result strings of the application control
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @see IAppControlEventListener
static result SendAppControlResult(const Tizen::Base::String& appControlRequestId, const Tizen::Base::Collection::IList* pResultList);
/**
- * Sets an IAppLaunchConditionEventListener to the %AppManager. @n
- * The listener gets notified when the application is launched by the registered condition.
- *
- * @since 2.0
- *
- * @param[in] pListener The event listener @n
- * To unset the listener, pass a @c null value to the listener parameter.
- * @remarks If the application is newly launched by the condition, then %SetAppLaunchConditionEventListener() must
- * be set within App::OnAppInitializing().
- * If the application does not set the listener using %SetAppLaunchConditionEventListener(),
- * then the application is launched without invoking any listener for the condition.
- * @see RegisterAppLaunch()
- */
+ * Sets an IAppLaunchConditionEventListener for the %AppManager. @n
+ * The listener gets notified when the application is launched by the registered condition.
+ *
+ * @since 2.0
+ *
+ * @param[in] pListener The event listener @n
+ * To unset the listener, pass a @c null value to the listener parameter.
+ * @remarks If the application is newly launched by the condition, then the %SetAppLaunchConditionEventListener() method
+ * within App::OnAppInitializing() must be set. @n
+ * If the application does not set the listener using the %SetAppLaunchConditionEventListener() method,
+ * then the application is launched without invoking any listener for the condition.
+ * @see RegisterAppLaunch()
+ */
void SetAppLaunchConditionEventListener(IAppLaunchConditionEventListener* pListener);
/**
- * Adds an IActiveAppEventListener to the %AppManager. @n
+ * Adds an IActiveAppEventListener for the %AppManager. @n
* The listener gets notified when the active application is changed.
*
* @since 2.0
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Active application is the top most window with focus.
+ * @remarks The active application is the top most window with focus.
* @see GetActiveApp()
* @see RemoveActiveAppEventListener()
*/
* @return An error code
* @param[in] listener The event listener
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c listener is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c listener has not been found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetActiveApp()
result RemoveActiveAppEventListener(IActiveAppEventListener& listener);
/**
- * Gets the current active application AppId.
+ * Gets the current active application's ID.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/appusage
*
* @return An error code
- * @param[out] appId The AppId of the active application
+ * @param[out] appId The ID of the active application
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Active application is the top most window with focus.
+ * @remarks The active application is the top most window with focus.
* @see AddActiveAppEventListener()
* @see RemoveActiveAppEventListener()
*/
result GetActiveApp(AppId& appId);
/**
- * Checks whether the specified application is declared as preferred application for any AppControl resolution
+ * Checks whether the specified application is declared as the preferred application for any AppControl resolution
*
* @since 2.2
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appmanager.setting
*
* @return @c true if the application is running, @n
- * else @c false
- * @param[in] appId Application ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The specified application is not installed.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
+ * else @c false
+ * @param[in] appId The application ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_APP_NOT_INSTALLED The specified application has not been installed.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
bool IsUserPreferredAppForAppControlResolution(const AppId& appId) const;
/**
- * Clear user preference for all AppControl resolutions on the specified application.
+ * Clears the user preference for all the AppControl resolutions of the specified application.
*
* @since 2.2
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appmanager.setting
*
- * @return An error code
+ * @return An error code
* @param[in] appId The preferred application's ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @exception E_APP_NOT_INSTALLED The specified application is not installed.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_APP_NOT_INSTALLED The specified application has not been installed.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks For more information on AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*/
result ClearUserPreferenceForAppControlResolution(const AppId& appId);
projects / platform / framework / native / appfw.git / blobdiff