Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(313)

Unified Diff: pkg/analysis_server/doc/api.html

Issue 769963003: Add paging support (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: pkg/analysis_server/doc/api.html
diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html
index 1fff91581a0d201efdd5ec2fc48c7d3640dad503..1fb8b8d00121c6aa4315e6883170e812e6e410e4 100644
--- a/pkg/analysis_server/doc/api.html
+++ b/pkg/analysis_server/doc/api.html
@@ -338,6 +338,8 @@ dt.typeDefinition {
+
+
<h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div class="box"><pre>request: {
"id": String
"method": "analysis.getErrors"
@@ -413,14 +415,12 @@ dt.typeDefinition {
<h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>
<p>
- The file in which hover information is being
- requested.
+ The file in which hover information is being requested.
</p>
</dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
<p>
- The offset for which hover information is being
- requested.
+ The offset for which hover information is being requested.
</p>
</dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt;<a href="#type_HoverInformation">HoverInformation</a>&gt; )</i></b></dt><dd>
@@ -432,6 +432,72 @@ dt.typeDefinition {
in multiple contexts in conflicting ways (such as a
part that is included in multiple libraries).
</p>
+ </dd></dl></dd><dt class="request">analysis.getNavigation</dt><dd><div class="box"><pre>request: {
+ "id": String
+ "method": "analysis.getNavigation"
+ "params": {
+ "<b>file</b>": <a href="#type_FilePath">FilePath</a>
+ "<b>start</b>": int
+ "<b>end</b>": int
+ }
+}</pre><br><pre>response: {
+ "id": String
+ "error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>
+ "result": {
+ "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
+ "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget</a>&gt;
+ "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion</a>&gt;
+ }
+}</pre></div>
+ <p>
+ Return the navigation information associated with the given region of
+ the given file.
+ </p>
+ <p>
+ If a navigation region is partially contained in (but extends either
+ before or after) the given region of the file it will be included in
+ the result. This means that it is theoretically possible to get the
+ same navigation region in response to multiple requests. Clients can
+ avoid this by always choosing a region that starts at the beginning of
+ a line and ends at the end of a line in the file.
+ </p>
+
+
+ <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>
+
+ <p>
+ The file in which navigation information is being requested.
+ </p>
+ </dd><dt class="field"><b><i>start ( int )</i></b></dt><dd>
+
+ <p>
+ The offset of the start of the region for which hover information
+ is being requested.
+ </p>
+ </dd><dt class="field"><b><i>end ( int )</i></b></dt><dd>
+
+ <p>
+ The offset of the end of the region for which hover information is
+ being requested.
+ </p>
+ </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>files ( List&lt;<a href="#type_FilePath">FilePath</a>&gt; )</i></b></dt><dd>
+
+ <p>
+ A list of the paths of files that are referenced by the navigation
+ targets.
+ </p>
+ </dd><dt class="field"><b><i>targets ( List&lt;<a href="#type_NavigationTarget">NavigationTarget</a>&gt; )</i></b></dt><dd>
+
+ <p>
+ A list of the navigation targets that are referenced by the
+ navigation regions.
+ </p>
+ </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_NavigationRegion">NavigationRegion</a>&gt; )</i></b></dt><dd>
+
+ <p>
+ A list of the navigation regions within the requested region of
+ the file.
+ </p>
</dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div class="box"><pre>request: {
"id": String
"method": "analysis.reanalyze"
@@ -779,6 +845,47 @@ dt.typeDefinition {
other highlight regions if there is more than one
meaning associated with a particular region.
</p>
+ </dd></dl></dd><dt class="notification">analysis.invalidate</dt><dd><div class="box"><pre>notification: {
+ "event": "analysis.invalidate"
+ "params": {
+ "<b>file</b>": <a href="#type_FilePath">FilePath</a>
+ "<b>start</b>": int
+ "<b>end</b>": int
+ "<b>delta</b>": int
+ }
+}</pre></div>
+ <p>
+ Reports that the navigation information associated with a region of a
+ single file has become invalid and should be re-requested.
+ </p>
+ <p>
+ This notification is not subscribed to by default. Clients can
+ subscribe by including the value <tt>"INVALIDATE"</tt> in the list of
+ services passed in an analysis.setSubscriptions request.
+ </p>
+
+ <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>
+
+ <p>
+ The file whose information has been invalidated.
+ </p>
+ </dd><dt class="field"><b><i>start ( int )</i></b></dt><dd>
+
+ <p>
+ The offset of the start of the invalidated region.
+ </p>
+ </dd><dt class="field"><b><i>end ( int )</i></b></dt><dd>
+
+ <p>
+ The offset of the end of the invalidated region.
+ </p>
+ </dd><dt class="field"><b><i>delta ( int )</i></b></dt><dd>
+
+ <p>
+ The delta to be applied to the offsets in information that follows
+ the invalidated region in order to update it so that it doesn't
+ need to be re-requested.
+ </p>
</dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><div class="box"><pre>notification: {
"event": "analysis.navigation"
"params": {
@@ -1941,7 +2048,7 @@ dt.typeDefinition {
domain.
</p>
- <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd>
+ <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt class="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd>
<p>
An indication of the current state of analysis.
</p>

Powered by Google App Engine
This is Rietveld 408576698