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

Detailed information for a group creation. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  CreationStatus_t {
  csUndefined = 0 , csOk = 1 , csNoJson = -1 , csConflictingRpListAndCluster = -2 ,
  csAlreadyExists = -3 , csInvalidConfiguration = -4 , csInvalidJson = -5 , csCryptoFailure = -6 ,
  csAudioInputFailure = -7 , csAudioOutputFailure = -8 , csUnsupportedAudioEncoder = -9 , csNoLicense = -10 ,
  csInvalidTransport = -11
}
 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 group.
 
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 group creation.

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

Definition at line 9940 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ CreationStatus_t

Creation status.

Enumerator
csUndefined 

Undefined.

csOk 

Creation OK.

csNoJson 

Configuration JSON is empty.

csConflictingRpListAndCluster 

Conflicting Rallypoint list and cluster.

csAlreadyExists 

Group already exists.

csInvalidConfiguration 

Invalid configuration.

csInvalidJson 

Invalid JSON.

csCryptoFailure 

Crypto failure.

csAudioInputFailure 

Audio input failure.

csAudioOutputFailure 

Audio input failure.

csUnsupportedAudioEncoder 

Unsupported audio encoder.

csNoLicense 

Insufficient group licenses available.

csInvalidTransport 

The transport type is invalid.

Definition at line 9948 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ GroupCreationDetail()

AppConfigurationObjects::GroupCreationDetail::GroupCreationDetail ( )
inline

Definition at line 9996 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::GroupCreationDetail::clear ( )
inline

Definition at line 10001 of file ConfigurationObjects.h.

Member Data Documentation

◆ id

std::string AppConfigurationObjects::GroupCreationDetail::id

ID of the group.

Definition at line 9991 of file ConfigurationObjects.h.

◆ status

CreationStatus_t AppConfigurationObjects::GroupCreationDetail::status

The creation status.

Definition at line 9994 of file ConfigurationObjects.h.


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