joinFederatedRoom method

Future<DynamiteResponse<RoomJoinFederatedRoomResponseApplicationJson, RoomRoomJoinFederatedRoomHeaders>> joinFederatedRoom({ required String token, RoomJoinFederatedRoomApiVersion? apiVersion, bool? oCSAPIRequest, RoomJoinFederatedRoomRequestApplicationJson? $body, })

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

The session id can be null only for requests from Talk < 20.

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: Federated user joined the room
• 404: Room not found

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomJoinFederatedRoomResponseApplicationJson, RoomRoomJoinFederatedRoomHeaders>>
    joinFederatedRoom({
  required String token,
  RoomJoinFederatedRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
  RoomJoinFederatedRoomRequestApplicationJson? $body,
}) async {
  final _request = $joinFederatedRoom_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 = $joinFederatedRoom_Serializer();
  return _i1.ResponseConverter<RoomJoinFederatedRoomResponseApplicationJson, RoomRoomJoinFederatedRoomHeaders>(
    _serializer,
  ).convert(_response);
}