Merge from 2.2

[platform/framework/native/telephony.git] / inc / FTelNetworkStatus.h

diff --git a/inc/FTelNetworkStatus.h b/inc/FTelNetworkStatus.h
index 8bbae70..0b7b450 100755 (executable)
--- a/inc/FTelNetworkStatus.h
+++ b/inc/FTelNetworkStatus.h
@@ -31,44 +31,69 @@ class _NetworkStatusImpl;
 
 /**
  * @class      NetworkStatus`
- * @brief      This class provides status information of the current network.
+ * @brief      This class provides the status information of the current network.
  *
  * @since      2.0
  *
- * The %NetworkStatus class provides methods to get status information of the current network, such as the roaming status, whether call service is available or not, and whether data service is available or not.
+ * The %NetworkStatus class provides methods to obtain the status information of the current network, such as the roaming status, whether the call service is available or not, 
+ * and whether the data service is available or not.
  *
- * The following example demonstrates how to use the %NetworkStatus class to get the network status information.
+ * The following example demonstrates how to use the %NetworkStatus class to obtain the network status information.
  *
  * @code
  *
- *     result
- *     MyClass::GetNetworkStatus(void)
- *     {
- *             NetworkStatus networkStatus;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             NetworkManager* pNetworkManager = new NetworkManager();
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
  *
- *             result r = pNetworkManager->Construct(this);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *   class MyClass
+ *      : public Object
+ *      , public ITelephonyNetworkEventListener
+ *   {
+ *     public:
+ *      MyClass(void) {}
+ *      ~MyClass(void) {}
  *
- *             r = pNetworkManager->GetNetworkStatus(networkStatus);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *      // ITelephonyNetworkEventListener
+ *      void OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus);
  *
- *             bool isCallAvail = networkStatus.IsCallServiceAvailable();
- *             bool isDataAvail = networkStatus.IsDataServiceAvailable();
- *             bool isRoaming = networkStatus.IsRoaming();
+ *      void GetNetworkStatus (void);
+ *   };
+ *   void
+ *   MyClass::OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus)
+ *   {
+ *     //Do something.
+ *   }
  *
- *             delete pNetworkManager;
- *             return E_SUCCESS;
- *     }
+ *   void
+ *   MyClass::GetNetworkStatus(void)
+ *   {
+ *      NetworkStatus networkStatus;
+ *
+ *      NetworkManager* pNetworkManager = new (std::nothrow) NetworkManager();
+ *      result r = pNetworkManager->Construct(this);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      r = pNetworkManager->GetNetworkStatus(networkStatus);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      bool isCallAvailable = networkStatus.IsCallServiceAvailable();
+ *      bool isDataAvailable = networkStatus.IsDataServiceAvailable();
+ *      bool isRoaming = networkStatus.IsRoaming();
+ *
+ *      delete pNetworkManager;
+ *      return;
+ *   }
  *
  * @endcode
  */
@@ -91,44 +116,50 @@ public:
        virtual ~NetworkStatus(void);
 
        /**
-     * Checks whether the current network is in roaming status or not.
+     * Checks whether the current network is in the roaming status or not.
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
      *
-     * @return @c true if the current network is in roaming status, @n
-     *                  else @c false
-     * @exception      E_SUCCESS       The method is successful.
+     * @return         @c true if the current network is in the roaming status, @n
+     *              else @c false
+     * @exception      E_SUCCESS                       The method is successful.
      * @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.
      */
        bool IsRoaming(void) const;
 
     /**
-     * Checks whether call service is available or not.
+     * Checks whether the call service is available or not.
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
      *
-     * @return @c true if call service is available, @n
-     *          else @c false
-     * @exception      E_SUCCESS       The method is successful.
+     * @return         @c true if the call service is available, @n
+     *                 else @c false
+     * @exception      E_SUCCESS                       The method is successful.
      * @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.
      */
        bool IsCallServiceAvailable(void) const;
 
        /**
-     * Checks whether data service is available or not.
+     * Checks whether the data service is available or not.
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
      *
-     * @return @c true if data service is available, @n
-     *          else @c false
+     * @return         @c true if the data service is available, @n
+     *                 else @c false
      * @exception      E_SUCCESS       The method is successful.
      * @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.