analysis_server_lib library
A library to access the analysis server API.
AnalysisServer is the main entry-point to this library.
Classes
- AddContentOverlay
- A directive to begin overlaying the contents of a file. The supplied content will be used for analysis in place of the file contents in the filesystem.
- AnalysisAnalyzedFiles
- AnalysisClosingLabels
- AnalysisDomain
- The analysis domain contains API's related to the analysis of files.
- AnalysisError
- An indication of an error, warning, or hint that was produced by the analysis.
- AnalysisErrorFixes
- A list of fixes associated with a specific error.
- AnalysisErrors
- AnalysisFlushResults
- AnalysisFolding
- AnalysisHighlights
- AnalysisImplemented
- AnalysisInvalidate
- AnalysisOccurrences
- AnalysisOptions
- AnalysisOutline
- AnalysisOverrides
- AnalysisServer
- A class to communicate with an analysis server instance.
- AnalysisStatus
- An indication of the current state of analysis.
- AnalyticsDomain
- The analytics domain contains APIs related to reporting analytics.
- AssistsResult
- AvailableRefactoringsResult
- AvailableSuggestion
-
A partial completion suggestion that can be used in combination with info
from
completion.resultsto build completion suggestions for not yet imported library tokens. - AvailableSuggestionSet
- BulkFix
- A description of bulk fixes to a library.
- BulkFixDetail
- A description of a fix applied to a library.
- BulkFixesResult
- ChangeContentOverlay
- A directive to modify an existing file content overlay. One or more ranges of text are deleted from the old file content overlay and replaced with new text.
- ClosingLabel
- A label that is associated with a range of code that may be useful to render at the end of the range to aid code readability. For example, a constructor call that spans multiple lines may result in a closing label to allow the constructor type/name to be rendered alongside the closing parenthesis.
- CompletionAvailableSuggestions
- CompletionDomain
- The code completion domain contains commands related to getting code completion suggestions.
- CompletionExistingImports
- CompletionResults
- CompletionSuggestion
- A suggestion for how to complete partially entered text. Many of the fields are optional, depending on the kind of element being suggested.
- ContentOverlayType
- ContextData
- Information about an analysis context.
- CreateContextResult
- DiagnosticDomain
- The diagnostic domain contains server diagnostics APIs.
- DiagnosticMessage
- A message associated with a diagnostic.
- DiagnosticsResult
- Domain
- EditDomain
- The edit domain contains commands related to edits that can be applied to the code.
- Element
- Information about an element (something that can be declared in code).
- ElementDeclaration
- A declaration - top-level (class, field, etc) or a class member (method, field, etc).
- ElementDeclarationsResult
- ErrorsResult
- ExecutableFile
- A description of an executable file.
- ExecutionDomain
- The execution domain contains commands related to providing an execution or debugging experience.
- ExecutionLaunchData
- ExistingImport
- Information about an existing import, with elements that it provides.
- ExistingImports
- Information about all existing imports in a library.
- ExtractLocalVariableFeedback
-
Feedback class for the
EXTRACT_LOCAL_VARIABLErefactoring. - ExtractLocalVariableRefactoringOptions
- Create a local variable initialized by the expression that covers the specified selection.
- ExtractMethodFeedback
-
Feedback class for the
EXTRACT_METHODrefactoring. - ExtractMethodRefactoringOptions
- Create a method whose body is the specified expression or list of statements, possibly augmented with a return statement.
- ExtractWidgetRefactoringOptions
- Create a new class that extends StatelessWidget, whose build() method is the widget creation expression, or a method returning a Flutter widget, at the specified offset.
- FindElementReferencesResult
- FindMemberDeclarationsResult
- FindMemberReferencesResult
- FindTopLevelDeclarationsResult
- FixesResult
- FlutterDomain
- The analysis domain contains API's related to Flutter support.
- FlutterOutline
- An node in the Flutter specific outline structure of a file.
- FlutterOutlineAttribute
- An attribute for a FlutterOutline.
- FlutterOutlineEvent
- FlutterWidgetProperty
- A property of a Flutter widget.
- FlutterWidgetPropertyEditor
- An editor for a property of a Flutter widget.
- FlutterWidgetPropertyValue
- A value of a property of a Flutter widget.
- FlutterWidgetPropertyValueEnumItem
-
An item of an enumeration in a general sense - actual
enumvalue, or a static field in a class. - FoldingRegion
- A description of a region that can be folded.
- FormatIfEnabledResult
- FormatResult
- HighlightRegion
- A description of a region that could have special highlighting associated with it.
- HoverInformation
- The hover information associated with a specific location.
- HoverResult
- ImplementedClass
- A description of a class that is implemented or extended.
- ImplementedMember
- A description of a class member that is implemented or overridden.
- ImportedElements
- A description of the elements that are referenced in a region of a file that come from a single imported library.
- ImportedElementSet
-
The set of top-level elements encoded as pairs of the defining library URI
and the name, and stored in the parallel lists
elementUrisandelementNames. - ImportedElementsResult
- ImportElementsResult
- IncludedSuggestionRelevanceTag
-
Each
AvailableSuggestioncan specify zero or more tags in the fieldrelevanceTags, so that when the included tag is equal to one of therelevanceTags, the suggestion is given higher relevance than the wholeIncludedSuggestionSet. - IncludedSuggestionSet
-
A reference to an
AvailableSuggestionSetnoting that the library's members which match the kind of this ref should be presented to the user. - InlineLocalVariableFeedback
-
Feedback class for the
INLINE_LOCAL_VARIABLErefactoring. - InlineMethodFeedback
-
Feedback class for the
INLINE_METHODrefactoring. - InlineMethodRefactoringOptions
- Inline a method in place of one or all references to that method.
- IsEnabledResult
- IsPostfixCompletionApplicableResult
- Jsonable
- LibraryDependenciesResult
- LibraryPathSet
- A list of associations between paths and the libraries that should be included for code completion when editing a file beneath that path.
- LinkedEditGroup
- A collection of positions that should be linked (edited simultaneously) for the purposes of updating code after a source change. For example, if a set of edits introduced a new variable name, the group would contain all of the positions of the variable name so that if the client wanted to let the user edit the variable name after the operation, all occurrences of the name could be edited simultaneously.
- LinkedEditSuggestion
-
A suggestion of a value that could be used to replace all of the linked edit
regions in a (LinkedEditGroup)
#type_LinkedEditGroup. - ListPostfixCompletionTemplatesResult
- Location
- A location (character range) within a file.
- MapUriResult
- MoveFileRefactoringOptions
-
Move the given file or folder and update all of the references to and from
it. The move operation is supported in general case - for renaming an item
in the same folder, moving it to a different folder or both. Moving or
renaming large folders may take time and clients should consider showing an
indicator to the user with the ability to cancel the request (which can be
done using
server.cancelRequest). - A description of a region from which the user can navigate to the declaration of an element.
- A description of a target to which the user can navigate.
- Occurrences
- A description of the references to a single element within a single file.
- OrganizeDirectivesResult
- Outline
- An node in the outline structure of a file.
- OverriddenMember
- A description of a member that is being overridden.
- Override
- A description of a member that overrides an inherited member.
- ParameterInfo
- A description of a member that is being overridden.
- Position
- A position within a file.
- PostfixCompletionResult
- PostfixTemplateDescriptor
- The description of a postfix completion template.
- PubStatus
- An indication of the current state of pub execution.
- ReachableSourcesResult
- RefactoringFeedback
- RefactoringMethodParameter
- A description of a parameter in a method refactoring.
- RefactoringOptions
- RefactoringProblem
- A description of a problem related to a refactoring.
- RefactoringResult
- Refactorings
- RemoveContentOverlay
- A directive to remove an existing file content overlay. After processing this directive, the file contents will once again be read from the file system.
- RenameFeedback
-
Feedback class for the
RENAMErefactoring. - RenameRefactoringOptions
- Rename a given element and all of the references to that element.
- RequestError
- RuntimeCompletionExpression
- An expression for which we want to know its runtime type. In expressions like 'a.b.c.where((e) => e.^)' we want to know the runtime type of 'a.b.c' to enforce it statically at the time when we compute completion suggestions, and get better type for 'e'.
- RuntimeCompletionExpressionType
- A type at runtime.
- RuntimeCompletionVariable
- A variable in a runtime context.
- RuntimeSuggestionsResult
- SearchDomain
- The search domain contains commands related to searches that can be performed against the code base.
- SearchResult
- A single result from a search request.
- SearchResults
- ServerConnected
- ServerDomain
- The server domain contains API's related to the execution of the server.
- ServerError
- ServerLog
- ServerLogEntry
- A log entry from the server.
- ServerPortResult
- ServerStatus
- SetWidgetPropertyValueResult
- SignatureResult
- SortMembersResult
- SourceChange
- A description of a set of edits that implement a single conceptual change.
- SourceEdit
- A description of a single change to a single file.
- SourceFileEdit
- A description of a set of changes to a single file.
- StatementCompletionResult
- SuggestionDetails2Result
- SuggestionDetailsResult
- Suggestions2Result
- SuggestionsResult
- TypeHierarchyItem
- A representation of a class in a type hierarchy.
- TypeHierarchyResult
- VersionResult
- WidgetDescriptionResult
Constants
- experimental → const String
- @experimental
- generatedProtocolVersion → const String
Typedefs
- MethodSend = void Function(String methodName)