$getParticipants_Request method
- @experimental
- required String token,
- RoomGetParticipantsIncludeStatus? includeStatus,
- RoomGetParticipantsApiVersion? apiVersion,
- bool? oCSAPIRequest,
Get a list of participants for a room.
Returns a DynamiteRequest
backing the getParticipants operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
includeStatus
Include the user statuses. Defaults to0
.apiVersion
Defaults to"v4"
.token
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Participants returned
- 403: Missing permissions for getting participants
See:
- getParticipants for a method executing this request and parsing the response.
- $getParticipants_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getParticipants_Request({
required String token,
RoomGetParticipantsIncludeStatus? includeStatus,
RoomGetParticipantsApiVersion? 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 $includeStatus =
_$jsonSerializers.serialize(includeStatus, specifiedType: const FullType(RoomGetParticipantsIncludeStatus));
$includeStatus ??= 0;
_parameters['includeStatus'] = $includeStatus;
var $apiVersion =
_$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomGetParticipantsApiVersion));
$apiVersion ??= 'v4';
_parameters['apiVersion'] = $apiVersion;
final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants{?includeStatus*}')
.expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('get', _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;
}