setFavorites method

Future<DynamiteResponse<WeatherStatusSetFavoritesResponseApplicationJson, void>> setFavorites({
  1. required BuiltList<String> favorites,
  2. bool? oCSAPIRequest,
})

Set favorites list.

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:

  • favorites Favorite addresses.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Favorites updated

See:

Implementation

Future<DynamiteResponse<WeatherStatusSetFavoritesResponseApplicationJson, void>> setFavorites({
  required BuiltList<String> favorites,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setFavoritesRaw(
    favorites: favorites,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}