Api
Source locationmrx/spoke-zone/api/Api.hpp
Provides configured access to the Spoke.Zone API.
All generated service APIs share one OpenApiClient, configured from the supplied SpokeZoneConfig. The config must have loaded successfully before construction. The client is updated when the config’s API server or token changes; those updates stop if the config is destroyed. The client and service APIs are owned by value; accordingly, this entrypoint is neither copyable nor movable.
Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
Api inline explicit | Constructs the API entrypoint using the loaded Spoke.Zone configuration. | |
Api | Deleted constructor. | |
Api& | operator= | Deleted assignment operator. |
Api | Deleted constructor. | |
Api& | operator= | Deleted assignment operator. |
AuthenticationApi& | auth inline | |
DevicesApi& | devices inline | |
DataFilesApi& | dataFiles inline | |
OtaFilesApi& | otaFiles inline |
inline explicit
Source locationmrx/spoke-zone/api/Api.hpp
Constructs the API entrypoint using the loaded Spoke.Zone configuration.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
config | const SpokeZoneConfig& | Successfully loaded Spoke.Zone configuration. |
Source locationmrx/spoke-zone/api/Api.hpp
Deleted constructor.
operator=
Section titled “operator=”Source locationmrx/spoke-zone/api/Api.hpp
Deleted assignment operator.
Source locationmrx/spoke-zone/api/Api.hpp
Deleted constructor.
operator=
Section titled “operator=”Source locationmrx/spoke-zone/api/Api.hpp
Deleted assignment operator.
inline
Source locationmrx/spoke-zone/api/Api.hpp
Returns
Section titled “Returns”The authentication API.
inline
devices
Section titled “devices”Source locationmrx/spoke-zone/api/Api.hpp
Returns
Section titled “Returns”The device API.
inline
dataFiles
Section titled “dataFiles”Source locationmrx/spoke-zone/api/Api.hpp
Returns
Section titled “Returns”The data files API.
inline
otaFiles
Section titled “otaFiles”Source locationmrx/spoke-zone/api/Api.hpp
Returns
Section titled “Returns”The OTA files API.