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+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 4158 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4169 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So
urceFileEdit: object</a></dt><dd> | 4169 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So
urceFileEdit: object</a></dt><dd> |
4170 <p> | 4170 <p> |
4171 A description of a set of changes to a single file. | 4171 A description of a set of changes to a single file. |
4172 </p> | 4172 </p> |
4173 | 4173 |
4174 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt><
dd> | 4174 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt><
dd> |
4175 | 4175 |
4176 <p> | 4176 <p> |
4177 The file containing the code to be modified. | 4177 The file containing the code to be modified. |
4178 </p> | 4178 </p> |
4179 </dd><dt class="field"><b>fileStamp: long</b></dt><dd> | 4179 </dd><dt class="field"><b><span class="deprecated">fileStamp</span>: long<
/b></dt><dd> |
4180 | 4180 |
4181 <p> | 4181 <p> |
4182 The modification stamp of the file at the moment when the change was | 4182 The modification stamp of the file at the moment when the change was |
4183 created, in milliseconds since the "Unix epoch". Will be -1 if the | 4183 created, in milliseconds since the "Unix epoch". Will be -1 if the |
4184 file did not exist and should be created. The client may use this | 4184 file did not exist and should be created. The client may use this |
4185 field to make sure that the file was not changed since then, so it is | 4185 field to make sure that the file was not changed since then, so it is |
4186 safe to apply the change. | 4186 safe to apply the change. |
4187 </p> | 4187 </p> |
4188 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">Source
Edit</a>></b></dt><dd> | 4188 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">Source
Edit</a>></b></dt><dd> |
4189 | 4189 |
(...skipping 389 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4579 produced by the server and the data that is returned with each. | 4579 produced by the server and the data that is returned with each. |
4580 </p> | 4580 </p> |
4581 <p> | 4581 <p> |
4582 TODO: TBD | 4582 TODO: TBD |
4583 </p> | 4583 </p> |
4584 <h2 class="domain"><a name="index">Index</a></h2> | 4584 <h2 class="domain"><a name="index">Index</a></h2> |
4585 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subi
ndex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersion</
a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="#req
uest_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h
5><div class="subindex"><ul><li><a href="#notification_server.connected">connect
ed</a></li><li><a href="#notification_server.error">error</a></li><li><a href="#
notification_server.status">status</a></li></ul></div></div><h4>analysis (<a hre
f="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_ana
lysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSour
ces">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDepend
encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat
ion">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanalyze</
a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a></li
><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscriptions
</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="#r
equest_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5>
<div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">ana
lyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><l
i><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href
="#notification_analysis.folding">folding</a></li><li><a href="#notification_ana
lysis.highlights">highlights</a></li><li><a href="#notification_analysis.impleme
nted">implemented</a></li><li><a href="#notification_analysis.invalidate">invali
date</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_ana
lysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#do
main_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a hr
ef="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifica
tions</h5><div class="subindex"><ul><li><a href="#notification_completion.result
s">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.find
ElementReferences">findElementReferences</a></li><li><a href="#request_search.fi
ndMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_searc
h.findMemberReferences">findMemberReferences</a></li><li><a href="#request_searc
h.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#reque
st_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="su
bindex"><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="#request_e
dit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#req
uest_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">
getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</a></
li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li></u
l></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="subind
ex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">createCo
ntext</a></li><li><a href="#request_execution.deleteContext">deleteContext</a></
li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_
execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5>
<div class="subindex"><ul><li><a href="#notification_execution.launchData">launc
hData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a
>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnost
ic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getSe
rverPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h
3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOver
lay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href=
"#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analysi
sErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorTy
pe">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOption
s</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a hre
f="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContent
Overlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Completio
nId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></l
i><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li>
<li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Element">
Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href=
"#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableKind"
>ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionContextI
d</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a h
ref="#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_Foldi
ngRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">Gener
alAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a
></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a
href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_Imple
mentedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">Impl
ementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></l
i><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a h
ref="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a hre
f="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Navigat
ionRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li>
<li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline">
Outline</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><l
i><a href="#type_Override">Override</a></li><li><a href="#type_Position">Positio
n</a></li><li><a href="#type_PostfixTemplateDescriptor">PostfixTemplateDescripto
r</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_Ref
actoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind
">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">Refacto
ringMethodParameter</a></li><li><a href="#type_RefactoringMethodParameterKind">R
efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringOptions">Ref
actoringOptions</a></li><li><a href="#type_RefactoringProblem">RefactoringProble
m</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSever
ity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></l
i><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_Reque
stErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a><
/li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_Sea
rchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Server
Service</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a hre
f="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">Sourc
eFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></l
i></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="su
bindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_T
O_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_MET
HOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_
LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD<
/a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</
a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a hre
f="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">R
ENAME</a></li></ul></div> | 4585 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subi
ndex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersion</
a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="#req
uest_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h
5><div class="subindex"><ul><li><a href="#notification_server.connected">connect
ed</a></li><li><a href="#notification_server.error">error</a></li><li><a href="#
notification_server.status">status</a></li></ul></div></div><h4>analysis (<a hre
f="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_ana
lysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSour
ces">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDepend
encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat
ion">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanalyze</
a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a></li
><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscriptions
</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="#r
equest_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5>
<div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">ana
lyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><l
i><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href
="#notification_analysis.folding">folding</a></li><li><a href="#notification_ana
lysis.highlights">highlights</a></li><li><a href="#notification_analysis.impleme
nted">implemented</a></li><li><a href="#notification_analysis.invalidate">invali
date</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_ana
lysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#do
main_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a hr
ef="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifica
tions</h5><div class="subindex"><ul><li><a href="#notification_completion.result
s">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.find
ElementReferences">findElementReferences</a></li><li><a href="#request_search.fi
ndMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_searc
h.findMemberReferences">findMemberReferences</a></li><li><a href="#request_searc
h.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#reque
st_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="su
bindex"><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="#request_e
dit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#req
uest_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">
getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</a></
li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li></u
l></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="subind
ex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">createCo
ntext</a></li><li><a href="#request_execution.deleteContext">deleteContext</a></
li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_
execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5>
<div class="subindex"><ul><li><a href="#notification_execution.launchData">launc
hData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a
>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnost
ic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getSe
rverPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h
3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOver
lay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href=
"#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analysi
sErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorTy
pe">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOption
s</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a hre
f="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContent
Overlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Completio
nId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></l
i><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li>
<li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Element">
Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href=
"#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableKind"
>ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionContextI
d</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a h
ref="#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_Foldi
ngRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">Gener
alAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a
></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a
href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_Imple
mentedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">Impl
ementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></l
i><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a h
ref="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a hre
f="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Navigat
ionRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li>
<li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline">
Outline</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><l
i><a href="#type_Override">Override</a></li><li><a href="#type_Position">Positio
n</a></li><li><a href="#type_PostfixTemplateDescriptor">PostfixTemplateDescripto
r</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_Ref
actoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind
">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">Refacto
ringMethodParameter</a></li><li><a href="#type_RefactoringMethodParameterKind">R
efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringOptions">Ref
actoringOptions</a></li><li><a href="#type_RefactoringProblem">RefactoringProble
m</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSever
ity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></l
i><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_Reque
stErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a><
/li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_Sea
rchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Server
Service</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a hre
f="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">Sourc
eFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></l
i></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="su
bindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_T
O_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_MET
HOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_
LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD<
/a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</
a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a hre
f="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">R
ENAME</a></li></ul></div> |
4586 | 4586 |
4587 | 4587 |
4588 </body></html> | 4588 </body></html> |
OLD | NEW |