getBreakoutRoomParticipantsRaw method

  1. @experimental
DynamiteRawResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson, RoomRoomGetBreakoutRoomParticipantsHeaders> getBreakoutRoomParticipantsRaw({
  1. required String token,
  2. RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus,
  3. RoomGetBreakoutRoomParticipantsApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Get the breakout room participants for 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:

  • includeStatus Include the user statuses. Defaults to 0.
  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Breakout room participants returned
  • 400: Getting breakout room participants is not possible
  • 403: Missing permissions to get breakout room participants

See:

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson,
    RoomRoomGetBreakoutRoomParticipantsHeaders> getBreakoutRoomParticipantsRaw({
  required String token,
  RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus,
  RoomGetBreakoutRoomParticipantsApiVersion? 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) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

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

  var $includeStatus = _$jsonSerializers.serialize(
    includeStatus,
    specifiedType: const FullType(RoomGetBreakoutRoomParticipantsIncludeStatus),
  );
  $includeStatus ??= 0;
  _parameters['includeStatus'] = $includeStatus;

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

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

  final _path = _i3.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/breakout-rooms/participants{?includeStatus*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson,
      RoomRoomGetBreakoutRoomParticipantsHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(RoomGetBreakoutRoomParticipantsResponseApplicationJson),
    headersType: const FullType(RoomRoomGetBreakoutRoomParticipantsHeaders),
    serializers: _$jsonSerializers,
  );
}