leaveFederatedRoom method

Future<DynamiteResponse<RoomLeaveFederatedRoomResponseApplicationJson, void>> leaveFederatedRoom({
  1. required String token,
  2. required String sessionId,
  3. RoomLeaveFederatedRoomApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Leave room on the host server using the session id of the federated user.

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 Token of the room.
  • sessionId Federated session id to leave with.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Successfully left the room
  • 404: Room not found (non-federation request)

See:

Implementation

Future<_i1.DynamiteResponse<RoomLeaveFederatedRoomResponseApplicationJson, void>> leaveFederatedRoom({
  required String token,
  required String sessionId,
  RoomLeaveFederatedRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $leaveFederatedRoom_Request(
    token: token,
    sessionId: sessionId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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