Engage Engine API  1.243.9083
Loading...
Searching...
No Matches
AppConfigurationObjects::BridgeCreationDetail Class Reference

Detailed information for a bridge creation. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  CreationStatus_t {
  csUndefined = 0 , csOk = 1 , csNoJson = -1 , csAlreadyExists = -3 ,
  csInvalidConfiguration = -4 , csInvalidJson = -5 , csInsufficientGroups = -6 , csTooManyGroups = -7 ,
  csDuplicateGroup = -8 , csLocalLoopDetected = -9
}
 Creation status. More...
 

Public Member Functions

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

Public Attributes

std::string id
 ID of the bridge.
 
CreationStatus_t status
 The creation status.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Detailed information for a bridge creation.

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

Definition at line 9374 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ CreationStatus_t

Creation status.

Enumerator
csUndefined 

Undefined.

csOk 

Creation OK.

csNoJson 

Configuration JSON is empty.

csAlreadyExists 

Bridge already exists.

csInvalidConfiguration 

Invalid configuration.

csInvalidJson 

Invalid JSON.

csInsufficientGroups 

Insufficient groups in bridge.

csTooManyGroups 

Too many groups in bridge.

csDuplicateGroup 

Duplicate group in the same bridge.

csLocalLoopDetected 

Duplicate group in the same bridge.

Definition at line 9382 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ BridgeCreationDetail()

AppConfigurationObjects::BridgeCreationDetail::BridgeCreationDetail ( )
inline

Definition at line 9421 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::BridgeCreationDetail::clear ( )
inline

Definition at line 9426 of file ConfigurationObjects.h.

Member Data Documentation

◆ id

std::string AppConfigurationObjects::BridgeCreationDetail::id

ID of the bridge.

Definition at line 9416 of file ConfigurationObjects.h.

◆ status

CreationStatus_t AppConfigurationObjects::BridgeCreationDetail::status

The creation status.

Definition at line 9419 of file ConfigurationObjects.h.


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