getWidgetItemsV2 method

Future<DynamiteResponse<DashboardApiGetWidgetItemsV2ResponseApplicationJson, void>> getWidgetItemsV2({
  1. ContentString<BuiltMap<String, String>>? sinceIds,
  2. int? limit,
  3. BuiltList<String>? widgets,
  4. bool? oCSAPIRequest,
})

Get the items for the widgets.

Only available since 27.1.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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. 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:

  • getWidgetItemsV2Raw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<DashboardApiGetWidgetItemsV2ResponseApplicationJson, void>> getWidgetItemsV2({
  ContentString<BuiltMap<String, String>>? sinceIds,
  int? limit,
  BuiltList<String>? widgets,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getWidgetItemsV2Raw(
    sinceIds: sinceIds,
    limit: limit,
    widgets: widgets,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}