$get method

Future<DynamiteResponse<AutoCompleteGetResponseApplicationJson, void>> $get({ required String search, String? itemType, String? itemId, String? sorter, BuiltList<int>? shareTypes, int? limit, bool? oCSAPIRequest, })

Autocomplete a query.

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:

• search Text to search for.
• itemType Type of the items to search for.
• itemId ID of the items to search for.
• sorter can be piped, top prio first, e.g.: "commenters|share-recipients".
• shareTypes Types of shares to search for. Defaults to [].
• limit Maximum number of results to return. Defaults to 10.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Autocomplete results returned

See:

• $$get_Request for the request send by this method.
• $$get_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<AutoCompleteGetResponseApplicationJson, void>> $get({
  required String search,
  String? itemType,
  String? itemId,
  String? sorter,
  BuiltList<int>? shareTypes,
  int? limit,
  bool? oCSAPIRequest,
}) async {
  final _request = $$get_Request(
    search: search,
    itemType: itemType,
    itemId: itemId,
    sorter: sorter,
    shareTypes: shareTypes,
    limit: limit,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $$get_Serializer();
  return _i1.ResponseConverter<AutoCompleteGetResponseApplicationJson, void>(_serializer).convert(_response);
}