inc/FNetWifiWifiNetAccountInfo.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file    FNetWifiWifiNetAccountInfo.h
  19  * @brief   This is the header file for the %WifiNetAccountInfo class.
  20  *
  21  * This header file contains the declarations of the %WifiNetAccountInfo class.
  22  */
  23 #ifndef _FNET_WIFI_WIFI_NET_ACCOUNT_INFO_H_
  24 #define _FNET_WIFI_WIFI_NET_ACCOUNT_INFO_H_
  25
  26 #include <FBaseObject.h>
  27 #include <FNetNetAccountInfo.h>
  28 #include <FNetWifiWifiSecurityInfo.h>
  29
  30 namespace Tizen { namespace Net { namespace Wifi
  31 {
  32 class _WifiNetAccountInfoImpl;
  33 class WifiSecurityInfo;
  34
  35 /**
  36  * @class   WifiNetAccountInfo
  37  * @brief   This class provides the functionality to control the WLAN network accounts.
  38  *
  39  * @since   2.0
  40  *
  41  * The %WifiNetAccountInfo class provides the functionality to control the WLAN network accounts and the basic network accounts.
  42  * This class inherits the NetAccountInfo class.
  43  *
  44  * For more information on the class features, see
  45  * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
  46  */
  47
  48 class _OSP_EXPORT_ WifiNetAccountInfo
  49         : public Tizen::Net::NetAccountInfo
  50 {
  51 public:
  52         /**
  53          * This is the destructor for this class.
  54          *
  55          *
  56          * @since       2.0
  57          */
  58         virtual ~WifiNetAccountInfo(void);
  59
  60         /**
  61          * Gets the BSSID of this account.
  62          *
  63          * @since       2.0
  64          *
  65          * @return      The BSS ID in the form '00-00-00-00-00-00'
  66          * @remarks     This operation is not yet supported.
  67          */
  68         Tizen::Base::String GetBssId(void) const;
  69
  70         /**
  71          * Gets the SSID of this account.
  72          *
  73          * @since       2.0
  74          *
  75          * @return      The SSID of this account
  76          */
  77         Tizen::Base::String GetSsid(void) const;
  78
  79         /**
  80          * Gets the type of BSS of this account.
  81          *
  82          * @since       2.0
  83          *
  84          * @return      The type of BSS of this account
  85          */
  86         WifiBssType GetBssType(void) const;
  87
  88         /**
  89          * Gets the security information of this account.
  90          *
  91          * @since       2.0
  92          *
  93          * @return      The authentication and encryption type of this account
  94          */
  95         const WifiSecurityInfo* GetSecurityInfo(void) const;
  96
  97         /**
  98          * Gets the radio channel of this account. @n
  99          * If this value is not set, the default value is WIFI_RADIO_CHANNEL_UNKNOWN.
 100          *
 101          * @since       2.0
 102          *
 103          * @return      The radio channel of this account
 104          * @remarks     This operation is not yet supported.
 105          */
 106         WifiRadioChannel GetRadioChannel(void) const;
 107
 108         /**
 109          * Checks whether the specified instance of %WifiNetAccountInfo equals the current instance.
 110          *
 111          * @since       2.0
 112          *
 113          * @return      @c true if the specified instance equals the current instance, @n
 114          *              else @c false
 115          * @param[in]   obj An instance of %WifiNetAccountInfo
 116          * @remarks     This method returns @c false if the specified object is not %WifiNetAccountInfo.
 117          */
 118         virtual bool Equals(const Tizen::Base::Object& obj) const;
 119
 120         /**
 121          * Gets the hash value of the current instance.
 122          *
 123          * @since       2.0
 124          *
 125          * @return      The hash value of the current instance
 126          */
 127         virtual int GetHashCode(void) const;
 128
 129 private:
 130         //
 131         // This default constructor is intentionally declared as private so that only the platform can create an instance.
 132         //
 133         WifiNetAccountInfo(void);
 134
 135         //
 136         // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
 137         //
 138         WifiNetAccountInfo(const WifiNetAccountInfo& value);
 139
 140         //
 141         // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
 142         //
 143         WifiNetAccountInfo& operator=(const WifiNetAccountInfo& rhs);
 144
 145 private:
 146         _WifiNetAccountInfoImpl* __pWifiNetAccountInfoImpl;
 147
 148         friend class _WifiNetAccountInfoImpl;
 149 }; // WifiNetAccountInfo
 150
 151 } } } // Tizen::Net::Wifi
 152 #endif // _FNET_WIFI_WIFI_NET_ACCOUNT_INFO_H_