joinRoomRaw method

  1. @experimental
DynamiteRawResponse<RoomJoinRoomResponseApplicationJson, void> joinRoomRaw({
  1. required String token,
  2. String? password,
  3. int? force,
  4. RoomJoinRoomApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Join a room.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • password Password of the room. Defaults to ''.
  • force Create a new session if necessary. Defaults to 1.
  • 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:

Implementation

@experimental
DynamiteRawResponse<RoomJoinRoomResponseApplicationJson, void> joinRoomRaw({
  required String token,
  String? password,
  int? force,
  RoomJoinRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $token = jsonSerializers.serialize(token, specifiedType: const FullType(String));
  dynamite_utils.checkPattern($token as String?, RegExp(r'^[a-z0-9]{4,30}$'), 'token');
  _parameters['token'] = $token;

  var $password = jsonSerializers.serialize(password, specifiedType: const FullType(String));
  $password ??= '';
  _parameters['password'] = $password;

  var $force = jsonSerializers.serialize(force, specifiedType: const FullType(int));
  $force ??= 1;
  _parameters['force'] = $force;

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

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path =
      UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/active{?password*,force*}')
          .expand(_parameters);
  return DynamiteRawResponse<RoomJoinRoomResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(RoomJoinRoomResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}