setMode method
Change the weather status mode. There are currently 2 modes: - ask the browser - use the user defined address.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
mode
New mode.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Weather status mode updated
See:
- $setMode_Request for the request send by this method.
- $setMode_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<WeatherStatusSetModeResponseApplicationJson, void>> setMode({
required int mode,
bool? oCSAPIRequest,
}) async {
final _request = $setMode_Request(
mode: mode,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $setMode_Serializer();
final _rawResponse =
await _i1.ResponseConverter<WeatherStatusSetModeResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}