inc/FNetWifiWifiDirectGroupMember.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    FNetWifiWifiDirectGroupMember.h
  19  * @brief   This is the header file for the %WifiDirectGroupMember class.
  20  *
  21  * This header file contains the declarations of the %WifiDirectGroupMember class.
  22  */
  23 #ifndef _FNET_WIFI_WIFI_DIRECT_GROUP_MEMBER_H_
  24 #define _FNET_WIFI_WIFI_DIRECT_GROUP_MEMBER_H_
  25
  26 #include <FBaseObject.h>
  27 #include <FNetWifiWifiTypes.h>
  28
  29 namespace Tizen { namespace Net { namespace Wifi
  30 {
  31 class WifiDirectGroupMemberImpl;
  32 /**
  33  * @if OSPDEPREC
  34  * @class       WifiDirectGroupMember
  35  * @brief       <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group member.
  36  * @deprecated  This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with
  37  *              ease irrespective of the role (for example, group owner, group client, and so on). @n
  38  *              Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to
  39  *              use these APIs.
  40  *
  41  * @since       2.0
  42  *
  43  * The %WifiDirectGroupMember class provides methods for the Wi-Fi Direct group member.
  44  * @endif
  45  */
  46
  47 class _OSP_EXPORT_ WifiDirectGroupMember
  48         : public Tizen::Base::Object
  49 {
  50 public:
  51         /**
  52          * @if OSPDEPREC
  53          * This destructor overrides Tizen::Base::Object::~Object().
  54          *
  55          * @brief       <i> [Deprecated] </i>
  56          * @deprecated  This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
  57          *              with ease irrespective of the role (for example, group owner, group client, and so on). @n
  58          *              Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
  59          *              to use these APIs.
  60          * @since       2.0
  61          * @endif
  62          */
  63         virtual ~WifiDirectGroupMember(void){}
  64
  65         /**
  66          * @if OSPDEPREC
  67          * Gets the type of the Wi-Fi Direct group member.
  68          *
  69          * @brief       <i> [Deprecated] </i>
  70          * @deprecated  This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
  71          *              with ease irrespective of the role (for example, group owner, group client, and so on). @n
  72          *              Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
  73          *              to use these APIs.
  74          *
  75          * @since       2.0
  76          *
  77          * @return      The type of the Wi-Fi Direct group member
  78          * @endif
  79          */
  80         WifiDirectGroupMemberType GetGroupMemberType(void) const;
  81
  82 protected:
  83         /**
  84          * This is the default constructor for this class.
  85          *
  86          * @since       2.0
  87          */
  88         WifiDirectGroupMember(void);
  89
  90         /**
  91          * This is the copy constructor for the %WifiDirectGroupMember class. @n
  92          * Do @b not use directly.
  93          *
  94          * @since       2.0
  95          *
  96          * @param[in]   value       An instance of %WifiDirectGroupMember
  97          */
  98         WifiDirectGroupMember(const WifiDirectGroupMember& value);
  99
 100         /**
 101          * Assigns the value of the specified instance to the current instance of %WifiDirectGroupMember. @n
 102          * Do @b not use directly.
 103          *
 104          * @since       2.0
 105          *
 106          * @param[in]   rhs         An instance of %WifiDirectGroupMember
 107          */
 108         WifiDirectGroupMember& operator =(const WifiDirectGroupMember& rhs);
 109
 110         //
 111         // This method is for internal use only. Using this method can cause behavioral, security-related,
 112         // and consistency-related issues in the application.
 113         //
 114         // This method is reserved and may change its name at any time without prior notice.
 115         //
 116         // @since       2.0
 117         //
 118         virtual void WifiDirectGroupMember_Reserved1(void){ }
 119
 120         //
 121         // This method is for internal use only. Using this method can cause behavioral, security-related,
 122         // and consistency-related issues in the application.
 123         //
 124         // This method is reserved and may change its name at any time without prior notice.
 125         //
 126         // @since       2.0
 127         //
 128         virtual void WifiDirectGroupMember_Reserved2(void){ }
 129
 130         //
 131         // This method is for internal use only. Using this method can cause behavioral, security-related,
 132         // and consistency-related issues in the application.
 133         //
 134         // This method is reserved and may change its name at any time without prior notice.
 135         //
 136         // @since       2.0
 137         //
 138         virtual void WifiDirectGroupMember_Reserved3(void){ }
 139
 140         //
 141         // This method is for internal use only. Using this method can cause behavioral, security-related,
 142         // and consistency-related issues in the application.
 143         //
 144         // This method is reserved and may change its name at any time without prior notice.
 145         //
 146         // @since       2.0
 147         //
 148         virtual void WifiDirectGroupMember_Reserved4(void){ }
 149
 150         //
 151         // This method is for internal use only. Using this method can cause behavioral, security-related,
 152         // and consistency-related issues in the application.
 153         //
 154         // This method is reserved and may change its name at any time without prior notice.
 155         //
 156         // @since       2.0
 157         //
 158         virtual void WifiDirectGroupMember_Reserved5(void){ }
 159
 160 protected:
 161         WifiDirectGroupMemberType _groupMemberType;
 162         WifiDirectGroupMemberImpl* _pWifiDirectGroupMemberImpl;
 163
 164         friend class WifiDirectGroupMemberImpl;
 165 }; // WifiDirectGroupMember
 166
 167 } } } // Tizen::Net::Wifi
 168 #endif // _FNET_WIFI_WIFI_DIRECT_GROUP_MEMBER_H_