OLD | NEW |
1 <!DOCTYPE html><html><head> | 1 <!DOCTYPE html><html><head> |
2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
3 <title>Analysis Server Plugin API Specification</title> | 3 <title>Analysis Server Plugin API Specification</title> |
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code
+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { | 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code
+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { |
5 font-family: 'Roboto', sans-serif; | 5 font-family: 'Roboto', sans-serif; |
6 max-width: 800px; | 6 max-width: 800px; |
7 margin: 0 auto; | 7 margin: 0 auto; |
8 padding: 0 16px; | 8 padding: 0 16px; |
9 font-size: 16px; | 9 font-size: 16px; |
10 line-height: 1.5; | 10 line-height: 1.5; |
(...skipping 1177 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1188 <p> | 1188 <p> |
1189 The Dartdoc associated with the element being suggested. This field is | 1189 The Dartdoc associated with the element being suggested. This field is |
1190 omitted if there is no Dartdoc associated with the element. | 1190 omitted if there is no Dartdoc associated with the element. |
1191 </p> | 1191 </p> |
1192 </dd><dt class="field"><b>declaringType (<span style="color:#999999">optio
nal</span> String)</b></dt><dd> | 1192 </dd><dt class="field"><b>declaringType (<span style="color:#999999">optio
nal</span> String)</b></dt><dd> |
1193 | 1193 |
1194 <p> | 1194 <p> |
1195 The class that declares the element being suggested. This field is | 1195 The class that declares the element being suggested. This field is |
1196 omitted if the suggested element is not a member of a class. | 1196 omitted if the suggested element is not a member of a class. |
1197 </p> | 1197 </p> |
| 1198 </dd><dt class="field"><b>defaultArgumentListString (<span style="color:#9
99999">optional</span> String)</b></dt><dd> |
| 1199 |
| 1200 <p> |
| 1201 A default String for use in generating argument list source contents |
| 1202 on the client side. |
| 1203 </p> |
| 1204 </dd><dt class="field"><b>defaultArgumentListTextRanges (<span style="colo
r:#999999">optional</span> List<int>)</b></dt><dd> |
| 1205 |
| 1206 <p> |
| 1207 Pairs of offsets and lengths describing 'defaultArgumentListString' |
| 1208 text ranges suitable for use by clients to set up linked edits of |
| 1209 default argument source contents. For example, given an argument list |
| 1210 string 'x, y', the corresponding text range [0, 1, 3, 1], indicates |
| 1211 two text ranges of length 1, starting at offsets 0 and 3. Clients can |
| 1212 use these ranges to treat the 'x' and 'y' values specially for linked |
| 1213 edits. |
| 1214 </p> |
1198 </dd><dt class="field"><b>element (<span style="color:#999999">optional</s
pan> <a href="#type_Element">Element</a>)</b></dt><dd> | 1215 </dd><dt class="field"><b>element (<span style="color:#999999">optional</s
pan> <a href="#type_Element">Element</a>)</b></dt><dd> |
1199 | 1216 |
1200 <p> | 1217 <p> |
1201 Information about the element reference being suggested. | 1218 Information about the element reference being suggested. |
1202 </p> | 1219 </p> |
1203 </dd><dt class="field"><b>returnType (<span style="color:#999999">optional
</span> String)</b></dt><dd> | 1220 </dd><dt class="field"><b>returnType (<span style="color:#999999">optional
</span> String)</b></dt><dd> |
1204 | 1221 |
1205 <p> | 1222 <p> |
1206 The return type of the getter, function or method or the type of the | 1223 The return type of the getter, function or method or the type of the |
1207 field being suggested. This field is omitted if the suggested element | 1224 field being suggested. This field is omitted if the suggested element |
(...skipping 1278 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2486 | 2503 |
2487 <p> | 2504 <p> |
2488 The name that the element should have after the refactoring. | 2505 The name that the element should have after the refactoring. |
2489 </p> | 2506 </p> |
2490 </dd></dl></dd></dl> | 2507 </dd></dl></dd></dl> |
2491 <h2 class="domain"><a name="index">Index</a></h2> | 2508 <h2 class="domain"><a name="index">Index</a></h2> |
2492 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi
ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe
ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error"
>error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)<
/h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ha
ndleWatchEvents">handleWatchEvents</a></li><li><a href="#request_analysis.reanal
yze">reanalyze</a></li><li><a href="#request_analysis.setContextBuilderOptions">
setContextBuilderOptions</a></li><li><a href="#request_analysis.setContextRoots"
>setContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPri
orityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscript
ions</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li
></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification
_analysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fo
lding</a></li><li><a href="#notification_analysis.highlights">highlights</a></li
><li><a href="#notification_analysis.navigation">navigation</a></li><li><a href=
"#notification_analysis.occurrences">occurrences</a></li><li><a href="#notificat
ion_analysis.outline">outline</a></li></ul></div></div><h4>completion (<a href="
#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a
href="#request_completion.getSuggestions">getSuggestions</a></li></ul></div><h4
>edit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5>
<ul><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#requ
est_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=
"#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactor
ing">getRefactoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><d
iv class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay<
/a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#ty
pe_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErr
orSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">
AnalysisErrorType</a></li><li><a href="#type_AnalysisService">AnalysisService</a
></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li>
<a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#
type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#ty
pe_ContextBuilderOptions">ContextBuilderOptions</a></li><li><a href="#type_Conte
xtRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a></li><li><a h
ref="#type_ElementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePat
h</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type
_FoldingRegion">FoldingRegion</a></li><li><a href="#type_HighlightRegion">Highli
ghtRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a
></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#
type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_Linke
dEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Locatio
n">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></l
i><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#ty
pe_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li>
<li><a href="#type_Position">Position</a></li><li><a href="#type_PrioritizedSour
ceChange">PrioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback
">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKin
d</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParame
ter</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><l
i><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind<
/a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a
href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li>
<a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#
type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Req
uestErrorCode</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li>
<a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit"
>SourceFileEdit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a
href="#type_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings
(<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refa
ctoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="
#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a h
ref="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a
href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactor
ing_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactori
ng_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOV
E_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> | 2509 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi
ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe
ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error"
>error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)<
/h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ha
ndleWatchEvents">handleWatchEvents</a></li><li><a href="#request_analysis.reanal
yze">reanalyze</a></li><li><a href="#request_analysis.setContextBuilderOptions">
setContextBuilderOptions</a></li><li><a href="#request_analysis.setContextRoots"
>setContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPri
orityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscript
ions</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li
></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification
_analysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fo
lding</a></li><li><a href="#notification_analysis.highlights">highlights</a></li
><li><a href="#notification_analysis.navigation">navigation</a></li><li><a href=
"#notification_analysis.occurrences">occurrences</a></li><li><a href="#notificat
ion_analysis.outline">outline</a></li></ul></div></div><h4>completion (<a href="
#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a
href="#request_completion.getSuggestions">getSuggestions</a></li></ul></div><h4
>edit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5>
<ul><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#requ
est_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=
"#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactor
ing">getRefactoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><d
iv class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay<
/a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#ty
pe_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErr
orSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">
AnalysisErrorType</a></li><li><a href="#type_AnalysisService">AnalysisService</a
></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li>
<a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#
type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#ty
pe_ContextBuilderOptions">ContextBuilderOptions</a></li><li><a href="#type_Conte
xtRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a></li><li><a h
ref="#type_ElementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePat
h</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type
_FoldingRegion">FoldingRegion</a></li><li><a href="#type_HighlightRegion">Highli
ghtRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a
></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#
type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_Linke
dEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Locatio
n">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></l
i><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#ty
pe_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li>
<li><a href="#type_Position">Position</a></li><li><a href="#type_PrioritizedSour
ceChange">PrioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback
">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKin
d</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParame
ter</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><l
i><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind<
/a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a
href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li>
<a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#
type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Req
uestErrorCode</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li>
<a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit"
>SourceFileEdit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a
href="#type_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings
(<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refa
ctoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="
#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a h
ref="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a
href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactor
ing_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactori
ng_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOV
E_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> |
2493 | 2510 |
2494 | 2511 |
2495 </body></html> | 2512 </body></html> |
OLD | NEW |