$joinRoom_Request method
- @experimental
- required String token,
- String? password,
- RoomJoinRoomForce? force,
- RoomJoinRoomApiVersion? apiVersion,
- bool? oCSAPIRequest,
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:
password
Password of the room. Defaults to""
.force
Create a new session if necessary. Defaults to1
.apiVersion
Defaults to"v4"
.token
Token of the room.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
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,
String? password,
RoomJoinRoomForce? force,
RoomJoinRoomApiVersion? apiVersion,
bool? oCSAPIRequest,
}) {
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 $password = _$jsonSerializers.serialize(password, specifiedType: const FullType(String));
$password ??= '';
_parameters['password'] = $password;
var $force = _$jsonSerializers.serialize(force, specifiedType: const FullType(RoomJoinRoomForce));
$force ??= 1;
_parameters['force'] = $force;
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{?password*,force*}')
.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 = _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);
return _request;
}