removeFromFavorites method

Future<DynamiteResponse<RoomRemoveFromFavoritesResponseApplicationJson, void>> removeFromFavorites({ required String token, RoomRemoveFromFavoritesApiVersion? apiVersion, bool? oCSAPIRequest, })

Remove a room from the favorites.

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:

• apiVersion Defaults to "v4".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Successfully removed room from favorites

See:

• $removeFromFavorites_Request for the request send by this method.
• $removeFromFavorites_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RoomRemoveFromFavoritesResponseApplicationJson, void>> removeFromFavorites({
  required String token,
  RoomRemoveFromFavoritesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $removeFromFavorites_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $removeFromFavorites_Serializer();
  return _i1.ResponseConverter<RoomRemoveFromFavoritesResponseApplicationJson, void>(_serializer).convert(_response);
}