getObjectsSharedInRoomRaw method

  1. @experimental
DynamiteRawResponse<ChatGetObjectsSharedInRoomResponseApplicationJson, ChatChatGetObjectsSharedInRoomHeaders> getObjectsSharedInRoomRaw({
  1. required String objectType,
  2. required String token,
  3. int? lastKnownMessageId,
  4. int? limit,
  5. ChatGetObjectsSharedInRoomApiVersion? apiVersion,
  6. bool? oCSAPIRequest,
})

Get objects that are shared in the 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:

  • objectType Type of the objects.
  • lastKnownMessageId ID of the last known message. Defaults to 0.
  • limit Maximum number of objects. Defaults to 100.
  • 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 returned

See:

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<ChatGetObjectsSharedInRoomResponseApplicationJson, ChatChatGetObjectsSharedInRoomHeaders>
    getObjectsSharedInRoomRaw({
  required String objectType,
  required String token,
  int? lastKnownMessageId,
  int? limit,
  ChatGetObjectsSharedInRoomApiVersion? 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 $objectType = _$jsonSerializers.serialize(objectType, specifiedType: const FullType(String));
  _parameters['objectType'] = $objectType;

  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 $lastKnownMessageId = _$jsonSerializers.serialize(lastKnownMessageId, specifiedType: const FullType(int));
  $lastKnownMessageId ??= 0;
  _parameters['lastKnownMessageId'] = $lastKnownMessageId;

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

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ChatGetObjectsSharedInRoomApiVersion));
  $apiVersion ??= 'v1';
  _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}/chat/{token}/share{?objectType*,lastKnownMessageId*,limit*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<ChatGetObjectsSharedInRoomResponseApplicationJson,
      ChatChatGetObjectsSharedInRoomHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(ChatGetObjectsSharedInRoomResponseApplicationJson),
    headersType: const FullType(ChatChatGetObjectsSharedInRoomHeaders),
    serializers: _$jsonSerializers,
  );
}