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 API Specification</title> | 3 <title>Analysis Server API Specification</title> |
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co
de+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { | 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co
de+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 2786 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2797 The class that declares the element being suggested. This | 2797 The class that declares the element being suggested. This |
2798 field is omitted if the suggested element is not a member | 2798 field is omitted if the suggested element is not a member |
2799 of a class. | 2799 of a class. |
2800 </p> | 2800 </p> |
2801 </dd><dt class="field"><b>defaultArgumentListString (<span style="colo
r:#999999">optional</span> String)</b></dt><dd> | 2801 </dd><dt class="field"><b>defaultArgumentListString (<span style="colo
r:#999999">optional</span> String)</b></dt><dd> |
2802 | 2802 |
2803 <p> | 2803 <p> |
2804 A default String for use in generating argument list | 2804 A default String for use in generating argument list |
2805 source contents on the client side. | 2805 source contents on the client side. |
2806 </p> | 2806 </p> |
| 2807 </dd><dt class="field"><b>defaultArgumentListTextRanges (<span style="
color:#999999">optional</span> List<int>)</b></dt><dd> |
| 2808 |
| 2809 <p> |
| 2810 Pairs of offsets and lengths describing 'defaultArgumentListString
' |
| 2811 text ranges suitable for use by clients to set up linked edits of |
| 2812 default argument source contents. For example, given an argument |
| 2813 list string 'x, y', the corresponding text range [0, 1, 3, 1], |
| 2814 indicates two text ranges of length 1, starting at offsets 0 and 3
. |
| 2815 Clients can use these ranges to treat the 'x' and 'y' values |
| 2816 specially for linked edits. |
| 2817 </p> |
2807 </dd><dt class="field"><b>element (<span style="color:#999999">optiona
l</span> <a href="#type_Element">Element</a>)</b></dt><dd> | 2818 </dd><dt class="field"><b>element (<span style="color:#999999">optiona
l</span> <a href="#type_Element">Element</a>)</b></dt><dd> |
2808 | 2819 |
2809 <p> | 2820 <p> |
2810 Information about the element reference being suggested. | 2821 Information about the element reference being suggested. |
2811 </p> | 2822 </p> |
2812 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 2823 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> |
2813 | 2824 |
2814 <p> | 2825 <p> |
2815 The return type of the getter, function or method | 2826 The return type of the getter, function or method |
2816 or the type of the field being suggested. | 2827 or the type of the field being suggested. |
(...skipping 1720 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4537 produced by the server and the data that is returned with each. | 4548 produced by the server and the data that is returned with each. |
4538 </p> | 4549 </p> |
4539 <p> | 4550 <p> |
4540 TODO: TBD | 4551 TODO: TBD |
4541 </p> | 4552 </p> |
4542 <h2 class="domain"><a name="index">Index</a></h2> | 4553 <h2 class="domain"><a name="index">Index</a></h2> |
4543 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachable
Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</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><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</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><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">
↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag
nostic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.g
etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>
)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent
Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h
ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana
lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr
orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp
tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon
tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl
etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a
></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a><
/li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme
nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h
ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK
ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont
extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li>
<a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath<
/a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F
oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G
eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio
n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l
i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I
mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">
ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a
></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li>
<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a
href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav
igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a><
/li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli
ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="#
type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos
ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type
_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa
rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba
ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori
ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring
MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr
oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS
everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a
></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R
equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId<
/a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type
_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se
rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a
href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S
ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a
></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class
="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT
ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT
_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR
ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET
HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB
LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a
href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM
E">RENAME</a></li></ul></div> | 4554 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachable
Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</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><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</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><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">
↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag
nostic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.g
etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>
)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent
Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h
ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana
lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr
orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp
tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon
tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl
etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a
></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a><
/li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme
nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h
ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK
ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont
extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li>
<a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath<
/a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F
oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G
eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio
n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l
i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I
mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">
ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a
></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li>
<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a
href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav
igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a><
/li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli
ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="#
type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos
ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type
_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa
rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba
ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori
ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring
MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr
oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS
everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a
></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R
equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId<
/a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type
_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se
rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a
href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S
ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a
></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class
="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT
ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT
_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR
ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET
HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB
LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a
href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM
E">RENAME</a></li></ul></div> |
4544 | 4555 |
4545 | 4556 |
4546 </body></html> | 4557 </body></html> |
OLD | NEW |