IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::EnrolleeConf Class Reference

This provide a set of getter APIs from received response for getConfiguration(). More...

Public Member Functions

 EnrolleeConf (const OCRepresentation &rep)
 Constructor The expected OCRepresentation is one for collection resource and has several child OCRepresentation object corresponding to WiFiConf, DevConf, and CoapCloudConf resources' representations. More...
 
 EnrolleeConf (const OCRepresentation &rep, const int OCFServerVersion)
 
 EnrolleeConf (const EnrolleeConf &enrolleeConf)
 
 EnrolleeConf (const EnrolleeConf &&enrolleeConf)
 
std::string getDeviceName () const
 Get a device name of Enrollee. More...
 
vector< WIFI_MODEgetWiFiModes () const
 Get a set of WiFi supported modes of Enrollee. More...
 
WIFI_FREQ getWiFiFreq () const
 Get a WiFi supported frequency of Enrollee. More...
 
vector< std::string > getSupportedWiFiAuthTypes () const
 Get supported WiFi authentication types by the Enrollee. More...
 
vector< std::string > getSupportedWiFiEncTypes () const
 Get supported WiFi encryption types by the Enrollee. More...
 
ProvStatus getProvStatus () const
 Get a provisioning status property of Enrollee. More...
 
ESErrorCode getLastErrCode () const
 Get a last error code property of Enrollee. More...
 
bool isCloudAccessible () const
 Get an accessibility to cloud server of an Enrollee. More...
 
const OCRepresentationgetEasySetupRep () const
 Get OCRepresentation object. More...
 
int getOCFSpecVersion () const
 Get OCF Specification Version. More...
 

Protected Attributes

OCRepresentation m_EasySetupRep
 
int m_OCFServerVersion
 

Detailed Description

This provide a set of getter APIs from received response for getConfiguration().

Received information includes a device name, WiFi supported mode, and frequency. Additionally, you can know if Enrollee can be access to cloud server with this object.

Constructor & Destructor Documentation

OIC::Service::EnrolleeConf::EnrolleeConf ( const OCRepresentation rep)
inline

Constructor The expected OCRepresentation is one for collection resource and has several child OCRepresentation object corresponding to WiFiConf, DevConf, and CoapCloudConf resources' representations.

OIC::Service::EnrolleeConf::EnrolleeConf ( const OCRepresentation rep,
const int  OCFServerVersion 
)
inline
OIC::Service::EnrolleeConf::EnrolleeConf ( const EnrolleeConf enrolleeConf)
inline
OIC::Service::EnrolleeConf::EnrolleeConf ( const EnrolleeConf &&  enrolleeConf)
inline

Member Function Documentation

std::string OIC::Service::EnrolleeConf::getDeviceName ( ) const
inline

Get a device name of Enrollee.

It is Device's human-friendly name like device model name.

Returns
a device name of Enrollee
const OCRepresentation& OIC::Service::EnrolleeConf::getEasySetupRep ( ) const
inline

Get OCRepresentation object.

Returns
OCRepresentation object
ESErrorCode OIC::Service::EnrolleeConf::getLastErrCode ( ) const
inline

Get a last error code property of Enrollee.

Returns
a last error code property of Enrollee.
int OIC::Service::EnrolleeConf::getOCFSpecVersion ( ) const
inline

Get OCF Specification Version.

Returns
version value
ProvStatus OIC::Service::EnrolleeConf::getProvStatus ( ) const
inline

Get a provisioning status property of Enrollee.

Returns
a provisioning status property of Enrollee
vector<std::string> OIC::Service::EnrolleeConf::getSupportedWiFiAuthTypes ( ) const
inline

Get supported WiFi authentication types by the Enrollee.

Returns
a set of supported WiFi authentication types of Enrollee.
See Also
WIFI_FREQ
vector<std::string> OIC::Service::EnrolleeConf::getSupportedWiFiEncTypes ( ) const
inline

Get supported WiFi encryption types by the Enrollee.

Returns
a set of supported WiFi encryption types of Enrollee.
See Also
WIFI_MODE
WIFI_FREQ OIC::Service::EnrolleeConf::getWiFiFreq ( ) const
inline

Get a WiFi supported frequency of Enrollee.

Returns
a WiFi supported frequency of Enrollee
See Also
WIFI_FREQ
vector<WIFI_MODE> OIC::Service::EnrolleeConf::getWiFiModes ( ) const
inline

Get a set of WiFi supported modes of Enrollee.

Returns
a set of WiFi supported modes of Enrollee
See Also
WIFI_MODE
bool OIC::Service::EnrolleeConf::isCloudAccessible ( ) const
inline

Get an accessibility to cloud server of an Enrollee.

Returns
an accessibility to cloud server of an Enrollee

Member Data Documentation

OCRepresentation OIC::Service::EnrolleeConf::m_EasySetupRep
protected
int OIC::Service::EnrolleeConf::m_OCFServerVersion
protected

The documentation for this class was generated from the following file: