$getWidgetItemsV2_Request method

@experimental Request $getWidgetItemsV2_Request({ ContentString<BuiltMap<String, String>>? sinceIds, int? limit, BuiltList<String>? widgets, bool? oCSAPIRequest, })

Get the items for the widgets.

Only available since 27.1.

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

Parameters:

• sinceIds Array indexed by widget Ids, contains date/id from which we want the new items.
• limit Limit number of result items per widget, not more than 30 are allowed. Defaults to 7.
• widgets Limit results to specific widgets. Defaults to [].
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Widget items returned

See:

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

Implementation

@_i2.experimental
_i3.Request $getWidgetItemsV2_Request({
  ContentString<BuiltMap<String, String>>? sinceIds,
  int? limit,
  BuiltList<String>? widgets,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $sinceIds = _$jsonSerializers.serialize(
    sinceIds,
    specifiedType: const FullType(ContentString, [
      FullType(BuiltMap, [FullType(String), FullType(String)]),
    ]),
  );
  _parameters['sinceIds'] = $sinceIds;

  var $limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
  $limit ??= 7;
  _i4.checkNumber(
    $limit,
    'limit',
    maximum: 30,
    minimum: 1,
  );
  _parameters['limit'] = $limit;

  var $widgets = _$jsonSerializers.serialize(widgets, specifiedType: const FullType(BuiltList, [FullType(String)]));
  $widgets ??= const [];
  _parameters['widgets%5B%5D'] = $widgets;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/dashboard/api/v2/widget-items{?sinceIds*,limit*,widgets%5B%5D*}')
      .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,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// 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;
}