{
public:
/**
- * Requests AppWidget service to trigger specified AppWidget update
+ * Requests the AppWidget service to trigger a specified AppWidget update.
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
* @exception E_SUCCESS The method is successful.
/**
* Called when the AppWidget popup provider is required to be created.
*
- * @since 2.1
+ * @since 2.1
*
* @return @c true if the method is successful, @n
* else @c false
* @param[in] userInfo User information that specifies when the AppWidget is added
- * @remarks AppWidgetPopup should be created and set here.
- * @see SetAppWidgetPopup()
+ * @remarks AppWidgetPopup should be created and set here.
+ * @see SetAppWidgetPopup()
*/
virtual bool OnAppWidgetPopupProviderInitializing(const Tizen::Base::String& userInfo) = 0;
/**
* Sets the AppWidget popup to the AppWidget popup provider.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @param[in] pAppWidgetPopup The pointer to the AppWidgetPopup instance that is set to AppWidget
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The pointer to AppWidgetPopup is @c null, or not constructed as yet.
* @class AppWidgetProvider
* @brief This class is the abstract base class for all AppWidget providers.
*
- * @since 2.1
+ * @since 2.1
*
* The %AppWidgetProvider class is an abstract base class that represents an AppWidget provider.
*/
/**
* Called when the AppWidget provider is created or initialized.
*
- * @since 2.1
+ * @since 2.1
*
* @return @c true if the method is successful, @n
* else @c false
* @param[in] width The width of the AppWidget
* @param[in] height The height of the AppWidget
* @param[in] userInfo User information that is specified when the AppWidget is added
- * @remarks AppWidgetFrame should be created and set here. @n
+ * @remarks AppWidgetFrame should be created and set here. @n
* If this method returns @c false, the AppWidget provider will be terminated.
- * @see AppWidgetProviderManager::AddAppWidget()
- * @see SetAppWidgetFrame()
+ * @see AppWidgetProviderManager::AddAppWidget()
+ * @see SetAppWidgetFrame()
*
* The following example demonstrates how to initialize the %AppWidgetProvider instance.
*
/**
* Called when the AppWidget provider is destroyed or terminated.
*
- * @since 2.1
+ * @since 2.1
*/
virtual void OnAppWidgetProviderTerminating(void) = 0;
/**
- * Called when the correspondent AppWidget is removed from AppWidget viewer application(such as the Home screen). @n
+ * Called when the correspondent AppWidget is removed from the AppWidget viewer application (such as the Home screen). @n
* If AppWidget provider state is stored in a persistent storage such as registry or DB, it can be destroyed by implementing this pure virtual function.
*
- * @since 2.1
+ * @since 2.1
*
* @remarks This method is called after the OnAppWidgetProviderTerminating() method is called.
*/
* Called when AppWidget is updated. @n
* AppWidget provider can be updated by implementing this pure virtual function.
*
- * @since 2.1
+ * @since 2.1
*
* @return @c true if the method is successful, @n
* else @c false
* @param[in] argument User information to update the AppWidget provider @n
* This parameter is delivered from AppWidgetProvider::RequestUpdate().
* @remarks
- * - This method is called when UpdatePeriod timer is expired or AppWidgetManager::RequestUpdate() is called.
- * - If this method returns @c false, the AppWidget provider will be removed.
+ * - This method is called when the UpdatePeriod timer expires or AppWidgetManager::RequestUpdate() is called.
+ * - If this method returns @c false, the AppWidget provider will be removed.
*/
virtual bool OnAppWidgetProviderUpdating(const Tizen::Base::String& argument) = 0;
/**
* Sets the AppWidgetFrame instance to the %AppWidgetProvider instance.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @param[in] pAppWidgetFrame The AppWidgetFrame instance to set as the %AppWidgetProvider instance
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The pointer to AppWidgetFrame is @c null, or not constructed as yet.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
- * - This method should be called only within the OnAppWidgetProviderInitializing() method.
- * - The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the AppWidgetFrame instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
+ * - This method should be called only within the OnAppWidgetProviderInitializing() method.
+ * - The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the %AppWidgetFrame instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed.
*/
result SetAppWidgetFrame(AppWidgetFrame* pAppWidgetFrame);
* @class AppWidgetProviderInfo
* @brief This class contains static AppWidget information.
*
- * @since 2.1
+ * @since 2.1
*
* The %AppWidgetProviderInfo class contains static AppWidget information.
*/
/**
* Copying of objects using this copy constructor is allowed.
*
- * @since 2.1
+ * @since 2.1
*
* @param[in] rhs An instance of %AppWidgetProviderInfo
*/
Tizen::Base::String GetName(void) const;
/**
- * Gets the display name of an AppWidget provider @n
+ * Gets the display name of an AppWidget provider. @n
* If the system language setting is changed, the %GetDisplayName() method returns the localized application name.
* The display name is displayed in applications showing AppWidget such as Launcher, and so on.
*
*
* @since 2.1
*
- * @return The ID of the application that exports AppControl to configure the AppWidget @n
+ * @return The ID of the application that exports AppControl to configure the AppWidget. @n
* An empty string is returned if there is no value.
*
* The following example demonstrates how to start the application control that is exported for AppWidget configuration.
* else @c false
*
* @remarks
- * - Default AppWidget provider providing AppWidget that represents application.
- * - Home application can show AppWidget instead of shortcut that is consisted of icon and text for applications that includes default AppWidget provider.
+ * - Default AppWidget provider, providing AppWidget that represents an application.
+ * - Home application can show AppWidget instead of a shortcut that consists of an icon and text for applications that include the default AppWidget provider.
*/
bool IsDefault(void) const;
/**
* Gets a list of AppWidgetSizeInfo of an AppWidget.
*
- * @since 2.1
+ * @since 2.1
*
- * @return A pointer to the array list that contains all AppWidgetSizeInfo of the AppWidgetProvider instance, @n
- * else @c null if an error occurs
+ * @return A pointer to the array list that contains all AppWidgetSizeInfo of the AppWidgetProvider instance, @n
+ * else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetSizeInfoListN(void) const;
//
// @since 2.1
//
- // @param[in] appId The ID of the application that provides AppWidget
+ // @param[in] appId The ID of the application that provides AppWidget
// @param[in] name The name of the AppWidget provider
//
AppWidgetProviderInfo(const Tizen::App::AppId& appId, const Tizen::Base::String& name);
* @class AppWidgetProviderManager
* @brief This class manages all the AppWidget providers.
*
- * @since 2.1
+ * @since 2.1
*
* @final This class is not intended for extension.
*
/**
* Gets the AppWidget manager instance.
*
- * @since 2.1
+ * @since 2.1
*
* @feature %http://tizen.org/feature/shell.appwidget
*
* @return A pointer to the %AppWidgetProviderManager instance, @n
* else @c null if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @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>.
- *
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Before calling this method, check whether the feature is supported by
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
static AppWidgetProviderManager* GetInstance(void);
/**
* Requests AppWidget service to trigger the specified AppWidget update.
*
- * @since 2.1
- *
- * @param[in] appId The appId that provides AppWidget
- * @param[in] providerName The name of the AppWidget provider
- * @param[in] argument User information for the AppWidget provider @n
- * This parameter will be delivered as parameter of AppWidgetProvider::OnAppWidgetProviderUpdating().
+ * @since 2.1
*
- * @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
+ * @param[in] appId The appId that provides AppWidget
+ * @param[in] providerName The name of the AppWidget provider
+ * @param[in] argument User information for the AppWidget provider @n
+ * This parameter will be delivered as parameter of AppWidgetProvider::OnAppWidgetProviderUpdating().
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
* @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to update AppWidget of other application package. @n
- * To get permission, the target application is signed with the same certificate.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
+ * To get permission, the target application is signed with the same certificate.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see AppWidgetProvider::OnAppWidgetProviderUpdating()
- * @remarks When specified Dynamic Box is implemented with Web app, argument won't be delivered.
+ * @remarks When the specified Dynamic Box is implemented with Web app, argument will not be delivered.
*/
result RequestUpdate(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& argument = L"");
/**
* Requests an AppWidget viewer (for example, Home screen, Lock screen) to add the specified AppWidget.
*
- * @since 2.1
+ * @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/appwidgetprovider.install
*
- * @param[in] providerAppId The ID of the application providing AppWidget
- * @param[in] providerName The name of the AppWidget provider to add
- * @param[in] alternateText Alternate text displayed in the AppWidgetView instance while the AppWidgetProvider instance is initializing or is unavailable
- * @param[in] userInfo User information for the AppWidget provider
- * @exception E_SUCCESS The method is successful.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] providerAppId The ID of the application providing AppWidget
+ * @param[in] providerName The name of the AppWidget provider to add
+ * @param[in] alternateText Alternate text displayed in the AppWidgetView instance while the AppWidgetProvider instance is initializing or is unavailable
+ * @param[in] userInfo User information for the AppWidget provider
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to add AppWidget of other application package. @n
- * To get permission, the target application is signed with the same certificate.
- * @exception E_UNSUPPORTED_OPERATION The specified AppWidget provider does not support this operation. @n
- * To request an AppWidget viewer to add an AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size.
- * @exception E_CONNECTION_FAILED The viewer application does not set a listener to receive this request.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * To get permission, the target application is signed with the same certificate.
+ * @exception E_UNSUPPORTED_OPERATION The specified AppWidget provider does not support this operation. @n
+ * To request an AppWidget viewer to add an AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size.
+ * @exception E_CONNECTION_FAILED The viewer application does not set a listener to receive this request.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks Only the AppWidget provider that is packaged with the caller application can be added by this method.
- * @see AppWidgetManager::SetAppWidgetRequestListener()
+ * @see AppWidgetManager::SetAppWidgetRequestListener()
*/
result AddAppWidget(const Tizen::App::AppId& providerAppId, const Tizen::Base::String& providerName, const Tizen::Base::String& alternateText, const Tizen::Base::String& userInfo);
* The %SetAppWidgetProviderFactory() method should be called in App::OnAppInitializing(), to receive the event correctly.
* Implementing AppWidgetProviderFactory is mandatory to provide AppWidget functionality.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] factory The factory to create concrete AppWidgetProvider
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @see IAppWidgetProviderFactory
+ * @return An error code
+ * @param[in] factory The factory to create concrete AppWidgetProvider
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @see IAppWidgetProviderFactory
*/
result SetAppWidgetProviderFactory(IAppWidgetProviderFactory& factory);
* @since 2.1
*
* @return An error code
- * @param[in] factory The factory to create concrete AppWidgetPopupProvider
+ * @param[in] factory The factory to create concrete AppWidgetPopupProvider
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget popup.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see IAppWidgetPopupProviderFactory
*/
result SetAppWidgetPopupProviderFactory(IAppWidgetPopupProviderFactory& factory);
/**
* This destructor overrides Tizen::Base::Object::~Object().
*
- * @since 2.1
+ * @since 2.1
*/
virtual ~AppWidgetSizeInfo(void);
/**
* Copying of objects using this copy constructor is allowed.
*
- * @since 2.1
+ * @since 2.1
*
* @param[in] rhs An instance of %AppWidgetSizeInfo
*/
Tizen::Graphics::FloatDimension GetSize(void) const;
/**
- * Gets the image path for preview for the size.
+ * Gets the image path for preview of the size.
*
* @since 2.1
*
Tizen::Base::String GetPreviewImagePath(void) const;
/**
- * Checks whether an AppWidget Viewer(such as the Home screen) needs to decorate frame of the Dynamic Box for the current size.
+ * Checks whether the AppWidget viewer (such as the Home screen) needs to decorate the frame of the Dynamic Box for the current size.
*
* @since 2.1
*
- * @return @c true if an AppWidget Viewer needs to decorate frame of the Dynamic Box for the size @n
+ * @return @c true if the AppWidget viewer needs to decorate the frame of the Dynamic Box for the size, @n
* else @c false
- * @remarks Decoration depends on current AppWidget Viewer implementation
+ * @remarks Decoration depends on the current AppWidget viewer implementation.
*/
bool IsDecorationFrameUsed(void) const;
// This is the constructor that initializes an instance of %AppWidgetSizeInfo with the specified values.
// This constructor is intentionally declared as private so that only the platform can create an instance.
//
- // @since 2.1
+ // @since 2.1
//
- // @param[in] size One of the size that the AppWidget provider supports.
+ // @param[in] size One of the size that the AppWidget provider supports.
// @param[in] previewImagePath The preview image path for the size.
- // @param[in] isDecorationFrameUsed Specify whether the Dynamic Box needs to be decorated on the Home screen.
+ // @param[in] isDecorationFrameUsed Specify whether the Dynamic Box needs to be decorated on the Home screen.
//
AppWidgetSizeInfo(Tizen::Graphics::FloatDimension size, const Tizen::Base::String& previewImagePath, bool isDecorationFrameUsed);
* @interface IAppWidgetProviderFactory
* @brief This interface defines the factory for the %AppWidgetProvider creation.
*
- * @since 2.1
+ * @since 2.1
*
* The %IAppWidgetProviderFactory interface defines a factory for the AppWidgetProvider creation.
* The AppWidgetProviderManager instance calls CreateInstance() when an instance of %AppWidgetProvider is required.
/**
* Called when the AppWidgetProvider creation request is received from the appwidget service. @n
- * Applications that provide the %AppWidgetProvider functionality must implement this pure virtual function.
+ * Applications that provide the %AppWidgetProvider functionality must implement this pure virtual method.
*
- * @since 2.1
+ * @since 2.1
*
* @param[in] providerName The name of the AppWidget provider
- * @param[in] width The width of the AppWidget
- * @param[in] height The height of the AppWidget
- * @param[in] userInfo User information that is specified when the AppWidget is added
- * @see AppWidgetProviderManager::AddAppWidget()
+ * @param[in] width The width of the AppWidget
+ * @param[in] height The height of the AppWidget
+ * @param[in] userInfo User information that is specified when the AppWidget is added
+ * @see AppWidgetProviderManager::AddAppWidget()
*/
virtual AppWidgetProvider* CreateInstance(const Tizen::Base::String& providerName, float width, float height, const Tizen::Base::String& userInfo) = 0;
/**
* @interface IAppWidgetRequestListener
- * @brief This interface defines a listener for an AppWidget viewer (such as the Home screen) that receives request to add AppWidget.
+ * @brief This interface defines a listener for an AppWidget viewer (such as the Home screen) that receives a request to add an AppWidget.
*
- * @since 2.1
+ * @since 2.1
*
- * The %IAppWidgetRequestListener interface defines a listener for an AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget.
+ * The %IAppWidgetRequestListener interface defines a listener for an AppWidget viewer (such as the Home screen) that receives a request to add an AppWidget.
*/
class _OSP_EXPORT_ IAppWidgetRequestListener
: virtual public Tizen::Base::Runtime::IEventListener
*
* @since 2.1
*
- * @param[in] appId The application ID of the application providing AppWidget
+ * @param[in] appId The application ID of the application providing AppWidget
* @param[in] providerName The name of the AppWidget provider to add
* @param[in] text Alternative text for the AppWidget
* @param[in] userInfo User information for the AppWidget provider
- * @remarks This method is invoked only in the main thread.
- * @see AppWidgetProviderManager::AddAppWidget()
+ * @remarks This method is invoked only in the main thread.
+ * @see AppWidgetProviderManager::AddAppWidget()
*/
virtual void OnAppWidgetAddRequested(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& text, const Tizen::Base::String& userInfo) = 0;
* @interface IBadgeEventListener
* @brief This interface defines a listener for the Home screen that receives badge updated event.
*
- * @since 2.1
+ * @since 2.1
*
* The %IBadgeEventListener interface defines a listener for the Home screen that receives badge updated event.
*/
/**
* Called when a badge number has been updated.
*
- * @since 2.1
+ * @since 2.1
*
- * @param[in] appId The application ID that updates the badge number
+ * @param[in] appId The application ID that updates the badge number
* @param[in] badgeNumber The updated badge number
- * @remarks This method is invoked only in the main thread
- * @see NotificationManager::Notify()
+ * @remarks This method is invoked only in the main thread.
+ * @see NotificationManager::Notify()
*/
virtual void OnBadgeUpdated(const Tizen::App::AppId& appId, int badgeNumber) = 0;
* @class NotificationManager
* @brief This class provides methods to alert the user about a notification.
*
- * @since 2.0
+ * @since 2.0
+ *
+ * @final This class is not intended for extension.
*
- * @final This class is not intended for extension.
+ * The %NotificationManager class provides methods to alert the user about notifications. @n
*
- * The %NotificationManager class provides methods to alert the user about notifications.
- * @n
* For more information about 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.
/**
* Initializes this instance of %NotificationManager.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
*/
result Construct(void);
/**
* Gets the current badge number of an application icon.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
/**
* Notifies the user who has @c badgeNumber as a badge number.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
/**
* Notifies the user with a message.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified input parameter is invalid.
- * - The specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
/**
* Notifies the user who has @c badgeNumber as badge number with a message.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @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
- * - The specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* - The specified @c badgeNumber is less than @c 0 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
* for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @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 or the @c badgeNumber is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER. @n
- * - The specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
* - The specified @c launchArguments is empty or the length of @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* Notifies the user with a request message. @n
* The notification request may have various pieces of information such as alert text, title text, launch arguments, and so on.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] request The notification request
- * @exception E_SUCCESS The method is successful.
+ * @param[in] request The notification request
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* The user who is identified with the @c appId is notified with a request message. @n
* The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
*
- * @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
* @param[in] appId The application ID
- * @param[in] request The notification request
- * @exception E_SUCCESS The method is successful.
+ * @param[in] request The notification request
+ * @exception E_SUCCESS The method is successful.
* @exception E_APP_NOT_INSTALLED The application is not installed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
/**
* Removes the notification message.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
* @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.
+ * @remarks This method returns @c E_SUCCESS when there is no outstanding notification.
*/
result RemoveNotification(void);
/**
* Removes the notification message on behalf of the specified application.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
/**
* Notifies the user about the ongoing activity using a message.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified input parameter is invalid. @n
- * - The specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
* for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @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 specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n
* - The specified @c launchArguments is empty or the length of @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* Notifies the user about the ongoing activity using a request message. @n
* The request may have various pieces of information such as alert text, title text, launch arguments, and so on.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @return An error code
- * @param[in] request The notification request
+ * @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* Notifies the user about the ongoing activity using a request message. @n
* The request may have various information like alert text, title text, launch arguments, and so on.
*
- * @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
* @param[in] appId The application ID
- * @param[in] request The notification request
+ * @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_APP_NOT_INSTALLED The application is not installed.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
/**
* Removes the notification message for the ongoing activity.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
/**
* Removes the notification message for ongoing activity on behalf of the specified application.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
/**
* Gets the badge number of the application icon mentioned in the @c appId.
*
- * @since 2.0
+ * @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification @n
* (%http://tizen.org/privilege/notificationmanager is deprecated.)
* @param[in] appId The application ID
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_APP_NOT_INSTALLED The application is not installed.
+ * @exception E_APP_NOT_INSTALLED The 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. @n
*
* Notifies the user with a message. @n
* It will disappear in a few seconds.
*
- * @since 2.1
+ * @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified input parameter is invalid.
- * - The specified @c messageText is empty or the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
+ * - The specified @c messageText is empty or the length of the @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The message is displayed in the status bar.
* The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">here</a>.
* The maximum size is @c 16 kilo bytes.
* @param[in] request The notification request
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks For more information on the implicit AppControl resolution, see <a href="../org.tizen.native.appprogramming/html/guide/app/resolving_appcontrols.htm">here</a>.
* Adds an IBadgeEventListener instance to the %NotificationManager instance. @n
* The listener gets notified when a badge number is updated. @n
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
* @param[in] listener The listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
- * @see NotificationManager::Notify()
+ * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
+ * @see NotificationManager::Notify()
*/
result AddBadgeEventListener(IBadgeEventListener& listener);
/**
* Removes an IBadgeEventListener instance from the %NotificationManager instance.
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
* @param[in] listener The listener to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The listener is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
+ * @remarks Internally platform does not have the ownership of this pointer, so caller should manage the listener object properly.
*/
result RemoveBadgeEventListener(IBadgeEventListener& listener);
* @class NotificationRequest
* @brief This class provides methods for handling a notification request.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
* The %NotificationRequest class provides methods for handling a notification request. The request can contain following
* items:
/**
* Initializes this instance of %NotificationRequest with the specified @c appBinding.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] appBinding Set to @c true to bind %NotificationRequest to the destination application, @n
* else @c false
- * @remarks Selecting the posted notification in the notification area leads to launch of the associated application
- * if %NotificationRequest is bound to the destination application.
- * @see SetAlertText()
+ * @remarks Selecting the posted notification in the notification area leads to launch of the associated application
+ * if %NotificationRequest is bound to the destination application.
+ * @see SetAlertText()
*/
explicit NotificationRequest(bool appBinding = true);
/**
* Copying of objects using this copy constructor is allowed.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] rhs An instance of %NotificationRequest
*/
/**
* Copying of objects using this copy assignment operator is allowed.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] rhs An instance of %NotificationRequest
*/
/**
* This destructor overrides Tizen::Base::Object::~Object().
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~NotificationRequest(void);
/**
* Checks whether the specified instance of %NotificationRequest equals the current instance.
*
- * @since 2.0
+ * @since 2.0
*
* @return @c true if the specified instance equals the current instance, @n
* else @c false
/**
* Gets the hash value of the current instance.
*
- * @since 2.0
+ * @since 2.0
*
* @return The hash value of the current instance
*/
/**
* Gets the badge number of a notification message.
*
- * @since 2.0
+ * @since 2.0
*
* @return The badge number value
- * @remarks If the badge number is not set, then this method returns @c -1.
+ * @remarks If the badge number is not set, then this method returns @c -1.
*/
int GetBadgeNumber(void) const;
*
* @since 2.0
*
- * @return An error code
- * @param[in] value The badge number value
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] value The badge number value
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c value is less than @c 0 or greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
*/
result SetBadgeNumber(int value);
/**
* Gets the badge number offset of a notification message.
*
- * @since 2.0
+ * @since 2.0
*
* @return The badge offset value
*/
* which can be acquired by NotificationManager::GetBadgeNumber(). Setting badge offset to @c 0
* means explicitly specifying not to change the current badge value with the notification message.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] value The badge number value
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] value The badge number value
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The absolute value of the specified @c value is greater than Shell::MAX_NOTIFICATION_BADGE_NUMBER.
- * @remarks Even though this method does not return @c E_INVALID_ARG, it does not guarantee the success of NotificationManager::Notify().
- * @see SetBadgeNumber()
+ * @remarks Even though this method does not return @c E_INVALID_ARG, it does not guarantee the success of NotificationManager::Notify().
+ * @see SetBadgeNumber()
*/
result SetBadgeOffset(int value);
/**
* Sets an alert text of a notification message.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] text The alert text
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] text The alert text
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c text is empty or the length of @c text is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
* @remarks
- * - @c text is displayed according to notification layout, and the length of the @c text depends on the font attributes or the variable font width.
+ * - @c text is displayed according to the notification layout, and the length of the @c text depends on the font attributes or the variable font width.
* - @c text is mandatory for a notification.
*/
result SetAlertText(const Tizen::Base::String& text);
*
* @since 2.0
*
- * @return The message for application
+ * @return The message for application
*/
Tizen::Base::String GetAppMessage(void) const;
* @c appMessage is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
* for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] appMessage The message for the application
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c appMessage is empty or the length of @c appMessage is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
+ * @return An error code
+ * @param[in] appMessage The message for the application
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c appMessage is empty or the length of the @c appMessage is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH.
* @exception E_INVALID_OPERATION This instance is not bound to the application.
- * @remarks This method returns @c E_INVALID_OPERATION if the %NotificationRequest instance is not bound to the application.
+ * @remarks This method returns @c E_INVALID_OPERATION if the %NotificationRequest instance is not bound to the application.
*/
result SetAppMessage(const Tizen::Base::String& appMessage);
/**
* Sets the title text of a notification message.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] title The title text
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c title is empty or the length of @c title is greater than Shell::MAX_NOTIFICATION_TITLE_LENGTH.
- * @remarks If @c title is not set, the application name is displayed.
+ * @return An error code
+ * @param[in] title The title text
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c title is empty or the length of the @c title is greater than Shell::MAX_NOTIFICATION_TITLE_LENGTH.
+ * @remarks If the @c title is not set, the application name is displayed.
*/
result SetTitleText(const Tizen::Base::String& title);
/**
* Sets the file path of the icon image for a notification message.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] iconPath The file path of the icon image
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks If @c iconPath is not set, the application icon is displayed.
+ * @remarks If the @c iconPath is not set, the application icon is displayed.
* The @c iconPath should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
*/
result SetIconFilePath(const Tizen::Base::String& iconPath);
*
* @since 2.0
*
- * @return An error code
- * @param[in] soundPath The file path of the sound file
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] soundPath The file path of the sound file
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
* @remarks
- * - If the format of the sound file is not valid, then the sound file is not played properly when the notification message is displayed.
- * - If @c soundPath is not set, the default sound is played when the %NotificationRequest instance is delivered to the NotificationManager::Notify() method.
+ * - If the format of the sound file is not valid, then the sound file does not play properly when the notification message is displayed.
+ * - If the @c soundPath is not set, the default sound is played when the %NotificationRequest instance is delivered to the NotificationManager::Notify() method.
* - The @c soundPath should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
*/
result SetSoundFilePath(const Tizen::Base::String& soundPath);
*
* @return The ongoing activity notification type
* @remarks This information is only meaningful when the %NotificationRequest instance is delivered to the NotificationManager::NotifyOngoingActivity() method.
- * @see SetOngoingActivityType()
+ * @see SetOngoingActivityType()
*/
OngoingActivityType GetOngoingActivityType(void) const;
/**
* Sets the notification type for an ongoing activity.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] type The notification type for an ongoing activity
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] type The notification type for an ongoing activity
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current progress value is not compatible to the specified @c type.
- * @remarks This information is only meaningful when the %NotificationRequest instance is delivered to the NotificationManager::NotifyOngoingActivity() method.
- * @see SetOngoingActivityProgress()
+ * @remarks This information is only meaningful when the %NotificationRequest instance is delivered to the NotificationManager::NotifyOngoingActivity() method.
+ * @see SetOngoingActivityProgress()
*/
result SetOngoingActivityType(OngoingActivityType type = ONGOING_ACTIVITY_TYPE_TEXT);
/**
* Sets the progress value with the specified @c value.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] value The progress value
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c value is less than @c 0.
- * - The specified @c value does not lie between @c 0 and @c 100 for Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
- * - The notification type for an ongoing activity is not set.
+ * @return An error code
+ * @param[in] value The progress value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * - The specified @c value is less than @c 0.
+ * - The specified @c value does not lie between @c 0 and @c 100 for Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
+ * - The notification type for an ongoing activity is not set.
* @exception E_INVALID_OPERATION This instance is in an invalid state. @n
- * OngoingActivityType must be either Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE or Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
- * @see SetOngoingActivityType()
+ * OngoingActivityType must be either Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE or Shell::ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE.
+ * @see SetOngoingActivityType()
*/
result SetOngoingActivityProgress(int value);
* @param[in] pThumbnailPathList A list of the thumbnail image file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
- * The path of thumbnail image should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
+ * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL.
+ * The path of the thumbnail image should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
*/
result SetMessageThumbnailFilePathList(const Tizen::Base::Collection::IList* pThumbnailPathList);
* @param[in] notificationCountText The notification count text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c notificationCountText is empty or the length of @c notificationCountText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH.
- * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL.
+ * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_NORMAL.
*/
result SetNotificationCountText(const Tizen::Base::String& notificationCountText);
* @param[in] imagePath The file path of the background image
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified path is invalid.
- * @remarks The @c imagePath should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
+ * @remarks The @c imagePath should start with the directory path returned by Tizen::App::App::GetAppSharedPath().
*/
result SetBackgroundImageFilePath(const Tizen::Base::String& imagePath);
/**
- * Gets the notification light operation properties.
+ * Gets the properties of a notification light operation.
*
- * @since 2.2
+ * @since 2.2
*
- * @param[out] color The light color
- * @param[out] onTime The time(milliseconds) at which the notification light is turned on
- * @param[out] offTime The time(milliseconds) at which the notification light is turned off
+ * @param[out] color The color of the notification light
+ * @param[out] onTime The time (in milliseconds) at which the notification light is turned on
+ * @param[out] offTime The time (in milliseconds) at which the notification light is turned off
*/
void GetLight(Tizen::Graphics::Color& color, int& onTime, int& offTime) const;
/**
- * Sets the notification light operation properties.
+ * Sets the properties of a notification light operation.
*
* @since 2.2
*
* @return An error code
- * @param[in] color The light color
- * @param[in] onTime The time(milliseconds) at which the notification light is turned on
- * @param[in] offTime The time(milliseconds) at which the notification light is turned off
+ * @param[in] color The color of the notification light
+ * @param[in] onTime The time (in milliseconds) at which the notification light is turned on
+ * @param[in] offTime The time (in milliseconds) at which the notification light is turned off
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method has effects only on devices with notification light.
- * @remarks The light flash continuously toggles on(@c onTime) and off(@c offTime).
- * @remarks To turn the light off, set Color(0, 0, 0, 0) to color or set 0 to onTime.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @remarks
+ * - This method has effects only on devices with notification light.
+ * - The light flash continuously toggles on (@c onTime) and off (@c offTime).
+ * - To turn the light off, set Color(0, 0, 0, 0) to @c color or set @c 0 to @c onTime.
*/
result SetLight(const Tizen::Graphics::Color& color, int onTime, int offTime);
projects / framework / osp / shell.git / commitdiff