addToFavorites method

Future<DynamiteResponse<RoomAddToFavoritesResponseApplicationJson, void>> addToFavorites({
  1. required String token,
  2. RoomAddToFavoritesApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Add a room to 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 added room to favorites

See:

Implementation

Future<_i1.DynamiteResponse<RoomAddToFavoritesResponseApplicationJson, void>> addToFavorites({
  required String token,
  RoomAddToFavoritesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $addToFavorites_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $addToFavorites_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<RoomAddToFavoritesResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}