pkg/analysis_server/doc/api.html - Issue 2879273002: Make server use the common protocol classes

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

Issue 2879273002: Make server use the common protocol classes (Closed)

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

« no previous file with comments | « pkg/analysis_server/benchmark/perf/benchmark_scenario.dart ('k') | pkg/analysis_server/lib/plugin/analysis/navigation/navigation_core.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: pkg/analysis_server/doc/api.html

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

index c4c452fdaaae3c8f3352d1fcfedf016decebf57b..f3e55037dc65f0dc9c2430a045e8c7f99ccb59eb 100644

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

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

@@ -1,7 +1,7 @@

<!DOCTYPE html><html><head>

- <meta charset="UTF-8">

- <title>Analysis Server API Specification</title>

- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {

+ <meta charset="UTF-8">

+ <title>Analysis Server API Specification</title>

+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {

font-family: 'Roboto', sans-serif;

max-width: 800px;

margin: 0 auto;

@@ -106,133 +106,136 @@ a:focus, a:hover {

list-style-type: none;

}

</style></head>

- <body>

- <h1>Analysis Server API Specification</h1>

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

-

- This document contains a specification of the API provided by the

- analysis server. The API in this document is currently under

- development. Changes to the API will be accompanied by an update to the

- protocol version number according to the principles of semantic

- versioning (<a href="http://semver.org/">semver.org</a>).

-

- <h2>Overview</h2>

-

- The analysis server API is a bi-directional client-server

- API. The API is independent of the transport mechanism used, but

- is heavily influenced by a model in which sockets or character

- streams are used to transport JSON-RPC encoded information.

-

- <h3>Transport Mechanism</h3>

-

- The characters passed to the server are expected to be encoded

- using UTF-8.

-

-

- When character streams are used as the transport, messages are

- delineated by newlines. This means, in particular, that the JSON

- encoding process must not introduce newlines within a

- message. Note however that newlines are used in this document

- for readability.

-

-

- It is the client's responsibility to read output from the server to

- avoid its blocking.

-

-

- To ease interoperability with Lisp-based clients (which may not

- be able to easily distinguish between empty lists, empty maps,

- and null), client-to-server communication is allowed to replace

- any instance of "<tt>{}</tt>" or "<tt>[]</tt>" with null. The

- server will always properly represent empty lists as

- "<tt>[]</tt>" and empty maps as "<tt>{}</tt>".

-

- <h3>Communication Structure</h3>

-

- Clients can make a request of the server and the server will

- provide a response for each request that it receives. While many

- of the requests that can be made by a client are informational

- in nature, we have chosen to always return a response so that

- clients can know whether the request was received and was

- correct.

-

-

- There is no guarantee concerning the order in which responses

- will be returned, but there is a guarantee that the server will

- process requests in the order in which they are sent as long as

- the transport mechanism also makes this guarantee. Responses can

- be returned in an order that is different from the order in

- which the requests were received because some requests take

- longer to process than others.

-

-

- Every request is required to have two fields and may have two

- additional optional fields. The first required field is the ‘id’

- field, which is only used by the server to associate a response

- with the request that generated the response. The second

- required field is the ‘method’ field, which is used to determine

- what the server is being requested to do. One optional field is

- the ‘params’ field, whose structure is dependent on the method

- being requested. The structure of this field is described with

- each request for which it is required. The other optional field

- is the 'clientRequestTime' field, which is a number indicating

- the time at which the client made the request (milliseconds

- since epoch). Providing clientRequestTime helps us track

- how responsive analysis server is to client requests

- and better address any issues that occur.

-

-

- Every response has up to three fields. The first field is the

- ‘id’ field, which is always present and whose value is the

- identifier that was passed to the request that generated the

- response. The second field is the ‘error’ field, which is only

- present if an error was encountered while processing the

- request. The third field is the ‘result’ field, whose structure

- is dependent on the method being responded to, and is described

- with each request that will produce it.

-

-

- The server can also communicate to the clients by sending a

- notification. The purpose of these notifications is to provide

- information to clients as it becomes available rather than to

- require that clients poll for it. Unless explicitly stated, all

- notifications are designed to return the complete information

- available at the time the notification is sent; clients are not

- required to update previously communicated

- results. Consequently, the server can and should return partial

- results before all results are available. For example, the

- syntactic errors for a file can be returned as soon as the

- syntactic analysis is complete, and both syntactic and semantic

- errors can be returned together at a later time.

-

-

- Each notification has two fields. The first field is the ‘event’

- field, which identifies the kind of notification. The second

- field is the ‘params’ field, whose structure is dependent on the

- kind of notification being sent. The structure of this field is

- described with each notification.

-

-

- In order to be backward compatible, clients should ignore fields that were

- not specified in the version of the API on which they were based. Clients

- should also use the server.getVersion request to test that the version of

- the server supports an API before using it.

-

- <h3>Eventual Consistency</h3>

-

- The analysis server satisfies requests under the principle of

- <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual consistency</a>.

- That is, in some cases it may return responses with the currently available

- results while it's catching up with unprocessed changes.

-

- <h3>Domains</h3>

-

- For convenience, the API is divided into domains. Each domain is specified

- in a separate section below. The specifications of the API’s refer to data

- structures beyond the standard JSON primitives. These data structures are

- documented in the section titled <a href="#types">Types</a>.

-

+<body>

+<h1>Analysis Server API Specification</h1>

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

+ 1.18.1

+</h1>

+

+ This document contains a specification of the API provided by the

+ analysis server. The API in this document is currently under

+ development. Changes to the API will be accompanied by an update to the

+ protocol version number according to the principles of semantic

+ versioning (<a href="http://semver.org/">semver.org</a>).

+

+<h2>Overview</h2>

+

+ The analysis server API is a bi-directional client-server

+ API. The API is independent of the transport mechanism used, but

+ is heavily influenced by a model in which sockets or character

+ streams are used to transport JSON-RPC encoded information.

+

+<h3>Transport Mechanism</h3>

+

+ The characters passed to the server are expected to be encoded

+ using UTF-8.

+

+

+ When character streams are used as the transport, messages are

+ delineated by newlines. This means, in particular, that the JSON

+ encoding process must not introduce newlines within a

+ message. Note however that newlines are used in this document

+ for readability.

+

+

+ It is the client's responsibility to read output from the server to

+ avoid its blocking.

+

+

+ To ease interoperability with Lisp-based clients (which may not

+ be able to easily distinguish between empty lists, empty maps,

+ and null), client-to-server communication is allowed to replace

+ any instance of "<tt>{}</tt>" or "<tt>[]</tt>" with null. The

+ server will always properly represent empty lists as

+ "<tt>[]</tt>" and empty maps as "<tt>{}</tt>".

+

+<h3>Communication Structure</h3>

+

+ Clients can make a request of the server and the server will

+ provide a response for each request that it receives. While many

+ of the requests that can be made by a client are informational

+ in nature, we have chosen to always return a response so that

+ clients can know whether the request was received and was

+ correct.

+

+

+ There is no guarantee concerning the order in which responses

+ will be returned, but there is a guarantee that the server will

+ process requests in the order in which they are sent as long as

+ the transport mechanism also makes this guarantee. Responses can

+ be returned in an order that is different from the order in

+ which the requests were received because some requests take

+ longer to process than others.

+

+

+ Every request is required to have two fields and may have two

+ additional optional fields. The first required field is the ‘id’

+ field, which is only used by the server to associate a response

+ with the request that generated the response. The second

+ required field is the ‘method’ field, which is used to determine

+ what the server is being requested to do. One optional field is

+ the ‘params’ field, whose structure is dependent on the method

+ being requested. The structure of this field is described with

+ each request for which it is required. The other optional field

+ is the 'clientRequestTime' field, which is a number indicating

+ the time at which the client made the request (milliseconds

+ since epoch). Providing clientRequestTime helps us track

+ how responsive analysis server is to client requests

+ and better address any issues that occur.

+

+

+ Every response has up to three fields. The first field is the

+ ‘id’ field, which is always present and whose value is the

+ identifier that was passed to the request that generated the

+ response. The second field is the ‘error’ field, which is only

+ present if an error was encountered while processing the

+ request. The third field is the ‘result’ field, whose structure

+ is dependent on the method being responded to, and is described

+ with each request that will produce it.

+

+

+ The server can also communicate to the clients by sending a

+ notification. The purpose of these notifications is to provide

+ information to clients as it becomes available rather than to

+ require that clients poll for it. Unless explicitly stated, all

+ notifications are designed to return the complete information

+ available at the time the notification is sent; clients are not

+ required to update previously communicated

+ results. Consequently, the server can and should return partial

+ results before all results are available. For example, the

+ syntactic errors for a file can be returned as soon as the

+ syntactic analysis is complete, and both syntactic and semantic

+ errors can be returned together at a later time.

+

+

+ Each notification has two fields. The first field is the ‘event’

+ field, which identifies the kind of notification. The second

+ field is the ‘params’ field, whose structure is dependent on the

+ kind of notification being sent. The structure of this field is

+ described with each notification.

+

+

+ In order to be backward compatible, clients should ignore fields that were

+ not specified in the version of the API on which they were based. Clients

+ should also use the server.getVersion request to test that the version of

+ the server supports an API before using it.

+

+<h3>Eventual Consistency</h3>

+

+ The analysis server satisfies requests under the principle of

+ <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual

+ consistency</a>.

+ That is, in some cases it may return responses with the currently available

+ results while it's catching up with unprocessed changes.

+

+<h3>Domains</h3>

+

+ For convenience, the API is divided into domains. Each domain is specified

+ in a separate section below. The specifications of the API’s refer to data

+ structures beyond the standard JSON primitives. These data structures are

+ documented in the section titled <a href="#types">Types</a>.

+

<a href="#domain_server">Server</a><ul><li><a href="#request_server.getVersion">server.getVersion</a></li>

<li><a href="#request_server.shutdown">server.shutdown</a></li>

<li><a href="#request_server.setSubscriptions">server.setSubscriptions</a></li>

@@ -282,88 +285,88 @@ a:focus, a:hover {

<li><a href="#request_diagnostic.getServerPort">diagnostic.getServerPort</a></li>

</ul>

- <h3>Command-line Arguments</h3>

-

- The command-line arguments that can be passed to the server.

-

- <h4>Options</h4>

- <blockquote>

- <dl>

- <dt>--client-id</dt>

- <dd>

+<h3>Command-line Arguments</h3>

+

+ The command-line arguments that can be passed to the server.

+

+<h4>Options</h4>

+<blockquote>

+ <dl>

+ <dt>--client-id</dt>

+ <dd>

- Specifies an identifier associated with the client. Used when

- generating error reports.

+ Specifies an identifier associated with the client. Used when

+ generating error reports.

- Clients are strongly encouraged to provide this information in

- order to improve the quality of information that can be provided

- to them.

+ Clients are strongly encouraged to provide this information in

+ order to improve the quality of information that can be provided

+ to them.

- </dd>

- </dl>

- <dl>

- <dt>--client-version</dt>

- <dd>

+ </dd>

+ </dl>

+ <dl>

+ <dt>--client-version</dt>

+ <dd>

- Specifies the version of the client that is communicating with

- the server. Used when generating error reports.

+ Specifies the version of the client that is communicating with

+ the server. Used when generating error reports.

Clients are strongly encouraged to provide this information in

order to improve the quality of information that can be provided

to them.

- </dd>

- </dl>

- <dl>

- <dt class="deprecated">--no-error-notification</dt>

- <dd>

- Deprecated: clients should no longer pass this option in

- Disable notifications about errors (see analysis.error). If this

- flag is not specified then notifications will be sent for all

- errors produced for all files in the actual analysis roots.

- </dd>

- </dl>

- <dl>

- <dt class="deprecated">--no-index</dt>

- <dd>

- Deprecated: clients should no longer pass this option in

- This flag used to disable the server from generating an index, but now

- it has no effect.

- </dd>

- </dl>

- <dl>

- <dt class="deprecated">--file-read-mode</dt>

- <dd>

- Deprecated: clients should no longer pass this option in

- An enumeration of the ways files can be read from disk. Some clients

- normalize end of line characters which would make the file offset and

- range information incorrect. The default option is <tt>as-is</tt>, but

- can also be set to <tt>normalize-eol-always</tt>. The default option

- (<tt>as-is</tt>) reads files as they are on disk. The

- <tt>normalize-eol-always</tt> option does the following:

- <ul>

- <li>'\r\n' is converted to '\n';</li>

- <li>'\r' by itself is converted to '\n';</li>

- <li>this happens regardless of the OS editor is running on.</li>

- </ul>

- </dd>

- </dl>

- </blockquote>

- <h1>Domains</h1>

- <h2 class="domain"><a name="domain_server">server domain</a></h2>

-

- The server domain contains API’s related to the execution of

- the server.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion">server.getVersion</a></dt><dd><div class="box"><pre>request: {

+ </dd>

+ </dl>

+ <dl>

+ <dt class="deprecated">--no-error-notification</dt>

+ <dd>

+ Deprecated: clients should no longer pass this option in

+ Disable notifications about errors (see analysis.error). If this

+ flag is not specified then notifications will be sent for all

+ errors produced for all files in the actual analysis roots.

+ </dd>

+ </dl>

+ <dl>

+ <dt class="deprecated">--no-index</dt>

+ <dd>

+ Deprecated: clients should no longer pass this option in

+ This flag used to disable the server from generating an index, but now

+ it has no effect.

+ </dd>

+ </dl>

+ <dl>

+ <dt class="deprecated">--file-read-mode</dt>

+ <dd>

+ Deprecated: clients should no longer pass this option in

+ An enumeration of the ways files can be read from disk. Some clients

+ normalize end of line characters which would make the file offset and

+ range information incorrect. The default option is <tt>as-is</tt>, but

+ can also be set to <tt>normalize-eol-always</tt>. The default option

+ (<tt>as-is</tt>) reads files as they are on disk. The

+ <tt>normalize-eol-always</tt> option does the following:

+ <ul>

+ <li>'\r\n' is converted to '\n';</li>

+ <li>'\r' by itself is converted to '\n';</li>

+ <li>this happens regardless of the OS editor is running on.</li>

+ </ul>

+ </dd>

+ </dl>

+</blockquote>

+<h1>Domains</h1>

+<h2 class="domain"><a name="domain_server">server domain</a></h2>

+

+ The server domain contains API’s related to the execution of

+ the server.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion">server.getVersion</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "server.getVersion"

}</pre> <pre>response: {

@@ -373,27 +376,27 @@ a:focus, a:hover {

"version": String

}

}</pre></div>

- Return the version number of the analysis server.

+ Return the version number of the analysis server.

+ <h4>returns:</h4><dl><dt class="field">version: String</dt><dd>

- <h4>returns:</h4><dl><dt class="field">version: String</dt><dd>

- The version number of the analysis server.

- </dd></dl></dd><dt class="request"><a name="request_server.shutdown">server.shutdown</a></dt><dd><div class="box"><pre>request: {

+ The version number of the analysis server.

+ </dd></dl></dd><dt class="request"><a name="request_server.shutdown">server.shutdown</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "server.shutdown"

}</pre> <pre>response: {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

-

- Cleanly shutdown the analysis server. Requests that are

- received after this request will not be processed. Requests

- that were received before this request, but for which a

- response has not yet been sent, will not be responded to. No

- further responses or notifications will be sent after the

- response to this request has been sent.

-

- </dd><dt class="request"><a name="request_server.setSubscriptions">server.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

+

+ Cleanly shutdown the analysis server. Requests that are

+ received after this request will not be processed. Requests

+ that were received before this request, but for which a

+ response has not yet been sent, will not be responded to. No

+ further responses or notifications will be sent after the

+ response to this request has been sent.

+

+ </dd><dt class="request"><a name="request_server.setSubscriptions">server.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "server.setSubscriptions"

"params": {

@@ -403,20 +406,20 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

-

- Subscribe for services. All previous subscriptions are

- replaced by the given set of services.

-

-

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

-

+

+ Subscribe for services. All previous subscriptions are

+ replaced by the given set of services.

+

+

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

+

+ <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_ServerService">ServerService</a>></dt><dd>

- <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_ServerService">ServerService</a>></dt><dd>

- A list of the services being subscribed to.

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_server.connected">server.connected</a></dt><dd><div class="box"><pre>notification: {

+ A list of the services being subscribed to.

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_server.connected">server.connected</a></dt><dd><div class="box"><pre>notification: {

"event": "server.connected"

"params": {

"version": String

@@ -424,27 +427,27 @@ a:focus, a:hover {

"sessionId": optional String

}

}</pre></div>

-

- Reports that the server is running. This notification is

- issued once after the server has started running but before

- any requests are processed to let the client know that it

- started correctly.

-

-

- It is not possible to subscribe to or unsubscribe from this

- notification.

-

- <h4>parameters:</h4><dl><dt class="field">version: String</dt><dd>

- The version number of the analysis server.

- </dd><dt class="field">pid: int</dt><dd>

- The process id of the analysis server process.

- </dd><dt class="field">sessionId: String (optional)</dt><dd>

- The session id for this session.

- </dd></dl></dd><dt class="notification"><a name="notification_server.error">server.error</a></dt><dd><div class="box"><pre>notification: {

+

+ Reports that the server is running. This notification is

+ issued once after the server has started running but before

+ any requests are processed to let the client know that it

+ started correctly.

+

+

+ It is not possible to subscribe to or unsubscribe from this

+ notification.

+

+ <h4>parameters:</h4><dl><dt class="field">version: String</dt><dd>

+ The version number of the analysis server.

+ </dd><dt class="field">pid: int</dt><dd>

+ The process id of the analysis server process.

+ </dd><dt class="field">sessionId: String (optional)</dt><dd>

+ The session id for this session.

+ </dd></dl></dd><dt class="notification"><a name="notification_server.error">server.error</a></dt><dd><div class="box"><pre>notification: {

"event": "server.error"

"params": {

"isFatal": bool

@@ -452,100 +455,100 @@ a:focus, a:hover {

"stackTrace": String

}

}</pre></div>

+

+ Reports that an unexpected error has occurred while

+ executing the server. This notification is not used for

+ problems with specific requests (which are returned as part

+ of the response) but is used for exceptions that occur while

+ performing other tasks, such as analysis or preparing

+ notifications.

+

+

+ It is not possible to subscribe to or unsubscribe from this

+ notification.

+

+ <h4>parameters:</h4><dl><dt class="field">isFatal: bool</dt><dd>

- Reports that an unexpected error has occurred while

- executing the server. This notification is not used for

- problems with specific requests (which are returned as part

- of the response) but is used for exceptions that occur while

- performing other tasks, such as analysis or preparing

- notifications.

+ True if the error is a fatal error, meaning that the

+ server will shutdown automatically after sending this

+ notification.

+ </dd><dt class="field">message: String</dt><dd>

- It is not possible to subscribe to or unsubscribe from this

- notification.

+ The error message indicating what kind of error was

+ encountered.

+ </dd><dt class="field">stackTrace: String</dt><dd>

- <h4>parameters:</h4><dl><dt class="field">isFatal: bool</dt><dd>

-

- True if the error is a fatal error, meaning that the

- server will shutdown automatically after sending this

- notification.

-

- </dd><dt class="field">message: String</dt><dd>

-

- The error message indicating what kind of error was

- encountered.

-

- </dd><dt class="field">stackTrace: String</dt><dd>

-

- The stack trace associated with the generation of the

- error, used for debugging the server.

-

- </dd></dl></dd><dt class="notification"><a name="notification_server.status">server.status</a></dt><dd><div class="box"><pre>notification: {

+

+ The stack trace associated with the generation of the

+ error, used for debugging the server.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_server.status">server.status</a></dt><dd><div class="box"><pre>notification: {

"event": "server.status"

"params": {

"analysis": optional <a href="#type_AnalysisStatus">AnalysisStatus</a>

"pub": optional <a href="#type_PubStatus">PubStatus</a>

}

}</pre></div>

+

+ Reports the current status of the server. Parameters are

+ omitted if there has been no change in the status

+ represented by that parameter.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"STATUS"</tt> in

+ the list of services passed in a server.setSubscriptions

+ request.

+

+ <h4>parameters:</h4><dl><dt class="field">analysis: <a href="#type_AnalysisStatus">AnalysisStatus</a> (optional)</dt><dd>

- Reports the current status of the server. Parameters are

- omitted if there has been no change in the status

- represented by that parameter.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"STATUS"</tt> in

- the list of services passed in a server.setSubscriptions

- request.

-

- <h4>parameters:</h4><dl><dt class="field">analysis: <a href="#type_AnalysisStatus">AnalysisStatus</a> (optional)</dt><dd>

-

- The current status of analysis, including whether

- analysis is being performed and if so what is being

- analyzed.

-

- </dd><dt class="field">pub: <a href="#type_PubStatus">PubStatus</a> (optional)</dt><dd>

-

- The current status of pub execution, indicating whether we are

- currently running pub.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2>

-

- The analysis domain contains API’s related to the analysis of

- files.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getErrors">analysis.getErrors</a></dt><dd><div class="box"><pre>request: {

+ The current status of analysis, including whether

+ analysis is being performed and if so what is being

+ analyzed.

+

+ </dd><dt class="field">pub: <a href="#type_PubStatus">PubStatus</a> (optional)</dt><dd>

+

+ The current status of pub execution, indicating whether we are

+ currently running pub.

+

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_analysis">analysis domain</a></h2>

+

+ The analysis domain contains API’s related to the analysis of

+ files.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getErrors">analysis.getErrors</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getErrors"

"params": {

@@ -558,46 +561,46 @@ a:focus, a:hover {

"errors": List<<a href="#type_AnalysisError">AnalysisError</a>>

}

}</pre></div>

+

+ Return the errors associated with the given file. If the

+ errors for the given file have not yet been computed, or the

+ most recently computed errors for the given file are out of

+ date, then the response for this request will be delayed

+ until they have been computed. If some or all of the errors

+ for the file cannot be computed, then the subset of the

+ errors that can be computed will be returned and the

+ response will contain an error to indicate why the errors

+ could not be computed. If the content of the file changes after this

+ request was received but before a response could be sent, then an

+ error of type <tt>CONTENT_MODIFIED</tt> will be generated.

+

+

+ This request is intended to be used by clients that cannot

+ asynchronously apply updated error information. Clients that

+ can apply error information as it becomes available

+ should use the information provided by the 'analysis.errors'

+ notification.

+

+

+ If a request is made for a file which does not exist, or

+ which is not currently subject to analysis (e.g. because it

+ is not associated with any analysis root specified to

+ analysis.setAnalysisRoots), an error of type

+ <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Return the errors associated with the given file. If the

- errors for the given file have not yet been computed, or the

- most recently computed errors for the given file are out of

- date, then the response for this request will be delayed

- until they have been computed. If some or all of the errors

- for the file cannot be computed, then the subset of the

- errors that can be computed will be returned and the

- response will contain an error to indicate why the errors

- could not be computed. If the content of the file changes after this

- request was received but before a response could be sent, then an

- error of type <tt>CONTENT_MODIFIED</tt> will be generated.

-

-

- This request is intended to be used by clients that cannot

- asynchronously apply updated error information. Clients that

- can apply error information as it becomes available

- should use the information provided by the 'analysis.errors'

- notification.

+ The file for which errors are being requested.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">errors: List<<a href="#type_AnalysisError">AnalysisError</a>></dt><dd>

- If a request is made for a file which does not exist, or

- which is not currently subject to analysis (e.g. because it

- is not associated with any analysis root specified to

- analysis.setAnalysisRoots), an error of type

- <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.

+ The errors associated with the file.

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file for which errors are being requested.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">errors: List<<a href="#type_AnalysisError">AnalysisError</a>></dt><dd>

-

- The errors associated with the file.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.getHover">analysis.getHover</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.getHover">analysis.getHover</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getHover"

"params": {

@@ -611,35 +614,35 @@ a:focus, a:hover {

"hovers": List<<a href="#type_HoverInformation">HoverInformation</a>>

}

}</pre></div>

+

+ Return the hover information associate with the given

+ location. If some or all of the hover information is not

+ available at the time this request is processed the

+ information will be omitted from the response.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file in which hover information is being requested.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset for which hover information is being requested.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">hovers: List<<a href="#type_HoverInformation">HoverInformation</a>></dt><dd>

- Return the hover information associate with the given

- location. If some or all of the hover information is not

- available at the time this request is processed the

- information will be omitted from the response.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file in which hover information is being requested.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset for which hover information is being requested.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">hovers: List<<a href="#type_HoverInformation">HoverInformation</a>></dt><dd>

-

- The hover information associated with the

- location. The list will be empty if no information

- could be determined for the location. The list can

- contain multiple items if the file is being analyzed

- in multiple contexts in conflicting ways (such as a

- part that is included in multiple libraries).

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.getReachableSources">analysis.getReachableSources</a></dt><dd><div class="box"><pre>request: {

+ The hover information associated with the

+ location. The list will be empty if no information

+ could be determined for the location. The list can

+ contain multiple items if the file is being analyzed

+ in multiple contexts in conflicting ways (such as a

+ part that is included in multiple libraries).

+

+ </dd></dl></dd><dt class="request"><a name="request_analysis.getReachableSources">analysis.getReachableSources</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getReachableSources"

"params": {

@@ -652,34 +655,39 @@ a:focus, a:hover {

"sources": Map<String, List<String>>

}

}</pre></div>

+

+ Return the transitive closure of reachable sources for a given file.

+

+

+ If a request is made for a file which does not exist, or

+ which is not currently subject to analysis (e.g. because it

+ is not associated with any analysis root specified to

+ analysis.setAnalysisRoots), an error of type

+ <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file for which reachable source information is being requested.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">sources: Map<String, List<String>></dt><dd>

- Return the transitive closure of reachable sources for a given file.

-

-

- If a request is made for a file which does not exist, or

- which is not currently subject to analysis (e.g. because it

- is not associated with any analysis root specified to

- analysis.setAnalysisRoots), an error of type

- <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file for which reachable source information is being requested.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">sources: Map<String, List<String>></dt><dd>

-

- A mapping from source URIs to directly reachable source URIs. For example,

- a file "foo.dart" that imports "bar.dart" would have the corresponding mapping

- { "file:///foo.dart" : ["file:///bar.dart"] }. If "bar.dart" has further imports

- (or exports) there will be a mapping from the URI "file:///bar.dart" to them.

- To check if a specific URI is reachable from a given file, clients can check

- for its presence in the resulting key set.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.getLibraryDependencies">analysis.getLibraryDependencies</a></dt><dd><div class="box"><pre>request: {

+ A mapping from source URIs to directly reachable source URIs. For

+ example,

+ a file "foo.dart" that imports "bar.dart" would have the corresponding

+ mapping

+ { "file:///foo.dart" : ["file:///bar.dart"] }. If "bar.dart" has

+ further imports

+ (or exports) there will be a mapping from the URI "file:///bar.dart"

+ to them.

+ To check if a specific URI is reachable from a given file, clients can

+ check

+ for its presence in the resulting key set.

+

+ </dd></dl></dd><dt class="request"><a name="request_analysis.getLibraryDependencies">analysis.getLibraryDependencies</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getLibraryDependencies"

}</pre> <pre>response: {

@@ -690,29 +698,29 @@ a:focus, a:hover {

"packageMap": Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>>

}

}</pre></div>

+

+ Return library dependency information for use in client-side indexing

+ and package URI resolution.

+

+

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

+ analyzedFiles notification instead.

+

+ <h4>returns:</h4><dl><dt class="field">libraries: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

- Return library dependency information for use in client-side indexing

- and package URI resolution.

+ A list of the paths of library elements referenced by

+ files in existing analysis roots.

+ </dd><dt class="field">packageMap: Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>></dt><dd>

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

- analyzedFiles notification instead.

+ A mapping from context source roots to package maps which map

+ package names to source directories for use in client-side

+ package URI resolution.

- <h4>returns:</h4><dl><dt class="field">libraries: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- A list of the paths of library elements referenced by

- files in existing analysis roots.

-

- </dd><dt class="field">packageMap: Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>></dt><dd>

-

- A mapping from context source roots to package maps which map

- package names to source directories for use in client-side

- package URI resolution.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.getNavigation">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.getNavigation">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.getNavigation"

"params": {

@@ -729,69 +737,69 @@ a:focus, a:hover {

"regions": List<<a href="#type_NavigationRegion">NavigationRegion</a>>

}

}</pre></div>

+

+ Return the navigation information associated with the given region of

+ the given file. If the navigation information for the given file has

+ not yet been computed, or the most recently computed navigation

+ information for the given file is out of date, then the response for

+ this request will be delayed until it has been computed. If the

+ content of the file changes after this request was received but before

+ a response could be sent, then an error of type

+ <tt>CONTENT_MODIFIED</tt> will be generated.

+

+

+ If a navigation region overlaps (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 (possibly different) line in the file.

+

+

+ If a request is made for a file which does not exist, or

+ which is not currently subject to analysis (e.g. because it

+ is not associated with any analysis root specified to

+ analysis.setAnalysisRoots), an error of type

+ <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file in which navigation information is being requested.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the region for which navigation information is being

+ requested.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region for which navigation information is being

+ requested.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

+

+ A list of the paths of files that are referenced by the navigation

+ targets.

+

+ </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

+

+ A list of the navigation targets that are referenced by the

+ navigation regions.

+

+ </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

- Return the navigation information associated with the given region of

- the given file. If the navigation information for the given file has

- not yet been computed, or the most recently computed navigation

- information for the given file is out of date, then the response for

- this request will be delayed until it has been computed. If the

- content of the file changes after this request was received but before

- a response could be sent, then an error of type

- <tt>CONTENT_MODIFIED</tt> will be generated.

-

-

- If a navigation region overlaps (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 (possibly different) line in the file.

-

-

- If a request is made for a file which does not exist, or

- which is not currently subject to analysis (e.g. because it

- is not associated with any analysis root specified to

- analysis.setAnalysisRoots), an error of type

- <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file in which navigation information is being requested.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the region for which navigation information is being

- requested.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region for which navigation information is being

- requested.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- A list of the paths of files that are referenced by the navigation

- targets.

-

- </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

-

- A list of the navigation targets that are referenced by the

- navigation regions.

-

- </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

-

- A list of the navigation regions within the requested region of

- the file.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">analysis.reanalyze</a></dt><dd><div class="box"><pre>request: {

+ A list of the navigation regions within the requested region of

+ the file.

+

+ </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">analysis.reanalyze</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.reanalyze"

"params": {

@@ -801,26 +809,26 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

+ Force the re-analysis of everything contained in the specified

+ analysis roots. This will cause all previously computed analysis

+ results to be discarded and recomputed, and will cause all subscribed

+ notifications to be re-sent.

+

+

+ If no analysis roots are provided, then all current analysis roots

+ will be re-analyzed. If an empty list of analysis roots is provided,

+ then nothing will be re-analyzed. If the list contains one or more

+ paths that are not currently analysis roots, then an error of type

+ <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">roots: List<<a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

- Force the re-analysis of everything contained in the specified

- analysis roots. This will cause all previously computed analysis

- results to be discarded and recomputed, and will cause all subscribed

- notifications to be re-sent.

-

-

- If no analysis roots are provided, then all current analysis roots

- will be re-analyzed. If an empty list of analysis roots is provided,

- then nothing will be re-analyzed. If the list contains one or more

- paths that are not currently analysis roots, then an error of type

- <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.

+ A list of the analysis roots that are to be re-analyzed.

- <h4>parameters:</h4><dl><dt class="field">roots: List<<a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

-

- A list of the analysis roots that are to be re-analyzed.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalysisRoots">analysis.setAnalysisRoots</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalysisRoots">analysis.setAnalysisRoots</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setAnalysisRoots"

"params": {

@@ -832,83 +840,83 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

+ Sets the root paths used to determine which files to analyze. The set

+ of files to be analyzed are all of the files in one of the root paths

+ that are not either explicitly or implicitly excluded. A file is

+ explicitly excluded if it is in one of the excluded paths. A file is

+ implicitly excluded if it is in a subdirectory of one of the root

+ paths where the name of the subdirectory starts with a period (that

+ is, a hidden directory).

+

+

+ Note that this request determines the set of requested

+ analysis roots. The actual set of analysis roots at any

+ given time is the intersection of this set with the set of

+ files and directories actually present on the

+ filesystem. When the filesystem changes, the actual set of

+ analysis roots is automatically updated, but the set of

+ requested analysis roots is unchanged. This means that if

+ the client sets an analysis root before the root becomes

+ visible to server in the filesystem, there is no error; once

+ the server sees the root in the filesystem it will start

+ analyzing it. Similarly, server will stop analyzing files

+ that are removed from the file system but they will remain

+ in the set of requested roots.

+

+

+ If an included path represents a file, then server will look

+ in the directory containing the file for a pubspec.yaml

+ file. If none is found, then the parents of the directory

+ will be searched until such a file is found or the root of

+ the file system is reached. If such a file is found, it will

+ be used to resolve package: URI’s within the file.

+

+ <h4>parameters:</h4><dl><dt class="field">included: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

+

+ A list of the files and directories that should be

+ analyzed.

+

+ </dd><dt class="field">excluded: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

+

+ A list of the files and directories within the

+ included directories that should not be analyzed.

+

+ </dd><dt class="field">packageRoots: Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

+

+ A mapping from source directories to package roots

+ that should override the normal package: URI resolution

+ mechanism.

+

+

+ If a package root is a directory, then

+ the analyzer will behave as though the associated

+ source directory in the map contains a special

+ pubspec.yaml file which resolves any package: URI to the

+ corresponding path within that package root directory. The

+ effect is the same as specifying the package root directory as

+ a "--package_root" parameter to the Dart VM when

+ executing any Dart file inside the source directory.

+

+

+ If a package root is a file, then the analyzer

+ will behave as though that file is a ".packages" file in the

+ source directory. The effect is the same as specifying the file

+ as a "--packages" parameter to the Dart VM when

+ executing any Dart file inside the source directory.

+

- Sets the root paths used to determine which files to analyze. The set

- of files to be analyzed are all of the files in one of the root paths

- that are not either explicitly or implicitly excluded. A file is

- explicitly excluded if it is in one of the excluded paths. A file is

- implicitly excluded if it is in a subdirectory of one of the root

- paths where the name of the subdirectory starts with a period (that

- is, a hidden directory).

-

-

- Note that this request determines the set of requested

- analysis roots. The actual set of analysis roots at any

- given time is the intersection of this set with the set of

- files and directories actually present on the

- filesystem. When the filesystem changes, the actual set of

- analysis roots is automatically updated, but the set of

- requested analysis roots is unchanged. This means that if

- the client sets an analysis root before the root becomes

- visible to server in the filesystem, there is no error; once

- the server sees the root in the filesystem it will start

- analyzing it. Similarly, server will stop analyzing files

- that are removed from the file system but they will remain

- in the set of requested roots.

-

-

- If an included path represents a file, then server will look

- in the directory containing the file for a pubspec.yaml

- file. If none is found, then the parents of the directory

- will be searched until such a file is found or the root of

- the file system is reached. If such a file is found, it will

- be used to resolve package: URI’s within the file.

-

- <h4>parameters:</h4><dl><dt class="field">included: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- A list of the files and directories that should be

- analyzed.

-

- </dd><dt class="field">excluded: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- A list of the files and directories within the

- included directories that should not be analyzed.

-

- </dd><dt class="field">packageRoots: Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

-

- A mapping from source directories to package roots

- that should override the normal package: URI resolution

- mechanism.

-

-

- If a package root is a directory, then

- the analyzer will behave as though the associated

- source directory in the map contains a special

- pubspec.yaml file which resolves any package: URI to the

- corresponding path within that package root directory. The

- effect is the same as specifying the package root directory as

- a "--package_root" parameter to the Dart VM when

- executing any Dart file inside the source directory.

-

-

- If a package root is a file, then the analyzer

- will behave as though that file is a ".packages" file in the

- source directory. The effect is the same as specifying the file

- as a "--packages" parameter to the Dart VM when

- executing any Dart file inside the source directory.

-

-

- Files in any directories that are not overridden by this

- mapping have their package: URI's resolved using the

- normal pubspec.yaml mechanism. If this field is absent,

- or the empty map is specified, that indicates that the

- normal pubspec.yaml mechanism should always be used.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.setGeneralSubscriptions">analysis.setGeneralSubscriptions</a></dt><dd><div class="box"><pre>request: {

+ Files in any directories that are not overridden by this

+ mapping have their package: URI's resolved using the

+ normal pubspec.yaml mechanism. If this field is absent,

+ or the empty map is specified, that indicates that the

+ normal pubspec.yaml mechanism should always be used.

+

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

"id": String

"method": "analysis.setGeneralSubscriptions"

"params": {

@@ -918,21 +926,21 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

-

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

-

-

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

-

+

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

+

+

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

+

+ <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>></dt><dd>

- <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>></dt><dd>

- A list of the services being subscribed to.

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

+ A list of the services being subscribed to.

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

"id": String

"method": "analysis.setPriorityFiles"

"params": {

@@ -942,38 +950,38 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

+ Set the priority files to the files in the given list. A

+ priority file is a file that is given priority when

+ scheduling which analysis work to do first. The list

+ typically contains those files that are visible to the user

+ and those for which analysis results will have the biggest

+ impact on the user experience. The order of the files within

+ the list is significant: the first file will be given higher

+ priority than the second, the second higher priority than

+ the third, and so on.

+

+

+ Note that this request determines the set of requested

+ priority files. The actual set of priority files is the

+ intersection of the requested set of priority files with the

+ set of files currently subject to analysis. (See

+ analysis.setSubscriptions for a description of files that

+ are subject to analysis.)

+

+

+ If a requested priority file is a directory it is ignored,

+ but remains in the set of requested priority files so that

+ if it later becomes a file it can be included in the set of

+ actual priority files.

+

+ <h4>parameters:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

- Set the priority files to the files in the given list. A

- priority file is a file that is given priority when

- scheduling which analysis work to do first. The list

- typically contains those files that are visible to the user

- and those for which analysis results will have the biggest

- impact on the user experience. The order of the files within

- the list is significant: the first file will be given higher

- priority than the second, the second higher priority than

- the third, and so on.

-

-

- Note that this request determines the set of requested

- priority files. The actual set of priority files is the

- intersection of the requested set of priority files with the

- set of files currently subject to analysis. (See

- analysis.setSubscriptions for a description of files that

- are subject to analysis.)

-

-

- If a requested priority file is a directory it is ignored,

- but remains in the set of requested priority files so that

- if it later becomes a file it can be included in the set of

- actual priority files.

-

- <h4>parameters:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- The files that are to be a priority for analysis.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscriptions">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

+ The files that are to be a priority for analysis.

+

+ </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscriptions">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.setSubscriptions"

"params": {

@@ -983,47 +991,47 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

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

+

+

+ Note that this request determines the set of requested

+ subscriptions. The actual set of subscriptions at any given

+ time is the intersection of this set with the set of files

+ currently subject to analysis. The files currently subject

+ to analysis are the set of files contained within an actual

+ analysis root but not excluded, plus all of the files

+ transitively reachable from those files via import, export

+ and part directives. (See analysis.setAnalysisRoots for an

+ explanation of how the actual analysis roots are

+ determined.) When the actual analysis roots change, the

+ actual set of subscriptions is automatically updated, but

+ the set of requested subscriptions is unchanged.

+

+

+ If a requested subscription is a directory it is ignored,

+ but remains in the set of requested subscriptions so that if

+ it later becomes a file it can be included in the set of

+ actual subscriptions.

+

+

+ It is an error if any of the keys in the map are not valid

+ services. If there is an error, then the existing

+ subscriptions will remain unchanged.

+

+ <h4>parameters:</h4><dl><dt class="field">subscriptions: Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>></dt><dd>

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

-

-

- Note that this request determines the set of requested

- subscriptions. The actual set of subscriptions at any given

- time is the intersection of this set with the set of files

- currently subject to analysis. The files currently subject

- to analysis are the set of files contained within an actual

- analysis root but not excluded, plus all of the files

- transitively reachable from those files via import, export

- and part directives. (See analysis.setAnalysisRoots for an

- explanation of how the actual analysis roots are

- determined.) When the actual analysis roots change, the

- actual set of subscriptions is automatically updated, but

- the set of requested subscriptions is unchanged.

-

-

- If a requested subscription is a directory it is ignored,

- but remains in the set of requested subscriptions so that if

- it later becomes a file it can be included in the set of

- actual subscriptions.

-

-

- It is an error if any of the keys in the map are not valid

- services. If there is an error, then the existing

- subscriptions will remain unchanged.

-

- <h4>parameters:</h4><dl><dt class="field">subscriptions: Map<<a href="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">FilePath</a>>></dt><dd>

-

- A table mapping services to a list of the files being

- subscribed to the service.

-

- </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent">analysis.updateContent</a></dt><dd><div class="box"><pre>request: {

+ A table mapping services to a list of the files being

+ subscribed to the service.

+

+ </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent">analysis.updateContent</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.updateContent"

"params": {

@@ -1035,25 +1043,25 @@ a:focus, a:hover {

"result": {

}

}</pre></div>

+

+ Update the content of one or more files. Files that were

+ previously updated but not included in this update remain

+ unchanged. This effectively represents an overlay of the

+ filesystem. The files whose content is overridden are

+ therefore seen by server as being files with the given

+ content, even if the files do not exist on the filesystem or

+ if the file path represents the path to a directory on the

+ filesystem.

+

+ <h4>parameters:</h4><dl><dt class="field">files: Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>></dt><dd>

- Update the content of one or more files. Files that were

- previously updated but not included in this update remain

- unchanged. This effectively represents an overlay of the

- filesystem. The files whose content is overridden are

- therefore seen by server as being files with the given

- content, even if the files do not exist on the filesystem or

- if the file path represents the path to a directory on the

- filesystem.

+ A table mapping the files whose content has changed to a

+ description of the content change.

- <h4>parameters:</h4><dl><dt class="field">files: Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>></dt><dd>

-

- A table mapping the files whose content has changed to a

- description of the content change.

-

- </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request deprecated"><a name="request_analysis.updateOptions">analysis.updateOptions</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request deprecated"><a name="request_analysis.updateOptions">analysis.updateOptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "analysis.updateOptions"

"params": {

@@ -1063,157 +1071,157 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

- Deprecated: all of the options can be set by users in

- an analysis options file.

-

- Update the options controlling analysis based on the given

- set of options. Any options that are not included in the

- analysis options will not be changed. If there are options

- in the analysis options that are not valid, they will be

- silently ignored.

-

- <h4>parameters:</h4><dl><dt class="field">options: <a href="#type_AnalysisOptions">AnalysisOptions</a></dt><dd>

-

- The options that are to be used to control analysis.

-

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a></dt><dd><div class="box"><pre>notification: {

+ Deprecated: all of the options can be set by users in

+ an analysis options file.

+

+ Update the options controlling analysis based on the given

+ set of options. Any options that are not included in the

+ analysis options will not be changed. If there are options

+ in the analysis options that are not valid, they will be

+ silently ignored.

+

+ <h4>parameters:</h4><dl><dt class="field">options: <a href="#type_AnalysisOptions">AnalysisOptions</a></dt><dd>

+

+ The options that are to be used to control analysis.

+

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

"event": "analysis.analyzedFiles"

"params": {

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

}

}</pre></div>

+

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

+

+

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

+

+ <h4>parameters:</h4><dl><dt class="field">directories: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

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

-

-

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

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

- <h4>parameters:</h4><dl><dt class="field">directories: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

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

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a></dt><dd><div class="box"><pre>notification: {

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

"event": "analysis.errors"

"params": {

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

"errors": List<<a href="#type_AnalysisError">AnalysisError</a>>

}

}</pre></div>

+

+ Reports the errors associated with a given file. The set of

+ errors included in the notification is always a complete

+ list that supersedes any previously reported errors.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the errors.

+

+ </dd><dt class="field">errors: List<<a href="#type_AnalysisError">AnalysisError</a>></dt><dd>

- Reports the errors associated with a given file. The set of

- errors included in the notification is always a complete

- list that supersedes any previously reported errors.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the errors.

-

- </dd><dt class="field">errors: List<<a href="#type_AnalysisError">AnalysisError</a>></dt><dd>

-

- The errors contained in the file.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.flushResults">analysis.flushResults</a></dt><dd><div class="box"><pre>notification: {

+ The errors contained in the file.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.flushResults">analysis.flushResults</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.flushResults"

"params": {

"files": List<<a href="#type_FilePath">FilePath</a>>

}

}</pre></div>

+

+ Reports that any analysis results that were previously

+ associated with the given files should be considered to be

+ invalid because those files are no longer being analyzed,

+ either because the analysis root that contained it is no

+ longer being analyzed or because the file no longer exists.

+

+

+ If a file is included in this notification and at some later

+ time a notification with results for the file is received,

+ clients should assume that the file is once again being

+ analyzed and the information should be processed.

+

+

+ It is not possible to subscribe to or unsubscribe from this

+ notification.

+

+ <h4>parameters:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

- Reports that any analysis results that were previously

- associated with the given files should be considered to be

- invalid because those files are no longer being analyzed,

- either because the analysis root that contained it is no

- longer being analyzed or because the file no longer exists.

-

-

- If a file is included in this notification and at some later

- time a notification with results for the file is received,

- clients should assume that the file is once again being

- analyzed and the information should be processed.

-

-

- It is not possible to subscribe to or unsubscribe from this

- notification.

+ The files that are no longer being analyzed.

- <h4>parameters:</h4><dl><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- The files that are no longer being analyzed.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.folding">analysis.folding</a></dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.folding">analysis.folding</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.folding"

"params": {

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

"regions": List<<a href="#type_FoldingRegion">FoldingRegion</a>>

}

}</pre></div>

+

+ Reports the folding regions associated with a given

+ file. Folding regions can be nested, but will not be

+ overlapping. Nesting occurs when a foldable element, such as

+ a method, is nested inside another foldable element such as

+ a class.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"FOLDING"</tt> in

+ the list of services passed in an analysis.setSubscriptions

+ request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the folding regions.

+

+ </dd><dt class="field">regions: List<<a href="#type_FoldingRegion">FoldingRegion</a>></dt><dd>

- Reports the folding regions associated with a given

- file. Folding regions can be nested, but will not be

- overlapping. Nesting occurs when a foldable element, such as

- a method, is nested inside another foldable element such as

- a class.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"FOLDING"</tt> in

- the list of services passed in an analysis.setSubscriptions

- request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the folding regions.

-

- </dd><dt class="field">regions: List<<a href="#type_FoldingRegion">FoldingRegion</a>></dt><dd>

-

- The folding regions contained in the file.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.highlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification: {

+ The folding regions contained in the file.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.highlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.highlights"

"params": {

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

"regions": List<<a href="#type_HighlightRegion">HighlightRegion</a>>

}

}</pre></div>

+

+ Reports the highlight regions associated with a given file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"HIGHLIGHTS"</tt>

+ in the list of services passed in an

+ analysis.setSubscriptions request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the highlight regions.

+

+ </dd><dt class="field">regions: List<<a href="#type_HighlightRegion">HighlightRegion</a>></dt><dd>

- Reports the highlight regions associated with a given file.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"HIGHLIGHTS"</tt>

- in the list of services passed in an

- analysis.setSubscriptions request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the highlight regions.

-

- </dd><dt class="field">regions: List<<a href="#type_HighlightRegion">HighlightRegion</a>></dt><dd>

-

- The highlight regions contained in the file. Each

- highlight region represents a particular syntactic or

- semantic meaning associated with some range. Note that

- the highlight regions that are returned can overlap

- other highlight regions if there is more than one

- meaning associated with a particular region.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.implemented">analysis.implemented</a></dt><dd><div class="box"><pre>notification: {

+ The highlight regions contained in the file. Each

+ highlight region represents a particular syntactic or

+ semantic meaning associated with some range. Note that

+ the highlight regions that are returned can overlap

+ other highlight regions if there is more than one

+ meaning associated with a particular region.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.implemented">analysis.implemented</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.implemented"

"params": {

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

@@ -1221,33 +1229,33 @@ a:focus, a:hover {

"members": List<<a href="#type_ImplementedMember">ImplementedMember</a>>

}

}</pre></div>

+

+ Reports the classes that are implemented or extended and

+ class members that are implemented or overridden in a file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"IMPLEMENTED"</tt> in

+ the list of services passed in an analysis.setSubscriptions

+ request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file with which the implementations are associated.

+

+ </dd><dt class="field">classes: List<<a href="#type_ImplementedClass">ImplementedClass</a>></dt><dd>

+

+ The classes defined in the file that are implemented or extended.

+

+ </dd><dt class="field">members: List<<a href="#type_ImplementedMember">ImplementedMember</a>></dt><dd>

- Reports the classes that are implemented or extended and

- class members that are implemented or overridden in a file.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"IMPLEMENTED"</tt> in

- the list of services passed in an analysis.setSubscriptions

- request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file with which the implementations are associated.

-

- </dd><dt class="field">classes: List<<a href="#type_ImplementedClass">ImplementedClass</a>></dt><dd>

-

- The classes defined in the file that are implemented or extended.

-

- </dd><dt class="field">members: List<<a href="#type_ImplementedMember">ImplementedMember</a>></dt><dd>

-

- The member defined in the file that are implemented or overridden.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.invalidate">analysis.invalidate</a></dt><dd><div class="box"><pre>notification: {

+ The member defined in the file that are implemented or overridden.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.invalidate">analysis.invalidate</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.invalidate"

"params": {

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

@@ -1256,39 +1264,39 @@ a:focus, a:hover {

"delta": int

}

}</pre></div>

+

+ Reports that the navigation information associated with a region of a

+ single file has become invalid and should be re-requested.

+

+

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

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file whose information has been invalidated.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the invalidated region.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the invalidated region.

+

+ </dd><dt class="field">delta: int</dt><dd>

- Reports that the navigation information associated with a region of a

- single file has become invalid and should be re-requested.

-

-

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

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file whose information has been invalidated.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the invalidated region.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the invalidated region.

-

- </dd><dt class="field">delta: int</dt><dd>

-

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

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.navigation">analysis.navigation</a></dt><dd><div class="box"><pre>notification: {

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

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.navigation">analysis.navigation</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.navigation"

"params": {

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

@@ -1297,79 +1305,79 @@ a:focus, a:hover {

"files": List<<a href="#type_FilePath">FilePath</a>>

}

}</pre></div>

+

+ Reports the navigation targets associated with a given file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"NAVIGATION"</tt>

+ in the list of services passed in an

+ analysis.setSubscriptions request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the navigation regions.

+

+ </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

+

+ The navigation regions contained in the file.

+ The regions are sorted by their offsets.

+ Each navigation region represents a list of targets

+ associated with some range. The lists will usually

+ contain a single target, but can contain more in the

+ case of a part that is included in multiple libraries

+ or in Dart code that is compiled against multiple

+ versions of a package. Note that the navigation

+ regions that are returned do not overlap other

+ navigation regions.

+

+ </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

+

+ The navigation targets referenced in the file.

+ They are referenced by <tt>NavigationRegion</tt>s by their

+ index in this array.

+

+ </dd><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

- Reports the navigation targets associated with a given file.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"NAVIGATION"</tt>

- in the list of services passed in an

- analysis.setSubscriptions request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the navigation regions.

-

- </dd><dt class="field">regions: List<<a href="#type_NavigationRegion">NavigationRegion</a>></dt><dd>

-

- The navigation regions contained in the file.

- The regions are sorted by their offsets.

- Each navigation region represents a list of targets

- associated with some range. The lists will usually

- contain a single target, but can contain more in the

- case of a part that is included in multiple libraries

- or in Dart code that is compiled against multiple

- versions of a package. Note that the navigation

- regions that are returned do not overlap other

- navigation regions.

-

- </dd><dt class="field">targets: List<<a href="#type_NavigationTarget">NavigationTarget</a>></dt><dd>

-

- The navigation targets referenced in the file.

- They are referenced by <tt>NavigationRegion</tt>s by their

- index in this array.

-

- </dd><dt class="field">files: List<<a href="#type_FilePath">FilePath</a>></dt><dd>

-

- The files containing navigation targets referenced in the file.

- They are referenced by <tt>NavigationTarget</tt>s by their

- index in this array.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.occurrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notification: {

+ The files containing navigation targets referenced in the file.

+ They are referenced by <tt>NavigationTarget</tt>s by their

+ index in this array.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.occurrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.occurrences"

"params": {

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

"occurrences": List<<a href="#type_Occurrences">Occurrences</a>>

}

}</pre></div>

+

+ Reports the occurrences of references to elements within a

+ single file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"OCCURRENCES"</tt>

+ in the list of services passed in an

+ analysis.setSubscriptions request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Reports the occurrences of references to elements within a

- single file.

+ The file in which the references occur.

+ </dd><dt class="field">occurrences: List<<a href="#type_Occurrences">Occurrences</a>></dt><dd>

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"OCCURRENCES"</tt>

- in the list of services passed in an

- analysis.setSubscriptions request.

+ The occurrences of references to elements within the

+ file.

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file in which the references occur.

-

- </dd><dt class="field">occurrences: List<<a href="#type_Occurrences">Occurrences</a>></dt><dd>

-

- The occurrences of references to elements within the

- file.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.outline">analysis.outline</a></dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.outline">analysis.outline</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.outline"

"params": {

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

@@ -1378,77 +1386,77 @@ a:focus, a:hover {

"outline": <a href="#type_Outline">Outline</a>

}

}</pre></div>

+

+ Reports the outline associated with a single file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"OUTLINE"</tt> in

+ the list of services passed in an analysis.setSubscriptions

+ request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file with which the outline is associated.

+

+ </dd><dt class="field">kind: <a href="#type_FileKind">FileKind</a></dt><dd>

+

+ The kind of the file.

+

+ </dd><dt class="field">libraryName: String (optional)</dt><dd>

+

+ The name of the library defined by the file using a "library"

+ directive, or referenced by a "part of" directive. If both

+ "library" and "part of" directives are present, then the

+ "library" directive takes precedence.

+ This field will be omitted if the file has neither "library"

+ nor "part of" directives.

+

+ </dd><dt class="field">outline: <a href="#type_Outline">Outline</a></dt><dd>

- Reports the outline associated with a single file.

-

-

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"OUTLINE"</tt> in

- the list of services passed in an analysis.setSubscriptions

- request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file with which the outline is associated.

-

- </dd><dt class="field">kind: <a href="#type_FileKind">FileKind</a></dt><dd>

-

- The kind of the file.

-

- </dd><dt class="field">libraryName: String (optional)</dt><dd>

-

- The name of the library defined by the file using a "library"

- directive, or referenced by a "part of" directive. If both

- "library" and "part of" directives are present, then the

- "library" directive takes precedence.

- This field will be omitted if the file has neither "library"

- nor "part of" directives.

-

- </dd><dt class="field">outline: <a href="#type_Outline">Outline</a></dt><dd>

-

- The outline associated with the file.

-

- </dd></dl></dd><dt class="notification"><a name="notification_analysis.overrides">analysis.overrides</a></dt><dd><div class="box"><pre>notification: {

+ The outline associated with the file.

+

+ </dd></dl></dd><dt class="notification"><a name="notification_analysis.overrides">analysis.overrides</a></dt><dd><div class="box"><pre>notification: {

"event": "analysis.overrides"

"params": {

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

"overrides": List<<a href="#type_Override">Override</a>>

}

}</pre></div>

+

+ Reports the overriding members in a file.

+

+

+ This notification is not subscribed to by default. Clients

+ can subscribe by including the value <tt>"OVERRIDES"</tt> in

+ the list of services passed in an analysis.setSubscriptions

+ request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Reports the overriding members in a file.

+ The file with which the overrides are associated.

+ </dd><dt class="field">overrides: List<<a href="#type_Override">Override</a>></dt><dd>

- This notification is not subscribed to by default. Clients

- can subscribe by including the value <tt>"OVERRIDES"</tt> in

- the list of services passed in an analysis.setSubscriptions

- request.

+ The overrides associated with the file.

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file with which the overrides are associated.

-

- </dd><dt class="field">overrides: List<<a href="#type_Override">Override</a>></dt><dd>

-

- The overrides associated with the file.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_completion">completion domain</a></h2>

-

- The code completion domain contains commands related to

- getting code completion suggestions.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggestions">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_completion">completion domain</a></h2>

+

+ The code completion domain contains commands related to

+ getting code completion suggestions.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggestions">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "completion.getSuggestions"

"params": {

@@ -1462,31 +1470,31 @@ a:focus, a:hover {

"id": <a href="#type_CompletionId">CompletionId</a>

}

}</pre></div>

+

+ Request that completion suggestions for the given offset in

+ the given file be returned.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the point at which suggestions are

+ to be made.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset within the file at which suggestions are to

+ be made.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_CompletionId">CompletionId</a></dt><dd>

- Request that completion suggestions for the given offset in

- the given file be returned.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the point at which suggestions are

- to be made.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset within the file at which suggestions are to

- be made.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_CompletionId">CompletionId</a></dt><dd>

-

- The identifier used to associate results with this

- completion request.

-

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_completion.results">completion.results</a></dt><dd><div class="box"><pre>notification: {

+ The identifier used to associate results with this

+ completion request.

+

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_completion.results">completion.results</a></dt><dd><div class="box"><pre>notification: {

"event": "completion.results"

"params": {

"id": <a href="#type_CompletionId">CompletionId</a>

@@ -1496,65 +1504,65 @@ a:focus, a:hover {

"isLast": bool

}

}</pre></div>

+

+ Reports the completion suggestions that should be presented

+ to the user. The set of suggestions included in the

+ notification is always a complete list that supersedes any

+ previously reported suggestions.

+

+ <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_CompletionId">CompletionId</a></dt><dd>

- Reports the completion suggestions that should be presented

- to the user. The set of suggestions included in the

- notification is always a complete list that supersedes any

- previously reported suggestions.

-

- <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_CompletionId">CompletionId</a></dt><dd>

-

- The id associated with the completion.

-

- </dd><dt class="field">replacementOffset: int</dt><dd>

-

- The offset of the start of the text to be

- replaced. This will be different than the offset used

- to request the completion suggestions if there was a

- portion of an identifier before the original

- offset. In particular, the replacementOffset will be

- the offset of the beginning of said identifier.

-

- </dd><dt class="field">replacementLength: int</dt><dd>

-

- The length of the text to be replaced if the remainder

- of the identifier containing the cursor is to be

- replaced when the suggestion is applied (that is, the

- number of characters in the existing identifier).

-

- </dd><dt class="field">results: List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>></dt><dd>

-

- The completion suggestions being reported. The

- notification contains all possible completions at the

- requested cursor position, even those that do not match

- the characters the user has already typed. This allows

- the client to respond to further keystrokes from the

- user without having to make additional requests.

-

- </dd><dt class="field">isLast: bool</dt><dd>

-

- True if this is that last set of results that will be

- returned for the indicated completion.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_search">search domain</a></h2>

-

- The search domain contains commands related to searches that

- can be performed against the code base.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_search.findElementReferences">search.findElementReferences</a></dt><dd><div class="box"><pre>request: {

+ The id associated with the completion.

+

+ </dd><dt class="field">replacementOffset: int</dt><dd>

+

+ The offset of the start of the text to be

+ replaced. This will be different than the offset used

+ to request the completion suggestions if there was a

+ portion of an identifier before the original

+ offset. In particular, the replacementOffset will be

+ the offset of the beginning of said identifier.

+

+ </dd><dt class="field">replacementLength: int</dt><dd>

+

+ The length of the text to be replaced if the remainder

+ of the identifier containing the cursor is to be

+ replaced when the suggestion is applied (that is, the

+ number of characters in the existing identifier).

+

+ </dd><dt class="field">results: List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>></dt><dd>

+

+ The completion suggestions being reported. The

+ notification contains all possible completions at the

+ requested cursor position, even those that do not match

+ the characters the user has already typed. This allows

+ the client to respond to further keystrokes from the

+ user without having to make additional requests.

+

+ </dd><dt class="field">isLast: bool</dt><dd>

+

+ True if this is that last set of results that will be

+ returned for the indicated completion.

+

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_search">search domain</a></h2>

+

+ The search domain contains commands related to searches that

+ can be performed against the code base.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_search.findElementReferences">search.findElementReferences</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "search.findElementReferences"

"params": {

@@ -1570,58 +1578,58 @@ a:focus, a:hover {

"element": optional <a href="#type_Element">Element</a>

}

}</pre></div>

+

+ Perform a search for references to the element defined or

+ referenced at the given offset in the given file.

+

+

+ An identifier is returned immediately, and individual

+ results will be returned via the search.results notification

+ as they become available.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the declaration of or reference to

+ the element used to define the search.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset within the file of the declaration of or

+ reference to the element.

+

+ </dd><dt class="field">includePotential: bool</dt><dd>

+

+ True if potential matches are to be included in the

+ results.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a> (optional)</dt><dd>

- Perform a search for references to the element defined or

- referenced at the given offset in the given file.

-

-

- An identifier is returned immediately, and individual

- results will be returned via the search.results notification

- as they become available.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the declaration of or reference to

- the element used to define the search.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset within the file of the declaration of or

- reference to the element.

-

- </dd><dt class="field">includePotential: bool</dt><dd>

-

- True if potential matches are to be included in the

- results.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a> (optional)</dt><dd>

-

- The identifier used to associate results with this

- search request.

-

-

- If no element was found at the given location, this

- field will be absent, and no results will be reported

- via the search.results notification.

-

- </dd><dt class="field">element: <a href="#type_Element">Element</a> (optional)</dt><dd>

-

- The element referenced or defined at the given offset

- and whose references will be returned in the search

- results.

-

-

- If no element was found at the given location, this

- field will be absent.

-

- </dd></dl></dd><dt class="request"><a name="request_search.findMemberDeclarations">search.findMemberDeclarations</a></dt><dd><div class="box"><pre>request: {

+ The identifier used to associate results with this

+ search request.

+

+

+ If no element was found at the given location, this

+ field will be absent, and no results will be reported

+ via the search.results notification.

+

+ </dd><dt class="field">element: <a href="#type_Element">Element</a> (optional)</dt><dd>

+

+ The element referenced or defined at the given offset

+ and whose references will be returned in the search

+ results.

+

+

+ If no element was found at the given location, this

+ field will be absent.

+

+ </dd></dl></dd><dt class="request"><a name="request_search.findMemberDeclarations">search.findMemberDeclarations</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "search.findMemberDeclarations"

"params": {

@@ -1634,29 +1642,29 @@ a:focus, a:hover {

"id": <a href="#type_SearchId">SearchId</a>

}

}</pre></div>

+

+ Perform a search for declarations of members whose name is

+ equal to the given name.

+

+

+ An identifier is returned immediately, and individual

+ results will be returned via the search.results notification

+ as they become available.

+

+ <h4>parameters:</h4><dl><dt class="field">name: String</dt><dd>

- Perform a search for declarations of members whose name is

- equal to the given name.

+ The name of the declarations to be found.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

- An identifier is returned immediately, and individual

- results will be returned via the search.results notification

- as they become available.

+ The identifier used to associate results with this

+ search request.

- <h4>parameters:</h4><dl><dt class="field">name: String</dt><dd>

-

- The name of the declarations to be found.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

-

- The identifier used to associate results with this

- search request.

-

- </dd></dl></dd><dt class="request"><a name="request_search.findMemberReferences">search.findMemberReferences</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_search.findMemberReferences">search.findMemberReferences</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "search.findMemberReferences"

"params": {

@@ -1669,31 +1677,31 @@ a:focus, a:hover {

"id": <a href="#type_SearchId">SearchId</a>

}

}</pre></div>

+

+ Perform a search for references to members whose name is

+ equal to the given name. This search does not check to see

+ that there is a member defined with the given name, so it is

+ able to find references to undefined members as well.

+

+

+ An identifier is returned immediately, and individual

+ results will be returned via the search.results notification

+ as they become available.

+

+ <h4>parameters:</h4><dl><dt class="field">name: String</dt><dd>

- Perform a search for references to members whose name is

- equal to the given name. This search does not check to see

- that there is a member defined with the given name, so it is

- able to find references to undefined members as well.

+ The name of the references to be found.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

- An identifier is returned immediately, and individual

- results will be returned via the search.results notification

- as they become available.

+ The identifier used to associate results with this

+ search request.

- <h4>parameters:</h4><dl><dt class="field">name: String</dt><dd>

-

- The name of the references to be found.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

-

- The identifier used to associate results with this

- search request.

-

- </dd></dl></dd><dt class="request"><a name="request_search.findTopLevelDeclarations">search.findTopLevelDeclarations</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_search.findTopLevelDeclarations">search.findTopLevelDeclarations</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "search.findTopLevelDeclarations"

"params": {

@@ -1706,31 +1714,31 @@ a:focus, a:hover {

"id": <a href="#type_SearchId">SearchId</a>

}

}</pre></div>

+

+ Perform a search for declarations of top-level elements

+ (classes, typedefs, getters, setters, functions and fields)

+ whose name matches the given pattern.

+

+

+ An identifier is returned immediately, and individual

+ results will be returned via the search.results notification

+ as they become available.

+

+ <h4>parameters:</h4><dl><dt class="field">pattern: String</dt><dd>

- Perform a search for declarations of top-level elements

- (classes, typedefs, getters, setters, functions and fields)

- whose name matches the given pattern.

+ The regular expression used to match the names of the

+ declarations to be found.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

- An identifier is returned immediately, and individual

- results will be returned via the search.results notification

- as they become available.

+ The identifier used to associate results with this

+ search request.

- <h4>parameters:</h4><dl><dt class="field">pattern: String</dt><dd>

-

- The regular expression used to match the names of the

- declarations to be found.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

-

- The identifier used to associate results with this

- search request.

-

- </dd></dl></dd><dt class="request"><a name="request_search.getTypeHierarchy">search.getTypeHierarchy</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_search.getTypeHierarchy">search.getTypeHierarchy</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "search.getTypeHierarchy"

"params": {

@@ -1745,46 +1753,46 @@ a:focus, a:hover {

"hierarchyItems": optional List<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>>

}

}</pre></div>

+

+ Return the type hierarchy of the class declared or

+ referenced at the given location.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the declaration or reference to the

+ type for which a hierarchy is being requested.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the name of the type within the file.

+

+ </dd><dt class="field">superOnly: bool (optional)</dt><dd>

+

+ True if the client is only requesting superclasses and

+ interfaces hierarchy.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">hierarchyItems: List<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>> (optional)</dt><dd>

- Return the type hierarchy of the class declared or

- referenced at the given location.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the declaration or reference to the

- type for which a hierarchy is being requested.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the name of the type within the file.

-

- </dd><dt class="field">superOnly: bool (optional)</dt><dd>

-

- True if the client is only requesting superclasses and

- interfaces hierarchy.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">hierarchyItems: List<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>> (optional)</dt><dd>

-

- A list of the types in the requested hierarchy. The

- first element of the list is the item representing the

- type for which the hierarchy was requested. The index of

- other elements of the list is unspecified, but

- correspond to the integers used to reference supertype

- and subtype items within the items.

-

-

- This field will be absent if the code at the given file

- and offset does not represent a type, or if the file has

- not been sufficiently analyzed to allow a type hierarchy

- to be produced.

-

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_search.results">search.results</a></dt><dd><div class="box"><pre>notification: {

+ A list of the types in the requested hierarchy. The

+ first element of the list is the item representing the

+ type for which the hierarchy was requested. The index of

+ other elements of the list is unspecified, but

+ correspond to the integers used to reference supertype

+ and subtype items within the items.

+

+

+ This field will be absent if the code at the given file

+ and offset does not represent a type, or if the file has

+ not been sufficiently analyzed to allow a type hierarchy

+ to be produced.

+

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_search.results">search.results</a></dt><dd><div class="box"><pre>notification: {

"event": "search.results"

"params": {

"id": <a href="#type_SearchId">SearchId</a>

@@ -1792,119 +1800,119 @@ a:focus, a:hover {

"isLast": bool

}

}</pre></div>

+

+ Reports some or all of the results of performing a requested

+ search. Unlike other notifications, this notification

+ contains search results that should be added to any

+ previously received search results associated with the same

+ search id.

+

+ <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

- Reports some or all of the results of performing a requested

- search. Unlike other notifications, this notification

- contains search results that should be added to any

- previously received search results associated with the same

- search id.

-

- <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_SearchId">SearchId</a></dt><dd>

-

- The id associated with the search.

-

- </dd><dt class="field">results: List<<a href="#type_SearchResult">SearchResult</a>></dt><dd>

-

- The search results being reported.

-

- </dd><dt class="field">isLast: bool</dt><dd>

-

- True if this is that last set of results that will be

- returned for the indicated search.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_edit">edit domain</a></h2>

-

- The edit domain contains commands related to edits that can be

- applied to the code.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit.format</a></dt><dd><div class="box"><pre>request: {

- "id": String

- "method": "edit.format"

- "params": {

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

- "selectionOffset": int

- "selectionLength": int

- "lineLength": optional int

- }

-}</pre> <pre>response: {

- "id": String

- "error": optional <a href="#type_RequestError">RequestError</a>

+ The id associated with the search.

+

+ </dd><dt class="field">results: List<<a href="#type_SearchResult">SearchResult</a>></dt><dd>

+

+ The search results being reported.

+

+ </dd><dt class="field">isLast: bool</dt><dd>

+

+ True if this is that last set of results that will be

+ returned for the indicated search.

+

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_edit">edit domain</a></h2>

+

+ The edit domain contains commands related to edits that can be

+ applied to the code.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit.format</a></dt><dd><div class="box"><pre>request: {

+ "id": String

+ "method": "edit.format"

+ "params": {

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

+ "selectionOffset": int

+ "selectionLength": int

+ "lineLength": optional int

+ }

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

+ "id": String

+ "error": optional <a href="#type_RequestError">RequestError</a>

"result": {

"edits": List<<a href="#type_SourceEdit">SourceEdit</a>>

"selectionOffset": int

"selectionLength": int

}

}</pre></div>

+

+ Format the contents of a single file. The currently selected region of

+ text is passed in so that the selection can be preserved across the

+ formatting operation. The updated selection will be as close to

+ matching the original as possible, but whitespace at the beginning or

+ end of the selected region will be ignored. If preserving selection

+ information is not required, zero (0) can be specified for both the

+ selection offset and selection length.

+

+

+ If a request is made for a file which does not exist, or which is not

+ currently subject to analysis (e.g. because it is not associated with

+ any analysis root specified to analysis.setAnalysisRoots), an error of

+ type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source

+ contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>

+ will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the code to be formatted.

+

+ </dd><dt class="field">selectionOffset: int</dt><dd>

+

+ The offset of the current selection in the file.

+

+ </dd><dt class="field">selectionLength: int</dt><dd>

+

+ The length of the current selection in the file.

+

+ </dd><dt class="field">lineLength: int (optional)</dt><dd>

+

+ The line length to be used by the formatter.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

+

+ The edit(s) to be applied in order to format the code. The list

+ will be empty if the code was already formatted (there are no

+ changes).

+

+ </dd><dt class="field">selectionOffset: int</dt><dd>

- Format the contents of a single file. The currently selected region of

- text is passed in so that the selection can be preserved across the

- formatting operation. The updated selection will be as close to

- matching the original as possible, but whitespace at the beginning or

- end of the selected region will be ignored. If preserving selection

- information is not required, zero (0) can be specified for both the

- selection offset and selection length.

-

-

- If a request is made for a file which does not exist, or which is not

- currently subject to analysis (e.g. because it is not associated with

- any analysis root specified to analysis.setAnalysisRoots), an error of

- type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source

- contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>

- will be generated.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the code to be formatted.

-

- </dd><dt class="field">selectionOffset: int</dt><dd>

-

- The offset of the current selection in the file.

-

- </dd><dt class="field">selectionLength: int</dt><dd>

-

- The length of the current selection in the file.

-

- </dd><dt class="field">lineLength: int (optional)</dt><dd>

-

- The line length to be used by the formatter.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

-

- The edit(s) to be applied in order to format the code. The list

- will be empty if the code was already formatted (there are no

- changes).

-

- </dd><dt class="field">selectionOffset: int</dt><dd>

-

- The offset of the selection after formatting the code.

-

- </dd><dt class="field">selectionLength: int</dt><dd>

-

- The length of the selection after formatting the code.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">edit.getAssists</a></dt><dd><div class="box"><pre>request: {

+ The offset of the selection after formatting the code.

+

+ </dd><dt class="field">selectionLength: int</dt><dd>

+

+ The length of the selection after formatting the code.

+

+ </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">edit.getAssists</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getAssists"

"params": {

@@ -1919,38 +1927,38 @@ a:focus, a:hover {

"assists": List<<a href="#type_SourceChange">SourceChange</a>>

}

}</pre></div>

+

+ Return the set of assists that are available at the given

+ location. An assist is distinguished from a refactoring

+ primarily by the fact that it affects a single file and does

+ not require user input in order to be performed.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the code for which assists are being

+ requested.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the code for which assists are being

+ requested.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the code for which assists are being

+ requested.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">assists: List<<a href="#type_SourceChange">SourceChange</a>></dt><dd>

- Return the set of assists that are available at the given

- location. An assist is distinguished from a refactoring

- primarily by the fact that it affects a single file and does

- not require user input in order to be performed.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the code for which assists are being

- requested.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the code for which assists are being

- requested.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the code for which assists are being

- requested.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">assists: List<<a href="#type_SourceChange">SourceChange</a>></dt><dd>

-

- The assists that are available at the given location.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefactorings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>request: {

+ The assists that are available at the given location.

+

+ </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefactorings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getAvailableRefactorings"

"params": {

@@ -1965,37 +1973,37 @@ a:focus, a:hover {

"kinds": List<<a href="#type_RefactoringKind">RefactoringKind</a>>

}

}</pre></div>

+

+ Get a list of the kinds of refactorings that are valid for

+ the given selection in the given file.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the code on which the refactoring

+ would be based.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the code on which the refactoring would be

+ based.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the code on which the refactoring would be

+ based.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">kinds: List<<a href="#type_RefactoringKind">RefactoringKind</a>></dt><dd>

- Get a list of the kinds of refactorings that are valid for

- the given selection in the given file.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the code on which the refactoring

- would be based.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the code on which the refactoring would be

- based.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the code on which the refactoring would be

- based.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">kinds: List<<a href="#type_RefactoringKind">RefactoringKind</a>></dt><dd>

-

- The kinds of refactorings that are valid for the given

- selection.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.getFixes</a></dt><dd><div class="box"><pre>request: {

+ The kinds of refactorings that are valid for the given

+ selection.

+

+ </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.getFixes</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getFixes"

"params": {

@@ -2009,30 +2017,30 @@ a:focus, a:hover {

"fixes": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>

}

}</pre></div>

+

+ Return the set of fixes that are available for the errors at

+ a given offset in a given file.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the errors for which fixes are being

+ requested.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset used to select the errors for which fixes

+ will be returned.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">fixes: List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>></dt><dd>

- Return the set of fixes that are available for the errors at

- a given offset in a given file.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the errors for which fixes are being

- requested.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset used to select the errors for which fixes

- will be returned.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">fixes: List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>></dt><dd>

-

- The fixes that are available for the errors at the given offset.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.getRefactoring">edit.getRefactoring</a></dt><dd><div class="box"><pre>request: {

+ The fixes that are available for the errors at the given offset.

+

+ </dd></dl></dd><dt class="request"><a name="request_edit.getRefactoring">edit.getRefactoring</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.getRefactoring"

"params": {

@@ -2055,108 +2063,108 @@ a:focus, a:hover {

"potentialEdits": optional List<String>

}

}</pre></div>

+

+ Get the changes required to perform a refactoring.

+

+

+ If another refactoring request is received during the processing

+ of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>

+ will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">kind: <a href="#type_RefactoringKind">RefactoringKind</a></dt><dd>

+

+ The kind of refactoring to be performed.

+

+ </dd><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the code involved in the

+ refactoring.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the region involved in the refactoring.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region involved in the refactoring.

+

+ </dd><dt class="field">validateOnly: bool</dt><dd>

+

+ True if the client is only requesting that the values of

+ the options be validated and no change be generated.

+

+ </dd><dt class="field">options: <a href="#type_RefactoringOptions">RefactoringOptions</a> (optional)</dt><dd>

+

+ Data used to provide values provided by the user. The

+ structure of the data is dependent on the kind of

+ refactoring being performed. The data that is expected is

+ documented in the section titled <a href="#refactorings">Refactorings</a>, labeled as

+ "Options". This field can be omitted if the refactoring

+ does not require any options or if the values of those

+ options are not known.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">initialProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

+

+ The initial status of the refactoring, i.e. problems related to

+ the context in which the refactoring is requested.

+ The array will be empty if there are no known problems.

+

+ </dd><dt class="field">optionsProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

+

+ The options validation status, i.e. problems in the given options,

+ such as light-weight validation of a new name, flags

+ compatibility, etc.

+ The array will be empty if there are no known problems.

+

+ </dd><dt class="field">finalProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

+

+ The final status of the refactoring, i.e. problems identified in

+ the result of a full, potentially expensive validation and / or

+ change creation.

+ The array will be empty if there are no known problems.

+

+ </dd><dt class="field">feedback: <a href="#type_RefactoringFeedback">RefactoringFeedback</a> (optional)</dt><dd>

- Get the changes required to perform a refactoring.

-

-

- If another refactoring request is received during the processing

- of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>

- will be generated.

-

- <h4>parameters:</h4><dl><dt class="field">kind: <a href="#type_RefactoringKind">RefactoringKind</a></dt><dd>

-

- The kind of refactoring to be performed.

-

- </dd><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the code involved in the

- refactoring.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the region involved in the refactoring.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region involved in the refactoring.

-

- </dd><dt class="field">validateOnly: bool</dt><dd>

-

- True if the client is only requesting that the values of

- the options be validated and no change be generated.

-

- </dd><dt class="field">options: <a href="#type_RefactoringOptions">RefactoringOptions</a> (optional)</dt><dd>

-

- Data used to provide values provided by the user. The

- structure of the data is dependent on the kind of

- refactoring being performed. The data that is expected is

- documented in the section titled <a href="#refactorings">Refactorings</a>, labeled as

- "Options". This field can be omitted if the refactoring

- does not require any options or if the values of those

- options are not known.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">initialProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

-

- The initial status of the refactoring, i.e. problems related to

- the context in which the refactoring is requested.

- The array will be empty if there are no known problems.

-

- </dd><dt class="field">optionsProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

-

- The options validation status, i.e. problems in the given options,

- such as light-weight validation of a new name, flags

- compatibility, etc.

- The array will be empty if there are no known problems.

-

- </dd><dt class="field">finalProblems: List<<a href="#type_RefactoringProblem">RefactoringProblem</a>></dt><dd>

-

- The final status of the refactoring, i.e. problems identified in

- the result of a full, potentially expensive validation and / or

- change creation.

- The array will be empty if there are no known problems.

-

- </dd><dt class="field">feedback: <a href="#type_RefactoringFeedback">RefactoringFeedback</a> (optional)</dt><dd>

-

- Data used to provide feedback to the user. The structure

- of the data is dependent on the kind of refactoring

- being created. The data that is returned is documented

- in the section titled <a href="#refactorings">Refactorings</a>, labeled as

- "Feedback".

-

- </dd><dt class="field">change: <a href="#type_SourceChange">SourceChange</a> (optional)</dt><dd>

-

- The changes that are to be applied to affect the

- refactoring. This field will be omitted if there are

- problems that prevent a set of changes from being

- computed, such as having no options specified for a

- refactoring that requires them, or if only validation

- was requested.

-

- </dd><dt class="field">potentialEdits: List<String> (optional)</dt><dd>

-

- The ids of source edits that are not known to be valid. An edit is

- not known to be valid if there was insufficient type information

- for the server to be able to determine whether or not the code

- needs to be modified, such as when a member is being renamed and

- there is a reference to a member from an unknown type. This field

- will be omitted if the change field is omitted or if there are no

- potential edits for the refactoring.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers">edit.sortMembers</a></dt><dd><div class="box"><pre>request: {

+ Data used to provide feedback to the user. The structure

+ of the data is dependent on the kind of refactoring

+ being created. The data that is returned is documented

+ in the section titled <a href="#refactorings">Refactorings</a>, labeled as

+ "Feedback".

+

+ </dd><dt class="field">change: <a href="#type_SourceChange">SourceChange</a> (optional)</dt><dd>

+

+ The changes that are to be applied to affect the

+ refactoring. This field will be omitted if there are

+ problems that prevent a set of changes from being

+ computed, such as having no options specified for a

+ refactoring that requires them, or if only validation

+ was requested.

+

+ </dd><dt class="field">potentialEdits: List<String> (optional)</dt><dd>

+

+ The ids of source edits that are not known to be valid. An edit is

+ not known to be valid if there was insufficient type information

+ for the server to be able to determine whether or not the code

+ needs to be modified, such as when a member is being renamed and

+ there is a reference to a member from an unknown type. This field

+ will be omitted if the change field is omitted or if there are no

+ potential edits for the refactoring.

+

+ </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers">edit.sortMembers</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.sortMembers"

"params": {

@@ -2169,33 +2177,33 @@ a:focus, a:hover {

"edit": <a href="#type_SourceFileEdit">SourceFileEdit</a>

}

}</pre></div>

+

+ Sort all of the directives, unit and class members

+ of the given Dart file.

+

+

+ If a request is made for a file that does not exist, does not belong

+ to an analysis root or is not a Dart file,

+ <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.

+

+

+ If the Dart file has scan or parse errors,

+ <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Sort all of the directives, unit and class members

- of the given Dart file.

-

-

- If a request is made for a file that does not exist, does not belong

- to an analysis root or is not a Dart file,

- <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.

+ The Dart file to sort.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></dt><dd>

- If the Dart file has scan or parse errors,

- <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.

+ The file edit that is to be applied to the given file to effect

+ the sorting.

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The Dart file to sort.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></dt><dd>

-

- The file edit that is to be applied to the given file to effect

- the sorting.

-

- </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirectives">edit.organizeDirectives</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirectives">edit.organizeDirectives</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "edit.organizeDirectives"

"params": {

@@ -2208,47 +2216,48 @@ a:focus, a:hover {

"edit": <a href="#type_SourceFileEdit">SourceFileEdit</a>

}

}</pre></div>

+

+ Organizes all of the directives - removes unused imports and sorts

+ directives of the given Dart file according to the

+ <a href="https://www.dartlang.org/articles/style-guide/">Dart Style

+ Guide</a>.

+

+

+ If a request is made for a file that does not exist, does not belong

+ to an analysis root or is not a Dart file,

+ <tt>FILE_NOT_ANALYZED</tt> will be generated.

+

+

+ If directives of the Dart file cannot be organized, for example

+ because it has scan or parse errors, or by other reasons,

+ <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message

+ will provide details about the reason.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Organizes all of the directives - removes unused imports and sorts

- directives of the given Dart file according to the

- <a href="https://www.dartlang.org/articles/style-guide/">Dart Style Guide</a>.

-

-

- If a request is made for a file that does not exist, does not belong

- to an analysis root or is not a Dart file,

- <tt>FILE_NOT_ANALYZED</tt> will be generated.

+ The Dart file to organize directives in.

+ </dd></dl><h4>returns:</h4><dl><dt class="field">edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></dt><dd>

- If directives of the Dart file cannot be organized, for example

- because it has scan or parse errors, or by other reasons,

- <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message

- will provide details about the reason.

+ The file edit that is to be applied to the given file to effect

+ the organizing.

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The Dart file to organize directives in.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></dt><dd>

-

- The file edit that is to be applied to the given file to effect

- the organizing.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_execution">execution domain</a></h2>

-

- The execution domain contains commands related to providing an execution

- or debugging experience.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createContext">execution.createContext</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_execution">execution domain</a></h2>

+

+ The execution domain contains commands related to providing an execution

+ or debugging experience.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_execution.createContext">execution.createContext</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "execution.createContext"

"params": {

@@ -2261,27 +2270,27 @@ a:focus, a:hover {

"id": <a href="#type_ExecutionContextId">ExecutionContextId</a>

}

}</pre></div>

+

+ Create an execution context for the executable file with the given

+ path. The context that is created will persist until

+ execution.deleteContext is used to delete it. Clients, therefore, are

+ responsible for managing the lifetime of execution contexts.

+

+ <h4>parameters:</h4><dl><dt class="field">contextRoot: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The path of the Dart or HTML file that will be launched, or the

+ path of the directory containing the file.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

- Create an execution context for the executable file with the given

- path. The context that is created will persist until

- execution.deleteContext is used to delete it. Clients, therefore, are

- responsible for managing the lifetime of execution contexts.

-

- <h4>parameters:</h4><dl><dt class="field">contextRoot: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The path of the Dart or HTML file that will be launched, or the

- path of the directory containing the file.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

-

- The identifier used to refer to the execution context that was

- created.

-

- </dd></dl></dd><dt class="request"><a name="request_execution.deleteContext">execution.deleteContext</a></dt><dd><div class="box"><pre>request: {

+ The identifier used to refer to the execution context that was

+ created.

+

+ </dd></dl></dd><dt class="request"><a name="request_execution.deleteContext">execution.deleteContext</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "execution.deleteContext"

"params": {

@@ -2291,18 +2300,18 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

+ Delete the execution context with the given identifier. The context id

+ is no longer valid after this command. The server is allowed to re-use

+ ids when they are no longer valid.

+

+ <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

- Delete the execution context with the given identifier. The context id

- is no longer valid after this command. The server is allowed to re-use

- ids when they are no longer valid.

+ The identifier of the execution context that is to be deleted.

- <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

-

- The identifier of the execution context that is to be deleted.

-

- </dd></dl></dd><dt class="request"><a name="request_execution.mapUri">execution.mapUri</a></dt><dd><div class="box"><pre>request: {

+ </dd></dl></dd><dt class="request"><a name="request_execution.mapUri">execution.mapUri</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "execution.mapUri"

"params": {

@@ -2318,65 +2327,65 @@ a:focus, a:hover {

"uri": optional String

}

}</pre></div>

+

+ Map a URI from the execution context to the file that it corresponds

+ to, or map a file to the URI that it corresponds to in the execution

+ context.

+

+

+ Exactly one of the file and uri fields must be provided. If both

+ fields are provided, then an error of type <tt>INVALID_PARAMETER</tt>

+ will be generated. Similarly, if neither field is provided, then an

+ error of type <tt>INVALID_PARAMETER</tt> will be generated.

+

+

+ If the file field is provided and the value is not the path of a file

+ (either the file does not exist or the path references something other

+ than a file), then an error of type <tt>INVALID_PARAMETER</tt> will

+ be generated.

+

+

+ If the uri field is provided and the value is not a valid URI or if

+ the URI references something that is not a file (either a file that

+ does not exist or something other than a file), then an error of type

+ <tt>INVALID_PARAMETER</tt> will be generated.

+

+

+ If the contextRoot used to create the execution context does not

+ exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will

+ be generated.

+

+ <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

+

+ The identifier of the execution context in which the URI is to be

+ mapped.

+

+ </dd><dt class="field">file: <a href="#type_FilePath">FilePath</a> (optional)</dt><dd>

+

+ The path of the file to be mapped into a URI.

+

+ </dd><dt class="field">uri: String (optional)</dt><dd>

+

+ The URI to be mapped into a file path.

+

+ </dd></dl><h4>returns:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a> (optional)</dt><dd>

+

+ The file to which the URI was mapped. This field is omitted if the

+ uri field was not given in the request.

+

+ </dd><dt class="field">uri: String (optional)</dt><dd>

- Map a URI from the execution context to the file that it corresponds

- to, or map a file to the URI that it corresponds to in the execution

- context.

-

-

- Exactly one of the file and uri fields must be provided. If both

- fields are provided, then an error of type <tt>INVALID_PARAMETER</tt>

- will be generated. Similarly, if neither field is provided, then an

- error of type <tt>INVALID_PARAMETER</tt> will be generated.

-

-

- If the file field is provided and the value is not the path of a file

- (either the file does not exist or the path references something other

- than a file), then an error of type <tt>INVALID_PARAMETER</tt> will

- be generated.

-

-

- If the uri field is provided and the value is not a valid URI or if

- the URI references something that is not a file (either a file that

- does not exist or something other than a file), then an error of type

- <tt>INVALID_PARAMETER</tt> will be generated.

-

-

- If the contextRoot used to create the execution context does not

- exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will

- be generated.

-

- <h4>parameters:</h4><dl><dt class="field">id: <a href="#type_ExecutionContextId">ExecutionContextId</a></dt><dd>

-

- The identifier of the execution context in which the URI is to be

- mapped.

-

- </dd><dt class="field">file: <a href="#type_FilePath">FilePath</a> (optional)</dt><dd>

-

- The path of the file to be mapped into a URI.

-

- </dd><dt class="field">uri: String (optional)</dt><dd>

-

- The URI to be mapped into a file path.

-

- </dd></dl><h4>returns:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a> (optional)</dt><dd>

-

- The file to which the URI was mapped. This field is omitted if the

- uri field was not given in the request.

-

- </dd><dt class="field">uri: String (optional)</dt><dd>

-

- The URI to which the file path was mapped. This field is omitted

- if the file field was not given in the request.

-

- </dd></dl></dd><dt class="request deprecated"><a name="request_execution.setSubscriptions">execution.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

+ The URI to which the file path was mapped. This field is omitted

+ if the file field was not given in the request.

+

+ </dd></dl></dd><dt class="request deprecated"><a name="request_execution.setSubscriptions">execution.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "execution.setSubscriptions"

"params": {

@@ -2386,26 +2395,26 @@ a:focus, a:hover {

"id": String

"error": optional <a href="#type_RequestError">RequestError</a>

}</pre></div>

+

+ Deprecated: the analysis server no longer fires

+ <tt>LAUNCH_DATA</tt> events.

+

+

+ Subscribe for services. All previous subscriptions are replaced by the

+ given set of services.

+

+

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

+

+ <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_ExecutionService">ExecutionService</a>></dt><dd>

- Deprecated: the analysis server no longer fires

- <tt>LAUNCH_DATA</tt> events.

-

-

- Subscribe for services. All previous subscriptions are replaced by the

- given set of services.

-

-

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

+ A list of the services being subscribed to.

- <h4>parameters:</h4><dl><dt class="field">subscriptions: List<<a href="#type_ExecutionService">ExecutionService</a>></dt><dd>

-

- A list of the services being subscribed to.

-

- </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_execution.launchData">execution.launchData</a></dt><dd><div class="box"><pre>notification: {

+ </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_execution.launchData">execution.launchData</a></dt><dd><div class="box"><pre>notification: {

"event": "execution.launchData"

"params": {

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

@@ -2413,41 +2422,41 @@ a:focus, a:hover {

"referencedFiles": optional List<<a href="#type_FilePath">FilePath</a>>

}

}</pre></div>

+

+ Reports information needed to allow a single file to be launched.

+

+

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

+ subscribe by including the value "LAUNCH_DATA" in the list of services

+ passed in an <tt>execution.setSubscriptions</tt> request.

+

+ <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

- Reports information needed to allow a single file to be launched.

-

-

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

- subscribe by including the value "LAUNCH_DATA" in the list of services

- passed in an <tt>execution.setSubscriptions</tt> request.

-

- <h4>parameters:</h4><dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file for which launch data is being provided. This will either

- be a Dart library or an HTML file.

-

- </dd><dt class="field">kind: <a href="#type_ExecutableKind">ExecutableKind</a> (optional)</dt><dd>

-

- The kind of the executable file. This field is omitted if the file

- is not a Dart file.

-

- </dd><dt class="field">referencedFiles: List<<a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

-

- A list of the Dart files that are referenced by the file. This

- field is omitted if the file is not an HTML file.

-

- </dd></dl></dd></dl>

- <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2>

-

- The diagnostic domain contains server diagnostics APIs.

-

- <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiagnostics">diagnostic.getDiagnostics</a></dt><dd><div class="box"><pre>request: {

+ The file for which launch data is being provided. This will either

+ be a Dart library or an HTML file.

+

+ </dd><dt class="field">kind: <a href="#type_ExecutableKind">ExecutableKind</a> (optional)</dt><dd>

+

+ The kind of the executable file. This field is omitted if the file

+ is not a Dart file.

+

+ </dd><dt class="field">referencedFiles: List<<a href="#type_FilePath">FilePath</a>> (optional)</dt><dd>

+

+ A list of the Dart files that are referenced by the file. This

+ field is omitted if the file is not an HTML file.

+

+ </dd></dl></dd></dl>

+<h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2>

+

+ The diagnostic domain contains server diagnostics APIs.

+

+<h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiagnostics">diagnostic.getDiagnostics</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "diagnostic.getDiagnostics"

}</pre> <pre>response: {

@@ -2457,12 +2466,12 @@ a:focus, a:hover {

"contexts": List<<a href="#type_ContextData">ContextData</a>>

}

}</pre></div>

- Return server diagnostics.

+ Return server diagnostics.

+ <h4>returns:</h4><dl><dt class="field">contexts: List<<a href="#type_ContextData">ContextData</a>></dt><dd>

- <h4>returns:</h4><dl><dt class="field">contexts: List<<a href="#type_ContextData">ContextData</a>></dt><dd>

- The list of analysis contexts.

- </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServerPort">diagnostic.getServerPort</a></dt><dd><div class="box"><pre>request: {

+ The list of analysis contexts.

+ </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServerPort">diagnostic.getServerPort</a></dt><dd><div class="box"><pre>request: {

"id": String

"method": "diagnostic.getServerPort"

}</pre> <pre>response: {

@@ -2472,2118 +2481,2084 @@ a:focus, a:hover {

"port": int

}

}</pre></div>

-

- Return the port of the diagnostic web server. If the server is not running

- this call will start the server. If unable to start the diagnostic web server,

- this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>.

-

- <h4>returns:</h4><dl><dt class="field">port: int</dt><dd>

- The diagnostic server port.

- </dd></dl></dd></dl>

+

+ Return the port of the diagnostic web server. If the server is not running

+ this call will start the server. If unable to start the diagnostic web

+ server,

+ this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>.

+

- <h2 class="domain"><a name="types">Types</a></h2>

-

- This section contains descriptions of the data types referenced

- in the API’s of the various domains.

-

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

-

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

- supplied content will be used for analysis in place of the

- file contents in the filesystem.

-

-

- If this directive is used on a file that already has a file

- content overlay, the old overlay is discarded and replaced

- with the new one.

-

- <dl><dt class="field">type = "add"</dt><dd></dd><dt class="field">content: String</dt><dd>

-

- The new content of the file.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: object</a></dt><dd>

-

- An indication of an error, warning, or hint that was produced

- by the analysis.

-

- <dl><dt class="field">severity: <a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></dt><dd>

-

- The severity of the error.

-

- </dd><dt class="field">type: <a href="#type_AnalysisErrorType">AnalysisErrorType</a></dt><dd>

-

- The type of the error.

-

- </dd><dt class="field">location: <a href="#type_Location">Location</a></dt><dd>

-

- The location associated with the error.

-

- </dd><dt class="field">message: String</dt><dd>

-

- The message to be displayed for this error. The message

- should indicate what is wrong with the code and why it is

- wrong.

-

- </dd><dt class="field">correction: String (optional)</dt><dd>

-

- The correction message to be displayed for this error. The

- correction message should indicate how the user can fix

- the error. The field is omitted if there is no correction

- message associated with the error code.

-

- </dd><dt class="field">code: String</dt><dd>

-

- The name, as a string, of the error code associated with this error.

-

- </dd><dt class="field">hasFix: bool (optional)</dt><dd>

-

- A hint to indicate to interested clients that this error has

- an associated fix (or fixes). The absence of this field implies

- there are not known to be fixes. Note that since the operation

- to calculate whether fixes apply needs to be performant it is

- possible that complicated tests will be skipped and a false

- negative returned. For this reason, this attribute should be

- treated as a "hint". Despite the possibility of false negatives,

- no false positives should be returned. If a client sees this

- flag set they can proceed with the confidence that there are in

- fact associated fixes.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorFixes">AnalysisErrorFixes: object</a></dt><dd>

-

- A list of fixes associated with a specific error.

-

- <dl><dt class="field">error: <a href="#type_AnalysisError">AnalysisError</a></dt><dd>

-

- The error with which the fixes are associated.

-

- </dd><dt class="field">fixes: List<<a href="#type_SourceChange">SourceChange</a>></dt><dd>

-

- The fixes associated with the error.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorSeverity">AnalysisErrorSeverity: String</a></dt><dd>

-

- An enumeration of the possible severities of analysis

- errors.

-

- <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorType">AnalysisErrorType: String</a></dt><dd>

-

- An enumeration of the possible types of analysis errors.

-

- <dl><dt class="value">CHECKED_MODE_COMPILE_TIME_ERROR</dt><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">LINT</dt><dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt class="typeDefinition deprecated"><a name="type_AnalysisOptions">AnalysisOptions: object</a></dt><dd>

- Deprecated: the only reference to this type has been

- deprecated.

-

- A set of options controlling what kind of analysis is to be

- performed. If the value of a field is omitted the value of the

- option will not be changed.

-

- <dl><dt class="field">enableAsync: bool (optional)</dt><dd>

- Deprecated: this feature is always enabled.

-

- True if the client wants to enable support for the

- proposed async feature.

-

- </dd><dt class="field">enableDeferredLoading: bool (optional)</dt><dd>

- Deprecated: this feature is always enabled.

-

- True if the client wants to enable support for the

- proposed deferred loading feature.

-

- </dd><dt class="field">enableEnums: bool (optional)</dt><dd>

- Deprecated: this feature is always enabled.

-

- True if the client wants to enable support for the

- proposed enum feature.

-

- </dd><dt class="field">enableNullAwareOperators: bool (optional)</dt><dd>

- Deprecated: this feature is always enabled.

-

- True if the client wants to enable support for the

- proposed "null aware operators" feature.

-

- </dd><dt class="field">enableSuperMixins: bool (optional)</dt><dd>

-

- True if the client wants to enable support for the

- proposed "less restricted mixins" proposal (DEP 34).

-

- </dd><dt class="field">generateDart2jsHints: bool (optional)</dt><dd>

-

- True if hints that are specific to dart2js should be

- generated. This option is ignored if generateHints is false.

-

- </dd><dt class="field">generateHints: bool (optional)</dt><dd>

-

- True if hints should be generated as part of generating

- errors and warnings.

-

- </dd><dt class="field">generateLints: bool (optional)</dt><dd>

-

- True if lints should be generated as part of generating

- errors and warnings.

-

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

-

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

- are related to a specific list of files.

-

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

-

- This service is not currently implemented and will become a

- GeneralAnalysisService in a future release.

-

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

-

- An indication of the current state of analysis.

-

- <dl><dt class="field">isAnalyzing: bool</dt><dd>

- True if analysis is currently being performed.

- </dd><dt class="field">analysisTarget: String (optional)</dt><dd>

-

- The name of the current target of analysis. This field is

- omitted if analyzing is false.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentOverlay">ChangeContentOverlay: object</a></dt><dd>

-

- A directive to modify an existing file content overlay. One or more

- ranges of text are deleted from the old file content overlay and

- replaced with new text.

-

-

- The edits are applied in the order in which they occur in the list.

- This means that the offset of each edit must be correct under the

- assumption that all previous edits have been applied.

-

-

- It is an error to use this overlay on a file that does not yet have

- a file content overlay or that has had its overlay removed via

- <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.

-

-

- If any of the edits cannot be applied due to its offset or

- length being out of range, an INVALID_OVERLAY_CHANGE error

- will be reported.

-

- <dl><dt class="field">type = "change"</dt><dd></dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

-

- The edits to be applied to the file.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">CompletionId: String</a></dt><dd>

-

- An identifier used to associate completion results with a

- completion request.

-

- </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">CompletionSuggestion: object</a></dt><dd>

-

- A suggestion for how to complete partially entered text. Many

- of the fields are optional, depending on the kind of element

- being suggested.

-

- <dl><dt class="field">kind: <a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></dt><dd>

-

- The kind of element being suggested.

-

- </dd><dt class="field">relevance: int</dt><dd>

-

- The relevance of this completion suggestion

- where a higher number indicates a higher relevance.

-

- </dd><dt class="field">completion: String</dt><dd>

-

- The identifier to be inserted if the suggestion is

- selected. If the suggestion is for a method or function,

- the client might want to additionally insert a template

- for the parameters. The information required in order to

- do so is contained in other fields.

-

- </dd><dt class="field">selectionOffset: int</dt><dd>

-

- The offset, relative to the beginning of the completion,

- of where the selection should be placed after insertion.

-

- </dd><dt class="field">selectionLength: int</dt><dd>

-

- The number of characters that should be selected after

- insertion.

-

- </dd><dt class="field">isDeprecated: bool</dt><dd>

-

- True if the suggested element is deprecated.

-

- </dd><dt class="field">isPotential: bool</dt><dd>

-

- True if the element is not known to be valid for the

- target. This happens if the type of the target is dynamic.

-

- </dd><dt class="field">docSummary: String (optional)</dt><dd>

-

- An abbreviated version of the Dartdoc associated with the

- element being suggested, This field is omitted if there is

- no Dartdoc associated with the element.

-

- </dd><dt class="field">docComplete: String (optional)</dt><dd>

-

- The Dartdoc associated with the element being suggested,

- This field is omitted if there is no Dartdoc associated

- with the element.

-

- </dd><dt class="field">declaringType: String (optional)</dt><dd>

-

- The class that declares the element being suggested. This

- field is omitted if the suggested element is not a member

- of a class.

-

- </dd><dt class="field">defaultArgumentListString: String (optional)</dt><dd>

-

- A default String for use in generating argument list

- source contents on the client side.

-

- </dd><dt class="field">defaultArgumentListTextRanges: List<int> (optional)</dt><dd>

-

- Pairs of offsets and lengths describing 'defaultArgumentListString'

- text ranges suitable for use by clients to set up linked edits of

- default argument source contents. For example, given an argument

- list string 'x, y', the corresponding text range [0, 1, 3, 1],

- indicates two text ranges of length 1, starting at offsets 0 and 3.

- Clients can use these ranges to treat the 'x' and 'y' values

- specially for linked edits.

-

- </dd><dt class="field">element: <a href="#type_Element">Element</a> (optional)</dt><dd>

-

- Information about the element reference being suggested.

-

- </dd><dt class="field">returnType: String (optional)</dt><dd>

-

- The return type of the getter, function or method

- or the type of the field being suggested.

- This field is omitted if the suggested element

- is not a getter, function or method.

-

- </dd><dt class="field">parameterNames: List<String> (optional)</dt><dd>

-

- The names of the parameters of the function or method

- being suggested. This field is omitted if the suggested

- element is not a setter, function or method.

-

- </dd><dt class="field">parameterTypes: List<String> (optional)</dt><dd>

-

- The types of the parameters of the function or method

- being suggested. This field is omitted if the

- parameterNames field is omitted.

-

- </dd><dt class="field">requiredParameterCount: int (optional)</dt><dd>

-

- The number of required parameters for the function or

- method being suggested. This field is omitted if the

- parameterNames field is omitted.

-

- </dd><dt class="field">hasNamedParameters: bool (optional)</dt><dd>

-

- True if the function or method being suggested has at

- least one named parameter. This field is omitted if the

- parameterNames field is omitted.

-

- </dd><dt class="field">parameterName: String (optional)</dt><dd>

-

- The name of the optional parameter being suggested. This

- field is omitted if the suggestion is not the addition of

- an optional argument within an argument list.

-

- </dd><dt class="field">parameterType: String (optional)</dt><dd>

-

- The type of the options parameter being suggested. This

- field is omitted if the parameterName field is omitted.

-

- </dd><dt class="field">importUri: String (optional)</dt><dd>

-

- The import to be added if the suggestion is out of scope

- and needs an import to be added to be in scope.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggestionKind">CompletionSuggestionKind: String</a></dt><dd>

-

- An enumeration of the kinds of elements that can be included

- in a completion suggestion.

-

- <dl><dt class="value">ARGUMENT_LIST</dt><dd>

-

- A list of arguments for the method or function that is being invoked.

- For this suggestion kind, the completion field is a textual representation

- of the invocation and the parameterNames, parameterTypes, and requiredParameterCount

- attributes are defined.

-

- </dd><dt class="value">IMPORT</dt><dt class="value">IDENTIFIER</dt><dd>

-

- The element identifier should be inserted at the completion location.

- For example "someMethod" in import 'myLib.dart' show someMethod; .

- For suggestions of this kind, the element attribute is defined

- and the completion field is the element's identifier.

-

- </dd><dt class="value">INVOCATION</dt><dd>

-

- The element is being invoked at the completion location.

- For example, "someMethod" in x.someMethod(); .

- For suggestions of this kind, the element attribute is defined

- and the completion field is the element's identifier.

-

- </dd><dt class="value">KEYWORD</dt><dd>

-

- A keyword is being suggested.

- For suggestions of this kind, the completion is the keyword.

-

- </dd><dt class="value">NAMED_ARGUMENT</dt><dd>

-

- A named argument for the current callsite is being suggested.

- For suggestions of this kind, the completion is

- the named argument identifier including a trailing ':' and space.

-

- </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextData: object</a></dt><dd>

-

- Information about an analysis context.

-

- <dl><dt class="field">name: String</dt><dd>

-

- The name of the context.

-

- </dd><dt class="field">explicitFileCount: int</dt><dd>

-

- Explicitly analyzed files.

-

- </dd><dt class="field">implicitFileCount: int</dt><dd>

-

- Implicitly analyzed files.

-

- </dd><dt class="field">workItemQueueLength: int</dt><dd>

-

- The number of work items in the queue.

-

- </dd><dt class="field">cacheEntryExceptions: List<String></dt><dd>

-

- Exceptions associated with cache entries.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>

-

- Information about an element (something that can be declared

- in code).

-

- <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

-

- The kind of the element.

-

- </dd><dt class="field">name: String</dt><dd>

-

- The name of the element. This is typically used as the

- label in the outline.

-

- </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

-

- The location of the name in the declaration of the

- element.

-

- </dd><dt class="field">flags: int</dt><dd>

-

- A bit-map containing the following flags:

-

- <ul>

- <li>0x01 - set if the element is explicitly or implicitly abstract</li>

- <li>0x02 - set if the element was declared to be ‘const’</li>

- <li>0x04 - set if the element was declared to be ‘final’</li>

- <li>0x08 - set if the element is a static member of a class or is a top-level function or field</li>

- <li>0x10 - set if the element is private</li>

- <li>0x20 - set if the element is deprecated</li>

- </ul>

- </dd><dt class="field">parameters: String (optional)</dt><dd>

-

- The parameter list for the element. If the element is not

- a method or function this field will not be defined. If

- the element doesn't have parameters (e.g. getter), this field

- will not be defined. If the element has zero parameters, this

- field will have a value of "()".

-

- </dd><dt class="field">returnType: String (optional)</dt><dd>

-

- The return type of the element. If the element is not a

- method or function this field will not be defined. If the

- element does not have a declared return type, this field

- will contain an empty string.

-

- </dd><dt class="field">typeParameters: String (optional)</dt><dd>

-

- The type parameter list for the element. If the element doesn't

- have type parameters, this field will not be defined.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">ElementKind: String</a></dt><dd>

-

- An enumeration of the kinds of elements.

-

- <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value deprecated">UNIT_TEST_GROUP</dt><dd>

- Deprecated: support for tests was removed.

- </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd>

- Deprecated: support for tests was removed.

- </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

-

- A description of an executable file.

-

- <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The path of the executable file.

-

- </dd><dt class="field">kind: <a href="#type_ExecutableKind">ExecutableKind</a></dt><dd>

-

- The kind of the executable file.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind">ExecutableKind: String</a></dt><dd>

-

- An enumeration of the kinds of executable files.

-

- <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="value">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt><dd>

-

- The identifier for a execution context.

-

- </dd><dt class="typeDefinition"><a name="type_ExecutionService">ExecutionService: String</a></dt><dd>

-

- An enumeration of the services provided by the execution

- domain.

-

- <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition"><a name="type_FileKind">FileKind: String</a></dt><dd>

-

- An enumeration of the kinds of files.

-

- <dl><dt class="value">LIBRARY</dt><dt class="value">PART</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd>

-

- The absolute, normalized path of a file.

-

-

- If the format of a file path in a request is not valid, e.g. the

- path is not absolute or is not normalized, then an error of type

- <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated.

-

- </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: String</a></dt><dd>

-

- An enumeration of the kinds of folding regions.

-

- <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt class="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt class="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name="type_FoldingRegion">FoldingRegion: object</a></dt><dd>

-

- A description of a region that can be folded.

-

- <dl><dt class="field">kind: <a href="#type_FoldingKind">FoldingKind</a></dt><dd>

-

- The kind of the region.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the region to be folded.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region to be folded.

-

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

-

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

-

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

-

- A description of a region that could have special highlighting

- associated with it.

-

- <dl><dt class="field">type: <a href="#type_HighlightRegionType">HighlightRegionType</a></dt><dd>

-

- The type of highlight associated with the region.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the region to be highlighted.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region to be highlighted.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegionType">HighlightRegionType: String</a></dt><dd>

-

- An enumeration of the kinds of highlighting that can be

- applied to files.

-

- <dl><dt class="value">ANNOTATION</dt><dt class="value">BUILT_IN</dt><dt class="value">CLASS</dt><dt class="value">COMMENT_BLOCK</dt><dt class="value">COMMENT_DOCUMENTATION</dt><dt class="value">COMMENT_END_OF_LINE</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">DIRECTIVE</dt><dt class="value">DYNAMIC_TYPE</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">DYNAMIC_LOCAL_VARIABLE_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">DYNAMIC_LOCAL_VARIABLE_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">DYNAMIC_PARAMETER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">DYNAMIC_PARAMETER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">FIELD_STATIC</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">FUNCTION</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">FUNCTION_DECLARATION</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER_DECLARATION</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">IDENTIFIER_DEFAULT</dt><dt class="value">IMPORT_PREFIX</dt><dt class="value">INSTANCE_FIELD_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_FIELD_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_GETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_GETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_METHOD_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_METHOD_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_SETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INSTANCE_SETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">INVALID_STRING_ESCAPE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">KEYWORD</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY_NAME</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">LITERAL_BOOLEAN</dt><dt class="value">LITERAL_DOUBLE</dt><dt class="value">LITERAL_INTEGER</dt><dt class="value">LITERAL_LIST</dt><dt class="value">LITERAL_MAP</dt><dt class="value">LITERAL_STRING</dt><dt class="value">LOCAL_FUNCTION_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">LOCAL_FUNCTION_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">LOCAL_VARIABLE</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">LOCAL_VARIABLE_DECLARATION</dt><dt class="value">LOCAL_VARIABLE_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">METHOD</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">METHOD_DECLARATION</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">METHOD_DECLARATION_STATIC</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">METHOD_STATIC</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">PARAMETER</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">SETTER_DECLARATION</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">TOP_LEVEL_VARIABLE</dt><dd>

- Only for version 1 of highlight.

- </dd><dt class="value">PARAMETER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">PARAMETER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_FIELD_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_GETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_GETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_METHOD_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_METHOD_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_SETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">STATIC_SETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_FUNCTION_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_FUNCTION_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_GETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_GETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_SETTER_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_SETTER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TOP_LEVEL_VARIABLE_DECLARATION</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">TYPE_NAME_DYNAMIC</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value">UNRESOLVED_INSTANCE_MEMBER_REFERENCE</dt><dd>

- Only for version 2 of highlight.

- </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>

- Only for version 2 of highlight.

- </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformation">HoverInformation: object</a></dt><dd>

-

- The hover information associated with a specific location.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the range of characters that encompasses the

- cursor position and has the same hover information as the

- cursor position.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the range of characters that encompasses the

- cursor position and has the same hover information as the

- cursor position.

-

- </dd><dt class="field">containingLibraryPath: String (optional)</dt><dd>

-

- The path to the defining compilation unit of the library

- in which the referenced element is declared. This data is

- omitted if there is no referenced element, or if the

- element is declared inside an HTML file.

-

- </dd><dt class="field">containingLibraryName: String (optional)</dt><dd>

-

- The name of the library in which the referenced element is

- declared. This data is omitted if there is no referenced

- element, or if the element is declared inside an HTML

- file.

-

- </dd><dt class="field">containingClassDescription: String (optional)</dt><dd>

-

- A human-readable description of the class declaring the element

- being referenced. This data is omitted if there is no referenced

- element, or if the element is not a class member.

-

- </dd><dt class="field">dartdoc: String (optional)</dt><dd>

-

- The dartdoc associated with the referenced element. Other

- than the removal of the comment delimiters, including

- leading asterisks in the case of a block comment, the

- dartdoc is unprocessed markdown. This data is omitted if

- there is no referenced element, or if the element has no

- dartdoc.

-

- </dd><dt class="field">elementDescription: String (optional)</dt><dd>

-

- A human-readable description of the element being

- referenced. This data is omitted if there is no referenced

- element.

-

- </dd><dt class="field">elementKind: String (optional)</dt><dd>

-

- A human-readable description of the kind of element being

- referenced (such as "class" or "function type

- alias"). This data is omitted if there is no referenced

- element.

-

- </dd><dt class="field">isDeprecated: bool (optional)</dt><dd>

-

- True if the referenced element is deprecated.

-

- </dd><dt class="field">parameter: String (optional)</dt><dd>

-

- A human-readable description of the parameter

- corresponding to the expression being hovered over. This

- data is omitted if the location is not in an argument to a

- function.

-

- </dd><dt class="field">propagatedType: String (optional)</dt><dd>

-

- The name of the propagated type of the expression. This

- data is omitted if the location does not correspond to an

- expression or if there is no propagated type information.

-

- </dd><dt class="field">staticType: String (optional)</dt><dd>

-

- The name of the static type of the expression. This data

- is omitted if the location does not correspond to an

- expression.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedClass">ImplementedClass: object</a></dt><dd>

-

- A description of a class that is implemented or extended.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the name of the implemented class.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the name of the implemented class.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMember">ImplementedMember: object</a></dt><dd>

-

- A description of a class member that is implemented or overridden.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the name of the implemented member.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the name of the implemented member.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">LinkedEditGroup: object</a></dt><dd>

-

- A collection of positions that should be linked (edited

- simultaneously) for the purposes of updating code after a

- source change. For example, if a set of edits introduced a

- new variable name, the group would contain all of the

- positions of the variable name so that if the client wanted

- to let the user edit the variable name after the operation,

- all occurrences of the name could be edited simultaneously.

-

- <dl><dt class="field">positions: List<<a href="#type_Position">Position</a>></dt><dd>

-

- The positions of the regions that should be edited

- simultaneously.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the regions that should be edited

- simultaneously.

-

- </dd><dt class="field">suggestions: List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>></dt><dd>

-

- Pre-computed suggestions for what every region might

- want to be changed to.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggestion">LinkedEditSuggestion: object</a></dt><dd>

-

- A suggestion of a value that could be used to replace all of

- the linked edit regions in a LinkedEditGroup.

-

- <dl><dt class="field">value: String</dt><dd>

-

- The value that could be used to replace all of the linked

- edit regions.

-

- </dd><dt class="field">kind: <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></dt><dd>

-

- The kind of value being proposed.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggestionKind">LinkedEditSuggestionKind: String</a></dt><dd>

-

- An enumeration of the kind of values that can be suggested

- for a linked edit.

-

- <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefinition"><a name="type_Location">Location: object</a></dt><dd>

-

- A location (character range) within a file.

-

- <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the range.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the range.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the range.

-

- </dd><dt class="field">startLine: int</dt><dd>

-

- The one-based index of the line containing the first

- character of the range.

-

- </dd><dt class="field">startColumn: int</dt><dd>

-

- The one-based index of the column containing the first

- character of the range.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegion">NavigationRegion: object</a></dt><dd>

-

- A description of a region from which the user can navigate to

- the declaration of an element.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the region from which the user can navigate.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region from which the user can navigate.

-

- </dd><dt class="field">targets: List<int></dt><dd>

-

- The indexes of the targets (in the enclosing navigation response)

- to which the given region is bound. By opening the target, clients

- can implement one form of navigation. This list cannot be empty.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarget">NavigationTarget: object</a></dt><dd>

-

- A description of a target to which the user can navigate.

-

- <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

-

- The kind of the element.

-

- </dd><dt class="field">fileIndex: int</dt><dd>

-

- The index of the file (in the enclosing navigation response) to

- navigate to.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the region to which the user can navigate.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region to which the user can navigate.

-

- </dd><dt class="field">startLine: int</dt><dd>

-

- The one-based index of the line containing the first

- character of the region.

-

- </dd><dt class="field">startColumn: int</dt><dd>

-

- The one-based index of the column containing the first

- character of the region.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">Occurrences: object</a></dt><dd>

-

- A description of the references to a single element within a

- single file.

-

- <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

-

- The element that was referenced.

-

- </dd><dt class="field">offsets: List<int></dt><dd>

-

- The offsets of the name of the referenced element within

- the file.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the name of the referenced element.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outline: object</a></dt><dd>

-

- An node in the outline structure of a file.

-

- <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

-

- A description of the element represented by this node.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the first character of the element. This is

- different than the offset in the Element, which if the

- offset of the name of the element. It can be used, for

- example, to map locations in the file back to an outline.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the element.

-

- </dd><dt class="field">children: List<<a href="#type_Outline">Outline</a>> (optional)</dt><dd>

-

- The children of the node. The field will be omitted if the

- node has no children.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Override: object</a></dt><dd>

-

- A description of a member that overrides an inherited member.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the name of the overriding member.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the name of the overriding member.

-

- </dd><dt class="field">superclassMember: <a href="#type_OverriddenMember">OverriddenMember</a> (optional)</dt><dd>

-

- The member inherited from a superclass that is overridden

- by the overriding member. The field is omitted if there is

- no superclass member, in which case there must be at least

- one interface member.

-

- </dd><dt class="field">interfaceMembers: List<<a href="#type_OverriddenMember">OverriddenMember</a>> (optional)</dt><dd>

-

- The members inherited from interfaces that are overridden

- by the overriding member. The field is omitted if there

- are no interface members, in which case there must be a

- superclass member.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMember">OverriddenMember: object</a></dt><dd>

-

- A description of a member that is being overridden.

-

- <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

-

- The element that is being overridden.

-

- </dd><dt class="field">className: String</dt><dd>

-

- The name of the class in which the member is defined.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Position: object</a></dt><dd>

-

- A position within a file.

-

- <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the position.

-

- </dd><dt class="field">offset: int</dt><dd>

-

- The offset of the position.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">PubStatus: object</a></dt><dd>

-

- An indication of the current state of pub execution.

-

- <dl><dt class="field">isListingPackageDirs: bool</dt><dd>

-

- True if the server is currently running pub to produce a list of

- package directories.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKind">RefactoringKind: String</a></dt><dd>

-

- An enumeration of the kinds of refactorings that can be

- created.

-

+ <h4>returns:</h4><dl><dt class="field">port: int</dt><dd>

- <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVERT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class="value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENAME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a></dt><dd>

-

- A description of a parameter in a method refactoring.

-

- <dl><dt class="field">id: String (optional)</dt><dd>

-

- The unique identifier of the parameter.

- Clients may omit this field for the parameters they want to add.

-

- </dd><dt class="field">kind: <a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a></dt><dd>

-

- The kind of the parameter.

-

- </dd><dt class="field">type: String</dt><dd>

-

- The type that should be given to the parameter, or the return type

- of the parameter's function type.

-

- </dd><dt class="field">name: String</dt><dd>

-

- The name that should be given to the parameter.

-

- </dd><dt class="field">parameters: String (optional)</dt><dd>

-

- The parameter list of the parameter's function type.

- If the parameter is not of a function type, this field will

- not be defined. If the function type has zero parameters, this

- field will have a value of "()".

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFeedback">RefactoringFeedback: object</a></dt><dd>

-

- An abstract superclass of all refactoring feedbacks.

-

- <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions">RefactoringOptions: object</a></dt><dd>

-

- An abstract superclass of all refactoring options.

-

- <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodParameterKind">RefactoringMethodParameterKind: String</a></dt><dd>

-

- An enumeration of the kinds of parameters.

-

- <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt class="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem">RefactoringProblem: object</a></dt><dd>

-

- A description of a problem related to a refactoring.

-

- <dl><dt class="field">severity: <a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></dt><dd>

-

- The severity of the problem being represented.

-

- </dd><dt class="field">message: String</dt><dd>

-

- A human-readable description of the problem being

- represented.

-

- </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

-

- The location of the problem being represented.

- This field is omitted unless there is a specific location

- associated with the problem (such as a location where an element

- being renamed will be shadowed).

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblemSeverity">RefactoringProblemSeverity: String</a></dt><dd>

-

- An enumeration of the severities of problems that can be

- returned by the refactoring requests.

-

- <dl><dt class="value">INFO</dt><dd>

- A minor code problem. No example, because it is not used yet.

-

- </dd><dt class="value">WARNING</dt><dd>

- A minor code problem. For example names of local variables

- should be camel case and start with a lower case letter. Staring

- the name of a variable with an upper case is OK from the language

- point of view, but it is nice to warn the user.

-

- </dd><dt class="value">ERROR</dt><dd>

- The refactoring technically can be performed, but there is a

- logical problem. For example the name of a local variable being

- extracted conflicts with another name in the scope, or

- duplicate parameter names in the method being extracted, or

- a conflict between a parameter name and a local variable, etc.

- In some cases the location of the problem is also provided, so

- the IDE can show user the location and the problem, and let the

- user decide whether she wants to perform the refactoring. For

- example the name conflict might be expected, and the user wants

- to fix it afterwards.

-

- </dd><dt class="value">FATAL</dt><dd>

- A fatal error, which prevents performing the refactoring.

- For example the name of a local variable being extracted is not a

- valid identifier, or selection is not a valid expression.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>

-

- A directive to remove an existing file content overlay.

- After processing this directive, the file contents will once

- again be read from the file system.

-

-

- If this directive is used on a file that doesn't currently

- have a content overlay, it has no effect.

-

- <dl><dt class="field">type = "remove"</dt><dd></dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><dd>

-

- An indication of a problem with the execution of the server,

- typically in response to a request.

-

- <dl><dt class="field">code: <a href="#type_RequestErrorCode">RequestErrorCode</a></dt><dd>

-

- A code that uniquely identifies the error that occurred.

-

- </dd><dt class="field">message: String</dt><dd>

-

- A short description of the error.

-

- </dd><dt class="field">stackTrace: String (optional)</dt><dd>

-

- The stack trace associated with processing the request,

- used for debugging the server.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCode">RequestErrorCode: String</a></dt><dd>

-

- An enumeration of the types of errors that can occur in the

- execution of the server.

-

- <dl><dt class="value">CONTENT_MODIFIED</dt><dd>

-

- An "analysis.getErrors" or "analysis.getNavigation" request could

- not be satisfied because the content of the file changed before

- the requested results could be computed.

-

- </dd><dt class="value">DEBUG_PORT_COULD_NOT_BE_OPENED</dt><dd>

-

- The server was unable to open a port for the diagnostic server.

-

- </dd><dt class="value">FILE_NOT_ANALYZED</dt><dd>

-

- A request specified a FilePath which does not match a file in

- an analysis root, or the requested operation is not available

- for the file.

-

- </dd><dt class="value">FORMAT_INVALID_FILE</dt><dd>

-

- An "edit.format" request specified a FilePath

- which does not match a Dart file in an analysis root.

-

- </dd><dt class="value">FORMAT_WITH_ERRORS</dt><dd>

-

- An "edit.format" request specified a file that contains syntax

- errors.

-

- </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>

-

- An "analysis.getErrors" request specified a FilePath

- which does not match a file currently subject to

- analysis.

-

- </dd><dt class="value">GET_NAVIGATION_INVALID_FILE</dt><dd>

-

- An "analysis.getNavigation" request specified a FilePath

- which does not match a file currently subject to

- analysis.

-

- </dd><dt class="value">GET_REACHABLE_SOURCES_INVALID_FILE</dt><dd>

-

- An "analysis.getReachableSources" request specified a FilePath

- which does not match a file currently subject to

- analysis.

-

- </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd>

-

- A path passed as an argument to a request (such as

- analysis.reanalyze) is required to be an analysis root, but isn't.

-

- </dd><dt class="value">INVALID_EXECUTION_CONTEXT</dt><dd>

-

- The context root used to create an execution context does not

- exist.

-

- </dd><dt class="value">INVALID_FILE_PATH_FORMAT</dt><dd>

-

- The format of the given file path is invalid, e.g. is not

- absolute and normalized.

-

- </dd><dt class="value">INVALID_OVERLAY_CHANGE</dt><dd>

-

- An "analysis.updateContent" request contained a

- ChangeContentOverlay object which can't be applied, due

- to an edit having an offset or length that is out of

- range.

-

- </dd><dt class="value">INVALID_PARAMETER</dt><dd>

-

- One of the method parameters was invalid.

-

- </dd><dt class="value">INVALID_REQUEST</dt><dd>

-

- A malformed request was received.

-

- </dd><dt class="value">ORGANIZE_DIRECTIVES_ERROR</dt><dd>

-

- An "edit.organizeDirectives" request specified a Dart file that

- cannot be analyzed. The reason is described in the message.

-

- </dd><dt class="value">REFACTORING_REQUEST_CANCELLED</dt><dd>

-

- Another refactoring request was received during processing of

- this one.

-

- </dd><dt class="value">SERVER_ALREADY_STARTED</dt><dd>

-

- The analysis server has already been started (and hence

- won't accept new connections).

-

-

- This error is included for future expansion; at present

- the analysis server can only speak to one client at a

- time so this error will never occur.

-

- </dd><dt class="value">SERVER_ERROR</dt><dd>

-

- An internal error occurred in the analysis server.

- Also see the server.error notification.

-

- </dd><dt class="value">SORT_MEMBERS_INVALID_FILE</dt><dd>

-

- An "edit.sortMembers" request specified a FilePath

- which does not match a Dart file in an analysis root.

-

- </dd><dt class="value">SORT_MEMBERS_PARSE_ERRORS</dt><dd>

-

- An "edit.sortMembers" request specified a Dart file that has

- scan or parse errors.

-

- </dd><dt class="value">UNANALYZED_PRIORITY_FILES</dt><dd>

-

- An "analysis.setPriorityFiles" request includes one or

- more files that are not being analyzed.

-

-

- This is a legacy error; it will be removed before the

- API reaches version 1.0.

-

- </dd><dt class="value">UNKNOWN_REQUEST</dt><dd>

-

- A request was received which the analysis server does

- not recognize, or cannot handle in its current

- configuration.

-

- </dd><dt class="value">UNKNOWN_SOURCE</dt><dd>

-

- The analysis server was requested to perform an action

- on a source that does not exist.

-

- </dd><dt class="value">UNSUPPORTED_FEATURE</dt><dd>

-

- The analysis server was requested to perform an action

- which is not supported.

-

-

- This is a legacy error; it will be removed before the

- API reaches version 1.0.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd>

-

- An identifier used to associate search results with a search

- request.

-

- </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>

-

- A single result from a search request.

-

- <dl><dt class="field">location: <a href="#type_Location">Location</a></dt><dd>

-

- The location of the code that matched the search criteria.

-

- </dd><dt class="field">kind: <a href="#type_SearchResultKind">SearchResultKind</a></dt><dd>

-

- The kind of element that was found or the kind of

- reference that was found.

-

- </dd><dt class="field">isPotential: bool</dt><dd>

-

- True if the result is a potential match but cannot be

- confirmed to be a match. For example, if all references to

- a method m defined in some class were requested, and a

- reference to a method m from an unknown class were found,

- it would be marked as being a potential match.

-

- </dd><dt class="field">path: List<<a href="#type_Element">Element</a>></dt><dd>

-

- The elements that contain the result, starting with the

- most immediately enclosing ancestor and ending with the

- library.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKind">SearchResultKind: String</a></dt><dd>

-

- An enumeration of the kinds of search results returned by the

- search domain.

-

- <dl><dt class="value">DECLARATION</dt><dd>

-

- The declaration of an element.

-

- </dd><dt class="value">INVOCATION</dt><dd>

-

- The invocation of a function or method.

-

- </dd><dt class="value">READ</dt><dd>

-

- A reference to a field, parameter or variable where it is being read.

-

- </dd><dt class="value">READ_WRITE</dt><dd>

-

- A reference to a field, parameter or variable where it is being read and written.

-

- </dd><dt class="value">REFERENCE</dt><dd>

-

- A reference to an element.

-

- </dd><dt class="value">UNKNOWN</dt><dd>

-

- Some other kind of search result.

-

- </dd><dt class="value">WRITE</dt><dd>

-

- A reference to a field, parameter or variable where it is being written.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_ServerService">ServerService: String</a></dt><dd>

-

- An enumeration of the services provided by the server domain.

-

- <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a name="type_SourceChange">SourceChange: object</a></dt><dd>

-

- A description of a set of edits that implement a single

- conceptual change.

-

- <dl><dt class="field">message: String</dt><dd>

-

- A human-readable description of the change to be applied.

-

- </dd><dt class="field">edits: List<<a href="#type_SourceFileEdit">SourceFileEdit</a>></dt><dd>

-

- A list of the edits used to effect the change, grouped by

- file.

-

- </dd><dt class="field">linkedEditGroups: List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>></dt><dd>

-

- A list of the linked editing groups used to customize

- the changes that were made.

-

- </dd><dt class="field">selection: <a href="#type_Position">Position</a> (optional)</dt><dd>

-

- The position that should be selected after the edits

- have been applied.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">SourceEdit: object</a></dt><dd>

-

- A description of a single change to a single file.

-

- <dl><dt class="field">offset: int</dt><dd>

-

- The offset of the region to be modified.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the region to be modified.

-

- </dd><dt class="field">replacement: String</dt><dd>

-

- The code that is to replace the specified region in the

- original code.

-

- </dd><dt class="field">id: String (optional)</dt><dd>

-

- An identifier that uniquely identifies this source edit from other

- edits in the same response. This field is omitted unless a

- containing structure needs to be able to identify the edit for

- some reason.

-

-

- For example, some refactoring operations can produce edits that

- might not be appropriate (referred to as potential edits). Such

- edits will have an id so that they can be referenced. Edits in

- the same response that do not need to be referenced will not have

- an id.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">SourceFileEdit: object</a></dt><dd>

-

- A description of a set of changes to a single file.

-

- <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The file containing the code to be modified.

-

- </dd><dt class="field">fileStamp: long</dt><dd>

-

- The modification stamp of the file at the moment when the change

- was created, in milliseconds since the "Unix epoch". Will be -1 if

- the file did not exist and should be created. The client may use

- this field to make sure that the file was not changed since then,

- so it is safe to apply the change.

-

- </dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

-

- A list of the edits used to effect the change.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyItem">TypeHierarchyItem: object</a></dt><dd>

-

- A representation of a class in a type hierarchy.

-

- <dl><dt class="field">classElement: <a href="#type_Element">Element</a></dt><dd>

-

- The class element represented by this item.

-

- </dd><dt class="field">displayName: String (optional)</dt><dd>

-

- The name to be displayed for the class. This field will be

- omitted if the display name is the same as the name of the

- element. The display name is different if there is

- additional type information to be displayed, such as type

- arguments.

-

- </dd><dt class="field">memberElement: <a href="#type_Element">Element</a> (optional)</dt><dd>

-

- The member in the class corresponding to the member on

- which the hierarchy was requested. This field will be

- omitted if the hierarchy was not requested for a member or

- if the class does not have a corresponding member.

-

- </dd><dt class="field">superclass: int (optional)</dt><dd>

-

- The index of the item representing the superclass of

- this class. This field will be omitted if this item

- represents the class Object.

-

- </dd><dt class="field">interfaces: List<int></dt><dd>

-

- The indexes of the items representing the interfaces

- implemented by this class. The list will be empty if

- there are no implemented interfaces.

-

- </dd><dt class="field">mixins: List<int></dt><dd>

-

- The indexes of the items representing the mixins

- referenced by this class. The list will be empty if

- there are no classes mixed in to this class.

-

- </dd><dt class="field">subclasses: List<int></dt><dd>

-

- The indexes of the items representing the subtypes of

- this class. The list will be empty if there are no

- subtypes or if this item represents a supertype of the

- pivot type.

-

- </dd></dl></dd></dl>

- <h2><a name="refactorings">Refactorings</a></h2>

-

- This section contains additional information for each kind of

- refactoring. In addition to a brief description of the

- refactoring, there is a specification of the feedback that is

- provided when a refactoring is requested using the

- edit.getRefactoring request (designed to improve the UX)

- and the options that may be provided to edit.getRefactoring.

-

- <dl><dt class="refactoring">CONVERT_GETTER_TO_METHOD</dt><dd>

-

- Convert a getter into a method by removing the keyword get

- and adding an empty parameter list.

-

-

- It is an error if the range contains anything other than all

- or part of the name of a single getter.

-

- <h4>Feedback:</h4>none<h4>Options:</h4>none</dd><dt class="refactoring">CONVERT_METHOD_TO_GETTER</dt><dd>

-

- Convert a method into a getter by adding the keyword get and

- removing the parameter list.

-

-

- It is an error if the range contains anything other than all

- or part of the name of a single method or if the method has

- a non-empty parameter list.

-

- <h4>Feedback:</h4>none<h4>Options:</h4>none</dd><dt class="refactoring">EXTRACT_LOCAL_VARIABLE</dt><dd>

-

- Create a local variable initialized by the expression that covers

- the specified selection.

-

-

- It is an error if the selection range is not covered by a

- complete expression.

-

- <h4>Feedback:</h4><dl><dt class="field">coveringExpressionOffsets: List<int> (optional)</dt><dd>

-

- The offsets of the expressions that cover the specified

- selection, from the down most to the up most.

-

- </dd><dt class="field">coveringExpressionLengths: List<int> (optional)</dt><dd>

-

- The lengths of the expressions that cover the specified

- selection, from the down most to the up most.

-

- </dd><dt class="field">names: List<String></dt><dd>

-

- The proposed names for the local variable.

-

- </dd><dt class="field">offsets: List<int></dt><dd>

-

- The offsets of the expressions that would be replaced by

- a reference to the variable.

-

- </dd><dt class="field">lengths: List<int></dt><dd>

-

- The lengths of the expressions that would be replaced by

- a reference to the variable. The lengths correspond to

- the offsets. In other words, for a given expression, if

- the offset of that expression is <tt>offsets[i]</tt>, then

- the length of that expression is <tt>lengths[i]</tt>.

-

- </dd></dl><h4>Options:</h4><dl><dt class="field">name: String</dt><dd>

-

- The name that the local variable should be given.

-

- </dd><dt class="field">extractAll: bool</dt><dd>

-

- True if all occurrences of the expression within the

- scope in which the variable will be defined should be

- replaced by a reference to the local variable. The

- expression used to initiate the refactoring will always

- be replaced.

-

- </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>

-

- Create a method whose body is the specified expression or

- list of statements, possibly augmented with a return

- statement.

-

-

- It is an error if the range contains anything other than a

- complete expression (no partial expressions are allowed) or

- a complete sequence of statements.

-

- <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

-

- The offset to the beginning of the expression or

- statements that will be extracted.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the expression or statements that will be

- extracted.

-

- </dd><dt class="field">returnType: String</dt><dd>

-

- The proposed return type for the method.

- If the returned element does not have a declared return type,

- this field will contain an empty string.

-

- </dd><dt class="field">names: List<String></dt><dd>

-

- The proposed names for the method.

-

- </dd><dt class="field">canCreateGetter: bool</dt><dd>

-

- True if a getter could be created rather than a method.

-

- </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

-

- The proposed parameters for the method.

-

- </dd><dt class="field">offsets: List<int></dt><dd>

-

- The offsets of the expressions or statements that would

- be replaced by an invocation of the method.

-

- </dd><dt class="field">lengths: List<int></dt><dd>

-

- The lengths of the expressions or statements that would

- be replaced by an invocation of the method. The lengths

- correspond to the offsets. In other words, for a given

- expression (or block of statements), if the offset of

- that expression is <tt>offsets[i]</tt>, then the length

- of that expression is <tt>lengths[i]</tt>.

-

- </dd></dl><h4>Options:</h4><dl><dt class="field">returnType: String</dt><dd>

-

- The return type that should be defined for the method.

-

- </dd><dt class="field">createGetter: bool</dt><dd>

-

- True if a getter should be created rather than a

- method. It is an error if this field is true and the

- list of parameters is non-empty.

-

- </dd><dt class="field">name: String</dt><dd>

-

- The name that the method should be given.

-

- </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

-

- The parameters that should be defined for the method.

-

-

- It is an error if a REQUIRED or NAMED parameter follows a

- POSITIONAL parameter.

- It is an error if a REQUIRED or POSITIONAL parameter follows a

- NAMED parameter.

-

- <ul>

- <li>

- To change the order and/or update proposed parameters, add

- parameters with the same identifiers as proposed.

- </li>

- <li>To add new parameters, omit their identifier.</li>

- <li>To remove some parameters, omit them in this list.</li>

- </ul>

- </dd><dt class="field">extractAll: bool</dt><dd>

-

- True if all occurrences of the expression or statements

- should be replaced by an invocation of the method. The

- expression or statements used to initiate the

- refactoring will always be replaced.

-

- </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>

-

- Inline the initializer expression of a local variable in

- place of any references to that variable.

-

-

- It is an error if the range contains anything other than all

- or part of the name of a single local variable.

-

- <h4>Feedback:</h4><dl><dt class="field">name: String</dt><dd>

-

- The name of the variable being inlined.

-

- </dd><dt class="field">occurrences: int</dt><dd>

-

- The number of times the variable occurs.

-

- </dd></dl><h4>Options:</h4>none</dd><dt class="refactoring">INLINE_METHOD</dt><dd>

-

- Inline a method in place of one or all references to that

- method.

-

-

- It is an error if the range contains anything other than all

- or part of the name of a single method.

-

- <h4>Feedback:</h4><dl><dt class="field">className: String (optional)</dt><dd>

-

- The name of the class enclosing the method being inlined.

- If not a class member is being inlined, this field will be absent.

-

- </dd><dt class="field">methodName: String</dt><dd>

-

- The name of the method (or function) being inlined.

-

- </dd><dt class="field">isDeclaration: bool</dt><dd>

-

- True if the declaration of the method is selected.

- So all references should be inlined.

-

- </dd></dl><h4>Options:</h4><dl><dt class="field">deleteSource: bool</dt><dd>

-

- True if the method being inlined should be removed.

- It is an error if this field is true and inlineAll is false.

-

- </dd><dt class="field">inlineAll: bool</dt><dd>

-

- True if all invocations of the method should be inlined,

- or false if only the invocation site used to create this

- refactoring should be inlined.

-

- </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>

-

- Move the given file and update all of the references to that file

- and from it. The move operation is supported in general case - for

- renaming a file in the same folder, moving it to a different folder

- or both.

-

-

- The refactoring must be activated before an actual file moving

- operation is performed.

-

-

- The "offset" and "length" fields from the request are ignored, but the

- file specified in the request specifies the file to be moved.

-

- <h4>Feedback:</h4>none<h4>Options:</h4><dl><dt class="field">newFile: <a href="#type_FilePath">FilePath</a></dt><dd>

-

- The new file path to which the given file is being moved.

-

- </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>

-

- Rename a given element and all of the references to that

+ The diagnostic server port.

+ </dd></dl></dd></dl>

+ <h2 class="domain"><a name="types">Types</a></h2>

+

+ This section contains descriptions of the data types referenced

+ in the API’s of the various domains.

+

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

+

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

+ content will be used for analysis in place of the file contents in the

+ filesystem.

+

+

+ If this directive is used on a file that already has a file content

+ overlay, the old overlay is discarded and replaced with the new one.

+

+ <dl><dt class="field">type = "add"</dt><dd>

+ </dd><dt class="field">content: String</dt><dd>

+

+ The new content of the file.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: object</a></dt><dd>

+

+ An indication of an error, warning, or hint that was produced by the

+ analysis.

+

+ <dl><dt class="field">severity: <a href="#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></dt><dd>

+

+ The severity of the error.

+

+ </dd><dt class="field">type: <a href="#type_AnalysisErrorType">AnalysisErrorType</a></dt><dd>

+

+ The type of the error.

+

+ </dd><dt class="field">location: <a href="#type_Location">Location</a></dt><dd>

+

+ The location associated with the error.

+

+ </dd><dt class="field">message: String</dt><dd>

+

+ The message to be displayed for this error. The message should

+ indicate what is wrong with the code and why it is wrong.

+

+ </dd><dt class="field">correction: String (optional)</dt><dd>

+

+ The correction message to be displayed for this error. The correction

+ message should indicate how the user can fix the error. The field is

+ omitted if there is no correction message associated with the error

+ code.

+

+ </dd><dt class="field">code: String</dt><dd>

+

+ The name, as a string, of the error code associated with this error.

+

+ </dd><dt class="field">hasFix: bool (optional)</dt><dd>

+

+ A hint to indicate to interested clients that this error has an

+ associated fix (or fixes). The absence of this field implies there

+ are not known to be fixes. Note that since the operation to calculate

+ whether fixes apply needs to be performant it is possible that

+ complicated tests will be skipped and a false negative returned. For

+ this reason, this attribute should be treated as a "hint". Despite the

+ possibility of false negatives, no false positives should be returned.

+ If a client sees this flag set they can proceed with the confidence

+ that there are in fact associated fixes.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorFixes">AnalysisErrorFixes: object</a></dt><dd>

+

+ A list of fixes associated with a specific error.

+

+ <dl><dt class="field">error: <a href="#type_AnalysisError">AnalysisError</a></dt><dd>

+

+ The error with which the fixes are associated.

+

+ </dd><dt class="field">fixes: List<<a href="#type_SourceChange">SourceChange</a>></dt><dd>

+

+ The fixes associated with the error.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorSeverity">AnalysisErrorSeverity: String</a></dt><dd>

+

+ An enumeration of the possible severities of analysis errors.

+

+ <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorType">AnalysisErrorType: String</a></dt><dd>

+

+ An enumeration of the possible types of analysis errors.

+

+ <dl><dt class="value">CHECKED_MODE_COMPILE_TIME_ERROR</dt><dt class="value">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">LINT</dt><dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><dt class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt class="typeDefinition deprecated"><a name="type_AnalysisOptions">AnalysisOptions: object</a></dt><dd>

+ Deprecated: the only reference to this type has been

+ deprecated.

+

+ A set of options controlling what kind of analysis is to be

+ performed. If the value of a field is omitted the value of the

+ option will not be changed.

+

+ <dl><dt class="field">enableAsync: bool (optional)</dt><dd>

+ Deprecated: this feature is always enabled.

+

+ True if the client wants to enable support for the

+ proposed async feature.

+

+ </dd><dt class="field">enableDeferredLoading: bool (optional)</dt><dd>

+ Deprecated: this feature is always enabled.

+

+ True if the client wants to enable support for the

+ proposed deferred loading feature.

+

+ </dd><dt class="field">enableEnums: bool (optional)</dt><dd>

+ Deprecated: this feature is always enabled.

+

+ True if the client wants to enable support for the

+ proposed enum feature.

+

+ </dd><dt class="field">enableNullAwareOperators: bool (optional)</dt><dd>

+ Deprecated: this feature is always enabled.

+

+ True if the client wants to enable support for the

+ proposed "null aware operators" feature.

+

+ </dd><dt class="field">enableSuperMixins: bool (optional)</dt><dd>

+

+ True if the client wants to enable support for the

+ proposed "less restricted mixins" proposal (DEP 34).

+

+ </dd><dt class="field">generateDart2jsHints: bool (optional)</dt><dd>

+

+ True if hints that are specific to dart2js should be

+ generated. This option is ignored if generateHints is false.

+

+ </dd><dt class="field">generateHints: bool (optional)</dt><dd>

+

+ True if hints should be generated as part of generating

+ errors and warnings.

+

+ </dd><dt class="field">generateLints: bool (optional)</dt><dd>

+

+ True if lints should be generated as part of generating

+ errors and warnings.

+

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

+

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

+ are related to a specific list of files.

+

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

+

+ This service is not currently implemented and will become a

+ GeneralAnalysisService in a future release.

+

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

+

+ An indication of the current state of analysis.

+

+ <dl><dt class="field">isAnalyzing: bool</dt><dd>

+ True if analysis is currently being performed.

+ </dd><dt class="field">analysisTarget: String (optional)</dt><dd>

+

+ The name of the current target of analysis. This field is

+ omitted if analyzing is false.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentOverlay">ChangeContentOverlay: object</a></dt><dd>

+

+ A directive to modify an existing file content overlay. One or more ranges

+ of text are deleted from the old file content overlay and replaced with

+ new text.

+

+

+ The edits are applied in the order in which they occur in the list. This

+ means that the offset of each edit must be correct under the assumption

+ that all previous edits have been applied.

+

+

+ It is an error to use this overlay on a file that does not yet have a file

+ content overlay or that has had its overlay removed via

+ <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.

+

+

+ If any of the edits cannot be applied due to its offset or length being

+ out of range, an <tt>INVALID_OVERLAY_CHANGE</tt> error will be reported.

+

+ <dl><dt class="field">type = "change"</dt><dd>

+ </dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

+

+ The edits to be applied to the file.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">CompletionId: String</a></dt><dd>

+

+ An identifier used to associate completion results with a

+ completion request.

+

+ </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">CompletionSuggestion: object</a></dt><dd>

+

+ A suggestion for how to complete partially entered text. Many of the

+ fields are optional, depending on the kind of element being suggested.

+

+ <dl><dt class="field">kind: <a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></dt><dd>

+

+ The kind of element being suggested.

+

+ </dd><dt class="field">relevance: int</dt><dd>

+

+ The relevance of this completion suggestion where a higher number

+ indicates a higher relevance.

+

+ </dd><dt class="field">completion: String</dt><dd>

+

+ The identifier to be inserted if the suggestion is selected. If the

+ suggestion is for a method or function, the client might want to

+ additionally insert a template for the parameters. The information

+ required in order to do so is contained in other fields.

+

+ </dd><dt class="field">selectionOffset: int</dt><dd>

+

+ The offset, relative to the beginning of the completion, of where the

+ selection should be placed after insertion.

+

+ </dd><dt class="field">selectionLength: int</dt><dd>

+

+ The number of characters that should be selected after insertion.

+

+ </dd><dt class="field">isDeprecated: bool</dt><dd>

+

+ True if the suggested element is deprecated.

+

+ </dd><dt class="field">isPotential: bool</dt><dd>

+

+ True if the element is not known to be valid for the target. This

+ happens if the type of the target is dynamic.

+

+ </dd><dt class="field">docSummary: String (optional)</dt><dd>

+

+ An abbreviated version of the Dartdoc associated with the element

+ being suggested, This field is omitted if there is no Dartdoc

+ associated with the element.

+

+ </dd><dt class="field">docComplete: String (optional)</dt><dd>

+

+ The Dartdoc associated with the element being suggested. This field is

+ omitted if there is no Dartdoc associated with the element.

+

+ </dd><dt class="field">declaringType: String (optional)</dt><dd>

+

+ The class that declares the element being suggested. This field is

+ omitted if the suggested element is not a member of a class.

+

+ </dd><dt class="field">defaultArgumentListString: String (optional)</dt><dd>

+

+ A default String for use in generating argument list source contents

+ on the client side.

+

+ </dd><dt class="field">defaultArgumentListTextRanges: List<int> (optional)</dt><dd>

+

+ Pairs of offsets and lengths describing 'defaultArgumentListString'

+ text ranges suitable for use by clients to set up linked edits of

+ default argument source contents. For example, given an argument list

+ string 'x, y', the corresponding text range [0, 1, 3, 1], indicates

+ two text ranges of length 1, starting at offsets 0 and 3. Clients can

+ use these ranges to treat the 'x' and 'y' values specially for linked

+ edits.

+

+ </dd><dt class="field">element: <a href="#type_Element">Element</a> (optional)</dt><dd>

+

+ Information about the element reference being suggested.

+

+ </dd><dt class="field">returnType: String (optional)</dt><dd>

+

+ The return type of the getter, function or method or the type of the

+ field being suggested. This field is omitted if the suggested element

+ is not a getter, function or method.

+

+ </dd><dt class="field">parameterNames: List<String> (optional)</dt><dd>

+

+ The names of the parameters of the function or method being suggested.

+ This field is omitted if the suggested element is not a setter,

+ function or method.

+

+ </dd><dt class="field">parameterTypes: List<String> (optional)</dt><dd>

+

+ The types of the parameters of the function or method being suggested.

+ This field is omitted if the parameterNames field is omitted.

+

+ </dd><dt class="field">requiredParameterCount: int (optional)</dt><dd>

+

+ The number of required parameters for the function or method being

+ suggested. This field is omitted if the parameterNames field is

+ omitted.

+

+ </dd><dt class="field">hasNamedParameters: bool (optional)</dt><dd>

+

+ True if the function or method being suggested has at least one named

+ parameter. This field is omitted if the parameterNames field is

+ omitted.

+

+ </dd><dt class="field">parameterName: String (optional)</dt><dd>

+

+ The name of the optional parameter being suggested. This field is

+ omitted if the suggestion is not the addition of an optional argument

+ within an argument list.

+

+ </dd><dt class="field">parameterType: String (optional)</dt><dd>

+

+ The type of the options parameter being suggested. This field is

+ omitted if the parameterName field is omitted.

+

+ </dd><dt class="field">importUri: String (optional)</dt><dd>

+

+ The import to be added if the suggestion is out of scope and needs

+ an import to be added to be in scope.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggestionKind">CompletionSuggestionKind: String</a></dt><dd>

+

+ An enumeration of the kinds of elements that can be included in a

+ completion suggestion.

+

+ <dl><dt class="value">ARGUMENT_LIST</dt><dd>

+

+ A list of arguments for the method or function that is being

+ invoked. For this suggestion kind, the completion field is a

+ textual representation of the invocation and the parameterNames,

+ parameterTypes, and requiredParameterCount attributes are defined.

+

+ </dd><dt class="value">IMPORT</dt><dt class="value">IDENTIFIER</dt><dd>

+

+ The element identifier should be inserted at the completion

+ location. For example "someMethod" in <tt>import 'myLib.dart' show

+ someMethod;</tt>. For suggestions of this kind, the element

+ attribute is defined and the completion field is the element's

+ identifier.

+

+ </dd><dt class="value">INVOCATION</dt><dd>

+

+ The element is being invoked at the completion location. For

+ example, 'someMethod' in <tt>x.someMethod();</tt>. For suggestions

+ of this kind, the element attribute is defined and the completion

+ field is the element's identifier.

+

+ </dd><dt class="value">KEYWORD</dt><dd>

+

+ A keyword is being suggested. For suggestions of this kind, the

+ completion is the keyword.

+

+ </dd><dt class="value">NAMED_ARGUMENT</dt><dd>

+

+ A named argument for the current call site is being suggested. For

+ suggestions of this kind, the completion is the named argument

+ identifier including a trailing ':' and a space.

+

+ </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextData: object</a></dt><dd>

+

+ Information about an analysis context.

+

+ <dl><dt class="field">name: String</dt><dd>

+

+ The name of the context.

+

+ </dd><dt class="field">explicitFileCount: int</dt><dd>

+

+ Explicitly analyzed files.

+

+ </dd><dt class="field">implicitFileCount: int</dt><dd>

+

+ Implicitly analyzed files.

+

+ </dd><dt class="field">workItemQueueLength: int</dt><dd>

+

+ The number of work items in the queue.

+

+ </dd><dt class="field">cacheEntryExceptions: List<String></dt><dd>

+

+ Exceptions associated with cache entries.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>

+

+ Information about an element (something that can be declared in code).

+

+ <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

+

+ The kind of the element.

+

+ </dd><dt class="field">name: String</dt><dd>

+

+ The name of the element. This is typically used as the label in the

+ outline.

+

+ </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

+

+ The location of the name in the declaration of the element.

+

+ </dd><dt class="field">flags: int</dt><dd>

+

+ A bit-map containing the following flags:

+

+ <ul>

+ <li>

+ 0x01 - set if the element is explicitly or implicitly abstract

+ </li>

+ <li>

+ 0x02 - set if the element was declared to be ‘const’

+ </li>

+ <li>

+ 0x04 - set if the element was declared to be ‘final’

+ </li>

+ <li>

+ 0x08 - set if the element is a static member of a class or is a

+ top-level function or field

+ </li>

+ <li>

+ 0x10 - set if the element is private

+ </li>

+ <li>

+ 0x20 - set if the element is deprecated

+ </li>

+ </ul>

+ </dd><dt class="field">parameters: String (optional)</dt><dd>

+

+ The parameter list for the element. If the element is not a method or

+ function this field will not be defined. If the element doesn't have

+ parameters (e.g. getter), this field will not be defined. If the

+ element has zero parameters, this field will have a value of "()".

+

+ </dd><dt class="field">returnType: String (optional)</dt><dd>

+

+ The return type of the element. If the element is not a method or

+ function this field will not be defined. If the element does not have

+ a declared return type, this field will contain an empty string.

+

+ </dd><dt class="field">typeParameters: String (optional)</dt><dd>

+

+ The type parameter list for the element. If the element doesn't have

+ type parameters, this field will not be defined.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">ElementKind: String</a></dt><dd>

+

+ An enumeration of the kinds of elements.

+

+ <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value deprecated">UNIT_TEST_GROUP</dt><dd>

+ Deprecated: support for tests was removed.

+ </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd>

+ Deprecated: support for tests was removed.

+ </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

+

+ A description of an executable file.

+

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The path of the executable file.

+

+ </dd><dt class="field">kind: <a href="#type_ExecutableKind">ExecutableKind</a></dt><dd>

+

+ The kind of the executable file.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind">ExecutableKind: String</a></dt><dd>

+

+ An enumeration of the kinds of executable files.

+

+ <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="value">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeDefinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt><dd>

+

+ The identifier for a execution context.

+

+ </dd><dt class="typeDefinition"><a name="type_ExecutionService">ExecutionService: String</a></dt><dd>

+

+ An enumeration of the services provided by the execution

+ domain.

+

+ <dl><dt class="value">LAUNCH_DATA</dt></dl></dd><dt class="typeDefinition"><a name="type_FileKind">FileKind: String</a></dt><dd>

+

+ An enumeration of the kinds of files.

+

+ <dl><dt class="value">LIBRARY</dt><dt class="value">PART</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd>

+

+ The absolute, normalized path of a file.

+

+

+ If the format of a file path in a request is not valid, e.g. the path is

+ not absolute or is not normalized, then an error of type

+ <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated.

+

+ </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: String</a></dt><dd>

+

+ An enumeration of the kinds of folding regions.

+

+ <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt class="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt class="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name="type_FoldingRegion">FoldingRegion: object</a></dt><dd>

+

+ A description of a region that can be folded.

+

+ <dl><dt class="field">kind: <a href="#type_FoldingKind">FoldingKind</a></dt><dd>

+

+ The kind of the region.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the region to be folded.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region to be folded.

+

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

+

+ 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).

+

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

+

+ A description of a region that could have special highlighting associated

+ with it.

+

+ <dl><dt class="field">type: <a href="#type_HighlightRegionType">HighlightRegionType</a></dt><dd>

+

+ The type of highlight associated with the region.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the region to be highlighted.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region to be highlighted.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegionType">HighlightRegionType: String</a></dt><dd>

+

+ An enumeration of the kinds of highlighting that can be applied to files.

+

+ <dl><dt class="value">ANNOTATION</dt><dt class="value">BUILT_IN</dt><dt class="value">CLASS</dt><dt class="value">COMMENT_BLOCK</dt><dt class="value">COMMENT_DOCUMENTATION</dt><dt class="value">COMMENT_END_OF_LINE</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">DIRECTIVE</dt><dt class="value">DYNAMIC_TYPE</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">DYNAMIC_LOCAL_VARIABLE_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">DYNAMIC_LOCAL_VARIABLE_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">DYNAMIC_PARAMETER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">DYNAMIC_PARAMETER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">FIELD_STATIC</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">FUNCTION</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">FUNCTION_DECLARATION</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER_DECLARATION</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">IDENTIFIER_DEFAULT</dt><dt class="value">IMPORT_PREFIX</dt><dt class="value">INSTANCE_FIELD_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_FIELD_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_GETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_GETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_METHOD_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_METHOD_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_SETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INSTANCE_SETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">INVALID_STRING_ESCAPE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">KEYWORD</dt><dt class="value">LABEL</dt><dt class="value">LIBRARY_NAME</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">LITERAL_BOOLEAN</dt><dt class="value">LITERAL_DOUBLE</dt><dt class="value">LITERAL_INTEGER</dt><dt class="value">LITERAL_LIST</dt><dt class="value">LITERAL_MAP</dt><dt class="value">LITERAL_STRING</dt><dt class="value">LOCAL_FUNCTION_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">LOCAL_FUNCTION_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">LOCAL_VARIABLE</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">LOCAL_VARIABLE_DECLARATION</dt><dt class="value">LOCAL_VARIABLE_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">METHOD</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">METHOD_DECLARATION</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">METHOD_DECLARATION_STATIC</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">METHOD_STATIC</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">PARAMETER</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">SETTER_DECLARATION</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">TOP_LEVEL_VARIABLE</dt><dd>

+ Only for version 1 of highlight.

+ </dd><dt class="value">PARAMETER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">PARAMETER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_FIELD_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_GETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_GETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_METHOD_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_METHOD_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_SETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">STATIC_SETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_FUNCTION_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_FUNCTION_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_GETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_GETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_SETTER_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_SETTER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TOP_LEVEL_VARIABLE_DECLARATION</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">TYPE_NAME_DYNAMIC</dt><dt class="value">TYPE_PARAMETER</dt><dt class="value">UNRESOLVED_INSTANCE_MEMBER_REFERENCE</dt><dd>

+ Only for version 2 of highlight.

+ </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>

+ Only for version 2 of highlight.

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformation">HoverInformation: object</a></dt><dd>

+

+ The hover information associated with a specific location.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the range of characters that encompasses the

+ cursor position and has the same hover information as the

+ cursor position.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the range of characters that encompasses the

+ cursor position and has the same hover information as the

+ cursor position.

+

+ </dd><dt class="field">containingLibraryPath: String (optional)</dt><dd>

+

+ The path to the defining compilation unit of the library

+ in which the referenced element is declared. This data is

+ omitted if there is no referenced element, or if the

+ element is declared inside an HTML file.

+

+ </dd><dt class="field">containingLibraryName: String (optional)</dt><dd>

+

+ The name of the library in which the referenced element is

+ declared. This data is omitted if there is no referenced

+ element, or if the element is declared inside an HTML

+ file.

+

+ </dd><dt class="field">containingClassDescription: String (optional)</dt><dd>

+

+ A human-readable description of the class declaring the element

+ being referenced. This data is omitted if there is no referenced

+ element, or if the element is not a class member.

+

+ </dd><dt class="field">dartdoc: String (optional)</dt><dd>

+

+ The dartdoc associated with the referenced element. Other

+ than the removal of the comment delimiters, including

+ leading asterisks in the case of a block comment, the

+ dartdoc is unprocessed markdown. This data is omitted if

+ there is no referenced element, or if the element has no

+ dartdoc.

+

+ </dd><dt class="field">elementDescription: String (optional)</dt><dd>

+

+ A human-readable description of the element being

+ referenced. This data is omitted if there is no referenced

element.

+ </dd><dt class="field">elementKind: String (optional)</dt><dd>

+

+ A human-readable description of the kind of element being

+ referenced (such as "class" or "function type

+ alias"). This data is omitted if there is no referenced

+ element.

+

+ </dd><dt class="field">isDeprecated: bool (optional)</dt><dd>

+

+ True if the referenced element is deprecated.

+

+ </dd><dt class="field">parameter: String (optional)</dt><dd>

+

+ A human-readable description of the parameter

+ corresponding to the expression being hovered over. This

+ data is omitted if the location is not in an argument to a

+ function.

+

+ </dd><dt class="field">propagatedType: String (optional)</dt><dd>

+

+ The name of the propagated type of the expression. This

+ data is omitted if the location does not correspond to an

+ expression or if there is no propagated type information.

+

+ </dd><dt class="field">staticType: String (optional)</dt><dd>

+

+ The name of the static type of the expression. This data

+ is omitted if the location does not correspond to an

+ expression.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedClass">ImplementedClass: object</a></dt><dd>

+

+ A description of a class that is implemented or extended.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the name of the implemented class.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the name of the implemented class.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMember">ImplementedMember: object</a></dt><dd>

+

+ A description of a class member that is implemented or overridden.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the name of the implemented member.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the name of the implemented member.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">LinkedEditGroup: object</a></dt><dd>

+

+ A collection of positions that should be linked (edited simultaneously)

+ for the purposes of updating code after a source change. For example, if a

+ set of edits introduced a new variable name, the group would contain all

+ of the positions of the variable name so that if the client wanted to let

+ the user edit the variable name after the operation, all occurrences of

+ the name could be edited simultaneously.

+

+ <dl><dt class="field">positions: List<<a href="#type_Position">Position</a>></dt><dd>

+

+ The positions of the regions that should be edited simultaneously.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the regions that should be edited simultaneously.

+

+ </dd><dt class="field">suggestions: List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>></dt><dd>

+

+ Pre-computed suggestions for what every region might want to be

+ changed to.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggestion">LinkedEditSuggestion: object</a></dt><dd>

+

+ A suggestion of a value that could be used to replace all of the linked

+ edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>.

+

+ <dl><dt class="field">value: String</dt><dd>

+

+ The value that could be used to replace all of the linked edit

+ regions.

+

+ </dd><dt class="field">kind: <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></dt><dd>

+

+ The kind of value being proposed.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggestionKind">LinkedEditSuggestionKind: String</a></dt><dd>

+

+ An enumeration of the kind of values that can be suggested for a linked

+ edit.

+

+ <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefinition"><a name="type_Location">Location: object</a></dt><dd>

+

+ A location (character range) within a file.

+

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the range.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the range.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the range.

+

+ </dd><dt class="field">startLine: int</dt><dd>

+

+ The one-based index of the line containing the first character of the

+ range.

+

+ </dd><dt class="field">startColumn: int</dt><dd>

+

+ The one-based index of the column containing the first character of

+ the range.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegion">NavigationRegion: object</a></dt><dd>

+

+ A description of a region from which the user can navigate to the

+ declaration of an element.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the region from which the user can navigate.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region from which the user can navigate.

+

+ </dd><dt class="field">targets: List<int></dt><dd>

+

+ The indexes of the targets (in the enclosing navigation response) to

+ which the given region is bound. By opening the target, clients can

+ implement one form of navigation. This list cannot be empty.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarget">NavigationTarget: object</a></dt><dd>

+

+ A description of a target to which the user can navigate.

+

+ <dl><dt class="field">kind: <a href="#type_ElementKind">ElementKind</a></dt><dd>

+

+ The kind of the element.

+

+ </dd><dt class="field">fileIndex: int</dt><dd>

+

+ The index of the file (in the enclosing navigation response) to

+ navigate to.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the region to which the user can navigate.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region to which the user can navigate.

+

+ </dd><dt class="field">startLine: int</dt><dd>

+

+ The one-based index of the line containing the first character of the

+ region.

+

+ </dd><dt class="field">startColumn: int</dt><dd>

+

+ The one-based index of the column containing the first character of

+ the region.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">Occurrences: object</a></dt><dd>

+

+ A description of the references to a single element within a single file.

+

+ <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

+

+ The element that was referenced.

+

+ </dd><dt class="field">offsets: List<int></dt><dd>

+

+ The offsets of the name of the referenced element within the file.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the name of the referenced element.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outline: object</a></dt><dd>

+

+ An node in the outline structure of a file.

+

+ <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

+

+ A description of the element represented by this node.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the first character of the element. This is different

+ than the offset in the Element, which is the offset of the name of the

+ element. It can be used, for example, to map locations in the file

+ back to an outline.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the element.

+

+ </dd><dt class="field">children: List<<a href="#type_Outline">Outline</a>> (optional)</dt><dd>

+

+ The children of the node. The field will be omitted if the node has no

+ children.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMember">OverriddenMember: object</a></dt><dd>

+

+ A description of a member that is being overridden.

+

+ <dl><dt class="field">element: <a href="#type_Element">Element</a></dt><dd>

+

+ The element that is being overridden.

+

+ </dd><dt class="field">className: String</dt><dd>

+

+ The name of the class in which the member is defined.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Override: object</a></dt><dd>

+

+ A description of a member that overrides an inherited member.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the name of the overriding member.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the name of the overriding member.

+

+ </dd><dt class="field">superclassMember: <a href="#type_OverriddenMember">OverriddenMember</a> (optional)</dt><dd>

+

+ The member inherited from a superclass that is overridden

+ by the overriding member. The field is omitted if there is

+ no superclass member, in which case there must be at least

+ one interface member.

+

+ </dd><dt class="field">interfaceMembers: List<<a href="#type_OverriddenMember">OverriddenMember</a>> (optional)</dt><dd>

+

+ The members inherited from interfaces that are overridden

+ by the overriding member. The field is omitted if there

+ are no interface members, in which case there must be a

+ superclass member.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Position: object</a></dt><dd>

+

+ A position within a file.

+

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the position.

+

+ </dd><dt class="field">offset: int</dt><dd>

+

+ The offset of the position.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">PubStatus: object</a></dt><dd>

+

+ An indication of the current state of pub execution.

+

+ <dl><dt class="field">isListingPackageDirs: bool</dt><dd>

+

+ True if the server is currently running pub to produce a list of

+ package directories.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFeedback">RefactoringFeedback: object</a></dt><dd>

+

+ An abstract superclass of all refactoring feedbacks.

+

+ <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKind">RefactoringKind: String</a></dt><dd>

+

+ An enumeration of the kinds of refactorings that can be created.

+

+ <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVERT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class="value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENAME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a></dt><dd>

+

+ A description of a parameter in a method refactoring.

+

+ <dl><dt class="field">id: String (optional)</dt><dd>

+

+ The unique identifier of the parameter. Clients may omit this field

+ for the parameters they want to add.

+

+ </dd><dt class="field">kind: <a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a></dt><dd>

+

+ The kind of the parameter.

+

+ </dd><dt class="field">type: String</dt><dd>

+

+ The type that should be given to the parameter, or the return type of

+ the parameter's function type.

+

+ </dd><dt class="field">name: String</dt><dd>

+

+ The name that should be given to the parameter.

+

+ </dd><dt class="field">parameters: String (optional)</dt><dd>

+

+ The parameter list of the parameter's function type. If the parameter

+ is not of a function type, this field will not be defined. If the

+ function type has zero parameters, this field will have a value of

+ '()'.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodParameterKind">RefactoringMethodParameterKind: String</a></dt><dd>

+

+ An enumeration of the kinds of parameters.

+

+ <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt class="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions">RefactoringOptions: object</a></dt><dd>

+

+ An abstract superclass of all refactoring options.

+

+ <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem">RefactoringProblem: object</a></dt><dd>

+

+ A description of a problem related to a refactoring.

+

+ <dl><dt class="field">severity: <a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></dt><dd>

+

+ The severity of the problem being represented.

+

+ </dd><dt class="field">message: String</dt><dd>

+

+ A human-readable description of the problem being represented.

+

+ </dd><dt class="field">location: <a href="#type_Location">Location</a> (optional)</dt><dd>

+

+ The location of the problem being represented. This field is omitted

+ unless there is a specific location associated with the problem (such

+ as a location where an element being renamed will be shadowed).

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblemSeverity">RefactoringProblemSeverity: String</a></dt><dd>

+

+ An enumeration of the severities of problems that can be returned by the

+ refactoring requests.

+

+ <dl><dt class="value">INFO</dt><dd>

+

+ A minor code problem. No example, because it is not used yet.

+

+ </dd><dt class="value">WARNING</dt><dd>

+

+ A minor code problem. For example names of local variables should be

+ camel case and start with a lower case letter. Staring the name of a

+ variable with an upper case is OK from the language point of view, but

+ it is nice to warn the user.

+

+ </dd><dt class="value">ERROR</dt><dd>

+

+ The refactoring technically can be performed, but there is a logical

+ problem. For example the name of a local variable being extracted

+ conflicts with another name in the scope, or duplicate parameter names

+ in the method being extracted, or a conflict between a parameter name

+ and a local variable, etc. In some cases the location of the problem

+ is also provided, so the IDE can show user the location and the

+ problem, and let the user decide whether they want to perform the

+ refactoring. For example the name conflict might be expected, and the

+ user wants to fix it afterwards.

+

+ </dd><dt class="value">FATAL</dt><dd>

+

+ A fatal error, which prevents performing the refactoring. For example

+ the name of a local variable being extracted is not a valid

+ identifier, or selection is not a valid expression.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>

+

+ A directive to remove an existing file content overlay. After processing

+ this directive, the file contents will once again be read from the file

+ system.

+

+

+ If this directive is used on a file that doesn't currently have a content

+ overlay, it has no effect.

+

+ <dl><dt class="field">type = "remove"</dt><dd>

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><dd>

+

+ An indication of a problem with the execution of the server,

+ typically in response to a request.

+

+ <dl><dt class="field">code: <a href="#type_RequestErrorCode">RequestErrorCode</a></dt><dd>

+

+ A code that uniquely identifies the error that occurred.

+

+ </dd><dt class="field">message: String</dt><dd>

+

+ A short description of the error.

+

+ </dd><dt class="field">stackTrace: String (optional)</dt><dd>

+

+ The stack trace associated with processing the request,

+ used for debugging the server.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCode">RequestErrorCode: String</a></dt><dd>

+

+ An enumeration of the types of errors that can occur in the

+ execution of the server.

+

+ <dl><dt class="value">CONTENT_MODIFIED</dt><dd>

+

+ An "analysis.getErrors" or "analysis.getNavigation" request could

+ not be satisfied because the content of the file changed before

+ the requested results could be computed.

+

+ </dd><dt class="value">DEBUG_PORT_COULD_NOT_BE_OPENED</dt><dd>

+

+ The server was unable to open a port for the diagnostic server.

+

+ </dd><dt class="value">FILE_NOT_ANALYZED</dt><dd>

+

+ A request specified a FilePath which does not match a file in

+ an analysis root, or the requested operation is not available

+ for the file.

+

+ </dd><dt class="value">FORMAT_INVALID_FILE</dt><dd>

+

+ An "edit.format" request specified a FilePath

+ which does not match a Dart file in an analysis root.

+

+ </dd><dt class="value">FORMAT_WITH_ERRORS</dt><dd>

+

+ An "edit.format" request specified a file that contains syntax

+ errors.

+

+ </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>

+

+ An "analysis.getErrors" request specified a FilePath

+ which does not match a file currently subject to

+ analysis.

+

+ </dd><dt class="value">GET_NAVIGATION_INVALID_FILE</dt><dd>

+

+ An "analysis.getNavigation" request specified a FilePath

+ which does not match a file currently subject to

+ analysis.

+

+ </dd><dt class="value">GET_REACHABLE_SOURCES_INVALID_FILE</dt><dd>

+

+ An "analysis.getReachableSources" request specified a FilePath

+ which does not match a file currently subject to

+ analysis.

+

+ </dd><dt class="value">INVALID_ANALYSIS_ROOT</dt><dd>

+

+ A path passed as an argument to a request (such as

+ analysis.reanalyze) is required to be an analysis root, but isn't.

+

+ </dd><dt class="value">INVALID_EXECUTION_CONTEXT</dt><dd>

+

+ The context root used to create an execution context does not

+ exist.

+

+ </dd><dt class="value">INVALID_FILE_PATH_FORMAT</dt><dd>

+

+ The format of the given file path is invalid, e.g. is not

+ absolute and normalized.

+

+ </dd><dt class="value">INVALID_OVERLAY_CHANGE</dt><dd>

+

+ An "analysis.updateContent" request contained a

+ ChangeContentOverlay object which can't be applied, due

+ to an edit having an offset or length that is out of

+ range.

+

+ </dd><dt class="value">INVALID_PARAMETER</dt><dd>

+

+ One of the method parameters was invalid.

+

+ </dd><dt class="value">INVALID_REQUEST</dt><dd>

+

+ A malformed request was received.

+

+ </dd><dt class="value">ORGANIZE_DIRECTIVES_ERROR</dt><dd>

+

+ An "edit.organizeDirectives" request specified a Dart file that

+ cannot be analyzed. The reason is described in the message.

+

+ </dd><dt class="value">REFACTORING_REQUEST_CANCELLED</dt><dd>

+

+ Another refactoring request was received during processing of

+ this one.

+

+ </dd><dt class="value">SERVER_ALREADY_STARTED</dt><dd>

+

+ The analysis server has already been started (and hence

+ won't accept new connections).

+

+

+ This error is included for future expansion; at present

+ the analysis server can only speak to one client at a

+ time so this error will never occur.

+

+ </dd><dt class="value">SERVER_ERROR</dt><dd>

+

+ An internal error occurred in the analysis server.

+ Also see the server.error notification.

+

+ </dd><dt class="value">SORT_MEMBERS_INVALID_FILE</dt><dd>

+

+ An "edit.sortMembers" request specified a FilePath

+ which does not match a Dart file in an analysis root.

+

+ </dd><dt class="value">SORT_MEMBERS_PARSE_ERRORS</dt><dd>

+

+ An "edit.sortMembers" request specified a Dart file that has

+ scan or parse errors.

+

+ </dd><dt class="value">UNANALYZED_PRIORITY_FILES</dt><dd>

+

+ An "analysis.setPriorityFiles" request includes one or

+ more files that are not being analyzed.

+

+

+ This is a legacy error; it will be removed before the

+ API reaches version 1.0.

+

+ </dd><dt class="value">UNKNOWN_REQUEST</dt><dd>

+

+ A request was received which the analysis server does

+ not recognize, or cannot handle in its current

+ configuration.

+

+ </dd><dt class="value">UNKNOWN_SOURCE</dt><dd>

+

+ The analysis server was requested to perform an action

+ on a source that does not exist.

+

+ </dd><dt class="value">UNSUPPORTED_FEATURE</dt><dd>

+

+ The analysis server was requested to perform an action

+ which is not supported.

+

+

+ This is a legacy error; it will be removed before the

+ API reaches version 1.0.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd>

+

+ An identifier used to associate search results with a search

+ request.

+

+ </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>

+

+ A single result from a search request.

+

+ <dl><dt class="field">location: <a href="#type_Location">Location</a></dt><dd>

+

+ The location of the code that matched the search criteria.

+

+ </dd><dt class="field">kind: <a href="#type_SearchResultKind">SearchResultKind</a></dt><dd>

+

+ The kind of element that was found or the kind of

+ reference that was found.

+

+ </dd><dt class="field">isPotential: bool</dt><dd>

+

+ True if the result is a potential match but cannot be

+ confirmed to be a match. For example, if all references to

+ a method m defined in some class were requested, and a

+ reference to a method m from an unknown class were found,

+ it would be marked as being a potential match.

+

+ </dd><dt class="field">path: List<<a href="#type_Element">Element</a>></dt><dd>

+

+ The elements that contain the result, starting with the

+ most immediately enclosing ancestor and ending with the

+ library.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKind">SearchResultKind: String</a></dt><dd>

+

+ An enumeration of the kinds of search results returned by the

+ search domain.

+

+ <dl><dt class="value">DECLARATION</dt><dd>

+

+ The declaration of an element.

+

+ </dd><dt class="value">INVOCATION</dt><dd>

+

+ The invocation of a function or method.

+

+ </dd><dt class="value">READ</dt><dd>

+

+ A reference to a field, parameter or variable where it is being read.

+

+ </dd><dt class="value">READ_WRITE</dt><dd>

+

+ A reference to a field, parameter or variable where it is being read

+ and written.

+

+ </dd><dt class="value">REFERENCE</dt><dd>

+

+ A reference to an element.

+

+ </dd><dt class="value">UNKNOWN</dt><dd>

+

+ Some other kind of search result.

+

+ </dd><dt class="value">WRITE</dt><dd>

+

+ A reference to a field, parameter or variable where it is being

+ written.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ServerService">ServerService: String</a></dt><dd>

+

+ An enumeration of the services provided by the server domain.

+

+ <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a name="type_SourceChange">SourceChange: object</a></dt><dd>

+

+ A description of a set of edits that implement a single conceptual change.

+

+ <dl><dt class="field">message: String</dt><dd>

+

+ A human-readable description of the change to be applied.

+

+ </dd><dt class="field">edits: List<<a href="#type_SourceFileEdit">SourceFileEdit</a>></dt><dd>

+

+ A list of the edits used to effect the change, grouped by file.

+

+ </dd><dt class="field">linkedEditGroups: List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>></dt><dd>

+

+ A list of the linked editing groups used to customize the changes that

+ were made.

+

+ </dd><dt class="field">selection: <a href="#type_Position">Position</a> (optional)</dt><dd>

+

+ The position that should be selected after the edits have been

+ applied.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">SourceEdit: object</a></dt><dd>

+

+ A description of a single change to a single file.

+

+ <dl><dt class="field">offset: int</dt><dd>

+

+ The offset of the region to be modified.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the region to be modified.

+

+ </dd><dt class="field">replacement: String</dt><dd>

+

+ The code that is to replace the specified region in the original code.

+

+ </dd><dt class="field">id: String (optional)</dt><dd>

+

+ An identifier that uniquely identifies this source edit from other

+ edits in the same response. This field is omitted unless a containing

+ structure needs to be able to identify the edit for some reason.

+

+

+ For example, some refactoring operations can produce edits that might

+ not be appropriate (referred to as potential edits). Such edits will

+ have an id so that they can be referenced. Edits in the same response

+ that do not need to be referenced will not have an id.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">SourceFileEdit: object</a></dt><dd>

+

+ A description of a set of changes to a single file.

+

+ <dl><dt class="field">file: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The file containing the code to be modified.

+

+ </dd><dt class="field">fileStamp: long</dt><dd>

+

+ The modification stamp of the file at the moment when the change was

+ created, in milliseconds since the "Unix epoch". Will be -1 if the

+ file did not exist and should be created. The client may use this

+ field to make sure that the file was not changed since then, so it is

+ safe to apply the change.

+

+ </dd><dt class="field">edits: List<<a href="#type_SourceEdit">SourceEdit</a>></dt><dd>

+

+ A list of the edits used to effect the change.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyItem">TypeHierarchyItem: object</a></dt><dd>

+

+ A representation of a class in a type hierarchy.

+

+ <dl><dt class="field">classElement: <a href="#type_Element">Element</a></dt><dd>

+

+ The class element represented by this item.

+

+ </dd><dt class="field">displayName: String (optional)</dt><dd>

+

+ The name to be displayed for the class. This field will be

+ omitted if the display name is the same as the name of the

+ element. The display name is different if there is

+ additional type information to be displayed, such as type

+ arguments.

+

+ </dd><dt class="field">memberElement: <a href="#type_Element">Element</a> (optional)</dt><dd>

+

+ The member in the class corresponding to the member on

+ which the hierarchy was requested. This field will be

+ omitted if the hierarchy was not requested for a member or

+ if the class does not have a corresponding member.

+

+ </dd><dt class="field">superclass: int (optional)</dt><dd>

+

+ The index of the item representing the superclass of

+ this class. This field will be omitted if this item

+ represents the class Object.

+

+ </dd><dt class="field">interfaces: List<int></dt><dd>

+

+ The indexes of the items representing the interfaces

+ implemented by this class. The list will be empty if

+ there are no implemented interfaces.

+

+ </dd><dt class="field">mixins: List<int></dt><dd>

- It is an error if the range contains anything other than all

- or part of the name of a single function (including methods,

- getters and setters), variable (including fields, parameters

- and local variables), class or function type.

-

- <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

-

- The offset to the beginning of the name selected to be

- renamed.

-

- </dd><dt class="field">length: int</dt><dd>

-

- The length of the name selected to be renamed.

-

- </dd><dt class="field">elementKindName: String</dt><dd>

-

- The human-readable description of the kind of element being

- renamed (such as "class" or "function type

- alias").

-

- </dd><dt class="field">oldName: String</dt><dd>

-

- The old name of the element before the refactoring.

-

- </dd></dl><h4>Options:</h4><dl><dt class="field">newName: String</dt><dd>

-

- The name that the element should have after the

- refactoring.

-

- </dd></dl></dd></dl>

- <h2>Errors</h2>

-

- This section contains a list of all of the errors that are

- produced by the server and the data that is returned with each.

-

-

- TODO: TBD

-

- <h2 class="domain"><a name="index">Index</a></h2>

- <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subindex"><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="#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_server.connected">connected</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 href="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDependencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigation">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="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.implemented">implemented</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="#notification_analysis.outline">outline</a></li><li><a href="#notification_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_completion.results">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.findElementReferences">findElementReferences</a></li><li><a href="#request_search.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_search.findMemberReferences">findMemberReferences</a></li><li><a href="#request_search.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#request_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="subindex"><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_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_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></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_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="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.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getServerPort">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_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><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">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a href="#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_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">GeneralAnalysisService</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_ImplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestionKind">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="#type_Override">Override</a></li><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">ServerService</a></li><li><a href="#type_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="#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 href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_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>

+ The indexes of the items representing the mixins

+ referenced by this class. The list will be empty if

+ there are no classes mixed in to this class.

+

+ </dd><dt class="field">subclasses: List<int></dt><dd>

+

+ The indexes of the items representing the subtypes of

+ this class. The list will be empty if there are no

+ subtypes or if this item represents a supertype of the

+ pivot type.

+

+ </dd></dl></dd></dl>

+ <h2><a name="refactorings">Refactorings</a></h2>

+

+ This section contains additional information for each kind of

+ refactoring. In addition to a brief description of the

+ refactoring, there is a specification of the feedback that is

+ provided when a refactoring is requested using the

+ edit.getRefactoring request (designed to improve the UX)

+ and the options that may be provided to edit.getRefactoring.

+

+<dl><dt class="refactoring">CONVERT_GETTER_TO_METHOD</dt><dd>

+

+ Convert a getter into a method by removing the keyword get

+ and adding an empty parameter list.

+

+

+ It is an error if the range contains anything other than all

+ or part of the name of a single getter.

+

+ <h4>Feedback:</h4>none<h4>Options:</h4>none</dd><dt class="refactoring">CONVERT_METHOD_TO_GETTER</dt><dd>

+

+ Convert a method into a getter by adding the keyword get and

+ removing the parameter list.

+

+

+ It is an error if the range contains anything other than all

+ or part of the name of a single method or if the method has

+ a non-empty parameter list.

+

+ <h4>Feedback:</h4>none<h4>Options:</h4>none</dd><dt class="refactoring">EXTRACT_LOCAL_VARIABLE</dt><dd>

+

+ Create a local variable initialized by the expression that covers

+ the specified selection.

+

+

+ It is an error if the selection range is not covered by a

+ complete expression.

+

+ <h4>Feedback:</h4><dl><dt class="field">coveringExpressionOffsets: List<int> (optional)</dt><dd>

+

+ The offsets of the expressions that cover the specified

+ selection, from the down most to the up most.

+

+ </dd><dt class="field">coveringExpressionLengths: List<int> (optional)</dt><dd>

+

+ The lengths of the expressions that cover the specified

+ selection, from the down most to the up most.

+

+ </dd><dt class="field">names: List<String></dt><dd>

+

+ The proposed names for the local variable.

+

+ </dd><dt class="field">offsets: List<int></dt><dd>

+

+ The offsets of the expressions that would be replaced by

+ a reference to the variable.

+

+ </dd><dt class="field">lengths: List<int></dt><dd>

+

+ The lengths of the expressions that would be replaced by

+ a reference to the variable. The lengths correspond to

+ the offsets. In other words, for a given expression, if

+ the offset of that expression is <tt>offsets[i]</tt>, then

+ the length of that expression is <tt>lengths[i]</tt>.

+

+ </dd></dl><h4>Options:</h4><dl><dt class="field">name: String</dt><dd>

+

+ The name that the local variable should be given.

+

+ </dd><dt class="field">extractAll: bool</dt><dd>

+

+ True if all occurrences of the expression within the

+ scope in which the variable will be defined should be

+ replaced by a reference to the local variable. The

+ expression used to initiate the refactoring will always

+ be replaced.

+

+ </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>

+

+ Create a method whose body is the specified expression or

+ list of statements, possibly augmented with a return

+ statement.

+

+

+ It is an error if the range contains anything other than a

+ complete expression (no partial expressions are allowed) or

+ a complete sequence of statements.

+

+ <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

+

+ The offset to the beginning of the expression or

+ statements that will be extracted.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the expression or statements that will be

+ extracted.

+

+ </dd><dt class="field">returnType: String</dt><dd>

+

+ The proposed return type for the method.

+ If the returned element does not have a declared return type,

+ this field will contain an empty string.

+

+ </dd><dt class="field">names: List<String></dt><dd>

+

+ The proposed names for the method.

+

+ </dd><dt class="field">canCreateGetter: bool</dt><dd>

+

+ True if a getter could be created rather than a method.

+

+ </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

+

+ The proposed parameters for the method.

+

+ </dd><dt class="field">offsets: List<int></dt><dd>

+

+ The offsets of the expressions or statements that would

+ be replaced by an invocation of the method.

+

+ </dd><dt class="field">lengths: List<int></dt><dd>

+

+ The lengths of the expressions or statements that would

+ be replaced by an invocation of the method. The lengths

+ correspond to the offsets. In other words, for a given

+ expression (or block of statements), if the offset of

+ that expression is <tt>offsets[i]</tt>, then the length

+ of that expression is <tt>lengths[i]</tt>.

+

+ </dd></dl><h4>Options:</h4><dl><dt class="field">returnType: String</dt><dd>

+

+ The return type that should be defined for the method.

+

+ </dd><dt class="field">createGetter: bool</dt><dd>

+

+ True if a getter should be created rather than a

+ method. It is an error if this field is true and the

+ list of parameters is non-empty.

+

+ </dd><dt class="field">name: String</dt><dd>

+

+ The name that the method should be given.

+

+ </dd><dt class="field">parameters: List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>></dt><dd>

+

+ The parameters that should be defined for the method.

+

+

+ It is an error if a REQUIRED or NAMED parameter follows a

+ POSITIONAL parameter.

+ It is an error if a REQUIRED or POSITIONAL parameter follows a

+ NAMED parameter.

+

+ <ul>

+ <li>

+ To change the order and/or update proposed parameters, add

+ parameters with the same identifiers as proposed.

+ </li>

+ <li>To add new parameters, omit their identifier.</li>

+ <li>To remove some parameters, omit them in this list.</li>

+ </ul>

+ </dd><dt class="field">extractAll: bool</dt><dd>

+

+ True if all occurrences of the expression or statements

+ should be replaced by an invocation of the method. The

+ expression or statements used to initiate the

+ refactoring will always be replaced.

+

+ </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>

+

+ Inline the initializer expression of a local variable in

+ place of any references to that variable.

+

+

+ It is an error if the range contains anything other than all

+ or part of the name of a single local variable.

+

+ <h4>Feedback:</h4><dl><dt class="field">name: String</dt><dd>

+

+ The name of the variable being inlined.

+

+ </dd><dt class="field">occurrences: int</dt><dd>

+

+ The number of times the variable occurs.

+

+ </dd></dl><h4>Options:</h4>none</dd><dt class="refactoring">INLINE_METHOD</dt><dd>

+

+ Inline a method in place of one or all references to that

+ method.

+

+

+ It is an error if the range contains anything other than all

+ or part of the name of a single method.

+

+ <h4>Feedback:</h4><dl><dt class="field">className: String (optional)</dt><dd>

+

+ The name of the class enclosing the method being inlined.

+ If not a class member is being inlined, this field will be absent.

+

+ </dd><dt class="field">methodName: String</dt><dd>

+

+ The name of the method (or function) being inlined.

+

+ </dd><dt class="field">isDeclaration: bool</dt><dd>

+

+ True if the declaration of the method is selected.

+ So all references should be inlined.

+

+ </dd></dl><h4>Options:</h4><dl><dt class="field">deleteSource: bool</dt><dd>

+

+ True if the method being inlined should be removed.

+ It is an error if this field is true and inlineAll is false.

+

+ </dd><dt class="field">inlineAll: bool</dt><dd>

+

+ True if all invocations of the method should be inlined,

+ or false if only the invocation site used to create this

+ refactoring should be inlined.

+

+ </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>

+

+ Move the given file and update all of the references to that file

+ and from it. The move operation is supported in general case - for

+ renaming a file in the same folder, moving it to a different folder

+ or both.

+

+

+ The refactoring must be activated before an actual file moving

+ operation is performed.

+

+

+ The "offset" and "length" fields from the request are ignored, but the

+ file specified in the request specifies the file to be moved.

+

+ <h4>Feedback:</h4>none<h4>Options:</h4><dl><dt class="field">newFile: <a href="#type_FilePath">FilePath</a></dt><dd>

+

+ The new file path to which the given file is being moved.

+

+ </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>

+

+ Rename a given element and all of the references to that

+ element.

+

+

+ It is an error if the range contains anything other than all

+ or part of the name of a single function (including methods,

+ getters and setters), variable (including fields, parameters

+ and local variables), class or function type.

+

+ <h4>Feedback:</h4><dl><dt class="field">offset: int</dt><dd>

+

+ The offset to the beginning of the name selected to be

+ renamed.

+

+ </dd><dt class="field">length: int</dt><dd>

+

+ The length of the name selected to be renamed.

+

+ </dd><dt class="field">elementKindName: String</dt><dd>

+

+ The human-readable description of the kind of element being

+ renamed (such as "class" or "function type

+ alias").

+

+ </dd><dt class="field">oldName: String</dt><dd>

+

+ The old name of the element before the refactoring.

+

+ </dd></dl><h4>Options:</h4><dl><dt class="field">newName: String</dt><dd>

+

+ The name that the element should have after the

+ refactoring.

+

+ </dd></dl></dd></dl>

+<h2>Errors</h2>

+

+ This section contains a list of all of the errors that are

+ produced by the server and the data that is returned with each.

+

+

+ TODO: TBD

+

+<h2 class="domain"><a name="index">Index</a></h2>

+<h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="subindex"><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="#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_server.connected">connected</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 href="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachableSources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDependencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNavigation">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="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles">analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></li><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.implemented">implemented</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="#notification_analysis.outline">outline</a></li><li><a href="#notification_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href="#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_completion.results">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.findElementReferences">findElementReferences</a></li><li><a href="#request_search.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_search.findMemberReferences">findMemberReferences</a></li><li><a href="#request_search.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#request_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="subindex"><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_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_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></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_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications</h5><div class="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.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.getServerPort">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_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><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">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li><a href="#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_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">GeneralAnalysisService</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_ImplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestionKind">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="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Override">Override</a></li><li><a href="#type_Position">Position</a></li><li><a href="#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">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_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">ServerService</a></li><li><a href="#type_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="#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 href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_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>

</body></html>