#include <utils/FluidHubAPIClient.hpp>
openfluid::utils::FluidHubAPIClient::FluidHubAPIClient |
( |
| ) |
|
|
inline |
openfluid::utils::FluidHubAPIClient::~FluidHubAPIClient |
( |
| ) |
|
|
inline |
Connects to the FluidHub given by the URL
- Parameters
-
[in] | URL | the URL of the FluidHub to connect to |
[in] | SSLConfig | the SSL configuration for the connection (if needed) |
- Returns
- true if the connection is OK, false otherwise
void openfluid::utils::FluidHubAPIClient::disconnect |
( |
| ) |
|
Disconnects from the connected FluidHub
WaresListByType_t openfluid::utils::FluidHubAPIClient::getAllAvailableWares |
( |
| ) |
const |
Returns the list of all available wares in the current FluidHub
- Returns
- the list of wares categorized by ware type
Returns the detailed list of all available wares in the current FluidHub
- Parameters
-
[in] | Type | the type of wares to list |
[in] | Username | Optional username used in returned git URL |
- Returns
- the detailed list of wares of the give type
QString openfluid::utils::FluidHubAPIClient::getHubAPIVersion |
( |
| ) |
const |
|
inline |
Returns the API version of the current FluidHub
- Returns
- the FluidHub API version
std::set<QString> openfluid::utils::FluidHubAPIClient::getHubCapabilities |
( |
| ) |
const |
|
inline |
Returns the capabilities list of the current FluidHub ("news","wareshub", ...)
- Returns
- the FluidHub capabilities
QString openfluid::utils::FluidHubAPIClient::getHubName |
( |
| ) |
const |
|
inline |
Returns the name of the current FluidHub
- Returns
- the FluidHub name
QString openfluid::utils::FluidHubAPIClient::getHubStatus |
( |
| ) |
const |
|
inline |
Returns the status of the current FluidHub
- Returns
- the FluidHub status
QString openfluid::utils::FluidHubAPIClient::getHubURL |
( |
| ) |
const |
|
inline |
Returns the URL of the current FluidHub
- Returns
- the FluidHub URL
QString openfluid::utils::FluidHubAPIClient::getNews |
( |
const QString & |
Lang = "" | ) |
const |
Returns the news as an RSS string content
- Parameters
-
[in] | Lang | Optional lang for news content |
- Returns
- the RSS content
bool openfluid::utils::FluidHubAPIClient::isConnected |
( |
| ) |
const |
|
inline |
Returns true if the client is currently connected
- Returns
- true if connected
The documentation for this class was generated from the following file: