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 2185 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2196 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So
urceFileEdit: object</a></dt><dd> | 2196 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So
urceFileEdit: object</a></dt><dd> |
2197 <p> | 2197 <p> |
2198 A description of a set of changes to a single file. | 2198 A description of a set of changes to a single file. |
2199 </p> | 2199 </p> |
2200 | 2200 |
2201 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt><
dd> | 2201 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt><
dd> |
2202 | 2202 |
2203 <p> | 2203 <p> |
2204 The file containing the code to be modified. | 2204 The file containing the code to be modified. |
2205 </p> | 2205 </p> |
2206 </dd><dt class="field"><b>fileStamp: long</b></dt><dd> | 2206 </dd><dt class="field"><b><span class="deprecated">fileStamp</span>: long<
/b></dt><dd> |
2207 | 2207 |
2208 <p> | 2208 <p> |
2209 The modification stamp of the file at the moment when the change was | 2209 The modification stamp of the file at the moment when the change was |
2210 created, in milliseconds since the "Unix epoch". Will be -1 if the | 2210 created, in milliseconds since the "Unix epoch". Will be -1 if the |
2211 file did not exist and should be created. The client may use this | 2211 file did not exist and should be created. The client may use this |
2212 field to make sure that the file was not changed since then, so it is | 2212 field to make sure that the file was not changed since then, so it is |
2213 safe to apply the change. | 2213 safe to apply the change. |
2214 </p> | 2214 </p> |
2215 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">Source
Edit</a>></b></dt><dd> | 2215 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">Source
Edit</a>></b></dt><dd> |
2216 | 2216 |
(...skipping 351 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2568 | 2568 |
2569 <p> | 2569 <p> |
2570 The name that the element should have after the refactoring. | 2570 The name that the element should have after the refactoring. |
2571 </p> | 2571 </p> |
2572 </dd></dl></dd></dl> | 2572 </dd></dl></dd></dl> |
2573 <h2 class="domain"><a name="index">Index</a></h2> | 2573 <h2 class="domain"><a name="index">Index</a></h2> |
2574 <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.ge
tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve
nts">handleWatchEvents</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setContextBuilderOptions">setContextBu
ilderOptions</a></li><li><a href="#request_analysis.setContextRoots">setContextR
oots</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</
a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li
><li><a href="#request_analysis.updateContent">updateContent</a></li></ul><h5>No
tifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.er
rors">errors</a></li><li><a href="#notification_analysis.folding">folding</a></l
i><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href
="#notification_analysis.navigation">navigation</a></li><li><a href="#notificati
on_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis
.outline">outline</a></li></ul></div></div><h4>completion (<a href="#domain_comp
letion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ
est_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>edit (<a hr
ef="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h
ref="#request_edit.getAssists">getAssists</a></li><li><a href="#request_edit.get
AvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_ed
it.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefa
ctoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="su
bindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li>
<a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisE
rrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity">
AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErro
rType</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#ty
pe_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_Complet
ionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextBu
ilderOptions">ContextBuilderOptions</a></li><li><a href="#type_ContextRoot">Cont
extRoot</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_E
lementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePath</a></li><l
i><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegi
on">FoldingRegion</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a
></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a
href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedE
ditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggest
ionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location<
/a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a hre
f="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrenc
es">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href=
"#type_Position">Position</a></li><li><a href="#type_PrioritizedSourceChange">Pr
ioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback">Refactorin
gFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><l
i><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li>
<li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKin
d</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li>
<a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type
_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#ty
pe_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_Request
Error">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCod
e</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#ty
pe_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileE
dit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type
_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#r
efactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONV
ERT_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 href="#refact
oring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refac
toring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_L
OCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_ME
THOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></
li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> | 2574 <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.ge
tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve
nts">handleWatchEvents</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setContextBuilderOptions">setContextBu
ilderOptions</a></li><li><a href="#request_analysis.setContextRoots">setContextR
oots</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</
a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li
><li><a href="#request_analysis.updateContent">updateContent</a></li></ul><h5>No
tifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.er
rors">errors</a></li><li><a href="#notification_analysis.folding">folding</a></l
i><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href
="#notification_analysis.navigation">navigation</a></li><li><a href="#notificati
on_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis
.outline">outline</a></li></ul></div></div><h4>completion (<a href="#domain_comp
letion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ
est_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>edit (<a hr
ef="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h
ref="#request_edit.getAssists">getAssists</a></li><li><a href="#request_edit.get
AvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_ed
it.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefa
ctoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="su
bindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li>
<a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisE
rrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity">
AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErro
rType</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#ty
pe_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_Complet
ionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextBu
ilderOptions">ContextBuilderOptions</a></li><li><a href="#type_ContextRoot">Cont
extRoot</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_E
lementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePath</a></li><l
i><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegi
on">FoldingRegion</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a
></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a
href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedE
ditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggest
ionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location<
/a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a hre
f="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrenc
es">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href=
"#type_Position">Position</a></li><li><a href="#type_PrioritizedSourceChange">Pr
ioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback">Refactorin
gFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><l
i><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li>
<li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKin
d</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li>
<a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type
_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#ty
pe_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_Request
Error">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCod
e</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#ty
pe_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileE
dit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type
_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#r
efactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONV
ERT_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 href="#refact
oring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refac
toring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_L
OCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_ME
THOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></
li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> |
2575 | 2575 |
2576 | 2576 |
2577 </body></html> | 2577 </body></html> |
OLD | NEW |