removeSelfFromRoom method

Future<DynamiteResponse<RoomRemoveSelfFromRoomResponseApplicationJson, void>> removeSelfFromRoom({
  1. required String token,
  2. RoomRemoveSelfFromRoomApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Remove the current user from 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:

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

Status codes:

  • 200: Participant removed successfully
  • 400: Removing participant is not possible
  • 404: Participant not found

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomRemoveSelfFromRoomResponseApplicationJson, void>> removeSelfFromRoom({
  required String token,
  RoomRemoveSelfFromRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = removeSelfFromRoomRaw(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}