$getObjectsSharedInRoomOverview_Request method

@experimental Request $getObjectsSharedInRoomOverview_Request({ required String token, int? limit, ChatGetObjectsSharedInRoomOverviewApiVersion? apiVersion, bool? oCSAPIRequest, })

Get objects that are shared in the room overview.

Returns a DynamiteRequest backing the getObjectsSharedInRoomOverview operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• limit Maximum number of objects. Defaults to 7.
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: List of shared objects messages of each type returned

See:

• getObjectsSharedInRoomOverview for a method executing this request and parsing the response.
• $getObjectsSharedInRoomOverview_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getObjectsSharedInRoomOverview_Request({
  required String token,
  int? limit,
  ChatGetObjectsSharedInRoomOverviewApiVersion? 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 $limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
  $limit ??= 7;
  _i4.checkNumber(
    $limit,
    'limit',
    maximum: 20,
    minimum: 1,
  );
  _parameters['limit'] = $limit;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/share/overview{?limit*}')
      .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;
}