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 91 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
102 -webkit-margin-before: 0; | 102 -webkit-margin-before: 0; |
103 -webkit-margin-start: 0; | 103 -webkit-margin-start: 0; |
104 -webkit-padding-start: 0; | 104 -webkit-padding-start: 0; |
105 | 105 |
106 list-style-type: none; | 106 list-style-type: none; |
107 } | 107 } |
108 </style></head> | 108 </style></head> |
109 <body> | 109 <body> |
110 <h1>Analysis Server API Specification</h1> | 110 <h1>Analysis Server API Specification</h1> |
111 <h1 style="color:#999999">Version | 111 <h1 style="color:#999999">Version |
112 1.18.3 | 112 1.18.4 |
113 </h1> | 113 </h1> |
114 <p> | 114 <p> |
115 This document contains a specification of the API provided by the | 115 This document contains a specification of the API provided by the |
116 analysis server. The API in this document is currently under | 116 analysis server. The API in this document is currently under |
117 development. Changes to the API will be accompanied by an update to the | 117 development. Changes to the API will be accompanied by an update to the |
118 protocol version number according to the principles of semantic | 118 protocol version number according to the principles of semantic |
119 versioning (<a href="http://semver.org/">semver.org</a>). | 119 versioning (<a href="http://semver.org/">semver.org</a>). |
120 </p> | 120 </p> |
121 <h2>Overview</h2> | 121 <h2>Overview</h2> |
122 <p> | 122 <p> |
(...skipping 4636 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4759 produced by the server and the data that is returned with each. | 4759 produced by the server and the data that is returned with each. |
4760 </p> | 4760 </p> |
4761 <p> | 4761 <p> |
4762 TODO: TBD | 4762 TODO: TBD |
4763 </p> | 4763 </p> |
4764 <h2 class="domain"><a name="index">Index</a></h2> | 4764 <h2 class="domain"><a name="index">Index</a></h2> |
4765 <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.closingLabels">closingLab
els</a></li><li><a href="#notification_analysis.errors">errors</a></li><li><a hr
ef="#notification_analysis.flushResults">flushResults</a></li><li><a href="#noti
fication_analysis.folding">folding</a></li><li><a href="#notification_analysis.h
ighlights">highlights</a></li><li><a href="#notification_analysis.implemented">i
mplemented</a></li><li><a href="#notification_analysis.invalidate">invalidate</a
></li><li><a href="#notification_analysis.navigation">navigation</a></li><li><a
href="#notification_analysis.occurrences">occurrences</a></li><li><a href="#noti
fication_analysis.outline">outline</a></li><li><a href="#notification_analysis.o
verrides">overrides</a></li></ul></div></div><h4>completion (<a href="#domain_co
mpletion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#re
quest_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifications</
h5><div class="subindex"><ul><li><a href="#notification_completion.results">resu
lts</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</a>)</h4><di
v class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.findElement
References">findElementReferences</a></li><li><a href="#request_search.findMembe
rDeclarations">findMemberDeclarations</a></li><li><a href="#request_search.findM
emberReferences">findMemberReferences</a></li><li><a href="#request_search.findT
opLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#request_sear
ch.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications</h5><div cl
ass="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 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><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="subindex"><h5
>Requests</h5><ul><li><a href="#request_execution.createContext">createContext</
a></li><li><a href="#request_execution.deleteContext">deleteContext</a></li><li>
<a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_executi
on.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div cl
ass="subindex"><ul><li><a href="#notification_execution.launchData">launchData</
a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a>)</h4>
<div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnostic.getD
iagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getServerPor
t">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div
class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a>
</li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_
AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorS
everity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Ana
lysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></
li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#typ
e_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay
">ChangeContentOverlay</a></li><li><a href="#type_ClosingLabel">ClosingLabel</a>
</li><li><a href="#type_CompletionId">CompletionId</a></li><li><a href="#type_Co
mpletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSu
ggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextData">C
ontextData</a></li><li><a href="#type_Element">Element</a></li><li><a href="#typ
e_ElementKind">ElementKind</a></li><li><a href="#type_ExecutableFile">Executable
File</a></li><li><a href="#type_ExecutableKind">ExecutableKind</a></li><li><a hr
ef="#type_ExecutionContextId">ExecutionContextId</a></li><li><a href="#type_Exec
utionService">ExecutionService</a></li><li><a href="#type_FileKind">FileKind</a>
</li><li><a href="#type_FilePath">FilePath</a></li><li><a href="#type_FoldingKin
d">FoldingKind</a></li><li><a href="#type_FoldingRegion">FoldingRegion</a></li><
li><a href="#type_GeneralAnalysisService">GeneralAnalysisService</a></li><li><a
href="#type_HighlightRegion">HighlightRegion</a></li><li><a href="#type_Highligh
tRegionType">HighlightRegionType</a></li><li><a href="#type_HoverInformation">Ho
verInformation</a></li><li><a href="#type_ImplementedClass">ImplementedClass</a>
</li><li><a href="#type_ImplementedMember">ImplementedMember</a></li><li><a href
="#type_ImportedElements">ImportedElements</a></li><li><a href="#type_KytheEntry
">KytheEntry</a></li><li><a href="#type_KytheVName">KytheVName</a></li><li><a hr
ef="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEdit
Suggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestion
Kind">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><li><a href="#t
ype_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Override">Over
ride</a></li><li><a href="#type_Position">Position</a></li><li><a href="#type_Po
stfixTemplateDescriptor">PostfixTemplateDescriptor</a></li><li><a href="#type_Pu
bStatus">PubStatus</a></li><li><a href="#type_RefactoringFeedback">RefactoringFe
edback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><li><
a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li><li
><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</
a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li><a
href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_Re
factoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_
RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestErr
or">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</
a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#type_SearchRe
sult">SearchResult</a></li><li><a href="#type_SearchResultKind">SearchResultKind
</a></li><li><a href="#type_ServerService">ServerService</a></li><li><a href="#t
ype_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit
</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</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="#refac
toring_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 hr
ef="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a h
ref="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactori
ng_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactorin
g_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE
_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> | 4765 <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.closingLabels">closingLab
els</a></li><li><a href="#notification_analysis.errors">errors</a></li><li><a hr
ef="#notification_analysis.flushResults">flushResults</a></li><li><a href="#noti
fication_analysis.folding">folding</a></li><li><a href="#notification_analysis.h
ighlights">highlights</a></li><li><a href="#notification_analysis.implemented">i
mplemented</a></li><li><a href="#notification_analysis.invalidate">invalidate</a
></li><li><a href="#notification_analysis.navigation">navigation</a></li><li><a
href="#notification_analysis.occurrences">occurrences</a></li><li><a href="#noti
fication_analysis.outline">outline</a></li><li><a href="#notification_analysis.o
verrides">overrides</a></li></ul></div></div><h4>completion (<a href="#domain_co
mpletion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#re
quest_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifications</
h5><div class="subindex"><ul><li><a href="#notification_completion.results">resu
lts</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</a>)</h4><di
v class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.findElement
References">findElementReferences</a></li><li><a href="#request_search.findMembe
rDeclarations">findMemberDeclarations</a></li><li><a href="#request_search.findM
emberReferences">findMemberReferences</a></li><li><a href="#request_search.findT
opLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#request_sear
ch.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications</h5><div cl
ass="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 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><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="subindex"><h5
>Requests</h5><ul><li><a href="#request_execution.createContext">createContext</
a></li><li><a href="#request_execution.deleteContext">deleteContext</a></li><li>
<a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_executi
on.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div cl
ass="subindex"><ul><li><a href="#notification_execution.launchData">launchData</
a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">↑</a>)</h4>
<div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diagnostic.getD
iagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getServerPor
t">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div
class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a>
</li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_
AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorS
everity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Ana
lysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></
li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#typ
e_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay
">ChangeContentOverlay</a></li><li><a href="#type_ClosingLabel">ClosingLabel</a>
</li><li><a href="#type_CompletionId">CompletionId</a></li><li><a href="#type_Co
mpletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSu
ggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextData">C
ontextData</a></li><li><a href="#type_Element">Element</a></li><li><a href="#typ
e_ElementKind">ElementKind</a></li><li><a href="#type_ExecutableFile">Executable
File</a></li><li><a href="#type_ExecutableKind">ExecutableKind</a></li><li><a hr
ef="#type_ExecutionContextId">ExecutionContextId</a></li><li><a href="#type_Exec
utionService">ExecutionService</a></li><li><a href="#type_FileKind">FileKind</a>
</li><li><a href="#type_FilePath">FilePath</a></li><li><a href="#type_FoldingKin
d">FoldingKind</a></li><li><a href="#type_FoldingRegion">FoldingRegion</a></li><
li><a href="#type_GeneralAnalysisService">GeneralAnalysisService</a></li><li><a
href="#type_HighlightRegion">HighlightRegion</a></li><li><a href="#type_Highligh
tRegionType">HighlightRegionType</a></li><li><a href="#type_HoverInformation">Ho
verInformation</a></li><li><a href="#type_ImplementedClass">ImplementedClass</a>
</li><li><a href="#type_ImplementedMember">ImplementedMember</a></li><li><a href
="#type_ImportedElements">ImportedElements</a></li><li><a href="#type_KytheEntry
">KytheEntry</a></li><li><a href="#type_KytheVName">KytheVName</a></li><li><a hr
ef="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEdit
Suggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestion
Kind">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><li><a href="#t
ype_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Override">Over
ride</a></li><li><a href="#type_Position">Position</a></li><li><a href="#type_Po
stfixTemplateDescriptor">PostfixTemplateDescriptor</a></li><li><a href="#type_Pu
bStatus">PubStatus</a></li><li><a href="#type_RefactoringFeedback">RefactoringFe
edback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><li><
a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li><li
><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</
a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li><a
href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_Re
factoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_
RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestErr
or">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</
a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#type_SearchRe
sult">SearchResult</a></li><li><a href="#type_SearchResultKind">SearchResultKind
</a></li><li><a href="#type_ServerService">ServerService</a></li><li><a href="#t
ype_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit
</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</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="#refac
toring_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 hr
ef="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a h
ref="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactori
ng_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactorin
g_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE
_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> |
4766 | 4766 |
4767 | 4767 |
4768 </body></html> | 4768 </body></html> |
OLD | NEW |