Fix a fd mis-match
[platform/framework/native/appfw.git] / inc / FAppNotificationManager.h
old mode 100755 (executable)
new mode 100644 (file)
index bd5b8db..ccc9870
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -67,28 +66,6 @@ static const int MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH = 1024;
  */
 static const int MAX_NOTIFICATION_BADGE_NUMBER = 999;
 
-/*
- * The maximum length of the title text.
- *
- * @since      2.0
- */
-static const int MAX_NOTIFICATION_TITLE_LENGTH = 1024;
-
-/*
- * @enum       OngoingActivityType
- *
- * Defines the ongoing activity notification type.
- *
- * @since      2.0
- */
-enum OngoingActivityType
-{
-       ONGOING_ACTIVITY_TYPE_TEXT = 1,                 /**< The text type */
-       ONGOING_ACTIVITY_TYPE_PROGRESS_BYTE,    /**< The progress type in byte */
-       ONGOING_ACTIVITY_TYPE_PROGRESS_PERCENTAGE       /**< The progress type in percentage */
-};
-
-
 /**
  * @if OSPDEPREC
  * @class              NotificationManager
@@ -101,7 +78,7 @@ enum OngoingActivityType
  *
  * 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/app/notifications.htm">Notifications</a>.
+ * 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.
  *
@@ -260,7 +237,7 @@ public:
         * @if OSPDEPREC
         * Notifies the user using a message and 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
+        * @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
         * for IAppControlProviderEventListener::OnAppControlRequestReceived().
         *
         * @brief               <i> [Deprecated] </i>
@@ -331,7 +308,7 @@ 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
+        * @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key
         * for IAppControlProviderEventListener::OnAppControlRequestReceived().
         *
         * @brief               <i> [Deprecated] </i>
@@ -369,7 +346,7 @@ public:
         * @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      The method returns @c E_SUCCESS when there is no outstanding notification.
+        * @remarks      This method returns @c E_SUCCESS when there is no outstanding notification.
         * @endif
         */
        result RemoveOngoingActivityNotification(void);
@@ -398,7 +375,6 @@ public:
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Notifies the user using a badge number on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -406,8 +382,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since       2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -420,13 +397,11 @@ public:
         * @exception   E_SYSTEM                        A system error has occurred.
         * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         * @endif
-        * @endif
         */
        result NotifyOnBehalf(const AppId& appId, int badgeNumber);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Notifies the user using a message on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -434,8 +409,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since       2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -448,13 +424,11 @@ public:
         * @exception   E_SYSTEM                        A system error has occurred.
         * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         * @endif
-        * @endif
         */
        result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Notifies the user using a message and badge number on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -462,8 +436,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since       2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -479,13 +454,11 @@ public:
         * @exception   E_SYSTEM                        A system error has occurred.
         * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
         * @endif
-        * @endif
         */
        result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, int badgeNumber);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * 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.
         *
@@ -494,8 +467,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since               2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -511,13 +485,11 @@ public:
         * @exception  E_SYSTEM                         A system error has occurred.
         * @exception E_PRIVILEGE_DENIED                The application does not have the privilege to call this method.
         * @endif
-        * @endif
         */
        result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Notifies the user about the ongoing activity using a message on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -525,8 +497,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since                               2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -539,13 +512,11 @@ public:
         * @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
-        * @endif
         */
        result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Notifies the user about the ongoing activity using a message on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -553,8 +524,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since                               2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -570,22 +542,21 @@ public:
         * @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
-        * @endif
         */
        result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
-        * Removes the notification message for ongoing activity on behalf of the specified application.
+        * Removes the notification message for the ongoing activity 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
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -595,13 +566,11 @@ public:
         * @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.
         * @endif
-        * @endif
         */
        result RemoveOngoingActivityNotificationOnBehalf(const AppId& appId);
 
        /**
         * @if OSPDEPREC
-        * @if VISPARTNER
         * Removes the notification message on behalf of the specified application.
         *
         * @brief               <i> [Deprecated] </i>
@@ -609,8 +578,9 @@ public:
         * @deprecated  This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class.
         * @since                       2.0
         *
-        * @visibility  partner
-        * @privilege   %http://tizen.org/privilege/notificationmanager
+        * @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
@@ -620,7 +590,6 @@ public:
         * @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.
         * @endif
-        * @endif
         */
        result RemoveNotificationOnBehalf(const AppId& appId);