joinRoom method

Future<DynamiteResponse<RoomJoinRoomResponseApplicationJson, RoomRoomJoinRoomHeaders>> joinRoom({ required String token, RoomJoinRoomApiVersion? apiVersion, bool? oCSAPIRequest, RoomJoinRoomRequestApplicationJson? $body, })

Join 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 Token of the room.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Room joined successfully
• 403: Joining room is not allowed
• 404: Room not found
• 409: Session already exists

See:

• $joinRoom_Request for the request send by this method.
• $joinRoom_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RoomJoinRoomResponseApplicationJson, RoomRoomJoinRoomHeaders>> joinRoom({
  required String token,
  RoomJoinRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
  RoomJoinRoomRequestApplicationJson? $body,
}) async {
  final _request = $joinRoom_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $joinRoom_Serializer();
  return _i1.ResponseConverter<RoomJoinRoomResponseApplicationJson, RoomRoomJoinRoomHeaders>(_serializer)
      .convert(_response);
}