CompletionResults class

Constructors

CompletionResults(String id, int replacementOffset, int replacementLength, List<CompletionSuggestion> results, bool isLast, {String? libraryFile, List<IncludedSuggestionSet>? includedSuggestionSets, List<String>? includedElementKinds, List<IncludedSuggestionRelevanceTag>? includedSuggestionRelevanceTags})

Properties

hashCode → int
The hash code for this object.
no setterinherited
id → String
The id associated with the completion.
final
includedElementKinds → List<String>?
The client is expected to check this list against the ElementKind sent in IncludedSuggestionSet to decide whether or not these symbols should should be presented to the user.
final
includedSuggestionRelevanceTags → List<IncludedSuggestionRelevanceTag>?
The client is expected to check this list against the values of the field relevanceTags of AvailableSuggestion to decide if the suggestion should be given a different relevance than the IncludedSuggestionSet that contains it. This might be used for example to give higher relevance to suggestions of matching types.
final
includedSuggestionSets → List<IncludedSuggestionSet>?
References to AvailableSuggestionSet objects previously sent to the client. The client can include applicable names from the referenced library in code completion suggestions.
final
isLast → bool
True if this is that last set of results that will be returned for the indicated completion.
final
libraryFile → String?
The library file that contains the file where completion was requested. The client might use it for example together with the existingImports notification to filter out available suggestions. If there were changes to existing imports in the library, the corresponding existingImports notification will be sent before the completion notification.
final
replacementLength → int
The length of the text to be replaced if the remainder of the identifier containing the cursor is to be replaced when the suggestion is applied (that is, the number of characters in the existing identifier).
final
replacementOffset → int
The offset of the start of the text to be replaced. This will be different than the offset used to request the completion suggestions if there was a portion of an identifier before the original offset. In particular, the replacementOffset will be the offset of the beginning of said identifier.
final
results → List<CompletionSuggestion>
The completion suggestions being reported. The notification contains all possible completions at the requested cursor position, even those that do not match the characters the user has already typed. This allows the client to respond to further keystrokes from the user without having to make additional requests.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

parse(Map m) → CompletionResults