Fawkes API Fawkes Development Version
|
PluginOpResponse representation for JSON transfer. More...
#include <PluginOpResponse.h>
Public Member Functions | |
PluginOpResponse () | |
Constructor. More... | |
PluginOpResponse (const std::string &json) | |
Constructor from JSON. More... | |
PluginOpResponse (const rapidjson::Value &v) | |
Constructor from JSON. More... | |
virtual | ~PluginOpResponse () |
Destructor. More... | |
virtual std::string | to_json (bool pretty=false) const |
Render object to JSON. More... | |
virtual void | to_json_value (rapidjson::Document &d, rapidjson::Value &v) const |
Render object to JSON. More... | |
virtual void | from_json (const std::string &json) |
Retrieve data from JSON string. More... | |
virtual void | from_json_value (const rapidjson::Value &v) |
Retrieve data from JSON string. More... | |
virtual void | validate (bool subcall=false) const |
Validate if all required fields have been set. More... | |
std::optional< std::string > | kind () const |
Get kind value. More... | |
void | set_kind (const std::string &kind) |
Set kind value. More... | |
std::optional< std::string > | apiVersion () const |
Get apiVersion value. More... | |
void | set_apiVersion (const std::string &apiVersion) |
Set apiVersion value. More... | |
std::optional< std::string > | name () const |
Get name value. More... | |
void | set_name (const std::string &name) |
Set name value. More... | |
std::optional< std::string > | state () const |
Get state value. More... | |
void | set_state (const std::string &state) |
Set state value. More... | |
std::optional< std::string > | message () const |
Get message value. More... | |
void | set_message (const std::string &message) |
Set message value. More... | |
Static Public Member Functions | |
static std::string | api_version () |
Get version of implemented API. More... | |
PluginOpResponse representation for JSON transfer.
Definition at line 26 of file PluginOpResponse.h.
PluginOpResponse::PluginOpResponse | ( | ) |
Constructor.
Definition at line 23 of file PluginOpResponse.cpp.
PluginOpResponse::PluginOpResponse | ( | const std::string & | json | ) |
Constructor from JSON.
json | JSON string to initialize from |
Definition at line 27 of file PluginOpResponse.cpp.
References from_json().
PluginOpResponse::PluginOpResponse | ( | const rapidjson::Value & | v | ) |
Constructor from JSON.
v | RapidJSON value object to initialize from. |
Definition at line 32 of file PluginOpResponse.cpp.
References from_json_value().
|
virtual |
Destructor.
Definition at line 37 of file PluginOpResponse.cpp.
|
inlinestatic |
Get version of implemented API.
Definition at line 48 of file PluginOpResponse.h.
|
inline |
Get apiVersion value.
Definition at line 109 of file PluginOpResponse.h.
Referenced by set_apiVersion().
|
virtual |
Retrieve data from JSON string.
json | JSON representation suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 96 of file PluginOpResponse.cpp.
References from_json_value().
Referenced by PluginOpResponse().
|
virtual |
Retrieve data from JSON string.
v | RapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 105 of file PluginOpResponse.cpp.
Referenced by from_json(), and PluginOpResponse().
|
inline |
Get kind value.
Definition at line 92 of file PluginOpResponse.h.
Referenced by set_kind().
|
inline |
Get message value.
Definition at line 160 of file PluginOpResponse.h.
Referenced by set_message().
|
inline |
Get name value.
Definition at line 126 of file PluginOpResponse.h.
Referenced by set_name().
|
inline |
Set apiVersion value.
apiVersion | new value |
Definition at line 118 of file PluginOpResponse.h.
References apiVersion().
|
inline |
Set kind value.
kind | new value |
Definition at line 101 of file PluginOpResponse.h.
References kind().
|
inline |
Set message value.
message | new value |
Definition at line 169 of file PluginOpResponse.h.
References message().
|
inline |
Set name value.
name | new value |
Definition at line 135 of file PluginOpResponse.h.
References name().
|
inline |
Set state value.
state | new value |
Definition at line 152 of file PluginOpResponse.h.
References state().
|
inline |
Get state value.
Definition at line 143 of file PluginOpResponse.h.
Referenced by set_state().
|
virtual |
Render object to JSON.
pretty | true to enable pretty printing (readable spacing) |
Definition at line 42 of file PluginOpResponse.cpp.
References to_json_value().
|
virtual |
Render object to JSON.
d | RapidJSON document to retrieve allocator from |
v | RapidJSON value to add data to |
Definition at line 61 of file PluginOpResponse.cpp.
Referenced by to_json().
|
virtual |
Validate if all required fields have been set.
subcall | true if this is called from another class, e.g., a sub-class or array holder. Will modify the kind of exception thrown. |
std::vector<std::string> | thrown if required information is missing and subcall is set to true. Contains a list of missing fields. |
std::runtime_error | informative message describing the missing fields |
Definition at line 125 of file PluginOpResponse.cpp.