* @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);
projects / platform / framework / native / appfw.git / blobdiff