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 3411 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3422 <p> | 3422 <p> |
3423 A description of the elements that are referenced in a region of a file | 3423 A description of the elements that are referenced in a region of a file |
3424 that come from a single imported library. | 3424 that come from a single imported library. |
3425 </p> | 3425 </p> |
3426 | 3426 |
3427 <dl><dt class="field"><b>path: <a href="#type_FilePath">FilePath</a></b></dt><
dd> | 3427 <dl><dt class="field"><b>path: <a href="#type_FilePath">FilePath</a></b></dt><
dd> |
3428 | 3428 |
3429 <p> | 3429 <p> |
3430 The absolute and normalized path of the file containing the library. | 3430 The absolute and normalized path of the file containing the library. |
3431 </p> | 3431 </p> |
3432 </dd><dt class="field"><b>uri: String</b></dt><dd> | |
3433 | |
3434 <p> | |
3435 The URI that was used when importing the library into the original | |
3436 source. | |
3437 </p> | |
3438 </dd><dt class="field"><b>prefix: String</b></dt><dd> | 3432 </dd><dt class="field"><b>prefix: String</b></dt><dd> |
3439 | 3433 |
3440 <p> | 3434 <p> |
3441 The prefix that was used when importing the library into the original | 3435 The prefix that was used when importing the library into the original |
3442 source. | 3436 source. |
3443 </p> | 3437 </p> |
3444 </dd><dt class="field"><b>elements: List<String></b></dt><dd> | 3438 </dd><dt class="field"><b>elements: List<String></b></dt><dd> |
3445 | 3439 |
3446 <p> | 3440 <p> |
3447 The names of the elements imported from the library. | 3441 The names of the elements imported from the library. |
(...skipping 1174 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4622 produced by the server and the data that is returned with each. | 4616 produced by the server and the data that is returned with each. |
4623 </p> | 4617 </p> |
4624 <p> | 4618 <p> |
4625 TODO: TBD | 4619 TODO: TBD |
4626 </p> | 4620 </p> |
4627 <h2 class="domain"><a name="index">Index</a></h2> | 4621 <h2 class="domain"><a name="index">Index</a></h2> |
4628 <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.getLibraryDepend
encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat
ion">getNavigation</a></li><li><a href="#request_analysis.getReachableSources">g
etReachableSources</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_ImportedElements">ImportedElements</a><
/li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#ty
pe_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedE
ditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location"
>Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</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><l
i><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_O
verride">Override</a></li><li><a href="#type_Position">Position</a></li><li><a h
ref="#type_PostfixTemplateDescriptor">PostfixTemplateDescriptor</a></li><li><a h
ref="#type_PubStatus">PubStatus</a></li><li><a href="#type_RefactoringFeedback">
RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind<
/a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParamete
r</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodPa
rameterKind</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a
></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a h
ref="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a
href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#ty
pe_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Reque
stErrorCode</a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#
type_SearchResult">SearchResult</a></li><li><a href="#type_SearchResultKind">Sea
rchResultKind</a></li><li><a href="#type_ServerService">ServerService</a></li><l
i><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdi
t">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</a></li>
<li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></li></ul></div><h3>R
efactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a
href="#refactoring_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 href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a>
</li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a hre
f="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href
="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MO
VE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul
></div> | 4622 <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.getLibraryDepend
encies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigat
ion">getNavigation</a></li><li><a href="#request_analysis.getReachableSources">g
etReachableSources</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_ImportedElements">ImportedElements</a><
/li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#ty
pe_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedE
ditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location"
>Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</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><l
i><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_O
verride">Override</a></li><li><a href="#type_Position">Position</a></li><li><a h
ref="#type_PostfixTemplateDescriptor">PostfixTemplateDescriptor</a></li><li><a h
ref="#type_PubStatus">PubStatus</a></li><li><a href="#type_RefactoringFeedback">
RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind<
/a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParamete
r</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodPa
rameterKind</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a
></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a h
ref="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a
href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#ty
pe_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Reque
stErrorCode</a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#
type_SearchResult">SearchResult</a></li><li><a href="#type_SearchResultKind">Sea
rchResultKind</a></li><li><a href="#type_ServerService">ServerService</a></li><l
i><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdi
t">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</a></li>
<li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a></li></ul></div><h3>R
efactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a
href="#refactoring_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 href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a>
</li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a hre
f="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href
="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MO
VE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul
></div> |
4629 | 4623 |
4630 | 4624 |
4631 </body></html> | 4625 </body></html> |
OLD | NEW |