setFavorites method

Future<DynamiteResponse<WeatherStatusSetFavoritesResponseApplicationJson, void>> setFavorites({ required BuiltList<String> favorites, 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:

• setFavoritesRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

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

  return rawResponse.future;
}