listCommandAutocompleteSuggestions method

Future<Response<BuiltList<AutocompleteSuggestion>>> listCommandAutocompleteSuggestions({ required String teamId, required String userInput, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, })

List commands' autocomplete data List commands' autocomplete data for the team. ##### Permissions `view_team` for the team. Minimum server version: 5.24

Parameters:

• teamId - Team GUID
• userInput - String inputted by the user.
• cancelToken - A CancelToken that can be used to cancel the operation
• headers - Can be used to add additional headers to the request
• extras - Can be used to add flags to the request
• validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
• onSendProgress - A ProgressCallback that can be used to get the send progress
• onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a BuiltList<AutocompleteSuggestion> as data Throws DioError if API call or serialization fails

Implementation

Future<Response<BuiltList<AutocompleteSuggestion>>> listCommandAutocompleteSuggestions({
  required String teamId,
  required String userInput,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/teams/{team_id}/commands/autocomplete_suggestions'.replaceAll('{' r'team_id' '}', teamId.toString());
  final _options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'http',
          'scheme': 'bearer',
          'name': 'bearerAuth',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final _queryParameters = <String, dynamic>{
    r'user_input': encodeQueryParameter(_serializers, userInput, const FullType(String)),
  };

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    queryParameters: _queryParameters,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  BuiltList<AutocompleteSuggestion> _responseData;

  try {
    const _responseType = FullType(BuiltList, [FullType(AutocompleteSuggestion)]);
    _responseData = _serializers.deserialize(
      _response.data!,
      specifiedType: _responseType,
    ) as BuiltList<AutocompleteSuggestion>;

  } catch (error, stackTrace) {
    throw DioError(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioErrorType.other,
      error: error,
    )..stackTrace = stackTrace;
  }

  return Response<BuiltList<AutocompleteSuggestion>>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}