pkg/analysis_server/doc/api.html - Issue 1232393005: Add notification of analyzed files

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

Issue 1232393005: Add notification of analyzed files (Closed) Base URL: https://github.com/dart-lang/sdk.git@master

Patch Set: Created 5 years, 5 months 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

Index: pkg/analysis_server/doc/api.html

diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html

index 38a28ab9735f7096ef4fd65c01e67b2448486940..9f6e6d98a679f8685225964aa6501cd0d18e1752 100644

--- a/pkg/analysis_server/doc/api.html

+++ b/pkg/analysis_server/doc/api.html

@@ -43,7 +43,7 @@ dt.typeDefinition {

</style></head>

<body>

<h1>Analysis Server API Specification</h1>

- <h1 style="color:#999999">Version 1.7.0</h1>

+ <h1 style="color:#999999">Version 1.8.0</h1>

<p>

This document contains a specification of the API provided by the

analysis server. The API in this document is currently under

@@ -384,6 +384,8 @@ dt.typeDefinition {

@@ -506,6 +508,10 @@ dt.typeDefinition {

Return library dependency information for use in client-side indexing

and package URI resolution.

</p>

+ <p>

+ Clients that are only using the libraries field should consider using the

+ analyzedFiles notification instead.

+ </p>

<h4>Returns</h4><dl><dt class="field"><b><i>libraries ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>

@@ -705,6 +711,30 @@ dt.typeDefinition {

or the empty map is specified, that indicates that the

normal pubspec.yaml mechanism should always be used.

</p>

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setGeneralSubscriptions">analysis.setGeneralSubscriptions</a> (<a href="#request_analysis.setGeneralSubscriptions">#</a>)</dt><dd><div class="box"><pre>request: {

+ "id": String

+ "method": "analysis.setGeneralSubscriptions"

+ "params": {

+ "<b>subscriptions</b>": List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>>

+ }

+}</pre><br><pre>response: {

+ "id": String

+ "error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>

+}</pre></div>

+ <p>

+ Subscribe for general services (that is, services that are not

+ specific to individual files). All previous subscriptions are replaced

+ by the given set of services.

+ </p>

+ <p>

+ It is an error if any of the elements in the list are not valid

+ services. If there is an error, then the current subscriptions will

+ remain unchanged.

+ </p>

+ <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>> )</i></b></dt><dd>

+ <p>A list of the services being subscribed to.</p>

</dd></dl></dd><dt class="request"><a name="request_analysis.setPriorityFiles">analysis.setPriorityFiles</a> (<a href="#request_analysis.setPriorityFiles">#</a>)</dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setPriorityFiles"

@@ -757,11 +787,11 @@ dt.typeDefinition {

"error": <span style="color:#999999">optional</span> <a href="#type_RequestError">RequestError</a>

}</pre></div>

<p>

- Subscribe for services. All previous subscriptions are

- replaced by the current set of subscriptions. If a given

- service is not included as a key in the map then no files

- will be subscribed to the service, exactly as if the service

- had been included in the map with an explicit empty list of

+ Subscribe for services that are specific to individual files.

+ All previous subscriptions are replaced by the current set of

+ subscriptions. If a given service is not included as a key in the map

+ then no files will be subscribed to the service, exactly as if the

+ service had been included in the map with an explicit empty list of

files.

</p>

<p>

@@ -849,7 +879,27 @@ dt.typeDefinition {

<p>

The options that are to be used to control analysis.

</p>

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a> (<a href="#notification_analysis.errors">#</a>)</dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a> (<a href="#notification_analysis.analyzedFiles">#</a>)</dt><dd><div class="box"><pre>notification: {

+ "event": "analysis.analyzedFiles"

+ "params": {

+ "<b>directories</b>": List<<a href="#type_FilePath">FilePath</a>>

+ }

+}</pre></div>

+ <p>

+ Reports the paths of the files that are being analyzed.

+ </p>

+ <p>

+ This notification is not subscribed to by default. Clients can

+ subscribe by including the value <tt>"ANALYZED_FILES"</tt> in the list

+ of services passed in an analysis.setGeneralSubscriptions request.

+ </p>

+ <h4>Parameters</h4><dl><dt class="field"><b><i>directories ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>

+ <p>

+ A list of the paths of the files that are being analyzed.

+ </p>

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a> (<a href="#notification_analysis.errors">#</a>)</dt><dd><div class="box"><pre>notification: {

"event": "analysis.errors"

"params": {

"<b>file</b>": <a href="#type_FilePath">FilePath</a>

@@ -2150,6 +2200,7 @@ dt.typeDefinition {

<dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOverlay: object</a></dt><dd>

<p>

A directive to begin overlaying the contents of a file. The

@@ -2283,11 +2334,17 @@ dt.typeDefinition {

</p>

</dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisService">AnalysisService: String</a></dt><dd>

<p>

- An enumeration of the services provided by the analysis

- domain.

+ An enumeration of the services provided by the analysis domain that

+ are related to a specific list of files.

</p>

- <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>

+ <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt class="value">INVALIDATE</dt><dd>

+ <p>

+ This service is not currently implemented and will become a

+ GeneralAnalysisService in a future release.

+ </p>

+ </dd><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>

@@ -2633,7 +2690,13 @@ dt.typeDefinition {

<p>

The length of the region to be folded.

</p>

- </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysisService">GeneralAnalysisService: String</a></dt><dd>

+ <p>

+ An enumeration of the services provided by the analysis domain that are

+ general in nature (that is, are not specific to some list of files).

+ </p>

+ <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>

<p>

A description of a region that could have special highlighting

associated with it.

« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/analysis_server.dart » ('j') | pkg/analysis_server/lib/src/analysis_server.dart » ('J')