Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::Connectivity Class Reference

Connectivity Information used as part of the PresenceDescriptor. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

void clear ()
 
virtual void initForDocumenting ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

int type
 Is the type of connectivity the device has to the network.
 
int strength
 Is the strength of the connection connection as reported by the OS - usually in dbm.
 
int rating
 Is the quality of the network connection as reported by the OS - OS dependent.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Connectivity Information used as part of the PresenceDescriptor.

Helper C++ class to serialize and de-serialize Connectivity JSON

Example JSON:

{
"rating": 3,
"strength": 2,
"type": 1
}
See also
PresenceDescriptor

Definition at line 1693 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Connectivity()

AppConfigurationObjects::Connectivity::Connectivity ( )
inline

Definition at line 1720 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Connectivity::clear ( )
inline

Definition at line 1725 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::Connectivity::initForDocumenting ( )
inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1732 of file ConfigurationObjects.h.

Member Data Documentation

◆ rating

int AppConfigurationObjects::Connectivity::rating

Is the quality of the network connection as reported by the OS - OS dependent.

Definition at line 1718 of file ConfigurationObjects.h.

◆ strength

int AppConfigurationObjects::Connectivity::strength

Is the strength of the connection connection as reported by the OS - usually in dbm.

Definition at line 1715 of file ConfigurationObjects.h.

◆ type

int AppConfigurationObjects::Connectivity::type

Is the type of connectivity the device has to the network.

Valid values are

Value Description
0 Undefined
1 Wired
2 Wireless WiFi
3 Wireless Cellular

Definition at line 1712 of file ConfigurationObjects.h.


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