* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FApp.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* 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
+ * the functionality exported by other applications through AppControl, and access to the application registry and resources. %Tizen
* also provides various macros for debugging purposes.
- * @n
+ *
* For more information on the %App namespace features and the macros, 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/debugging_macros.htm">Debugging Macros</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %App namespace.
*
* The %App class is the base class of a %Tizen native application.
* A %Tizen native application must be inherited from the UiApp or ServiceApp class. These classes are inherited from the %App class. This class provides the basic features necessary to define an 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>, <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/application_lifecycle.htm">Application Life-cycle</a>, and <a href="../org.tizen.native.appprogramming/html/guide/app/app_system_events.htm">System Events</a>.
*
*/
/**
* @if OSPDEPREC
- * Gets the list of the launch arguments. @n
+ * Gets the list of launch arguments. @n
* For more information on the launch arguments, see <a href="../org.tizen.native.appprogramming/html/guide/app/launching_other_apps_within_apps.htm">Launching Other Applications</a>.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of using this method, it is recommended to use IAppControlProviderEventListener
- * to acquire delivered arguments list.
+ * to acquire the delivered arguments list.
* @since 2.0
*
* @return A pointer to the list that contains the Tizen::Base::String instances of the launch arguments
* Gets the locale-independent name of the application.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @section CompGetAppNamePageIssue Issues
* Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
*
- * -# GetAppName() returns the localized name of the application while the meaning of the application name is ambiguous.
- * There are different use cases for locale-dependent name and localized name and the platform does not provide
- * a method for obtaining language-neutral name.
+ * -# The GetAppName() method returns the localized name of the application while the meaning of the application name is ambiguous.
+ * There are different use cases for the locale-dependent name and the localized name. The platform does not provide
+ * any method for obtaining the language-neutral name.
*
* @section CompGetAppNamePageResolution Resolutions
* The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
*
- * -# GetAppDisplayName() is introduced to acquire localized name and GetAppName() returns locale-independent application name.
+ * -# The GetAppDisplayName() method is introduced to acquire the localized application name and the GetAppName() method returns the locale-independent application name.
*/
/**
AppId GetAppId(void) const;
/**
- * Gets the path of the application's root directory where the application is installed.
+ * Gets the path to the application's root directory where the application is installed.
*
* @since 2.0
*
Tizen::Base::String GetAppRootPath(void) const;
/**
- * Gets the path of the application's data directory used to store its own private data.
+ * Gets the path to the application's data directory where its private data is stored.
*
* @since 2.0
*
Tizen::Base::String GetAppDataPath(void) const;
/**
- * Gets the path of the application's resource directory that ships resource files delivered with the application
- * package.
+ * Gets the path to the application's resource directory that ships the resource files that are delivered with the application package.
*
* @since 2.0
*
Tizen::Base::String GetAppResourcePath(void) const;
/**
- * Gets the path of the application's shared directory to export data to other applications.
+ * Gets the path to the application's shared directory to export data to other applications.
*
* @since 2.1
*
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state.
*/
* including restoring the application's states, must be done in the %OnAppInitializing() method.
* If this method fails, the application's state changes to App::TERMINATED.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the method is successful, @n
- * else @c false
+ * @return @c true if the method is successful, @n
+ * else @c false
* @param[in] appRegistry The instance of AppRegistry that manages the application's states
* @remarks Introducing the modal dialogs (for example, MessageBox) in this method is not allowed,
- * because it blocks the initialization procedure.
+ * because it blocks the initialization procedure.
*/
virtual bool OnAppInitializing(AppRegistry& appRegistry) = 0;
/**
* Called when the application's initialization is finished. @n
* After the %OnAppInitialized() method succeeds, the application's state changes to App::RUNNING.
- * If this method fails, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called.
+ * If this method fails, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called.
*
* @since 2.0
*
/**
* Called when the application is requested to terminate. @n
* The %OnAppWillTerminate() method returns @c false to prevent the application from getting terminated.
- * If this method returns @c true, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called.
+ * If this method returns @c true, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called.
*
* @since 2.0
*
/**
* Called when the application's state changes to App::TERMINATING. @n
- * All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method.
+ * All the activities involved in terminating the application, including saving the application's states, must be done by the %OnAppTerminating() method.
* After this method, the application code cannot be executed. The application is destroyed subsequently. @n
*
- * An application's termination is triggered either by the system or other applications. @n
- * When the termination is triggered by the system because of conditions such as power-off and OOM, it is called "urgent termination" and during these terminations %OnAppTerminating(), cannot be executed properly.
+ * An application's termination is triggered either by the system or by other applications. @n
+ * When the termination is triggered by the system because of conditions, such as power-off, and OOM, it is called "urgent termination" and during these terminations the %OnAppTerminating() method cannot be executed properly.
* When an application is terminated because of a power-off, although this method is called, it should be executed in a short duration. And when an application is killed by OOM, this method is not called. @n
- * This implies that this method is not likely to be called during an urgent termination, and hence the application should save the critical data as often as possible.
- * For example, the application can set a check point or use the callback for low memory.
- * When an application is terminated by self or other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for executing it as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n
+ * This implies that this method is not likely to be called during an urgent termination, and hence the application should save its critical data as often as possible.
+ * For example, the application can set a check point or use a callback for low memory issues.
+ * When an application terminates itself or is terminated by other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for execution as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n
* When this method is called, the main loop has already been quit.
* Thus, the application should not use any kind of asynchronous API that has callbacks triggered by the main loop.
*
* @since 2.0
*
- * @return @c true if the method is successful, @n
- * else @c false
+ * @return @c true if the method is successful, @n
+ * else @c false
* @param[in] appRegistry The instance that manages the application's states
* @param[in] urgentTermination Set to @c true if the application is terminated by the system, @n
* else @c false
virtual bool OnAppTerminating(AppRegistry& appRegistry, bool urgentTermination = false) = 0;
/**
- * Called when the system detects that the system wide memory or application heap memory is insufficient to run the application any further. @n
+ * Called when the system detects that the system wide memory or the application heap memory is insufficient to run the application any further. @n
* Resources that are not in use currently can be released using the %OnLowMemory() method.
*
* @since 2.0
/**
* Called when the battery level changes. @n
- * It is recommended that the application decides whether to terminate by itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
+ * It is recommended that the application decides whether to terminate itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
*
* @since 2.0
*
*
* @return An error code
* @param[in] requestId The user defined event ID
- * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String
+ * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String
* @exception E_SUCCESS The method is successful.
* @see OnUserEventReceivedN()
*/
* @since 2.0
*
* @param[in] requestId The user defined event ID
- * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String
+ * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String
*/
virtual void OnUserEventReceivedN(RequestId requestId, Tizen::Base::Collection::IList* pArgs);
/**
- * Gets the %App instance's pointer.
+ * Gets a pointer to the %App instance.
*
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_contact.htm">Contact Application Control</a>.
*
* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.contacts".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_calendar.htm">Calendar Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.calendar".
+* Instead of this variable, use the literal, L"tizen.calendar".
* @since 2.0
* @endif
*/
* @if OSPDEPREC
* The Todo %AppControl ID.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This application control provider name is deprecated.
-* @b OPERATION_PICK:
-* @since 2.0
+* @brief <i> [Deprecated] </i>
+* @deprecated This application control provider name is deprecated.
+* @b OPERATION_PICK:
+* @since 2.0
*
-* @remarks This constant is currently not available.
+* @remarks This constant is currently not available.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_TODO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/dial".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/dial".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/call".
-* @since 2.0
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/call".
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/systeminfo
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_message.htm">Message Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.messages".
* @since 2.0
*
-* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n
-* MMS attachments cannot contain a video in combination with an image or an audio file.
+* @remarks
+* - An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file.
+* - MMS attachments cannot contain a video in combination with an image or an audio file.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_MESSAGE;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_email.htm">Email Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.email".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.email".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_media.htm">Media Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery".
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_image.htm">Image Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.imageviewer".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_video.htm">Video Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.videoplayer".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_audio.htm">Audio Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.musicplayer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_AUDIO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_browser.htm">Browser Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.internet".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_camera.htm">Camera Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.camera".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_bluetooth.htm">Bluetooth Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.bluetooth".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_BT;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_settings.htm">Settings Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.settings".
* @since 2.0
* @endif
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_contact.htm">Contact Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.contacts".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CONTACT;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_certmgr.htm">Certificate Manager Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.certificatemanager".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_calendar.htm">Calendar Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.calendar".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_call.htm">Call Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.phone".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/systeminfo
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_message.htm">Message Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.messages".
-* @since 2.0
+* @since 2.0
*
-* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n
-* MMS attachments cannot contain a video in combination with an image or an audio file. @n
-* From Tizen 2.0, the CC and BCC recipients are merged with the TO recipients when launching the MMS app control.
+* @remarks An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file. @n
+* MMS attachments cannot contain a video in combination with an image or an audio file. @n
+* From %Tizen 2.0, the CC and BCC recipients are merged with the TO recipients while launching the MMS application control.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_MESSAGE;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_email.htm">Email Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.email".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_EMAIL;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_media.htm">Media Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
-* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery".
+* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery".
* @since 2.0
* @endif
*/
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_image.htm">Image Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.imageviewer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE;
-/*
+/**
* @if OSPDEPREC
-* The ImageCrop application control provider ID @n
+* The Image Editor %AppControl provider ID @n
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in a future release.
* use the literal, L"tizen.imageeditor", instead of this variable.
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE_EDITOR;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_video.htm">Video Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.videoplayer".
* @since 2.0
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_audio.htm">Audio Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.musicplayer".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_AUDIO;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_browser.htm">Browser Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.internet".
-* @since 2.0
+* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_camera.htm">Camera Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.camera".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CAMERA;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_bluetooth.htm">Bluetooth Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.bluetooth".
-* @since 2.0
+* @since 2.0
*
-* @remarks Bluetooth functionality cannot be tested on the Emulator.
+* @remarks Bluetooth functionality cannot be tested on the Emulator.
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_BLUETOOTH;
*
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_settings.htm">Settings Application Control</a>.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"tizen.settings".
* @since 2.0
* Operation Add. @n
* Adds an application item.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add".
* @since 2.0
* @endif
/**
* @if OSPDEPREC
* Operation Pick. @n
-* Picks some application item(s).
+* Picks an application item(s).
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PICK;
* Operation Edit. @n
* Edits an application item.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/edit".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_EDIT;
* Operation View. @n
* Shows the application content.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_VIEW;
* Operation Play. @n
* Plays the application content.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PLAY;
* Operation Default. @n
*
* Uses the default operation specific to the application control.
-* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation.
+* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as the alias for that operation.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main".
* @since 2.0
* @endif
* @if OSPDEPREC
* Operation Capture.
*
-* @brief <i> [Deprecated] </i>
-* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
+* @brief <i> [Deprecated] </i>
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/createcontent".
* @since 2.0
* @endif
* Operation Add. @n
* Adds an application item.
*
-* @brief <i> [Deprecated] </i>
+* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_ADD;
* Operation Default. @n
*
* Uses the default operation specific to the application control.
-* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation.
+* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as an alias for that operation.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* @if OSPDEPREC
* Operation Main. @n
*
-* All the application exports the implicit %AppControl with %APPCONTROL_OPERATION_MAIN operation.
+* All the applications export the implicit %AppControl with the %APPCONTROL_OPERATION_MAIN operation.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main".
-* @since 2.0
+* @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_MAIN;
/**
* @if OSPDEPREC
* Operation Pick. @n
-* Picks some application item(s).
+* Picks an application item(s).
*
* @brief <i> [Deprecated] </i>
-* @deprecated This variable is providyed only for backward compatibility and will be deleted in the near future.
+* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick".
* @since 2.0
* @endif
/**
* @if OSPDEPREC
* Operation Record. @n
-* Records the content.
+* Records the application content.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* Operation Share. @n
-* Shares the contents.
+* Shares the application content.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* Operation Crop. @n
-* Shows image with the crop rectangle.
+* Shows the image with the crop rectangle.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
- * Not specified category.
+ * No specified category.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
* The media category. @n
- * Specifying App::APPCONTROL_CATEGORY_MEDIA is equivalent to specifying all the App::APPCONTROL_CATEGORY_AUDIO,
+ * Specifying %APPCONTROL_CATEGORY_MEDIA is equivalent to specifying the App::APPCONTROL_CATEGORY_AUDIO,
* App::APPCONTROL_CATEGORY_IMAGE, and App::APPCONTROL_CATEGORY_VIDEO categories.
*
* @brief <i> [Deprecated] </i>
/**
* @if OSPDEPREC
- * The complete URI handling category corresponding to AppManager::StartAppControl().
+ * The complete URI handling category corresponding to the AppManager::StartAppControl() method.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
/**
* @if OSPDEPREC
- * The %AppControl operation is canceled.
+ * The %AppControl operation is cancelled.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* @brief This class represents the application control behavior.
* @since 2.0
*
-* @final This class is not intended for extension.
+* @final This class is not intended for extension.
*
-* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications.
+* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/app_controls.htm">Application Controls</a>.
*
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] pDataList The data list to deliver to the resolved application control @n
- * The maximum size of the list is 4096 bytes.
- * @param[in] pListener The application control callback listener @n
- * Some application controls need to get the callback result by implementing the IAppControlEventListener interface.
+ * @param[in] pDataList The data list to deliver to the resolved application control @n
+ * The maximum size of the list is 4096 bytes.
+ * @param[in] pListener The application control callback listener @n
+ * Some application controls get the callback result by implementing the IAppControlEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The target application control resource is not found.
- * @exception E_IN_PROGRESS The application control is in progress: @n
- * - The application has already started an %AppControl. @n
+ * @exception E_OBJ_NOT_FOUND The target application control resource has not been found.
+ * @exception E_IN_PROGRESS The application control is in progress:
+ * - The application has already started an %AppControl.
* - The target application has already started.
* @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_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
- * @remarks If the IAppControlEventListener instance (@c pListener) needs to get the
- * callback result for an application control, it must be valid till
- * IAppControlEventListener::OnAppControlCompleted() is invoked.
- * For example, a form object listener must not be deleted before the
- * system invokes %IAppControlEventListener::OnAppControlCompleted().
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
+ * @remarks If the specified @c pListener needs to get the callback result for an application control, it must be valid till IAppControlEventListener::OnAppControlCompleted() is invoked. @n
+ * For example, a form object listener must not be deleted before the system invokes %IAppControlEventListener::OnAppControlCompleted().
* @see AppManager::FindAppControlN()
* @see AppManager::FindAppControlsN()
* @endif
result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener);
/**
- * Starts the found application control. @n
- * Once the found application starts, the calling application goes to the background and the found
+ * Starts the located application control. @n
+ * Once the located application starts, the calling application goes to the background and the located
* application is displayed.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] pUriData A pointer to the URI data
- * @param[in] pDataType A pointer to the MIME type (RFC 2046) data
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type String and the value is of type String or of type ArrayList of String to deliver to the resolved application @n
- * The maximum size is 16 kilo bytes.
- * @param[in] pListener The application control callback listener @n
- * Some application need to get the result by implementing the IAppControlResponseListener interface.
+ * @param[in] pUriData A pointer to the URI data
+ * @param[in] pDataType A pointer to the MIME type (RFC 2046) data
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String, which is delivered to the resolved application @n
+ * The maximum size is 16 kilo bytes.
+ * @param[in] pListener The application control callback listener @n
+ * Some applications get the result by implementing the IAppControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The size of @c pExtraData has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The target application control is not found.
+ * @exception E_OBJ_NOT_FOUND The target application control has not been found.
* @exception E_IN_PROGRESS The application control is in progress: @n
* - The application has already started an %AppControl.
* @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_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1
- * @remarks If the calling application needs to get some result for application control,
- * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked.
+ * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1
+ * @remarks If the calling application needs to get some result for the application control,
+ * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked. @n
* For example, a form object listener must not be deleted before the
* system invokes %IAppControlResponseListener::OnAppControlCompleteResponseReceived().
* @see AppManager::FindAppControlN()
result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
/**
- * Finds the matching application control with given operation ID, URI pattern, data type, and category and
- * starts the found one. @n
- * If there are more than one application controls found, then the selection is shown for user and the one that the user selects is started.
+ * Finds the matching application control with the given operation ID, URI pattern, data type, and category, after which it
+ * starts the found application control. @n
+ * If more than one application control is found, then user selection is enabled and the one selected by the user is started.
* When the found application control is started, the URI pattern, MIME type, and extra data is delivered using IAppControlProviderEventListener.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/application.launch
*
* @return An error code
- * @param[in] operationId The operation ID
- * @param[in] pUriPattern A URI pattern which is used for application control resolution and is delivered as the argument
- * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
- * The '.' prefix must be used when specifying the file extension.
- * @param[in] pCategory The application control category
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of
- * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String to deliver to
- * the resolved application @n
- * The maximum size is 16 kilo bytes.
- * @param[in] pListener A listener that gets notified
- * @exception E_SUCCESS The method is successful.
- * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
- * @exception E_OBJ_NOT_FOUND The application control is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] operationId The operation ID
+ * @param[in] pUriPattern The URI pattern that is used for the application control resolution which is delivered as an argument
+ * @param[in] pDataType The MIME type (RFC 2046) or file extension @n
+ * The '.' prefix must be used while specifying the file extension.
+ * @param[in] pCategory The application control category
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of
+ * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String which is delivered to
+ * the resolved application @n
+ * The maximum size is 16 kilo bytes.
+ * @param[in] pListener The listener that gets notified
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit.
+ * @exception E_OBJ_NOT_FOUND The application control has not been found.
+ * @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_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
*/
static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener);
*
* @since 2.0
*
- * @param[in] pListener The listener to stop receiving the application control result
+ * @param[in] pListener The listener to stop from receiving the application control result
*/
static void StopAppControlResponseListener(IAppControlResponseListener* pListener);
*
* @since 2.0
*
- * @return The name of the application providing this %AppControl instance
+ * @return The name of the application that provides this %AppControl instance
*/
Tizen::Base::String GetAppName(void) const;
AppId GetAppId(void) const;
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* Gets the associated application control provider ID.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because application ID replaced the role of provider ID. @n
+ * @deprecated This method is deprecated because the application ID has replaced the role of the provider ID. @n
* Instead of using this method, use GetAppId().
* @since 2.0
*
* @return The application control provider ID
- * @endif
+ * @endif
*/
Tizen::Base::String GetAppControlProviderId(void) const;
*
* @since 2.0
*
- * @return A pointer to the list of application control categories, @n
- * else @c null if an error occurs
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the list of application control categories, @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* Stops the activated application control. @n
- * The %Stop() method works only with the following %AppControls provided by the platform:
+ * The %Stop() method works only with the following AppControls provided by the platform:
* tizen.bluetooth, tizen.calendar, tizen.camera, tizen.certificatemanager, tizen.contacts,
* tizen.email, tizen.filemanager, tizen.gallery, tizen.imageviewer, tizen.mmsmessages, and tizen.smsmessages.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The application control is not permitted to call this method.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The application control is not permitted to call this method.
* @remarks This method is asynchronous.
*/
result Stop(void);
* The %AppControl provider registers or unregisters the IAppControlProviderEventListener listener
* for providing the %AppControl functionality, looks up for the delivered %AppControl request information,
* and sends the %AppControl result back to the calling application. @n
- *
- * The request ID is used to identify each %AppControl request and can be acquired using
- * IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * The request ID is used to identify each %AppControl request and can be acquired using the
+ * IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
*/
class _OSP_EXPORT_ AppControlProviderManager
{
public:
/**
- * Gets the application control provider manager instance.
+ * Gets a pointer to the %AppControlProviderManager instance.
*
* @since 2.0
*
- * @return A pointer to the %AppControlProviderManager instance if it succeeds, @n
- * else @c null
+ * @return A pointer to the %AppControlProviderManager instance, @n
+ * else @c null if it fails
*/
static AppControlProviderManager* GetInstance(void);
* Sets the application control provider listener to the application control provider manager. @n
* The listener gets notified when the application control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter. @n
- *
- * If the application does not set the listener using %SetAppControlProviderEventListener(),
+ * If the application does not set the listener using the %SetAppControlProviderEventListener() method,
* then the application is launched or moves to the foreground without invoking any listener
* for the application request from another application.
*
* @since 2.0
*
- * @return An error code
- * @param[in] pListener The application control provider listener
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for the valid %App class.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If the application is newly launched with the AppControl request, then %SetAppControlProviderEventListener() must
- * be set before invoking IAppControlProviderEventListener::OnAppControlRequestReceived().
- * For valid %AppControl request handling, %SetAppControlProviderEventListener() must be called within
- * App::OnAppInitializing().
+ * @return An error code
+ * @param[in] pListener The application control provider listener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_OPERATION The listener must be set for the valid App class.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - If the application is newly launched with the AppControl request, then the %SetAppControlProviderEventListener() method must
+ * be set before invoking the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
+ * - For valid %AppControl request handling, the %SetAppControlProviderEventListener() method within App::OnAppInitializing()
+ * must be called.
*/
result SetAppControlProviderEventListener(IAppControlProviderEventListener* pListener);
*
* @since 2.0
*
- * @return The application ID @n
- * If an error occurs, an empty string is returned.
- * @param[in] reqId The requestID
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
+ * @return The application ID, @n
+ * else an empty string is returned if an error occurs
+ * @param[in] reqId The requestID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
AppId GetClientAppId(RequestId reqId) const;
/**
* Sends the result list for the application control request. @n
- * The client receives the result by implementing IAppControlResponseListener::OnAppControlCompleteResponseReceived().
+ * The client receives the result by implementing the IAppControlResponseListener::OnAppControlCompleteResponseReceived() method.
*
* @since 2.0
*
- * @return An error code
- * @param[in] reqId The application control request ID
+ * @return An error code
+ * @param[in] reqId The application control request ID
* @param[in] appControlResult The application control result
- * @param[in] pExtraData A pointer to an extra argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application control request is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @param[in] pExtraData A pointer to the extra argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The application control request has not been found.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SendAppControlResult(RequestId reqId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData);
* @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);
*
* @final This class is not intended for extension.
*
- * The %AppRegistry class lets an application to save or restore its preferences.
+ * The %AppRegistry class lets an application save or restore its preferences.
* An instance of this class can be obtained through the Application class.
* Also, since an application's state is generally restored in the App::OnAppInitializing() method and saved in the App::OnAppTerminating() method, an instance of this class is passed as an argument when these methods are invoked.
* @n
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The 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.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @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);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer 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.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @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);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The 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_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @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);
/**
- * Sets a string value associated with the specified @c key.
+ * Sets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The 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_INVALID_ARG The specified @c key is empty or is a 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 Save() method must be called.
*/
result Set(const Tizen::Base::String& key, const Tizen::Base::String& value);
/**
- * Sets an integer value associated with the specified @c key.
+ * Sets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer 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 a 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 Save() method must be called.
*/
result Set(const Tizen::Base::String& key, int value);
/**
- * Sets a floating point value associated with the specified @c key.
+ * Sets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The 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 a 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 Save() method must be called.
*/
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
*/
result Save(void);
/**
- * Removes a preference associated with the specified @c key.
+ * Removes the preference associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to remove
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key The key of the value to remove
+ * @exception E_SUCCESS The method is successful.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Remove(const Tizen::Base::String& key);
/**
- * Gets a string value associated with the specified @c key.
+ * Gets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A string value to retrieve
+ * @return An error code
+ * @param[in] key The key of the string value to retrieve
+ * @param[out] value The string value to retrieve
* @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 a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, Tizen::Base::String& value) const;
/**
- * Gets an integer value associated with the specified @c key.
+ * Gets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value An integer value to retrieve
+ * @return An error code
+ * @param[in] key The key of the integer value to retrieve
+ * @param[out] value The integer value to retrieve
* @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 a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, int& value) const;
/**
- * Gets a floating point value associated with the specified @c key.
+ * Gets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A floating point value to retrieve
+ * @return An error code
+ * @param[in] key The key of the floating point value to retrieve
+ * @param[out] value The floating point value to retrieve
* @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 a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, double& value) const;
/**
- * Gets the %AppRegistry instance pointer.
+ * Gets a pointer to the %AppRegistry instance.
*
* @since 2.0
*
- * @return A pointer to the %AppRegistry instance, @n
- * else @c null if it fails
+ * @return A pointer to the %AppRegistry instance, @n
+ * else @c null if it fails
*/
static AppRegistry* GetInstance(void);
//
/**
- * @file FAppAppResource.h
- * @brief This is the header file for the %AppResource class.
+ * @file FAppAppResource.h
+ * @brief This is the header file for the %AppResource class.
*
* This header file contains the declarations of the %AppResource class.
*/
{
/**
-* @class AppResource
-* @brief This class provides convenient methods to load application resources at run time.
+* @class AppResource
+* @brief This class provides convenient methods to load application resources at run time.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %AppResource class provides convenient methods to load application resources at run time: @n
-* - Use AppResource::GetString() to get handle and display localized strings.
-* - Use AppResource::GetBitmapN() to obtain a bitmap image that matches the screen density.
-* - If the matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used.
+* - Use the AppResource::GetString() method to get a handle and display localized strings.
+* - Use the AppResource::GetBitmapN() method to obtain a bitmap image that matches the screen density.
+* - If a matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used.
*
-* The instance of this class can be obtained through App::GetAppResource().
+* The instance of this class can be obtained through the App::GetAppResource() method.
*
* The following example demonstrates how to use the %AppResource class to get strings.
*
* @return An error code
* @param[in] resourceId The resource ID of type Tizen::Base::String that describes the resource
* @param[out] loadedString The string obtained from the loaded application resource
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The argument passed is not found.
- * @exception E_INVALID_ARG The argument passed to a method contains an invalid resource ID.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The argument passed has not been found.
+ * @exception E_INVALID_ARG The argument passed to the method contains an invalid resource ID.
*/
result GetString(const Tizen::Base::String& resourceId, Tizen::Base::String& loadedString) const;
/**
* Gets the bitmap at the specified path. @n
* The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n
- * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png").
- * Then, the system will first look for the image file in the folder specific to the current device resolution, such as
+ * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png").
+ * The system will first look for the image file in the folder specific to the current device resolution, such as
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
- * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
+ * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see <a href="../org.tizen.native.appprogramming/html/multiple_screen/autoscale_resource_fallback.htm">Resource Fallback and Prescaling.</a>
*
* @since 2.0
*
- * @return A pointer to the Bitmap instance generated from the specified file
+ * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
* @param[in] imagePath The relative path starting from the directory @b "res/screen-density-XXX/" or @b "res/AxB", @n
- * where A and B represent the screen width and height of the supported device models, respectively.
+ * where A and B represent the screen width and screen height of the supported device models, respectively.
* @param[in] pixelFormat The pixel format of the resulting bitmap
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The image file format or specified pixel format is not supported.
+ * @exception E_UNSUPPORTED_FORMAT Either the image file format or the specified @c pixelFormat is not supported.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
/**
* Gets the bitmap at the specified path. @n
* The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n
- * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png").
- * Then, the system will first look for the image file in the folder specific to the current device resolution, such as
+ * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png").
+ * The system will first look for the image file in the folder specific to the current device resolution, such as
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
- * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
+ * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see <a href="../org.tizen.native.appprogramming/html/multiple_screen/autoscale_resource_fallback.htm">Resource Fallback and Prescaling.</a>
*
* @since 2.0
*
- * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
+ * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file
* @param[in] imagePath The relative path starting from the density directory @b "res/screen-density-XXX/" or @b "res/AxB", @n
- * where A and B represent the width and height of the screen of the supported device models, respectively
+ * where A and B represent the screen width and screen height of the supported device models, respectively
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath) const;
/**
- * Gets the %AppResource instance pointer.
+ * Gets a pointer to the %AppResource instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the %AppResource instance, @n
- * else @c null if it fails
+ * @return A pointer to the %AppResource instance, @n
+ * else @c null if it fails
*/
static AppResource* GetInstance(void);
/**
- * Gets the resource instance of the specified resource path.
- * @since 2.0
+ * Gets an %AppResource instance of the specified @c resourcePath.
+ * @since 2.0
* @return A pointer to the %AppResource instance, @n
* else @c null if it fails
* @param[in] resourcePath The relative path starting from the resource directory path of the current application
* @exception E_SUCCESS The method is successful.
- * @exception E_FILE_NOT_FOUND The specified resource path does not exist.
- * @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations.
- * @exception E_SYSTEM Initializing string and bitmap resource is failed due to system error.
+ * @exception E_FILE_NOT_FOUND The specified @c resourcePath does not exist.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - The length of the specified path is @c 0.
+ * - The length of the specified path exceeds system limitations.
+ * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AppResource* LoadAppResource(const Tizen::Base::String& resourcePath);
/**
- * Gets the application resource instance of the specified @c appId.
+ * Gets an %AppResource instance of the specified @c appId.
*
* @since 2.0
*
* @privlevel platform
- * @privilege %http://tizen.org/privilege/appsetting
+ * @privilege %http://tizen.org/privilege/appsetting
*
* @return A pointer to the %AppResource instance, @n
* else @c null if it fails
- * @param[in] appId The AppId of the installed application
+ * @param[in] appId The ID of the installed application
* @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The instance of specified @c appId does not provide the string resource.
+ * @exception E_DATA_NOT_FOUND The specified @c appId does not provide the required string resource.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_APP_NOT_INSTALLED The specified @c appId is not found in the list of installed applications.
- * @exception E_SYSTEM Initializing string and bitmap resource has failed due to a system error.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_APP_NOT_INSTALLED The specified @c appId has not been found in the list of installed applications.
+ * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error.
+ * @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.
*/
static AppResource* GetInstanceByAppId(const AppId& appId);
/**
- * Releases the application resource instance of the specified @c appId.
+ * Releases the %AppResource instance of the specified @c appId.
*
* @since 2.0
*
- * @privlevel platform
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appsetting
*
* @return An error code
- * @param[in] appId The AppId of the installed application
+ * @param[in] appId The ID of the installed application
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Individual instances are managed by the platform. @n
- * It is recommended to release instances to reduce memory usage.
+ * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId has not been found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - Individual instances are managed by the platform.
+ * - It is recommended to release instances to reduce memory usage.
*/
static result ReleaseInstanceByAppId(const AppId& appId);
* @final This class is not intended for extension.
*
* The %AppSetting class is a helper class for an application to save or restore its settings.
- * A setting entity is composed of a string-typed key and a value. The value type must be only of these three types: @c int, @c bool, and @c String.
- * The settings are pre-defined in setting/setting.xml in the application's base directory
+ * A setting entity is composed of a string-typed key and a value. The value type must only be of three types: @c int, @c bool, and @c String.
+ * The settings are pre-defined at setting/setting.xml in the application's base directory
* and they can be easily set with %Tizen IDE (<a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/creating_running_app_setting.htm">Creating and Using Application Settings</a>, <a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/application_settings_editor.htm">Application Settings Editor</a>).
- * (The setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n
- * The %AppSetting class is basically used for specific applications such as IME, which have no UI.
+ * (setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n
+ * The %AppSetting class is basically used for specific applications which have no UI, such as IME.
* Because the applications have no external way to modify their settings, users can adjust the setting values through the setting application, which is delegated to manage the settings.
- * For supporting the consistency of setting values between two applications, the target application and the setting application, when setting a value in the setting application, the target application is notified from the setting application through
- * IAppSettingEventListener::OnAppSettingChanged()
- * For detailed example on this class, see <a href="../org.tizen.native.appprogramming/html/tutorials/app_tutorial/task_app_settings.htm?resultof=%22%41%70%70%53%65%74%74%69%6e%67%22%20%22%61%70%70%73%65%74%74%69%6e%67%22%20">Task: App Setting</a>.
+ * For supporting the consistency between the setting values of two applications, that is, the target application and the setting application, the setting application notifies the target application through
+ * the IAppSettingEventListener::OnAppSettingChanged() method when setting a value.
+ *
+ * For a detailed example on the %AppSetting class, see <a href="../org.tizen.native.appprogramming/html/tutorials/app_tutorial/task_app_settings.htm?resultof=%22%41%70%70%53%65%74%74%69%6e%67%22%20%22%61%70%70%73%65%74%74%69%6e%67%22%20">Task: App Setting</a>.
*
* @see IAppSettingEventListener
*/
{
public:
/**
- * Gets the application setting instance.
+ * Gets the pointer to the %AppSetting instance.
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance for the last setting, @n
+ * @return The pointer to the %AppSetting instance for the last setting, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
static AppSetting* GetInstance(void);
/**
- * Gets the application setting instance of the specified version.
+ * Gets the pointer to the %AppSetting instance of the specified version.
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance, @n
+ * @return The pointer to the %AppSetting instance, @n
* else @c null if it fails
- * @param[in] settingVersion The version of setting is retrieved from GetAppSettingVersionListN()
+ * @param[in] settingVersion The version of the setting which is retrieved from GetAppSettingVersionListN()
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified version is not found.
+ * @exception E_OBJ_NOT_FOUND The specified version has not been found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see GetAppSettingVersionListN()
*/
static AppSetting* GetInstance(const Tizen::Base::String& settingVersion);
/**
- * Gets the application setting instance of the specified AppId.
+ * Gets an %AppSetting instance of the specified ID.
*
* @since 2.0
*
*
* @return A pointer to the %AppSetting instance, @n
* else @c null if it fails
- * @param[in] appId The AppId of the application that has a valid application setting
+ * @param[in] appId The ID of the application that has a valid application setting
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The instance of specified AppId does not have setting information.
+ * @exception E_OBJ_NOT_FOUND The specified @c appId does not have the required setting information.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_APP_NOT_INSTALLED The AppId is not found.
+ * @exception E_APP_NOT_INSTALLED The @c appId 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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
static AppSetting* GetInstanceByAppId(const AppId& appId);
/**
- * Releases the specified application setting instance.
+ * Releases the specified %AppSetting instance.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/appsetting
*
* @return An error code
- * @param[in] appId The AppId of the application that has a valid application setting
+ * @param[in] appId The ID of the application that has a valid application setting
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified instance of AppId is not found or already released.
+ * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred:
+ * - The specified @c appId has not been found.
+ * - The specified @c appId is already released.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Individual instances are managed by the platform. @n
- * It is recommended to release instances to reduce memory usage.
+ * @remarks
+ * - Individual instances are managed by the platform.
+ * - It is recommended to release instances to reduce memory usage.
* @see GetInstanceByAppId()
*/
static result ReleaseInstanceByAppId(const AppId& appId);
/**
- * Gets a list of all the versions that existed prior to the current version. @n
- * The versions listed are based on the setting.xml file, which is generated when an application is installed.
+ * Gets the list of all the versions that existed prior to the current version. @n
+ * The versions are listed based on the setting.xml file, which is generated when an application is installed.
*
* @since 2.0
*
- * @return A pointer to the list that contains the Tizen::Base::String instances of version list @n
- * The latest version string is located in the first position. If the old version does not exist then return empty collection.
+ * @return A pointer to the list that contains the Tizen::Base::String instances of the version list @n
+ * The latest version string is located at the first position @n
+ * If the old version does not exist then an empty collection is returned.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
static Tizen::Base::Collection::IList* GetAppSettingVersionListN(void);
/**
- * Gets a @c bool value associated with the specified @c id.
+ * Gets the @c bool value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to retrieve
- * @param[out] value A boolean value to retrieve
+ * @param[in] id The ID of the boolean value to retrieve
+ * @param[out] value The boolean value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, bool& value) const;
/**
- * Gets an integer value associated with the specified @c id.
+ * Gets the integer value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to retrieve
- * @param[out] value An integer value to retrieve
+ * @param[in] id The ID of the integer value to retrieve
+ * @param[out] value The integer value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, int& value) const;
/**
- * Gets a string value associated with the specified @c id.
+ * Gets the string value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The id of the value to retrieve
- * @param[out] value A string value to retrieve
+ * @param[in] id The ID of the string value to retrieve
+ * @param[out] value The string value to retrieve
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
*/
result GetValue(const Tizen::Base::String& id, Tizen::Base::String& value) const;
/**
- * Sets a @c bool value associated with the specified @c id.
+ * Sets the @c bool value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value A boolean value
+ * @param[in] id The ID of the boolean value to modify
+ * @param[in] value The boolean value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, bool value);
/**
- * Sets an integer value associated with the specified @c id.
+ * Sets the integer value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value An integer value
+ * @param[in] id The ID of the integer value to modify
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
- * @exception E_OUT_OF_RANGE The specified @c value is out of range.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
+ * @exception E_OUT_OF_RANGE The specified @c value is out of the valid range.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, int value);
/**
- * Sets a string value associated with the specified @c id.
+ * Sets the string value associated with the specified @c id.
*
* @since 2.0
*
* @return An error code
- * @param[in] id The ID of the value to modify
- * @param[in] value A string value
+ * @param[in] id The ID of the string value to modify
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting.
- * @exception E_OUT_OF_RANGE The specified string length is out of range.
+ * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting.
+ * @exception E_OUT_OF_RANGE The specified string length is out of the valid range.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access different types.
+ * @exception E_TYPE_MISMATCH The types accessed by the method do not match.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetValue(const Tizen::Base::String& id, const Tizen::Base::String& value);
/**
- * Sets a setting event listener.
+ * Sets the setting event listener.
*
* @since 2.0
*
*
* @final This class is not intended for extension.
*
- * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications and to send results or error message for each data control operation.
+ * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications, and to send results or error messages for each data control operation.
*/
class _OSP_EXPORT_ DataControlProviderManager
: public Tizen::Base::Object
public:
/**
- * Sets an SQL-friendly interface based data control provider listener to the data control provider manager. @n
- * The listener gets notified when a data control request is received from the other applications.
+ * Sets an SQL-friendly interface based data control provider listener for the data control provider manager. @n
+ * The listener gets notified when a data control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
* The listener must implement the ISqlDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for a service application.
+ * @exception E_INVALID_OPERATION The listener has not been set for a service application.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener
+ * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener
* before receiving the data control request.
*/
result SetSqlDataControlProviderEventListener(ISqlDataControlProviderEventListener* pListener);
/**
- * Sets a key-value structured data control provider listener to the data control provider manager. @n
- * The listener gets notified when a data control request is received from the other applications.
+ * Sets a key-value structured data control provider listener for the data control provider manager. @n
+ * The listener gets notified when a data control request is received from other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
* The listener must implement the IMapDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_OPERATION The listener must be set for a service application.
+ * @exception E_INVALID_OPERATION The listener has not been set for a service application.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener
+ * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener
* before receiving the data control request.
*/
result SetMapDataControlProviderEventListener(IMapDataControlProviderEventListener* pListener);
/**
- * Sends the success result and the result set of SELECT request to the application requesting the SQL-friendly interface based
+ * Sends the success result and the result set of the SELECT request to the application requesting for the SQL-friendly interface based
* data control. @n
* The data control provider must call the %SendSqlDataControlSelectResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @param[in] pDbEnum The Tizen::Io::DbEnumerator instance to obtain the result set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - This method cannot send result for the specified @c reqId of INSERT, UPDATE, or DELETE requests.
- * - Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_OBJECT_LOCKED The database instance associated to the specified @c pDbEnum is locked.
- * @exception E_INVALID_FORMAT The database file associated to the specified @c pDbEnum is malformed.
+ * - The result for the specified @c reqId of the INSERT, UPDATE, or DELETE request cannot be sent.
+ * - The Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_OBJECT_LOCKED The database instance associated with the specified @c pDbEnum is locked.
+ * @exception E_INVALID_FORMAT The database file associated with the specified @c pDbEnum is in an invalid format.
* @exception E_IO Either of the following conditions has occurred:
- * - An unexpected device failure has occurred as the media ejected suddenly.
- * - %File corruption is detected.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption has been detected.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::ISqlDataControlProviderEventListener
*/
result SendSqlDataControlSelectResult(RequestId reqId, Tizen::Io::IDbEnumerator* pDbEnum);
/**
- * Sends the success result of INSERT request and the last inserted row ID to the application requesting
+ * Sends the success result of the INSERT request and the last inserted row ID to the application requesting for
* the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlInsertResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the last inserted row ID
*
* @return An error code
* @param[in] reqId The request ID
- * @param[in] insertRowId The row ID of database changed by INSERT request
+ * @param[in] insertRowId The row ID of the database changed by the INSERT request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT, UPDATE, or DELETE request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
+ * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT, UPDATE, or DELETE request cannot be sent.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::ISqlDataControlProviderEventListener
* @see Tizen::Io::Database::GetLastInsertRowId()
*/
result SendSqlDataControlInsertResult(RequestId reqId, long long insertRowId);
/**
- * Sends the success result of UPDATE / DELETE request to the application requesting the SQL-friendly interface based data control. @n
+ * Sends the success result of the UPDATE or DELETE request to the application requesting for the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlUpdateDeleteResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result by implementing Tizen::App::ISqlDataControlResponseListener.
*
* @return An error code
* @param[in] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT or INSERT request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
+ * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT or INSERT request cannot be sent.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
result SendSqlDataControlUpdateDeleteResult(RequestId reqId);
/**
- * Sends the success result and the result list of the provider to the application requesting the key-value structured
+ * Sends the success result and the result list of the provider to the application requesting for the key-value structured
* data control. @n
* The data control provider must call the %SendMapDataControlResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @param[in] reqId The request ID
* @param[in] pResultValueList The result list to request @n
* The type of objects contained in the specified @c pResultValueList must be
- * Tizen::Base::String class.
+ * Tizen::Base::String.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
- * - The specified @c pResultValueList must be @c null if the request is one of
- * AddValue, SetValue, RemoveValue queries.
- * - The specified @c pResultValueList must not be @c null if the request is
- * GetValue() query.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * - The specified @c pResultValueList must be @c null if the request is an
+ * AddValue(), SetValue(), or RemoveValue() query.
+ * - The specified @c pResultValueList must not be @c null if the request is
+ * a GetValue() query.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
- * @see Tizen::App::IMapDataControlProviderEventListener
*/
result SendMapDataControlResult(RequestId reqId, Tizen::Base::Collection::IList* pResultValueList = null);
/**
- * Sends the provider error message to the application requesting the data control. @n
+ * Sends the provider error message to the application requesting for the data control. @n
* The data control provider must call the %SendDataControlError() method to notify failure to the requesting application.
* The application requesting the data control can get the failure result and the error message
* by implementing Tizen::App::ISqlDataControlResponseListener.
* @param[in] reqId The request ID
* @param[in] errorMsg The provider-defined error message
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
- * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
+ * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist.
+ * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
* @see Tizen::App::DataControlProviderManager::SendMapDataControlResult()
- * @see Tizen::App::ISqlDataControlProviderEventListener
* @see Tizen::App::IMapDataControlProviderEventListener
*/
result SendDataControlError(RequestId reqId, const Tizen::Base::String& errorMsg);
/**
- * Gets the data control provider manager instance.
+ * Gets a pointer to the %DataControlProviderManager instance.
*
* @since 2.0
*
- * @return A pointer to the %DataControlProviderManager instance if it succeeds, @n
- * else @c null
+ * @return A pointer to the %DataControlProviderManager instance, @n
+ * else @c null if it fails
*/
static DataControlProviderManager* GetInstance(void);
/**
* @interface IActiveAppEventListener
- * @brief This interface is the listener interface for receiving the AppId of active application.
+ * @brief This interface is the listener interface for receiving the ID of an active application.
*
* @since 2.0
*
- *
* The %IActiveAppEventListener interface is the listener interface for receiving the active application change events.
- * The class that processes an active application change event implements this interface and registers using
+ * The class that processes an active application change event implements this interface and registers it using
* the AppManager::AddActiveAppEventListener() method.
*
*/
{
public:
/**
- * 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.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] appId The AppId of the active application
+ * @param[in] appId The ID of the active application
*/
virtual void OnActiveAppChanged(const AppId& appId) = 0;
//
/**
- * @file FAppIAppCheckPointEventListener.h
- * @brief This is the header file for the %IAppCheckpointEventListener interface.
+ * @file FAppIAppCheckPointEventListener.h
+ * @brief This is the header file for the %IAppCheckpointEventListener interface.
*
* This header file contains the declarations of the %IAppCheckpointEventListener interface. @n
* If a checkpoint event is generated, a method of this interface is called.
/**
* @interface IAppCheckpointEventListener
- * @brief This interface defines the listener for the checkpoint event.
+ * @brief This interface defines the listener for a checkpoint event.
*
* @since 2.0
*
- * The %IAppCheckpointEventListener interface is used for receiving the checkpoint event.
- * The event is fired when the system is about to terminate an application due to, for example, low memory or when another application
- * is being launched.
+ * The %IAppCheckpointEventListener interface is used for receiving a checkpoint event.
+ * The event is fired when the system is about to terminate an application due to reasons such as, low memory or when another application
+ * is being launched.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/tizen_app_model/multitasking_in_tizen.htm">Multitasking in Tizen</a>.
*
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
* Called when a checkpoint event occurs.
*
* @since 2.0
- * @param[in] appRegistry The application registry
+ * @param[in] appRegistry The application's registry
*/
virtual void OnAppCheckpointing(AppRegistry& appRegistry) = 0;
//
/**
- * @file FAppIAppControlEventListener.h
- * @brief This is the header file for the %IAppControlEventListener interface.
+ * @if OSPDEPREC
+ * @file FAppIAppControlEventListener.h
+ * @brief This is the header file for the %IAppControlEventListener interface.
*
* This header file contains the declarations of the %IAppControlEventListener interface.
+ * @endif
*/
#ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
/**
* @if OSPDEPREC
* @interface IAppControlEventListener
-* @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl result events.
+* @brief <i>[Deprecated]</i> This interface defines a listener for the %AppControl result events.
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
public:
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
/**
* @if OSPDEPREC
* Called when the application control is completed. @n
- * The client can get callback result for some application controls by implementing this listener. @n
- * %OnAppControlCompleted() is called after AppControl::Start() with listener for some application controls.
+ * The client can get the callback result for some application controls by implementing this listener. @n
+ * The %OnAppControlCompleted() method is called after AppControl::Start() is done listening to application controls.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
*
- * @param[in] providerId The provider ID
- * @param[in] operationId The operation ID used in application control invocation
- * @param[in] pResultList The list of callback strings of application control
+ * @param[in] providerId The provider ID
+ * @param[in] operationId The operation ID used for application control invocation
+ * @param[in] pResultList The list of callback strings for application control
*
- * @remarks The specified @c pResultList provides the result code for the first array element.
- * @remarks When the invoked application control is terminated without sending a result,
- * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
- * @remarks Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
- * (UiApp::OnForeground()). If %UiApp::OnForeground() is being used in the application logic,
- * it is recommended to avoid switching forms in this listener.
+ * @remarks
+ * - The specified @c pResultList provides the result code for the first array element.
+ * - When the invoked application control is terminated without sending a result,
+ * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
+ * - Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
+ * (UiApp::OnForeground()). @n If the %UiApp::OnForeground() method is being used in the application logic, it is recommended to avoid switching forms in this listener.
* @see Tizen::App::AppControl
* @endif
*/
//
/**
- * @file FAppIAppControlListener.h
- * @brief This is the header file for the %IAppControlListener interface.
+ * @if OSPDEPREC
+ * @file FAppIAppControlListener.h
+ * @brief This is the header file for the %IAppControlListener interface.
*
* This header file contains the declarations of the %IAppControlListener interface.
+ * @endif
*/
#ifndef _FAPP_IAPP_CONTROL_LISTENER_H_
/**
* @if OSPDEPREC
* @interface IAppControlListener
- * @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl start and result events.
+ * @brief <i>[Deprecated]</i> This interface defines a listener for the %AppControl start and result events.
*
* @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
* @since 2.0
public:
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i>[Deprecated]</i>
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
* @since 2.0
*
- * @param[in] reqId The application control request ID
+ * @param[in] reqId The application control request ID
* @param[in] operationId The application control operation ID
* @param[in] pUriData A pointer to the URI data
* @param[in] pMimeType A pointer to the MIME type (RFC 2046) data
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
- * @remarks To reply to the application control request, use AppControlProviderManager::SendAppControlResult() with the given request ID.
- * @remarks When the application receives the AppControl request on the background,
- * %OnAppControlRequestReceived() is invoked before UiApp::OnForeground().
- * @remarks When the application control is resolved with the file extension with AppControl::FindAndStart(),
- * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter.
+ * @param[in] pExtraData A pointer to the argument map of the key and value pair, where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @remarks
+ * - To reply to the application control request, use the AppControlProviderManager::SendAppControlResult() method with the given request ID. @n
+ * When the application receives the AppControl request in the background,
+ * the %OnAppControlRequestReceived() method is invoked before the UiApp::OnForeground() method.
+ * - When the application control is resolved with the file extension returned by the AppControl::FindAndStart() method,
+ * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter.
*/
virtual void OnAppControlRequestReceived(RequestId reqId, const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData) = 0;
//
/**
- * @file FAppIAppControlResponseListener.h
- * @brief This is the header file for the %IAppControlResponseListener interface.
+ * @file FAppIAppControlResponseListener.h
+ * @brief This is the header file for the %IAppControlResponseListener interface.
*
* This header file contains the declarations of the %IAppControlResponseListener interface.
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IAppControlResponseListener(void) {}
/**
- * Called when the response for application control completion is received.
+ * Called when the response for an application control completion is received.
*
* @since 2.0
*
- * @param[in] appId The ID of the requested application
- * @param[in] operationId The operation ID used in application control invocation
+ * @param[in] appId The ID of the requested application
+ * @param[in] operationId The operation ID used in the application control invocation
* @param[in] appControlResult The application control result
- * @param[in] pExtraData A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of
- * type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String
+ * @param[in] pExtraData A pointer to the result map of the key and value pair, where the key is of type Tizen::Base::String and the value is of
+ * type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
* @remarks The application control completion result is received when the requested application control
- * sends the result using AppControlProviderManager::SendAppControlResult().
+ * sends the result using the AppControlProviderManager::SendAppControlResult() method.
* @see AppControl
*/
virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
/**
- * Called when the application control is about to start or to be canceled by the user resolution. @n
+ * Called when the application control is about to start or is to be cancelled by the user resolution. @n
* The calling application can get the result of the resolution by implementing this empty body method.
*
* @since 2.0
*
- * @param[in] appId The ID of the requested application
- * @param[in] operationId The operation ID used in application control invocation
- * @param[in] r The result of the application control start response @n
- * The exception code may be given through this parameter.
- * @exception E_SUCCESS The method is successful.
- * @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.
+ * @param[in] appId The ID of the requested application
+ * @param[in] operationId The operation ID used in the application control invocation
+ * @param[in] r The result of the application control start response @n
+ * The following exceptions may be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OPERATION_CANCELED The application control resolve request has been cancelled by the 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 is invoked only for the implicit AppControl resolution.
- * @see AppControl
* @see AppControl::FindAndStart()
*/
virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}
//
/**
- * @file FAppIAppFrame.h
- * @brief This is the header file for the %IAppFrame interface.
+ * @file FAppIAppFrame.h
+ * @brief This is the header file for the %IAppFrame interface.
*
* This header file contains the declarations of the %IAppFrame interface.
*/
*
* @since 2.0
*
- * The %IAppFrame interface provides methods for the application frame. A frame is the outermost boundary of the application UI.
+ * The %IAppFrame interface provides methods for the application frame.
+ * A frame is the outermost boundary of the application UI.
*/
class IAppFrame
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
* @since 2.0
*
- * @return A pointer to the Tizen::Graphics::Canvas class
+ * @return A pointer to the Tizen::Graphics::Canvas instance
*/
virtual Tizen::Graphics::Canvas* GetCanvasN(void) const = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IKeyEventListener instance to add
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to add
* @exception E_SUCCESS The method is successful.
*/
virtual result AddKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IKeyEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add
+ * @exception E_SUCCESS The method is successful.
*/
virtual result AddTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result AddWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
*
* @since 2.0
*
- * @return An error code
- * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove
+ * @return An error code
+ * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove
* @exception E_SUCCESS The method is successful.
*/
virtual result RemoveWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
*
* @since 2.0
*
- * @return A pointer to Tizen::Ui::Controls::Frame if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_UNSUPPORTED_OPERATION This method cannot be supported.
+ * @return A pointer to the Tizen::Ui::Controls::Frame instance, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_UNSUPPORTED_OPERATION This method is not supported.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Ui::Controls::Frame* GetFrame(void) = 0;
//
/**
- * @file FAppIAppLaunchConditionEventListener.h
- * @brief This is the header file for the %IAppLaunchConditionEventListener interface.
+ * @file FAppIAppLaunchConditionEventListener.h
+ * @brief This is the header file for the %IAppLaunchConditionEventListener interface.
*
* This header file contains the declarations of the %IAppLaunchConditionEventListener interface.
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
* @since 2.0
*
* @param[in] condition The registered condition for the application launch
- * @param[in] pArguments A list of string arguments specified when the condition is registered
- * @param[in] pExtraData A pointer to the instance of object that system delivered, @n
+ * @param[in] pArguments The list of string arguments specified when the condition is registered
+ * @param[in] pExtraData A pointer to the Tizen::Base::Object instance that the system delivered, @n
* else @c null if there is no extra data
*
- * @remarks If extra data is required to be delivered, @c pExtraData contains the data,
+ * @remarks If the extra data has to be delivered, @c pExtraData contains the data,
* and this must be freed by the launched application after use.
- * ( Currently, only NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. )
+ * ( Currently, only the NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. )
* @see Tizen::App::AppManager::RegisterAppLaunch()
* @see Tizen::App::AppManager::SetAppLaunchConditionEventListener()
*
- * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get Tizen::Net::Nfc::NdefMessage instance, when an application is launched by NFC condition.
+ * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get the Tizen::Net::Nfc::NdefMessage instance, when an application is launched by the NFC condition.
* @code
* NdefMessage* pMessage = dynamic_cast<NdefMessage*>(pExtraData);
* @endcode
/**
* @interface IAppSettingEventListener
- * @brief This interface is the listener interface for receiving the setting change events.
+ * @brief This interface is the listener interface for receiving setting change events.
*
* @since 2.0
*
- * The %IAppSettingEventListener interface is the listener interface for receiving the setting change events.
- * The class that processes a setting change event implements this interface and registers using
+ * The %IAppSettingEventListener interface is the listener interface for receiving setting change events.
+ * The class that processes a setting change event implements this interface and registers it using
* the AppSetting::SetAppSettingEventListener() method.
*
*/
{
public:
/**
- * 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.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*
- * @remarks This method is invoked only in the main thread
+ * @remarks This method is invoked only in the main thread.
*/
virtual ~IAppSettingEventListener(void) {}
*
* @param[in] id The ID of the application setting whose value is changed
*
- * @remarks This method is invoked only in the main thread
+ * @remarks This method is invoked only in the main thread.
*/
virtual void OnAppSettingChanged(const Tizen::Base::String& id) = 0;
/**
* @interface IMapDataControlProviderEventListener
- * @brief This interface defines a listener for dealing with key-value structured data control request.
+ * @brief This interface defines a listener for dealing with a key-value structured data control request.
*
* @since 2.0
*
- * The %IMapDataControlProviderEventListener interface defines a listener for dealing with key-value structured data control request.
+ * The %IMapDataControlProviderEventListener interface defines a listener for dealing with a key-value structured data control request.
*
* The following example demonstrates how to use the %IMapDataControlProviderEventListener interface.
* @code
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IMapDataControlProviderEventListener(void) {}
/**
- * Called when the request for getting the value list is received from key-value structured data control consumer. @n
+ * Called when the request for obtaining the value list is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to get from @n
+ * @param[in] dataId The string that identifies the specific map to obtain from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to obtain
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to obtain
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlGetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key) = 0;
/**
- * Called when the request for adding the value is received from key-value structured data control consumer. @n
+ * Called when the request for adding the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to add to @n
+ * @param[in] dataId The string that identifies the specific map to add to @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to add
- * @param[in] value A value to add
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to add
+ * @param[in] value The value to add
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlAddValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
/**
- * Called when the request for replacing the value is received from key-value structured data control consumer. @n
+ * Called when the request for replacing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to update @n
+ * @param[in] dataId The string that identifies the specific map to update @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to replace
- * @param[in] oldValue A value to replace
- * @param[in] newValue A new value to replace the existing value
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to replace
+ * @param[in] oldValue The value to replace
+ * @param[in] newValue The new value that replaces the existing value
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlSetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue,
const Tizen::Base::String& newValue) = 0;
/**
- * Called when the request for removing the value is received from key-value structured data control consumer. @n
+ * Called when the request for removing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to remove from @n
+ * @param[in] dataId The string that identifies the specific map 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 remove
- * @param[in] value A value to remove
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to remove
+ * @param[in] value The value to remove
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlRemoveValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IMapDataControlResponseListener(void) {}
/**
- * Called when the result value list is received from key-value structured data control provider. @n
+ * Called when the result value list is received from the key-value structured data control provider. @n
* The application requesting the data control can get the result value list by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result value set.
- * It is called after MapDataControl::GetValue().
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result value set.
+ * It is called after the MapDataControl::GetValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to get from @n
+ * @param[in] dataId The string that identifies the specific map to obtain from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] resultValueList The result value list of data control request getting matching values @n
- * The type of objects contained in the specified @c resultValueList is
- * Tizen::Base::String class.
+ * @param[in] resultValueList The result value list of the data control request that gets the matching values @n
+ * The type of objects contained in the specified @c resultValueList are
+ * Tizen::Base::String.
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request getting the values, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
+ * Called when the response is received from the key-value structured data control provider. @n
* The application requesting the data control can get the result by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::AddValue().
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::AddValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to add to @n
+ * @param[in] dataId The string that identifies the specific map to add to @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request adding a value, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
- * The application requesting the data control can get the result for some data controls by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::SetValue().
+ * Called when the response is received from the key-value structured data control provider. @n
+ * The application requesting the data control can get the result by implementing this listener. @n
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::SetValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to update @n
+ * @param[in] dataId The string that identifies the specific map to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request replacing a value, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from key-value structured data control provider. @n
- * The application requesting the data control can get the result for some data controls by implementing this listener. @n
- * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response.
- * It is called after MapDataControl::RemoveValue().
+ * Called when the response is received from the key-value structured data control provider. @n
+ * The application requesting the data control can get the result by implementing this listener. @n
+ * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
+ * It is called after the MapDataControl::RemoveValue() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to remove from @n
+ * @param[in] dataId The string that identifies the specific map to remove from @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the request removing a value, @n
* else @c false
/**
* @interface ISqlDataControlProviderEventListener
- * @brief This interface defines a listener for dealing with SQL-friendly interface based data control request.
+ * @brief This interface defines a listener for dealing with an SQL-friendly interface based data control request.
*
* @since 2.0
*
- * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with SQL-friendly interface based data control request.
+ * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with an SQL-friendly interface based data control request.
*
* The following example demonstrates how to use the %ISqlDataControlProviderEventListener interface.
*
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~ISqlDataControlProviderEventListener(void) {}
/**
- * Called when a select request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the select request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to query from @n
- * The string consists of one or more components, separated by a slash('/').
- * If the specified @c pColumnList is @c null, all columns are selected.
- * @param[in] pColumnList A list of column names to query @n
- * The type of objects contained in the specified @c pColumnList is
- * Tizen::Base::String class.
- * @param[in] pWhere A filter to select desired rows to query @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to query from @n
+ * The string consists of one or more components, separated by a slash('/') @n
+ * If the specified @c pColumnList is @c null, all the columns are selected.
+ * @param[in] pColumnList The list of column names to query @n
+ * The type of objects contained in the specified @c pColumnList are
+ * Tizen::Base::String.
+ * @param[in] pWhere The filter that selects the desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @param[in] pOrder The sorting order of rows to query @n
+ * @param[in] pOrder The sorting order of the rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlSelectResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlSelectResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlSelectRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder) = 0;
/**
- * Called when an insert request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the insert request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to insert into @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to insert into @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] insertMap The field values in a record to insert @n
- * The type of objects contained in the specified @c insertMap is
- * Tizen::Base::String class.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlInsertResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] insertMap The field values to insert in the record @n
+ * The type of objects contained in the specified @c insertMap are
+ * Tizen::Base::String.
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlInsertResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlInsertRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap) = 0;
/**
- * Called when an update request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the update request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to update @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to update @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] updateMap The field values in a record to update @n
- * The type of objects contained in the specified @c updateMap is
- * Tizen::Base::String class.
- * @param[in] pWhere A filter to select desired rows to update @n
+ * @param[in] updateMap The field values to update in the record @n
+ * The type of objects contained in the specified @c updateMap are
+ * Tizen::Base::String.
+ * @param[in] pWhere The filter to select the desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlUpdateRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere) = 0;
/**
- * Called when a delete request is received from an application using SQL-friendly interface based data control. @n
+ * Called when the delete request is received from an application using an SQL-friendly interface based data control. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
- * @param[in] providerId The provider ID for identifying the data control
- * @param[in] dataId A string for identifying a specific table to delete from @n
+ * @param[in] providerId The provider ID that identifies the data control
+ * @param[in] dataId The string that identifies the specific table to delete from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pWhere A filter to select desired rows to delete @n
+ * @param[in] pWhere The filter to select the desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnSqlDataControlDeleteRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere) = 0;
/**
* @interface ISqlDataControlResponseListener
-* @brief This interface defines a listener for the SQL-friendly interface based data control response.
+* @brief This interface defines a listener for an SQL-friendly interface based data control response.
*
* @since 2.0
*
-* The %ISqlDataControlResponseListener interface defines a listener for the SQL-friendly interface based data control response.
+* The %ISqlDataControlResponseListener interface defines a listener for an SQL-friendly interface based data control response.
*/
class _OSP_EXPORT_ ISqlDataControlResponseListener
: virtual public Tizen::Base::Runtime::IEventListener
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~ISqlDataControlResponseListener(void) {}
/**
- * Called when the result set is received from SQL-friendly interface based data control provider. @n
+ * Called when the result set is received from an SQL-friendly interface based data control provider. @n
* The application requesting the data control can get the query result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result set.
- * It is called after SqlDataControl::Select().
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result set.
+ * It is called after the SqlDataControl::Select() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to query from @n
+ * @param[in] dataId The string that identifies the specific table to query from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] resultSetEnumerator Navigates the result of data control select request
+ * @param[in] resultSetEnumerator Navigates the result of the data control select request
* @param[in] providerResult Set to @c true if the data control provider successfully processed the query request, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
const Tizen::Base::String& dataId, Tizen::Io::IDbEnumerator& resultSetEnumerator, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get insert result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Insert().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the insert result by implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Insert() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to insert into @n
+ * @param[in] dataId The string that identifies the specific table to insert into @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] insertRowId The inserted row ID set by the data control provider if the specified @c providerResult is @c true, @n
- * else @c -1
+ * else @c -1 if it fails
* @param[in] providerResult Set to @c true if the data control provider successfully processed the insert request, @n
* else @c false
* @param[in] pErrorMsg The error message from the data control provider
const Tizen::Base::String& dataId, long long insertRowId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get update result implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Update().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the update result implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Update() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to update @n
+ * @param[in] dataId The string that identifies the specific table to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the update request, @n
* else @c false
const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
/**
- * Called when the response is received from SQL-friendly interface based data control provider. @n
- * The application requesting the data control can get delete result by implementing this listener. @n
- * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
- * It is called after SqlDataControl::Delete().
+ * Called when the response is received from an SQL-friendly interface based data control provider. @n
+ * The application requesting the data control can get the delete result by implementing this listener. @n
+ * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+ * It is called after the SqlDataControl::Delete() method.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific table to delete from @n
+ * @param[in] dataId The string that identifies the specific table to delete from @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] providerResult Set to @c true if the data control provider successfully processed the delete request, @n
* else @c false
*
* The %MapDataControl class represents the key-value structured data control behavior, that provides a standard mechanism
* for accessing specific data exported by other applications.
- * Data control provider can share its own data to data control consumers.
+ * A data control provider can share its data with data control consumers.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/data_controls.htm">Data Controls</a>.
*
virtual ~MapDataControl(void);
/**
- * Gets the value list associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n
+ * Gets the value list associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n
* The %GetValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
- * When the requested value list has been received from data control provider,
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
+ * When the requested value list has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlGetValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to get from @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to obtain
- * @param[out] reqId The ID of the request
- * @param[in] pageNo The page number of the value set @n
- * It starts from @c 1.
- * @param[in] countPerPage The desired maximum count of the data item on the page
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to get from @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value list to obtain
+ * @param[out] reqId The ID of the request
+ * @param[in] pageNo The page number of the value set @n
+ * It starts from @c 1.
+ * @param[in] countPerPage The desired maximum count of the data items per page
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed as yet.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c pageNo parameter is less than @c 1.
- * - The specified @c countPerPage parameter is less than @c 1.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pageNo is less than @c 1.
+ * - The specified @c countPerPage is less than @c 1.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20);
/**
- * Adds the value associated with the specified @c key, to a key-values map owned by key-value structured data control provider. @n
+ * Adds the value associated with the specified @c key, to the key-values map owned by the key-value structured data control provider. @n
* The %AddValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlAddValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to add to @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to add
- * @param[in] value A value to add
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to add to @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value list to add
+ * @param[in] value The value to add
+ * @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_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
/**
- * Sets the value associated with the specified @c key with a new value. @n
- * The key-values map is owned by key-value structured data control provider. @n
+ * Sets the value associated with the specified @c key to a new value. @n
+ * The key-values map is owned by the key-value structured data control provider. @n
* The %SetValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlSetValueResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a registry section to update @n
- * The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to replace
- * @param[in] oldValue A value to replace
- * @param[in] newValue A new value to replace the existing value
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the specific data, usually a registry section to update @n
+ * The string consists of one or more components, separated by a slash('/').
+ * @param[in] key The key of the value to replace
+ * @param[in] oldValue The value to replace
+ * @param[in] newValue The new value that replaces the existing value
+ * @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_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
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 key-value structured data control provider. @n
+ * Removes the value associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n
* The %RemoveValue() method is asynchronous.
- * For receiving the response from data control provider, set the listener
- * with MapDataControl::SetMapDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener
+ * using the MapDataControl::SetMapDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the IMapDataControlResponseListener::OnMapDataControlRemoveValueResponseReceived() method is called.
*
* @since 2.0
*
* @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 remove
- * @param[in] value A value to remove
- * @param[out] reqId The ID of the request
+ * @param[in] dataId The string that identifies the 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 The key of the value to remove
+ * @param[in] value The 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_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The total size of method arguments has exceeded the maximum limit.
- * - The number of requests sent has exceeded the maximum limit.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
+ * - The total size of the method arguments has exceeded the maximum limit.
+ * - The number of requests sent have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
/**
- * Sets the MAP-based data control listener to this instance.
+ * Sets the MAP-based data control listener for this instance.
*
* @since 2.0
*
* Some data controls need to get the callback result by implementing
* the IMapDataControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly as yet.
* @exception E_SYSTEM A system error has occurred.
*/
result SetMapDataControlResponseListener(IMapDataControlResponseListener* pListener);
* @final This class is not intended for extension.
*
* The %NotificationManager class provides methods to alert the user about a notification.
- * @n
- * For more information
about the class features, see <a href="../org.tizen.native.appprogramming/html/guide/shell/notifications.htm">Notifications</a>.
+ *
+ * For more information
on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/shell/notifications.htm">Notifications</a>.
*
* The following example demonstrates how to use the %NotificationManager class.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
- * @return The current badge number
+ * @return The current badge number, @n
+ * else @c -1 if it fails
* @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.
+ * @exception E_OBJ_NOT_FOUND The 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. @n
- * In case of failure, this method returns @c -1.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
int GetBadgeNumber(void);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c badgeNumber is less than @c 0.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number.
+ * Notifies the user using a message and a badge number.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c badgeNumber is less than @c 0, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number. @n
+ * Notifies the user using a message and a badge number. @n
* If the user checks the message, @c launchArguments is delivered to the application. @n
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
- * for IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
- * @param[in] launchArguments The message for application
+ * @param[in] launchArguments The message for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The specified @c badgeNumber is less than @c 0. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IAppControlProviderEventListener::OnAppControlRequestReceived()
* @endif
*/
result Notify(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @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 This method returns @c E_SUCCESS when there is no outstanding notification.
* @endif
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @if OSPDEPREC
* Notifies the user about the ongoing activity using a message. @n
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
- * for IAppControlProviderEventListener::OnAppControlRequestReceived().
+ * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for the application
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
* - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
* @privilege %http://tizen.org/privilege/notification
*
- * @return The current badge number
+ * @return The current badge number, @n
+ * else @c -1 if it fails
* @param[in] appId The application ID
* @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.
+ * @exception E_OBJ_NOT_FOUND The 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. @n
- * In case of failure, this method returns @c -1.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
int GetBadgeNumber(const AppId& appId);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c badgeNumber is less than @c 0.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number on behalf of the specified application.
+ * Notifies the user using a message and a badge number on behalf of the specified application.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] messageText The notification message
* @param[in] badgeNumber The badge number
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The specified @c badgeNumber is less than @c 0. @n
- * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c badgeNumber is less than @c 0.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
/**
* @if OSPDEPREC
- * Notifies the user using a message and badge number on behalf of the specified application. @n
- * If the user checks the message, the @c launchArguments is delivered to the application.
+ * Notifies the user using a message and a badge number on behalf of the specified application. @n
+ * If the user checks the message, @c launchArguments is delivered to the application.
*
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
*
- * @return An error code
+ * @return An error code
* @param[in] appId The application ID
- * @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for the application
+ * @param[in] messageText The notification message
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
+ * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy.
* @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_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @param[in] appId The application ID
* @param[in] messageText The notification message
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @param[in] messageText The notification message
- * @param[in] launchArguments The launch arguments for application
+ * @param[in] launchArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
- * - The length of @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @exception E_APP_NOT_INSTALLED The application has not been installed.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @endif
*/
result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @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_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
+ * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
* @endif
*/
result RemoveOngoingActivityNotificationOnBehalf(const AppId& appId);
* @brief <i> [Deprecated] </i>
*
* @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
- * @since 2.0
+ * @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* @return An error code
* @param[in] appId The application ID
* @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_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
+ * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS.
* @endif
*/
result RemoveNotificationOnBehalf(const AppId& appId);
/**
* @class ServiceApp
- * @brief This class is the base class of a %Tizen native service application.
+ * @brief This class is the base class of the %Tizen native service application.
*
* @since 2.0
*
- * The %ServiceApp class is the base class of a %Tizen native service application which has no UI.
+ * The %ServiceApp class is the base class of the %Tizen native service application which has no UI.
* A %Tizen native service application must inherit from the %ServiceApp class. This class provides the basic features necessary to define the
* %Tizen native service 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>.
*
*/
virtual ~ServiceApp(void);
/**
- * Gets the %ServiceApp instance's pointer.
+ * Gets a pointer to the %ServiceApp instance.
*
* @since 2.0
*
/**
* 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.
+ * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE.
*
* @since 2.0
*
* @return An error code
- * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp's instance
- * @param[in] pArguments The launch arguments for %App
+ * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp instance
+ * @param[in] pArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INIT_FAILED The initialization failure during OnAppInitializing().
+ * @exception E_INIT_FAILED The initialization using the OnAppInitializing() method has failed.
* @exception E_SYSTEM A system error has occurred.
*/
static result Execute(ServiceAppInstanceFactory pServiceAppFactory, const Tizen::Base::Collection::IList* pArguments);
/**
* @class SqlDataControl
- * @brief This class represents the SQL-friendly interface based data control behavior.
+ * @brief This class represents the SQL-friendly interface based data control's behavior.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %SqlDataControl class represents the data control behavior, that provides a standard mechanism
- * for accessing specific data exported by other applications.
- * Data control provider can share its own data to data control consumers.
+ * The %SqlDataControl class represents the data control's behavior that provides a standard mechanism
+ * for accessing the specific data exported by other applications.
+ * A data control provider can share its data with data control consumers.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/data_controls.htm">Data Controls</a>.
*
/**
* Selects the specified columns to be queried. @n
- * The result set of the specified columns is retrieved from a table owned by an SQL-friendly interface based data control provider. @n
+ * The result set of the specified columns is retrieved from a table owned by the SQL-friendly interface based data control provider. @n
* The %Select() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the requested result set has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlSelectResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to query from @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to query from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pColumnList A list of column names to query @n
+ * @param[in] pColumnList The list of column names to query @n
* The type of objects contained in the specified @c pColumnList must be
- * Tizen::Base::String class.
- * If the specified @c pColumnList is @c null, all columns are selected.
- * @param[in] pWhere A filter to select desired rows to query @n
+ * Tizen::Base::String @n
+ * If the specified @c pColumnList is @c null, all the columns are selected.
+ * @param[in] pWhere The filter to select the desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue. @n\r
- * If the value is string, the value must be wrapped in single quotes.\r
- * Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLite SQL documents.\r
- * @param[in] pOrder The sorting order of rows to query @n
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * otherwise it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLite SQL documents.
+ * @param[in] pOrder The sorting order of the rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
* @param[out] reqId The request ID
- * @param[in] pageNo The page number of the result set @n It starts from @c 1.
- * @param[in] countPerPage The desired maximum count of rows on a page
+ * @param[in] pageNo The page number of the result set @n
+ * It starts from @c 1.
+ * @param[in] countPerPage The desired maximum count of the rows per page
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c pColumnList is empty.
- * - The specified @c pageNo parameter is less than @c 1.
- * - The specified @c countPerPage parameter is less than @c 1.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * - The specified @c pageNo is less than @c 1.
+ * - The specified @c countPerPage is less than @c 1.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result Select(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String *pOrder, RequestId& reqId,
int pageNo = 1, int countPerPage = 20);
/**
- * Inserts new rows into a table owned by an SQL-friendly interface based data control provider. @n
+ * Inserts new rows into a table owned by the SQL-friendly interface based data control provider. @n
* The %Insert() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlInsertResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to insert into @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to insert into @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] insertMap The column-value pairs to insert @n
- * The type of objects must be Tizen::Base::String class. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLite SQL documents.\r
+ * The type of objects must be Tizen::Base::String @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLite SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_INVALID_ARG The specified @c insertMap is empty.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
+ * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 1MB.
*/
result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
/**
- * Updates values of a table owned by an SQL-friendly interface based data control provider. @n
+ * Updates values of a table owned by the SQL-friendly interface based data control provider. @n
* The %Update() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlUpdateResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to update @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] updateMap The column-value pairs to update @n
- * The type of objects must be Tizen::Base::String class. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
- * @param[in] pWhere A filter to select desired rows to update @n
+ * The type of objects must be Tizen::Base::String @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
+ * @param[in] pWhere The filter to select the desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it is not wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_INVALID_ARG The specified @c updateMap is empty.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
+ * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 1MB.
*/
result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere, RequestId& reqId);
/**
- * Deletes rows of a table owned by an SQL-friendly interface based data control provider. @n
+ * Deletes rows of a table owned by the SQL-friendly interface based data control provider. @n
* The %Delete() method is asynchronous.
- * For receiving the response from the data control provider, set the listener with
- * SqlDataControl::SetSqlDataControlResponseListener(). @n
+ * For receiving the response from the data control provider, set the listener using
+ * the SqlDataControl::SetSqlDataControlResponseListener() method. @n
* When the response has been received from the data control provider,
* the ISqlDataControlResponseListener::OnSqlDataControlDeleteResponseReceived() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] dataId A string for identifying specific data, usually a database table to delete from @n
+ * @param[in] dataId The string that identifies the specific data, usually a database table to delete from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] pWhere A filter to select desired rows to delete @n
+ * @param[in] pWhere The filter to select the desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
- * If it is @c null, all rows are deleted. @n\r
- * If the value is string, the value must be wrapped in\r
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
- * For more information on the SQL statement, see SQLITE SQL documents.\r
+ * column1 = 'stringValue' AND column2 = numericValue @n
+ * If it is @c null, all the rows are deleted @n
+ * If the value is a string, the value must be wrapped in single quotes,
+ * else it need not be wrapped in single quotes @n
+ * For more information on the SQL statement, see SQLITE SQL documents.
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
- * @exception E_INVALID_ARG A specified parameter is invalid.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - Access is denied due to insufficient permission.
- * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The access is denied due to insufficient permission.
+ * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The size of the sending buffer has exceeded the maximum limit.
+ * - The number of sending requests have exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.\r
+ * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 16KB.
*/
result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);
*
* @return An error code
* @param[in] pListener The data control callback listener @n
- * Some data controls need to get the callback result by implementing
+ * Some data controls get the callback result by implementing
* the ISqlDataControlResponseListener interface.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance has not been properly constructed.
+ * @exception E_INVALID_STATE This instance has not been constructed properly.
* @exception E_SYSTEM A system error has occurred.
*/
result SetSqlDataControlResponseListener(ISqlDataControlResponseListener* pListener);
/**
* @file FAppTypes.h
- * @brief This is the header file for the enumerations of the App class.
+ * @brief This is the header file for the enumerations of the %App class.
*
- * This header file contains the declarations of the enumerations of the App class.
+ * This header file contains the declarations of the enumerations of the App class.
* @see Application
*/
/**
* @if OSPDEPREC
* The application secret
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This type is deprecated because the associated App::GetAppSecret() method is deprecated.
*
- * @since 2.0
+ * @since 2.0
* @endif
*/
typedef Tizen::Base::String AppSecret;
{
INITIALIZING, /**< The application has been launched */
RUNNING, /**< The application has been initialized and is currently being executed */
- TERMINATING, /**< The application is about to exit and releases its resources and saves its preferences */
- TERMINATED /**< The application has been destroyed */
+ TERMINATING, /**< The application is about to exit, release its resources, and save its preferences */
+ TERMINATED /**< The application has been destroyed */
};
/**
*/
enum AppUiState
{
- APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible on foreground */
+ APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible in the foreground */
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 */
+ APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application, or an application control */
};
/**
{
APP_CTRL_RESULT_SUCCEEDED = 0x00, /**< The application operation is successful */
APP_CTRL_RESULT_FAILED = 0x01, /**< The application operation has failed */
- APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is canceled by the callee application */
- APP_CTRL_RESULT_TERMINATED = 0x04, /**< The callee application is terminated without sending the result */
+ APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is cancelled by the calling application */
+ APP_CTRL_RESULT_TERMINATED = 0x04, /**< The calling application is terminated without sending the result */
APP_CTRL_RESULT_ABORTED = 0x08, /**< The application operation is aborted by the platform */
};
/**
* @if OSPDEPREC
* The application launch request ID. @n
- * Represents the application launch arguments in App::App::OnUserEventReceivedN().
+ * Represents the application launch arguments in the App::App::OnUserEventReceivedN() method.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This variable is deprecated. From %Tizen API version 2.1, App::App::OnUserEventReceivedN()
- * is not invoked for the request from application and %AppLaunchRequestId is not used anymore.
+ * @deprecated This variable is deprecated. From Tizen API version 2.1, the App::App::OnUserEventReceivedN()
+ * method is not invoked for the request from the application and the %AppLaunchRequestId() method is not used anymore.
* Instead, use IAppControlProviderEventListener.
- * @since 2.0
+ * @since 2.0
*
- * @see App::App::OnUserEventReceivedN()
* @endif
*/
const long AppLaunchRequestId = (-0xFFFF);
/**
* @if OSPDEPREC
- * Defines the launch type - normal launch.
+ * Defines the launch type, for example, normal launch.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
* Instead of using this variable, it is recommended to use IAppControlProviderEventListener to acquire the launch information.
- * @since 2.0
+ * @since 2.0
* @endif
*/
_OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_NORMAL;
/**
* @if OSPDEPREC
- * Defines the launch type - conditional launch.
+ * Defines the launch type, for example, conditional launch.
*
* @brief <i> [Deprecated] </i>
* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
*
* @since 2.0
*
- * The %UiApp class is the base class of a %Tizen native UI application.
+ * The %UiApp class is the base class of a %Tizen native UI application.@n
* 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.
- * @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>.
*
*/
virtual ~UiApp(void);
/**
- * Gets the first frame in the frame list of the UI application.
+ * Gets the first frame to the frame list of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the IAppFrame interface of the frame, @n
- * 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 The frame is not found.
+ * @return A pointer to the IAppFrame instance of the frame, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The frame has not been initialized properly.
+ * @exception E_OBJ_NOT_FOUND The frame has not been found.
*/
IAppFrame* GetAppFrame(void) const;
/**
- * Adds the frame to the end of the list that is maintained by the UI application.
+ * Adds a frame to the end of the list that is maintained by the UI application.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame that is added to the UI application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
/**
* Gets the list of the frames of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to Tizen::Base::Collection::IList that contains Tizen::Ui::Frame instances, @n
- * else @c null if it fails
+ * @return A pointer to the Tizen::Base::Collection::IList that contains the Tizen::Ui::Frame instances, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The application is in an invalid state.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* Gets the frame with the specified @c name.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame having the specified @c name, @n
- * else @c null if it fails
+ * @return A pointer to the frame that contains the specified @c name, @n
+ * else @c null if it fails
* @param[in] name The name of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
Tizen::Ui::Controls::Frame* GetFrame(const Tizen::Base::String& name) const;
/**
- * Gets the frame at the specified @c index of the list.
+ * Gets the frame at the specified @c index in the list.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame at the specified @c index, @n
- * else @c null if it fails
+ * @return A pointer to the frame at the specified @c index, @n
+ * else @c null if it fails
* @param[in] index The index of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the frame list.
* @since 2.0
*
* @return The UI state of the UI application
- * @remarks Note that UiApp::OnBackground() is invoked when the UI state of a UI application changes
- * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND or App::APP_UI_STATE_BACKGROUND.
+ * @remarks Note that the UiApp::OnBackground() method is invoked when the UI state of the UI application changes
+ * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND, or App::APP_UI_STATE_BACKGROUND.
*/
AppUiState GetAppUiState(void) const;
/**
- * Called when a UI application moves to the foreground. @n
+ * Called when the UI application moves to the foreground. @n
* User interaction is enabled when the UI application moves to the foreground. @n
* A UI application moves to the foreground when:
*
- * - A UI application is selected from the Task Switcher.
- * - A UI application icon in the Launcher application is pressed when it is running in the background.
- * - A UI application is to be launched while it is running in the background.
- * - A system pop-up, such as an incoming call, notification (for example, SMS), or a low battery warning
- * pop-up disappears.
+ * - The UI application is selected from the Task Switcher.
+ * - The UI application icon in the Launcher application is pressed when it is running in the background.
+ * - The UI application is to be launched while it is running in the background.
+ * - A system pop-up, such as an incoming call, a notification (for example, an SMS), or a low battery warning
+ * pop-up disappears.
*
- * When this method is invoked, the following actions are recommended:
+ * When the %OnForeground() method is invoked, the following actions are recommended:
*
* - Resume the graphic processing, such as 3D or animation, as the UI application now has the focus.
* - Resume the operations that stopped when the UI application is last moved to the background.
* A UI application moves to the background when:
*
* - A system pop-up, such as an incoming call or a low battery warning pop-up is displayed.
- * - A device is locked.
+ * - The device is locked.
* - The Home key is pressed.
*
- * Whenever this method is invoked, the following actions are recommended:
+ * When the %OnBackground() method is invoked, the following actions are recommended:
*
* - Stop the graphic processing, such as 3D or animation, as they will not be displayed.
* - Release unnecessary resources.
*
* @since 2.0
*
- * @remarks When notification (for example, SMS) pops up, this method is not called.
- * When a system pop-up is displayed, a UI application becomes partially hidden
- * (App::APP_UI_STATE_PARTIAL_BACKGROUND).
- * If a UI application is partially hidden, it is recommended to hold the activated
- * tasks or resources instead of stopping or releasing them.
+ * @remarks
+ * - When a notification (for example, an SMS) pops up, this method is not called.
+ * - When a system pop-up is displayed, the UI application becomes partially hidden (App::APP_UI_STATE_PARTIAL_BACKGROUND).
+ * - If the UI application is partially hidden, it is recommended to hold the activated tasks or resources instead of stopping or releasing them.
* @see GetAppUiState()
*/
virtual void OnBackground(void);
/**
- * Gets the %UiApp instance's pointer.
+ * Gets a pointer to the %UiApp instance.
*
* @since 2.0
*
/**
* Executes an application implemented by inheriting this class.
- * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE.
+ * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] pUiAppFactory The factory method that creates this UiApp's instance
- * @param[in] pArguments The launch arguments for %App
+ * @return An error code
+ * @param[in] pUiAppFactory The factory method that creates this UiApp instance
+ * @param[in] pArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INIT_FAILED The initialization failure during OnAppInitializing().
+ * @exception E_INIT_FAILED A failure occurred while initializing using the OnAppInitializing() method.
* @exception E_SYSTEM A system error has occurred.
*/
static result Execute(UiAppInstanceFactory pUiAppFactory, const Tizen::Base::Collection::IList* pArguments);
projects / platform / framework / native / appfw.git / commitdiff