$joinRoom_Request method

@experimental Request $joinRoom_Request({ required String token, RoomJoinRoomApiVersion? apiVersion, bool? oCSAPIRequest, RoomJoinRoomRequestApplicationJson? $body, })

Join a room.

Returns a DynamiteRequest backing the joinRoom operation. 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 for a method executing this request and parsing the response.
• $joinRoom_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $joinRoom_Request({
  required String token,
  RoomJoinRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
  RoomJoinRoomRequestApplicationJson? $body,
}) {
  final _parameters = <String, Object?>{};
  final __token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    __token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = __token;

  var __apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomJoinRoomApiVersion));
  __apiVersion ??= 'v4';
  _parameters['apiVersion'] = __apiVersion;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/active')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = $body != null
      ? json.encode(
          _$jsonSerializers.serialize($body, specifiedType: const FullType(RoomJoinRoomRequestApplicationJson)),
        )
      : json.encode(
          _$jsonSerializers.serialize(
            RoomJoinRoomRequestApplicationJson(),
            specifiedType: const FullType(RoomJoinRoomRequestApplicationJson),
          ),
        );
  return _request;
}