|
OpenCPN Partial API docs
|
Public Types | |
| enum class | Cmd { Ping , Object , CheckWrite , ListRoutes , ActivateRoute , ReverseRoute , PluginMsg } |
Static Public Member Functions | |
| static RestIoEvtData | CreateCmdData (const std::string &key, const std::string &src, const std::string &gpx_data, bool _force, bool _activate) |
| Create a Cmd::Object instance. | |
| static RestIoEvtData | CreatePingData (const std::string &key, const std::string &src) |
| Create a Cmd::Ping instance: | |
| static RestIoEvtData | CreateChkWriteData (const std::string &key, const std::string &src, const std::string &guid) |
| Create a Cmd::CheckWrite instance. | |
| static RestIoEvtData | CreateListRoutesData (const std::string &key, const std::string &src) |
| Create a Cmd::ListRoutes instance. | |
| static RestIoEvtData | CreateActivateRouteData (const std::string &key, const std::string &src, const std::string &guid) |
| static RestIoEvtData | CreatePluginMsgData (const std::string &key, const std::string &src, const std::string &id, const std::string &msg) |
| static RestIoEvtData | CreateReverseRouteData (const std::string &key, const std::string &src, const std::string &guid) |
Public Attributes | |
| enum RestIoEvtData::Cmd | cmd |
| const std::string | api_key |
| Rest API parameter apikey. | |
| const std::string | source |
| Rest API parameter source. | |
| const std::string | id |
| rest API parameter id for PluginMsg. | |
| const bool | force |
| rest API parameter force | |
| const bool | activate |
| rest API parameter activate | |
| const std::string | payload |
| GPX data for Cmd::Object, Guid for Cmd::CheckWrite, Activate, Reverse. | |
Definition at line 66 of file rest_server.cpp.