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:

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

Implementation

Future<_i1.DynamiteResponse<RoomAddToFavoritesResponseApplicationJson, void>> addToFavorites({
  required String token,
  RoomAddToFavoritesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = addToFavoritesRaw(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}