renameRoom method

Future<DynamiteResponse<RoomRenameRoomResponseApplicationJson, void>> renameRoom({
  1. required String roomName,
  2. required String token,
  3. RoomRenameRoomApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Rename a room.

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:

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

Status codes:

  • 200: Room renamed successfully
  • 400: Renaming room is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomRenameRoomResponseApplicationJson, void>> renameRoom({
  required String roomName,
  required String token,
  RoomRenameRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = renameRoomRaw(
    roomName: roomName,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}