X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppNotificationManager.h;h=2bbff00c55ce259b8279ceabf7e80c374235fac7;hb=102d9124a6981de495cb23e8bd98c2de322960fb;hp=ccc987019370bc97d5e5dc40b4ff172318519b8a;hpb=3635d7c924ade9802d64139c8310c04d9ce6c904;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppNotificationManager.h b/inc/FAppNotificationManager.h index ccc9870..2bbff00 100644 --- a/inc/FAppNotificationManager.h +++ b/inc/FAppNotificationManager.h @@ -15,10 +15,12 @@ // /** + * @if OSPDEPREC * @file FAppNotificationManager.h * @brief This is the header file for the %NotificationManager class. * * This header file contains the declarations of the %NotificationManager class. + * @endif */ #ifndef _FAPP_NOTIFICATION_MANAGER_H_ @@ -77,8 +79,8 @@ static const int MAX_NOTIFICATION_BADGE_NUMBER = 999; * @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 Notifications. + * + * For more information on the class features, see Notifications. * * The following example demonstrates how to use the %NotificationManager class. * @@ -155,13 +157,13 @@ public: * @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); @@ -173,16 +175,17 @@ public: * @brief [Deprecated] * * @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 */ @@ -195,16 +198,17 @@ public: * @brief [Deprecated] * * @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 */ @@ -212,22 +216,23 @@ public: /** * @if OSPDEPREC - * Notifies the user using a message and badge number. + * Notifies the user using a message and a badge number. * * @brief [Deprecated] * * @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 */ @@ -235,31 +240,30 @@ public: /** * @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 [Deprecated] * * @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); @@ -271,12 +275,12 @@ public: * @brief [Deprecated] * * @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 @@ -290,16 +294,17 @@ public: * @brief [Deprecated] * * @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 */ @@ -309,24 +314,24 @@ public: * @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 [Deprecated] * * @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 */ @@ -339,7 +344,7 @@ public: * @brief [Deprecated] * * @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 @@ -358,17 +363,17 @@ public: * @brief [Deprecated] * * @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); @@ -380,7 +385,7 @@ public: * @brief [Deprecated] * * @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 @@ -390,10 +395,11 @@ public: * @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 @@ -407,7 +413,7 @@ public: * @brief [Deprecated] * * @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 @@ -417,10 +423,11 @@ public: * @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 @@ -429,12 +436,12 @@ public: /** * @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 [Deprecated] * * @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 @@ -445,12 +452,12 @@ public: * @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 @@ -459,31 +466,31 @@ public: /** * @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 [Deprecated] * * @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); @@ -495,7 +502,7 @@ public: * @brief [Deprecated] * * @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 @@ -505,12 +512,13 @@ public: * @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); @@ -522,7 +530,7 @@ public: * @brief [Deprecated] * * @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 @@ -531,16 +539,16 @@ public: * @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); @@ -552,7 +560,7 @@ public: * @brief [Deprecated] * * @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 @@ -561,10 +569,10 @@ public: * @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); @@ -576,7 +584,7 @@ public: * @brief [Deprecated] * * @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 @@ -585,10 +593,10 @@ public: * @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);