getSignature method

  1. @experimental
Future<SignatureResult> getSignature(
  1. String? file,
  2. int? offset
)

Return the signature information associated with the given location in the given file. If the signature information for the given file has not yet been computed, or the most recently computed signature information for the given file is out of date, then the response for this request will be delayed until it has been computed. If a request is made for a file which does not exist, or which is not currently subject to analysis (e.g. because it is not associated with any analysis root specified to analysis.setAnalysisRoots), an error of type GET_SIGNATURE_INVALID_FILE will be generated. If the location given is not inside the argument list for a function (including method and constructor) invocation, then an error of type GET_SIGNATURE_INVALID_OFFSET will be generated. If the location is inside an argument list but the function is not defined or cannot be determined (such as a method invocation where the target has type 'dynamic') then an error of type GET_SIGNATURE_UNKNOWN_FUNCTION will be generated.

Implementation

@experimental
Future<SignatureResult> getSignature(String? file, int? offset) {
  final Map m = {'file': file, 'offset': offset};
  return _call('analysis.getSignature', m).then(SignatureResult.parse);
}