pkg/analysis_server/doc/api.html - Issue 2296023002: Update the styles for the analysis server specification.

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 2296023002: Update the styles for the analysis server specification. (Closed)

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

OLD	NEW
1 <!DOCTYPE html><html><head>	1 <!DOCTYPE html><html><head>

2 <meta charset="UTF-8">	2 <meta charset="UTF-8">

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

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

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

6 padding-left: 5%;	6 max-width: 800px;

7 padding-right: 5%;	7 margin: 0 auto;

	8 padding: 0 16px;

	9 font-size: 16px;

	10 line-height: 1.5;

	11 color: #111;

	12 background-color: #fdfdfd;

	13 font-weight: 300;

	14 -webkit-font-smoothing: auto;

8 }	15 }

	16

9 h1 {	17 h1 {

10 text-align: center;	18 text-align: center;

11 }	19 }

	20

	21 h2, h3, h4, h5 {

	22 margin-bottom: 0;

	23 }

	24

12 h2.domain {	25 h2.domain {

13 border-bottom: 3px solid rgb(160, 160, 160);	26 border-bottom: 1px solid rgb(200, 200, 200);

	27 margin-bottom: 0.5em;

14 }	28 }

	29

	30 h4 {

	31 font-size: 18px;

	32 }

	33

	34 h5 {

	35 font-size: 16px;

	36 }

	37

	38 p {

	39 margin-top: 0;

	40 }

	41

15 pre {	42 pre {

16 margin: 0px;	43 margin: 0;

	44 font-family: 'Source Code Pro', monospace;

	45 font-size: 15px;

17 }	46 }

	47

18 div.box {	48 div.box {

19 border: 1px solid rgb(0, 0, 0);	49 background-color: rgb(240, 245, 240);

20 background-color: rgb(207, 226, 243);	50 border-radius: 4px;

21 padding: 0.5em;	51 padding: 4px 12px;

	52 margin: 16px 0;

22 }	53 }

	54

23 div.hangingIndent {	55 div.hangingIndent {

24 padding-left: 3em;	56 padding-left: 3em;

25 text-indent: -3em;	57 text-indent: -3em;

26 }	58 }

	59

	60 dl dt {

	61 font-weight: bold;

	62 }

	63

	64 dl dd {

	65 margin-left: 16px;

	66 }

	67

27 dt {	68 dt {

28 margin-top: 1em;	69 margin-top: 1em;

29 margin-bottom: 1em;

30 }	70 }

	71

31 dt.notification {	72 dt.notification {

32 font-weight: bold;	73 font-weight: bold;

33 }	74 }

	75

34 dt.refactoring {	76 dt.refactoring {

35 font-weight: bold;	77 font-weight: bold;

36 }	78 }

	79

37 dt.request {	80 dt.request {

38 font-weight: bold;	81 font-weight: bold;

39 }	82 }

	83

40 dt.typeDefinition {	84 dt.typeDefinition {

41 font-weight: bold;	85 font-weight: bold;

42 }	86 }

43	87

44 */	88 a {

45 * Styles for index	89 text-decoration: none;

46 */	90 }

	91

	92 a:focus, a:hover {

	93 text-decoration: underline;

	94 }

	95

	96 /* Styles for index */

47	97

48 .subindex {	98 .subindex {

49 }	99 }

50	100

51 .subindex ul {	101 .subindex ul {

52 padding-left: 0px;	102 padding-left: 0;

53 margin-left: 0px;	103 margin-left: 0;

54	104

55 -webkit-margin-before: 0px;	105 -webkit-margin-before: 0;

56 -webkit-margin-start: 0px;	106 -webkit-margin-start: 0;

57 -webkit-padding-start: 0px;	107 -webkit-padding-start: 0;

58	108

59 list-style-type: none;	109 list-style-type: none;

60 }	110 }

61 </style></head>	111 </style></head>

62 <body>	112 <body>

63 <h1>Analysis Server API Specification</h1>	113 <h1>Analysis Server API Specification</h1>

64 <h1 style="color:#999999">Version 1.16.0</h1>	114 <h1 style="color:#999999">Version 1.16.0</h1>

65 <p>	115 <p>

66 This document contains a specification of the API provided by the	116 This document contains a specification of the API provided by the

67 analysis server. The API in this document is currently under	117 analysis server. The API in this document is currently under

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

69 protocol version number according to the principles of semantic	119 protocol version number according to the principles of semantic

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

71 </p>	121 </p>

72 <h2>Overview</h2>	122 <h2>Overview</h2>

73 <p>	123 <p>

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

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

76 is heavily influenced by a model in which sockets or character	126 is heavily influenced by a model in which sockets or character

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

78 </p>	128 </p>

79 <h3>Transport Mechanism</h3>	129 <h3>Transport Mechanism</h3>

80 <p>	130 <p>

(...skipping 85 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
166 described with each notification.	216 described with each notification.

167 </p>	217 </p>

168 <p>	218 <p>

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

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

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

172 the server supports an API before using it.	222 the server supports an API before using it.

173 </p>	223 </p>

174 <h3>Eventual Consistency</h3>	224 <h3>Eventual Consistency</h3>

175 <p>	225 <p>

176 TBD	226 TODO: TBD

177 </p>	227 </p>

178 <h3>Domains</h3>	228 <h3>Domains</h3>

179 <p>	229 <p>

180 For convenience, the API is divided into domains. Each domain is	230 For convenience, the API is divided into domains. Each domain is

181 specified in a separate section below:	231 specified in a separate section below:

182 </p>	232 </p>

183 <ul>	233 <ul>

184 <li><a href="#domain_server">Server</a></li>	234 <li><a href="#domain_server">Server</a></li>

185 <li><a href="#domain_analysis">Analysis</a></li>	235 <li><a href="#domain_analysis">Analysis</a></li>

186 <li><a href="#domain_completion">Code Completion</a></li>	236 <li><a href="#domain_completion">Code Completion</a></li>

(...skipping 43 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
230 <dt>--no-index</dt>	280 <dt>--no-index</dt>

231 <dd>	281 <dd>

232 Disable the server from generating an index. If this flag is passed and an	282 Disable the server from generating an index. If this flag is passed and an

233 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED< /tt>,	283 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED< /tt>,

234 will be thrown. The set of API calls that require an index include:	284 will be thrown. The set of API calls that require an index include:

235 refactoring calls, code completions and searching.	285 refactoring calls, code completions and searching.

236	286

237 </dd>	287 </dd>

238 </dl>	288 </dl>

239 </blockquote>	289 </blockquote>

240 <h2 class="domain"><a name="domain_server">Domain: server</a></h2>	290 <h2 class="domain"><a name="domain_server">server domain</a></h2>

241 <p>	291 <p>

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

243 the server.	293 the server.

244 </p>	294 </p>

245	295

246	296

247	297

248	298

249	299

250	300

251 <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion" >server.getVersion</a> (<a href="#request_server.getVersion">#</a>)</dt><dd><div class="box"><pre>request: {	301 <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion" >server.getVersion</a> (<a href="#request_server.getVersion">#</a>)</dt><dd><div class="box"><pre>request: {

252 "id": String	302 "id": String

253 "method": "server.getVersion"	303 "method": "server.getVersion"

254 }</pre><br><pre>response: {	304 }</pre><br><pre>response: {

255 "id": String	305 "id": String

256 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	306 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

257 "result": {	307 "result": {

258 "<b>version</b>": String	308 "<b>version</b>": String

259 }	309 }

260 }</pre></div>	310 }</pre></div>

261 <p>Return the version number of the analysis server.</p>	311 <p>Return the version number of the analysis server.</p>

262	312

263 <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt ><dd>	313 <h4>returns:</h4><dl><dt class="field"><b>version (String)</b></dt><dd>

264	314

265 <p>The version number of the analysis server.</p>	315 <p>The version number of the analysis server.</p>

266 </dd></dl></dd><dt class="request"><a name="request_server.shutdown">s erver.shutdown</a> (<a href="#request_server.shutdown">#</a>)</dt><dd><div class ="box"><pre>request: {	316 </dd></dl></dd><dt class="request"><a name="request_server.shutdown">s erver.shutdown</a> (<a href="#request_server.shutdown">#</a>)</dt><dd><div class ="box"><pre>request: {

267 "id": String	317 "id": String

268 "method": "server.shutdown"	318 "method": "server.shutdown"

269 }</pre><br><pre>response: {	319 }</pre><br><pre>response: {

270 "id": String	320 "id": String

271 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	321 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

272 }</pre></div>	322 }</pre></div>

273 <p>	323 <p>

(...skipping 17 matching lines...) Expand all Loading...
291 <p>	341 <p>

292 Subscribe for services. All previous subscriptions are	342 Subscribe for services. All previous subscriptions are

293 replaced by the given set of services.	343 replaced by the given set of services.

294 </p>	344 </p>

295 <p>	345 <p>

296 It is an error if any of the elements in the list are not	346 It is an error if any of the elements in the list are not

297 valid services. If there is an error, then the current	347 valid services. If there is an error, then the current

298 subscriptions will remain unchanged.	348 subscriptions will remain unchanged.

299 </p>	349 </p>

300	350

301 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd>	351 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_ServerService">ServerService</a>>)</b></dt><dd>

302	352

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

304 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_server.connected">server.connected</a> (<a href="#notific ation_server.connected">#</a>)</dt><dd><div class="box"><pre>notification: {	354 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_server.connected">server.connected</a> (<a href="#notific ation_server.connected">#</a>)</dt><dd><div class="box"><pre>notification: {

305 "event": "server.connected"	355 "event": "server.connected"

306 "params": {	356 "params": {

307 "<b>version</b>": String	357 "<b>version</b>": String

308 "<b>pid</b>": int	358 "<b>pid</b>": int

309 }	359 }

310 }</pre></div>	360 }</pre></div>

311 <p>	361 <p>

312 Reports that the server is running. This notification is	362 Reports that the server is running. This notification is

313 issued once after the server has started running but before	363 issued once after the server has started running but before

314 any requests are processed to let the client know that it	364 any requests are processed to let the client know that it

315 started correctly.	365 started correctly.

316 </p>	366 </p>

317 <p>	367 <p>

318 It is not possible to subscribe to or unsubscribe from this	368 It is not possible to subscribe to or unsubscribe from this

319 notification.	369 notification.

320 </p>	370 </p>

321	371

322 <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b>< /dt><dd>	372 <h4>parameters:</h4><dl><dt class="field"><b>version (String)</b></dt><dd>

323	373

324 <p>The version number of the analysis server.</p>	374 <p>The version number of the analysis server.</p>

325 </dd><dt class="field"><b><i>pid ( int )</i></b></dt><dd>	375 </dd><dt class="field"><b>pid (int)</b></dt><dd>

326	376

327 <p>The process id of the analysis server process.</p>	377 <p>The process id of the analysis server process.</p>

328 </dd></dl></dd><dt class="notification"><a name="notification_server.er ror">server.error</a> (<a href="#notification_server.error">#</a>)</dt><dd><div class="box"><pre>notification: {	378 </dd></dl></dd><dt class="notification"><a name="notification_server.er ror">server.error</a> (<a href="#notification_server.error">#</a>)</dt><dd><div class="box"><pre>notification: {

329 "event": "server.error"	379 "event": "server.error"

330 "params": {	380 "params": {

331 "<b>isFatal</b>": bool	381 "<b>isFatal</b>": bool

332 "<b>message</b>": String	382 "<b>message</b>": String

333 "<b>stackTrace</b>": String	383 "<b>stackTrace</b>": String

334 }	384 }

335 }</pre></div>	385 }</pre></div>

336 <p>	386 <p>

337 Reports that an unexpected error has occurred while	387 Reports that an unexpected error has occurred while

338 executing the server. This notification is not used for	388 executing the server. This notification is not used for

339 problems with specific requests (which are returned as part	389 problems with specific requests (which are returned as part

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

341 performing other tasks, such as analysis or preparing	391 performing other tasks, such as analysis or preparing

342 notifications.	392 notifications.

343 </p>	393 </p>

344 <p>	394 <p>

345 It is not possible to subscribe to or unsubscribe from this	395 It is not possible to subscribe to or unsubscribe from this

346 notification.	396 notification.

347 </p>	397 </p>

348	398

349 <h4>Parameters</h4><dl><dt class="field"><b><i>isFatal ( bool )</i></b></d t><dd>	399 <h4>parameters:</h4><dl><dt class="field"><b>isFatal (bool)</b></dt><dd>

350	400

351 <p>	401 <p>

352 True if the error is a fatal error, meaning that the	402 True if the error is a fatal error, meaning that the

353 server will shutdown automatically after sending this	403 server will shutdown automatically after sending this

354 notification.	404 notification.

355 </p>	405 </p>

356 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>	406 </dd><dt class="field"><b>message (String)</b></dt><dd>

357	407

358 <p>	408 <p>

359 The error message indicating what kind of error was	409 The error message indicating what kind of error was

360 encountered.	410 encountered.

361 </p>	411 </p>

362 </dd><dt class="field"><b><i>stackTrace ( String )</i></b></dt><dd>	412 </dd><dt class="field"><b>stackTrace (String)</b></dt><dd>

363	413

364 <p>	414 <p>

365 The stack trace associated with the generation of the	415 The stack trace associated with the generation of the

366 error, used for debugging the server.	416 error, used for debugging the server.

367 </p>	417 </p>

368 </dd></dl></dd><dt class="notification"><a name="notification_server.s tatus">server.status</a> (<a href="#notification_server.status">#</a>)</dt><dd>< div class="box"><pre>notification: {	418 </dd></dl></dd><dt class="notification"><a name="notification_server.s tatus">server.status</a> (<a href="#notification_server.status">#</a>)</dt><dd>< div class="box"><pre>notification: {

369 "event": "server.status"	419 "event": "server.status"

370 "params": {	420 "params": {

371 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ e_AnalysisStatus">AnalysisStatus</a>	421 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ e_AnalysisStatus">AnalysisStatus</a>

372 "<b>pub</b>": <span style="color:#999999">optional</span> <a href="#type_Pub Status">PubStatus</a>	422 "<b>pub</b>": <span style="color:#999999">optional</span> <a href="#type_Pub Status">PubStatus</a>

373 }	423 }

374 }</pre></div>	424 }</pre></div>

375 <p>	425 <p>

376 Reports the current status of the server. Parameters are	426 Reports the current status of the server. Parameters are

377 omitted if there has been no change in the status	427 omitted if there has been no change in the status

378 represented by that parameter.	428 represented by that parameter.

379 </p>	429 </p>

380 <p>	430 <p>

381 This notification is not subscribed to by default. Clients	431 This notification is not subscribed to by default. Clients

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

383 the list of services passed in a server.setSubscriptions	433 the list of services passed in a server.setSubscriptions

384 request.	434 request.

385 </p>	435 </p>

386	436

387 <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="col or:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )< /i></b></dt><dd>	437 <h4>parameters:</h4><dl><dt class="field"><b>analysis (<span style="color: #999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a>)</b>< /dt><dd>

388	438

389 <p>	439 <p>

390 The current status of analysis, including whether	440 The current status of analysis, including whether

391 analysis is being performed and if so what is being	441 analysis is being performed and if so what is being

392 analyzed.	442 analyzed.

393 </p>	443 </p>

394 </dd><dt class="field"><b><i>pub ( <span style="color:#999999">optiona l</span> <a href="#type_PubStatus">PubStatus</a> )</i></b></dt><dd>	444 </dd><dt class="field"><b>pub (<span style="color:#999999">optional</s pan> <a href="#type_PubStatus">PubStatus</a>)</b></dt><dd>

395	445

396 <p>	446 <p>

397 The current status of pub execution, indicating whether we are	447 The current status of pub execution, indicating whether we are

398 currently running pub.	448 currently running pub.

399 </p>	449 </p>

400 </dd></dl></dd></dl>	450 </dd></dl></dd></dl>

401 <h2 class="domain"><a name="domain_analysis">Domain: analysis</a></h2>	451 <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2>

402 <p>	452 <p>

403 The analysis domain contains API’s related to the analysis of	453 The analysis domain contains API’s related to the analysis of

404 files.	454 files.

405 </p>	455 </p>

406	456

407	457

408	458

409	459

410	460

411	461

(...skipping 49 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
461 </p>	511 </p>

462 <p>	512 <p>

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

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

465 is not associated with any analysis root specified to	515 is not associated with any analysis root specified to

466 analysis.setAnalysisRoots), an error of type	516 analysis.setAnalysisRoots), an error of type

467 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.	517 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.

468 </p>	518 </p>

469	519

470	520

471 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	521 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

472	522

473 <p>	523 <p>

474 The file for which errors are being requested.	524 The file for which errors are being requested.

475 </p>	525 </p>

476 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List&lt ;<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd>	526 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors (List<<a href="#type_AnalysisError">AnalysisError</a>>)</b></dt><dd>

477	527

478 <p>	528 <p>

479 The errors associated with the file.	529 The errors associated with the file.

480 </p>	530 </p>

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

482 "id": String	532 "id": String

483 "method": "analysis.getHover"	533 "method": "analysis.getHover"

484 "params": {	534 "params": {

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

486 "<b>offset</b>": int	536 "<b>offset</b>": int

487 }	537 }

488 }</pre><br><pre>response: {	538 }</pre><br><pre>response: {

489 "id": String	539 "id": String

490 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	540 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

491 "result": {	541 "result": {

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

493 }	543 }

494 }</pre></div>	544 }</pre></div>

495 <p>	545 <p>

496 Return the hover information associate with the given	546 Return the hover information associate with the given

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

498 available at the time this request is processed the	548 available at the time this request is processed the

499 information will be omitted from the response.	549 information will be omitted from the response.

500 </p>	550 </p>

501	551

502	552

503 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	553 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

504	554

505 <p>	555 <p>

506 The file in which hover information is being requested.	556 The file in which hover information is being requested.

507 </p>	557 </p>

508 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	558 </dd><dt class="field"><b>offset (int)</b></dt><dd>

509	559

510 <p>	560 <p>

511 The offset for which hover information is being requested.	561 The offset for which hover information is being requested.

512 </p>	562 </p>

513 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd>	563 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers (List<<a href="#type_HoverInformation">HoverInformation</a>>)</b></dt><dd>

514	564

515 <p>	565 <p>

516 The hover information associated with the	566 The hover information associated with the

517 location. The list will be empty if no information	567 location. The list will be empty if no information

518 could be determined for the location. The list can	568 could be determined for the location. The list can

519 contain multiple items if the file is being analyzed	569 contain multiple items if the file is being analyzed

520 in multiple contexts in conflicting ways (such as a	570 in multiple contexts in conflicting ways (such as a

521 part that is included in multiple libraries).	571 part that is included in multiple libraries).

522 </p>	572 </p>

523 </dd></dl></dd><dt class="request"><a name="request_analysis.getReacha bleSources">analysis.getReachableSources</a> (<a href="#request_analysis.getReac hableSources">#</a>)</dt><dd><div class="box"><pre>request: {	573 </dd></dl></dd><dt class="request"><a name="request_analysis.getReacha bleSources">analysis.getReachableSources</a> (<a href="#request_analysis.getReac hableSources">#</a>)</dt><dd><div class="box"><pre>request: {

(...skipping 14 matching lines...) Expand all Loading...
538 </p>	588 </p>

539 <p>	589 <p>

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

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

542 is not associated with any analysis root specified to	592 is not associated with any analysis root specified to

543 analysis.setAnalysisRoots), an error of type	593 analysis.setAnalysisRoots), an error of type

544 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.	594 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.

545 </p>	595 </p>

546	596

547	597

548 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	598 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

549	599

550 <p>	600 <p>

551 The file for which reachable source information is being requested .	601 The file for which reachable source information is being requested .

552 </p>	602 </p>

553 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>sources ( Map&lt ;String, List<String>> )</i></b></dt><dd>	603 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources (Map<St ring, List<String>>)</b></dt><dd>

554	604

555 <p>	605 <p>

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

557 a file "foo.dart" that imports "bar.dart" would have the correspon ding mapping	607 a file "foo.dart" that imports "bar.dart" would have the correspon ding mapping

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

559 (or exports) there will be a mapping from the URI "file:///bar.dar t" to them.	609 (or exports) there will be a mapping from the URI "file:///bar.dar t" to them.

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

561 for its presence in the resulting key set.	611 for its presence in the resulting key set.

562 </p>	612 </p>

563 </dd></dl></dd><dt class="request"><a name="request_analysis.getLibrar yDependencies">analysis.getLibraryDependencies</a> (<a href="#request_analysis.g etLibraryDependencies">#</a>)</dt><dd><div class="box"><pre>request: {	613 </dd></dl></dd><dt class="request"><a name="request_analysis.getLibrar yDependencies">analysis.getLibraryDependencies</a> (<a href="#request_analysis.g etLibraryDependencies">#</a>)</dt><dd><div class="box"><pre>request: {

564 "id": String	614 "id": String

565 "method": "analysis.getLibraryDependencies"	615 "method": "analysis.getLibraryDependencies"

566 }</pre><br><pre>response: {	616 }</pre><br><pre>response: {

567 "id": String	617 "id": String

568 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	618 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

569 "result": {	619 "result": {

570 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>>	620 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>>

571 "<b>packageMap</b>": Map<String, Map<String, List<<a href="#type_Fi lePath">FilePath</a>>>>	621 "<b>packageMap</b>": Map<String, Map<String, List<<a href="#type_Fi lePath">FilePath</a>>>>

572 }	622 }

573 }</pre></div>	623 }</pre></div>

574 <p>	624 <p>

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

576 and package URI resolution.	626 and package URI resolution.

577 </p>	627 </p>

578 <p>	628 <p>

579 Clients that are only using the libraries field should consider using th e	629 Clients that are only using the libraries field should consider using th e

580 analyzedFiles notification instead.	630 analyzedFiles notification instead.

581 </p>	631 </p>

582	632

583 <h4>Returns</h4><dl><dt class="field"><b><i>libraries ( List<<a href="# type_FilePath">FilePath</a>> )</i></b></dt><dd>	633 <h4>returns:</h4><dl><dt class="field"><b>libraries (List<<a href="#typ e_FilePath">FilePath</a>>)</b></dt><dd>

584	634

585 <p>	635 <p>

586 A list of the paths of library elements referenced by	636 A list of the paths of library elements referenced by

587 files in existing analysis roots.	637 files in existing analysis roots.

588 </p>	638 </p>

589 </dd><dt class="field"><b><i>packageMap ( Map<String, Map<Stri ng, List<<a href="#type_FilePath">FilePath</a>>>> )</i></b></dt><dd>	639 </dd><dt class="field"><b>packageMap (Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>>)</b></dt><dd>

590	640

591 <p>	641 <p>

592 A mapping from context source roots to package maps which map	642 A mapping from context source roots to package maps which map

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

594 package URI resolution.	644 package URI resolution.

595 </p>	645 </p>

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

597 "id": String	647 "id": String

598 "method": "analysis.getNavigation"	648 "method": "analysis.getNavigation"

599 "params": {	649 "params": {

(...skipping 30 matching lines...) Expand all Loading...
630 </p>	680 </p>

631 <p>	681 <p>

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

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

634 is not associated with any analysis root specified to	684 is not associated with any analysis root specified to

635 analysis.setAnalysisRoots), an error of type	685 analysis.setAnalysisRoots), an error of type

636 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.	686 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.

637 </p>	687 </p>

638	688

639	689

640 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	690 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

641	691

642 <p>	692 <p>

643 The file in which navigation information is being requested.	693 The file in which navigation information is being requested.

644 </p>	694 </p>

645 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	695 </dd><dt class="field"><b>offset (int)</b></dt><dd>

646	696

647 <p>	697 <p>

648 The offset of the region for which navigation information is being	698 The offset of the region for which navigation information is being

649 requested.	699 requested.

650 </p>	700 </p>

651 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	701 </dd><dt class="field"><b>length (int)</b></dt><dd>

652	702

653 <p>	703 <p>

654 The length of the region for which navigation information is being	704 The length of the region for which navigation information is being

655 requested.	705 requested.

656 </p>	706 </p>

657 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>files ( List< <a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>	707 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd>

658	708

659 <p>	709 <p>

660 A list of the paths of files that are referenced by the navigation	710 A list of the paths of files that are referenced by the navigation

661 targets.	711 targets.

662 </p>	712 </p>

663 </dd><dt class="field"><b><i>targets ( List<<a href="#type_Navigati onTarget">NavigationTarget</a>> )</i></b></dt><dd>	713 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa rget">NavigationTarget</a>>)</b></dt><dd>

664	714

665 <p>	715 <p>

666 A list of the navigation targets that are referenced by the	716 A list of the navigation targets that are referenced by the

667 navigation regions.	717 navigation regions.

668 </p>	718 </p>

669 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Navigati onRegion">NavigationRegion</a>> )</i></b></dt><dd>	719 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe gion">NavigationRegion</a>>)</b></dt><dd>

670	720

671 <p>	721 <p>

672 A list of the navigation regions within the requested region of	722 A list of the navigation regions within the requested region of

673 the file.	723 the file.

674 </p>	724 </p>

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

676 "id": String	726 "id": String

677 "method": "analysis.reanalyze"	727 "method": "analysis.reanalyze"

678 "params": {	728 "params": {

679 "<b>roots</b>": <span style="color:#999999">optional</span> List<<a href= "#type_FilePath">FilePath</a>>	729 "<b>roots</b>": <span style="color:#999999">optional</span> List<<a href= "#type_FilePath">FilePath</a>>

680 }	730 }

681 }</pre><br><pre>response: {	731 }</pre><br><pre>response: {

682 "id": String	732 "id": String

683 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	733 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

684 }</pre></div>	734 }</pre></div>

685 <p>	735 <p>

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

687 analysis roots. This will cause all previously computed analysis	737 analysis roots. This will cause all previously computed analysis

688 results to be discarded and recomputed, and will cause all subscribed	738 results to be discarded and recomputed, and will cause all subscribed

689 notifications to be re-sent.	739 notifications to be re-sent.

690 </p>	740 </p>

691 <p>	741 <p>

692 If no analysis roots are provided, then all current analysis roots	742 If no analysis roots are provided, then all current analysis roots

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

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

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

696 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.	746 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.

697 </p>	747 </p>

698	748

699 <h4>Parameters</h4><dl><dt class="field"><b><i>roots ( <span style="color: #999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i> </b></dt><dd>	749 <h4>parameters:</h4><dl><dt class="field"><b>roots (<span style="color:#99 9999">optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt ><dd>

700	750

701 <p>	751 <p>

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

703 </p>	753 </p>

704 </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalys isRoots">analysis.setAnalysisRoots</a> (<a href="#request_analysis.setAnalysisRo ots">#</a>)</dt><dd><div class="box"><pre>request: {	754 </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalys isRoots">analysis.setAnalysisRoots</a> (<a href="#request_analysis.setAnalysisRo ots">#</a>)</dt><dd><div class="box"><pre>request: {

705 "id": String	755 "id": String

706 "method": "analysis.setAnalysisRoots"	756 "method": "analysis.setAnalysisRoots"

707 "params": {	757 "params": {

708 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>>	758 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>>

709 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>>	759 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>>

(...skipping 29 matching lines...) Expand all Loading...
739 </p>	789 </p>

740 <p>	790 <p>

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

742 in the directory containing the file for a pubspec.yaml	792 in the directory containing the file for a pubspec.yaml

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

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

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

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

747 </p>	797 </p>

748	798

749 <h4>Parameters</h4><dl><dt class="field"><b><i>included ( List<<a href= "#type_FilePath">FilePath</a>> )</i></b></dt><dd>	799 <h4>parameters:</h4><dl><dt class="field"><b>included (List<<a href="#t ype_FilePath">FilePath</a>>)</b></dt><dd>

750	800

751 <p>	801 <p>

752 A list of the files and directories that should be	802 A list of the files and directories that should be

753 analyzed.	803 analyzed.

754 </p>	804 </p>

755 </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePat h">FilePath</a>> )</i></b></dt><dd>	805 </dd><dt class="field"><b>excluded (List<<a href="#type_FilePath">F ilePath</a>>)</b></dt><dd>

756	806

757 <p>	807 <p>

758 A list of the files and directories within the	808 A list of the files and directories within the

759 included directories that should not be analyzed.	809 included directories that should not be analyzed.

760 </p>	810 </p>

761 </dd><dt class="field"><b><i>packageRoots ( <span style="color:#999999 ">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_F ilePath">FilePath</a>> )</i></b></dt><dd>	811 </dd><dt class="field"><b>packageRoots (<span style="color:#999999">op tional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FileP ath">FilePath</a>>)</b></dt><dd>

762	812

763 <p>	813 <p>

764 A mapping from source directories to package roots	814 A mapping from source directories to package roots

765 that should override the normal package: URI resolution	815 that should override the normal package: URI resolution

766 mechanism.	816 mechanism.

767 </p>	817 </p>

768 <p>	818 <p>

769 If a package root is a directory, then	819 If a package root is a directory, then

770 the analyzer will behave as though the associated	820 the analyzer will behave as though the associated

771 source directory in the map contains a special	821 source directory in the map contains a special

(...skipping 31 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
803 Subscribe for general services (that is, services that are not	853 Subscribe for general services (that is, services that are not

804 specific to individual files). All previous subscriptions are replaced	854 specific to individual files). All previous subscriptions are replaced

805 by the given set of services.	855 by the given set of services.

806 </p>	856 </p>

807 <p>	857 <p>

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

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

810 remain unchanged.	860 remain unchanged.

811 </p>	861 </p>

812	862

813 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_GeneralAnalysisService">GeneralAnalysisService</a>> )</i></b></dt ><dd>	863 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_GeneralAnalysisService">GeneralAnalysisService</a>>)</b></dt><dd>

814	864

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

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

817 "id": String	867 "id": String

818 "method": "analysis.setPriorityFiles"	868 "method": "analysis.setPriorityFiles"

819 "params": {	869 "params": {

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

821 }	871 }

822 }</pre><br><pre>response: {	872 }</pre><br><pre>response: {

823 "id": String	873 "id": String

(...skipping 18 matching lines...) Expand all Loading...
842 analysis.setSubscriptions for a description of files that	892 analysis.setSubscriptions for a description of files that

843 are subject to analysis.)	893 are subject to analysis.)

844 </p>	894 </p>

845 <p>	895 <p>

846 If a requested priority file is a directory it is ignored,	896 If a requested priority file is a directory it is ignored,

847 but remains in the set of requested priority files so that	897 but remains in the set of requested priority files so that

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

849 actual priority files.	899 actual priority files.

850 </p>	900 </p>

851	901

852 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>	902 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type _FilePath">FilePath</a>>)</b></dt><dd>

853	903

854 <p>	904 <p>

855 The files that are to be a priority for analysis.	905 The files that are to be a priority for analysis.

856 </p>	906 </p>

857 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscr iptions">analysis.setSubscriptions</a> (<a href="#request_analysis.setSubscripti ons">#</a>)</dt><dd><div class="box"><pre>request: {	907 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscr iptions">analysis.setSubscriptions</a> (<a href="#request_analysis.setSubscripti ons">#</a>)</dt><dd><div class="box"><pre>request: {

858 "id": String	908 "id": String

859 "method": "analysis.setSubscriptions"	909 "method": "analysis.setSubscriptions"

860 "params": {	910 "params": {

861 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi ce</a>, List<<a href="#type_FilePath">FilePath</a>>>	911 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi ce</a>, List<<a href="#type_FilePath">FilePath</a>>>

862 }	912 }

(...skipping 28 matching lines...) Expand all Loading...
891 but remains in the set of requested subscriptions so that if	941 but remains in the set of requested subscriptions so that if

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

893 actual subscriptions.	943 actual subscriptions.

894 </p>	944 </p>

895 <p>	945 <p>

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

897 services. If there is an error, then the existing	947 services. If there is an error, then the existing

898 subscriptions will remain unchanged.	948 subscriptions will remain unchanged.

899 </p>	949 </p>

900	950

901 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( Map<<a h ref="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath ">FilePath</a>>> )</i></b></dt><dd>	951 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (Map<<a href ="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">F ilePath</a>>>)</b></dt><dd>

902	952

903 <p>	953 <p>

904 A table mapping services to a list of the files being	954 A table mapping services to a list of the files being

905 subscribed to the service.	955 subscribed to the service.

906 </p>	956 </p>

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

908 "id": String	958 "id": String

909 "method": "analysis.updateContent"	959 "method": "analysis.updateContent"

910 "params": {	960 "params": {

911 "<b>files</b>": Map<<a href="#type_FilePath">FilePath</a>, <a href="#type _AddContentOverlay">AddContentOverlay</a> \| <a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a> \| <a href="#type_RemoveContentOverlay">RemoveContentOv erlay</a>>	961 "<b>files</b>": Map<<a href="#type_FilePath">FilePath</a>, <a href="#type _AddContentOverlay">AddContentOverlay</a> \| <a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a> \| <a href="#type_RemoveContentOverlay">RemoveContentOv erlay</a>>

912 }	962 }

913 }</pre><br><pre>response: {	963 }</pre><br><pre>response: {

914 "id": String	964 "id": String

915 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	965 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

916 "result": {	966 "result": {

917 }	967 }

918 }</pre></div>	968 }</pre></div>

919 <p>	969 <p>

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

921 previously updated but not included in this update remain	971 previously updated but not included in this update remain

922 unchanged. This effectively represents an overlay of the	972 unchanged. This effectively represents an overlay of the

923 filesystem. The files whose content is overridden are	973 filesystem. The files whose content is overridden are

924 therefore seen by server as being files with the given	974 therefore seen by server as being files with the given

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

926 if the file path represents the path to a directory on the	976 if the file path represents the path to a directory on the

927 filesystem.	977 filesystem.

928 </p>	978 </p>

929	979

930	980

931 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map<<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</ a> \| <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> \| <a href="#t ype_RemoveContentOverlay">RemoveContentOverlay</a>> )</i></b></dt><dd>	981 <h4>parameters:</h4><dl><dt class="field"><b>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>>)</b></dt><dd>

932	982

933 <p>	983 <p>

934 A table mapping the files whose content has changed to a	984 A table mapping the files whose content has changed to a

935 description of the content change.	985 description of the content change.

936 </p>	986 </p>

937 </dd></dl><h4>Returns</h4><dl></dl></dd><dt class="request"><a name="r equest_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_ana lysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: {	987 </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request"><a name=" request_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_an alysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: {

938 "id": String	988 "id": String

939 "method": "analysis.updateOptions"	989 "method": "analysis.updateOptions"

940 "params": {	990 "params": {

941 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>	991 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>

942 }	992 }

943 }</pre><br><pre>response: {	993 }</pre><br><pre>response: {

944 "id": String	994 "id": String

945 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	995 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

946 }</pre></div>	996 }</pre></div>

947 <p>	997 <p>

948 Update the options controlling analysis based on the given	998 Update the options controlling analysis based on the given

949 set of options. Any options that are not included in the	999 set of options. Any options that are not included in the

950 analysis options will not be changed. If there are options	1000 analysis options will not be changed. If there are options

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

952 silently ignored.	1002 silently ignored.

953 </p>	1003 </p>

954	1004

955 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An alysisOptions">AnalysisOptions</a> )</i></b></dt><dd>	1005 <h4>parameters:</h4><dl><dt class="field"><b>options (<a href="#type_Analy sisOptions">AnalysisOptions</a>)</b></dt><dd>

956	1006

957 <p>	1007 <p>

958 The options that are to be used to control analysis.	1008 The options that are to be used to control analysis.

959 </p>	1009 </p>

960 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a> (<a hr ef="#notification_analysis.analyzedFiles">#</a>)</dt><dd><div class="box"><pre>n otification: {	1010 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a> (<a hr ef="#notification_analysis.analyzedFiles">#</a>)</dt><dd><div class="box"><pre>n otification: {

961 "event": "analysis.analyzedFiles"	1011 "event": "analysis.analyzedFiles"

962 "params": {	1012 "params": {

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

964 }	1014 }

965 }</pre></div>	1015 }</pre></div>

966 <p>	1016 <p>

967 Reports the paths of the files that are being analyzed.	1017 Reports the paths of the files that are being analyzed.

968 </p>	1018 </p>

969 <p>	1019 <p>

970 This notification is not subscribed to by default. Clients can	1020 This notification is not subscribed to by default. Clients can

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

972 of services passed in an analysis.setGeneralSubscriptions request.	1022 of services passed in an analysis.setGeneralSubscriptions request.

973 </p>	1023 </p>

974	1024

975 <h4>Parameters</h4><dl><dt class="field"><b><i>directories ( List<<a hr ef="#type_FilePath">FilePath</a>> )</i></b></dt><dd>	1025 <h4>parameters:</h4><dl><dt class="field"><b>directories (List<<a href= "#type_FilePath">FilePath</a>>)</b></dt><dd>

976	1026

977 <p>	1027 <p>

978 A list of the paths of the files that are being analyzed.	1028 A list of the paths of the files that are being analyzed.

979 </p>	1029 </p>

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

981 "event": "analysis.errors"	1031 "event": "analysis.errors"

982 "params": {	1032 "params": {

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

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

985 }	1035 }

986 }</pre></div>	1036 }</pre></div>

987 <p>	1037 <p>

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

989 errors included in the notification is always a complete	1039 errors included in the notification is always a complete

990 list that supersedes any previously reported errors.	1040 list that supersedes any previously reported errors.

991 </p>	1041 </p>

992 <p>	1042 <p>

993 It is only possible to unsubscribe from this notification by	1043 It is only possible to unsubscribe from this notification by

994 using the command-line flag --no-error-notification.	1044 using the command-line flag --no-error-notification.

995 </p>	1045 </p>

996	1046

997 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1047 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

998	1048

999 <p>	1049 <p>

1000 The file containing the errors.	1050 The file containing the errors.

1001 </p>	1051 </p>

1002 </dd><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisE rror">AnalysisError</a>> )</i></b></dt><dd>	1052 </dd><dt class="field"><b>errors (List<<a href="#type_AnalysisError ">AnalysisError</a>>)</b></dt><dd>

1003	1053

1004 <p>	1054 <p>

1005 The errors contained in the file.	1055 The errors contained in the file.

1006 </p>	1056 </p>

1007 </dd></dl></dd><dt class="notification"><a name="notification_analysis .flushResults">analysis.flushResults</a> (<a href="#notification_analysis.flushR esults">#</a>)</dt><dd><div class="box"><pre>notification: {	1057 </dd></dl></dd><dt class="notification"><a name="notification_analysis .flushResults">analysis.flushResults</a> (<a href="#notification_analysis.flushR esults">#</a>)</dt><dd><div class="box"><pre>notification: {

1008 "event": "analysis.flushResults"	1058 "event": "analysis.flushResults"

1009 "params": {	1059 "params": {

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

1011 }	1061 }

1012 }</pre></div>	1062 }</pre></div>

1013 <p>	1063 <p>

1014 Reports that any analysis results that were previously	1064 Reports that any analysis results that were previously

1015 associated with the given files should be considered to be	1065 associated with the given files should be considered to be

1016 invalid because those files are no longer being analyzed,	1066 invalid because those files are no longer being analyzed,

1017 either because the analysis root that contained it is no	1067 either because the analysis root that contained it is no

1018 longer being analyzed or because the file no longer exists.	1068 longer being analyzed or because the file no longer exists.

1019 </p>	1069 </p>

1020 <p>	1070 <p>

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

1022 time a notification with results for the file is received,	1072 time a notification with results for the file is received,

1023 clients should assume that the file is once again being	1073 clients should assume that the file is once again being

1024 analyzed and the information should be processed.	1074 analyzed and the information should be processed.

1025 </p>	1075 </p>

1026 <p>	1076 <p>

1027 It is not possible to subscribe to or unsubscribe from this	1077 It is not possible to subscribe to or unsubscribe from this

1028 notification.	1078 notification.

1029 </p>	1079 </p>

1030	1080

1031 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>	1081 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type _FilePath">FilePath</a>>)</b></dt><dd>

1032	1082

1033 <p>	1083 <p>

1034 The files that are no longer being analyzed.	1084 The files that are no longer being analyzed.

1035 </p>	1085 </p>

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

1037 "event": "analysis.folding"	1087 "event": "analysis.folding"

1038 "params": {	1088 "params": {

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

1040 "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>&gt ;	1090 "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>&gt ;

1041 }	1091 }

1042 }</pre></div>	1092 }</pre></div>

1043 <p>	1093 <p>

1044 Reports the folding regions associated with a given	1094 Reports the folding regions associated with a given

1045 file. Folding regions can be nested, but will not be	1095 file. Folding regions can be nested, but will not be

1046 overlapping. Nesting occurs when a foldable element, such as	1096 overlapping. Nesting occurs when a foldable element, such as

1047 a method, is nested inside another foldable element such as	1097 a method, is nested inside another foldable element such as

1048 a class.	1098 a class.

1049 </p>	1099 </p>

1050 <p>	1100 <p>

1051 This notification is not subscribed to by default. Clients	1101 This notification is not subscribed to by default. Clients

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

1053 the list of services passed in an analysis.setSubscriptions	1103 the list of services passed in an analysis.setSubscriptions

1054 request.	1104 request.

1055 </p>	1105 </p>

1056	1106

1057 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1107 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1058	1108

1059 <p>	1109 <p>

1060 The file containing the folding regions.	1110 The file containing the folding regions.

1061 </p>	1111 </p>

1062 </dd><dt class="field"><b><i>regions ( List<<a href="#type_FoldingR egion">FoldingRegion</a>> )</i></b></dt><dd>	1112 </dd><dt class="field"><b>regions (List<<a href="#type_FoldingRegio n">FoldingRegion</a>>)</b></dt><dd>

1063	1113

1064 <p>	1114 <p>

1065 The folding regions contained in the file.	1115 The folding regions contained in the file.

1066 </p>	1116 </p>

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

1068 "event": "analysis.highlights"	1118 "event": "analysis.highlights"

1069 "params": {	1119 "params": {

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

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

1072 }	1122 }

1073 }</pre></div>	1123 }</pre></div>

1074 <p>	1124 <p>

1075 Reports the highlight regions associated with a given file.	1125 Reports the highlight regions associated with a given file.

1076 </p>	1126 </p>

1077 <p>	1127 <p>

1078 This notification is not subscribed to by default. Clients	1128 This notification is not subscribed to by default. Clients

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

1080 in the list of services passed in an	1130 in the list of services passed in an

1081 analysis.setSubscriptions request.	1131 analysis.setSubscriptions request.

1082 </p>	1132 </p>

1083	1133

1084 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1134 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1085	1135

1086 <p>	1136 <p>

1087 The file containing the highlight regions.	1137 The file containing the highlight regions.

1088 </p>	1138 </p>

1089 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Highligh tRegion">HighlightRegion</a>> )</i></b></dt><dd>	1139 </dd><dt class="field"><b>regions (List<<a href="#type_HighlightReg ion">HighlightRegion</a>>)</b></dt><dd>

1090	1140

1091 <p>	1141 <p>

1092 The highlight regions contained in the file. Each	1142 The highlight regions contained in the file. Each

1093 highlight region represents a particular syntactic or	1143 highlight region represents a particular syntactic or

1094 semantic meaning associated with some range. Note that	1144 semantic meaning associated with some range. Note that

1095 the highlight regions that are returned can overlap	1145 the highlight regions that are returned can overlap

1096 other highlight regions if there is more than one	1146 other highlight regions if there is more than one

1097 meaning associated with a particular region.	1147 meaning associated with a particular region.

1098 </p>	1148 </p>

1099 </dd></dl></dd><dt class="notification"><a name="notification_analysis .implemented">analysis.implemented</a> (<a href="#notification_analysis.implemen ted">#</a>)</dt><dd><div class="box"><pre>notification: {	1149 </dd></dl></dd><dt class="notification"><a name="notification_analysis .implemented">analysis.implemented</a> (<a href="#notification_analysis.implemen ted">#</a>)</dt><dd><div class="box"><pre>notification: {

1100 "event": "analysis.implemented"	1150 "event": "analysis.implemented"

1101 "params": {	1151 "params": {

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

1103 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass< /a>>	1153 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass< /a>>

1104 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe r</a>>	1154 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe r</a>>

1105 }	1155 }

1106 }</pre></div>	1156 }</pre></div>

1107 <p>	1157 <p>

1108 Reports the classes that are implemented or extended and	1158 Reports the classes that are implemented or extended and

1109 class members that are implemented or overridden in a file.	1159 class members that are implemented or overridden in a file.

1110 </p>	1160 </p>

1111 <p>	1161 <p>

1112 This notification is not subscribed to by default. Clients	1162 This notification is not subscribed to by default. Clients

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

1114 the list of services passed in an analysis.setSubscriptions	1164 the list of services passed in an analysis.setSubscriptions

1115 request.	1165 request.

1116 </p>	1166 </p>

1117	1167

1118 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1168 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1119	1169

1120 <p>	1170 <p>

1121 The file with which the implementations are associated.	1171 The file with which the implementations are associated.

1122 </p>	1172 </p>

1123 </dd><dt class="field"><b><i>classes ( List<<a href="#type_Implemen tedClass">ImplementedClass</a>> )</i></b></dt><dd>	1173 </dd><dt class="field"><b>classes (List<<a href="#type_ImplementedC lass">ImplementedClass</a>>)</b></dt><dd>

1124	1174

1125 <p>	1175 <p>

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

1127 </p>	1177 </p>

1128 </dd><dt class="field"><b><i>members ( List<<a href="#type_Implemen tedMember">ImplementedMember</a>> )</i></b></dt><dd>	1178 </dd><dt class="field"><b>members (List<<a href="#type_ImplementedM ember">ImplementedMember</a>>)</b></dt><dd>

1129	1179

1130 <p>	1180 <p>

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

1132 </p>	1182 </p>

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

1134 "event": "analysis.invalidate"	1184 "event": "analysis.invalidate"

1135 "params": {	1185 "params": {

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

1137 "<b>offset</b>": int	1187 "<b>offset</b>": int

1138 "<b>length</b>": int	1188 "<b>length</b>": int

1139 "<b>delta</b>": int	1189 "<b>delta</b>": int

1140 }	1190 }

1141 }</pre></div>	1191 }</pre></div>

1142 <p>	1192 <p>

1143 Reports that the navigation information associated with a region of a	1193 Reports that the navigation information associated with a region of a

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

1145 </p>	1195 </p>

1146 <p>	1196 <p>

1147 This notification is not subscribed to by default. Clients can	1197 This notification is not subscribed to by default. Clients can

1148 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of	1198 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of

1149 services passed in an analysis.setSubscriptions request.	1199 services passed in an analysis.setSubscriptions request.

1150 </p>	1200 </p>

1151	1201

1152 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1202 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1153	1203

1154 <p>	1204 <p>

1155 The file whose information has been invalidated.	1205 The file whose information has been invalidated.

1156 </p>	1206 </p>

1157 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1207 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1158	1208

1159 <p>	1209 <p>

1160 The offset of the invalidated region.	1210 The offset of the invalidated region.

1161 </p>	1211 </p>

1162 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	1212 </dd><dt class="field"><b>length (int)</b></dt><dd>

1163	1213

1164 <p>	1214 <p>

1165 The length of the invalidated region.	1215 The length of the invalidated region.

1166 </p>	1216 </p>

1167 </dd><dt class="field"><b><i>delta ( int )</i></b></dt><dd>	1217 </dd><dt class="field"><b>delta (int)</b></dt><dd>

1168	1218

1169 <p>	1219 <p>

1170 The delta to be applied to the offsets in information that follows	1220 The delta to be applied to the offsets in information that follows

1171 the invalidated region in order to update it so that it doesn't	1221 the invalidated region in order to update it so that it doesn't

1172 need to be re-requested.	1222 need to be re-requested.

1173 </p>	1223 </p>

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

1175 "event": "analysis.navigation"	1225 "event": "analysis.navigation"

1176 "params": {	1226 "params": {

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

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

1179 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget< /a>>	1229 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget< /a>>

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

1181 }	1231 }

1182 }</pre></div>	1232 }</pre></div>

1183 <p>	1233 <p>

1184 Reports the navigation targets associated with a given file.	1234 Reports the navigation targets associated with a given file.

1185 </p>	1235 </p>

1186 <p>	1236 <p>

1187 This notification is not subscribed to by default. Clients	1237 This notification is not subscribed to by default. Clients

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

1189 in the list of services passed in an	1239 in the list of services passed in an

1190 analysis.setSubscriptions request.	1240 analysis.setSubscriptions request.

1191 </p>	1241 </p>

1192	1242

1193 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1243 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1194	1244

1195 <p>	1245 <p>

1196 The file containing the navigation regions.	1246 The file containing the navigation regions.

1197 </p>	1247 </p>

1198 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Navigati onRegion">NavigationRegion</a>> )</i></b></dt><dd>	1248 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe gion">NavigationRegion</a>>)</b></dt><dd>

1199	1249

1200 <p>	1250 <p>

1201 The navigation regions contained in the file.	1251 The navigation regions contained in the file.

1202 The regions are sorted by their offsets.	1252 The regions are sorted by their offsets.

1203 Each navigation region represents a list of targets	1253 Each navigation region represents a list of targets

1204 associated with some range. The lists will usually	1254 associated with some range. The lists will usually

1205 contain a single target, but can contain more in the	1255 contain a single target, but can contain more in the

1206 case of a part that is included in multiple libraries	1256 case of a part that is included in multiple libraries

1207 or in Dart code that is compiled against multiple	1257 or in Dart code that is compiled against multiple

1208 versions of a package. Note that the navigation	1258 versions of a package. Note that the navigation

1209 regions that are returned do not overlap other	1259 regions that are returned do not overlap other

1210 navigation regions.	1260 navigation regions.

1211 </p>	1261 </p>

1212 </dd><dt class="field"><b><i>targets ( List<<a href="#type_Navigati onTarget">NavigationTarget</a>> )</i></b></dt><dd>	1262 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa rget">NavigationTarget</a>>)</b></dt><dd>

1213	1263

1214 <p>	1264 <p>

1215 The navigation targets referenced in the file.	1265 The navigation targets referenced in the file.

1216 They are referenced by <tt>NavigationRegion</tt>s by their	1266 They are referenced by <tt>NavigationRegion</tt>s by their

1217 index in this array.	1267 index in this array.

1218 </p>	1268 </p>

1219 </dd><dt class="field"><b><i>files ( List<<a href="#type_FilePath"> FilePath</a>> )</i></b></dt><dd>	1269 </dd><dt class="field"><b>files (List<<a href="#type_FilePath">File Path</a>>)</b></dt><dd>

1220	1270

1221 <p>	1271 <p>

1222 The files containing navigation targets referenced in the file.	1272 The files containing navigation targets referenced in the file.

1223 They are referenced by <tt>NavigationTarget</tt>s by their	1273 They are referenced by <tt>NavigationTarget</tt>s by their

1224 index in this array.	1274 index in this array.

1225 </p>	1275 </p>

1226 </dd></dl></dd><dt class="notification"><a name="notification_analysis .occurrences">analysis.occurrences</a> (<a href="#notification_analysis.occurren ces">#</a>)</dt><dd><div class="box"><pre>notification: {	1276 </dd></dl></dd><dt class="notification"><a name="notification_analysis .occurrences">analysis.occurrences</a> (<a href="#notification_analysis.occurren ces">#</a>)</dt><dd><div class="box"><pre>notification: {

1227 "event": "analysis.occurrences"	1277 "event": "analysis.occurrences"

1228 "params": {	1278 "params": {

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

1230 "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>&gt ;	1280 "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>&gt ;

1231 }	1281 }

1232 }</pre></div>	1282 }</pre></div>

1233 <p>	1283 <p>

1234 Reports the occurrences of references to elements within a	1284 Reports the occurrences of references to elements within a

1235 single file.	1285 single file.

1236 </p>	1286 </p>

1237 <p>	1287 <p>

1238 This notification is not subscribed to by default. Clients	1288 This notification is not subscribed to by default. Clients

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

1240 in the list of services passed in an	1290 in the list of services passed in an

1241 analysis.setSubscriptions request.	1291 analysis.setSubscriptions request.

1242 </p>	1292 </p>

1243	1293

1244 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1294 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1245	1295

1246 <p>	1296 <p>

1247 The file in which the references occur.	1297 The file in which the references occur.

1248 </p>	1298 </p>

1249 </dd><dt class="field"><b><i>occurrences ( List<<a href="#type_Occu rrences">Occurrences</a>> )</i></b></dt><dd>	1299 </dd><dt class="field"><b>occurrences (List<<a href="#type_Occurren ces">Occurrences</a>>)</b></dt><dd>

1250	1300

1251 <p>	1301 <p>

1252 The occurrences of references to elements within the	1302 The occurrences of references to elements within the

1253 file.	1303 file.

1254 </p>	1304 </p>

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

1256 "event": "analysis.outline"	1306 "event": "analysis.outline"

1257 "params": {	1307 "params": {

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

1259 "<b>kind</b>": <a href="#type_FileKind">FileKind</a>	1309 "<b>kind</b>": <a href="#type_FileKind">FileKind</a>

1260 "<b>libraryName</b>": <span style="color:#999999">optional</span> String	1310 "<b>libraryName</b>": <span style="color:#999999">optional</span> String

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

1262 }	1312 }

1263 }</pre></div>	1313 }</pre></div>

1264 <p>	1314 <p>

1265 Reports the outline associated with a single file.	1315 Reports the outline associated with a single file.

1266 </p>	1316 </p>

1267 <p>	1317 <p>

1268 This notification is not subscribed to by default. Clients	1318 This notification is not subscribed to by default. Clients

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

1270 the list of services passed in an analysis.setSubscriptions	1320 the list of services passed in an analysis.setSubscriptions

1271 request.	1321 request.

1272 </p>	1322 </p>

1273	1323

1274 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1324 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1275	1325

1276 <p>	1326 <p>

1277 The file with which the outline is associated.	1327 The file with which the outline is associated.

1278 </p>	1328 </p>

1279 </dd><dt class="field"><b><i>kind ( <a href="#type_FileKind">FileKind< /a> )</i></b></dt><dd>	1329 </dd><dt class="field"><b>kind (<a href="#type_FileKind">FileKind</a>) </b></dt><dd>

1280	1330

1281 <p>	1331 <p>

1282 The kind of the file.	1332 The kind of the file.

1283 </p>	1333 </p>

1284 </dd><dt class="field"><b><i>libraryName ( <span style="color:#999999" >optional</span> String )</i></b></dt><dd>	1334 </dd><dt class="field"><b>libraryName (<span style="color:#999999">opt ional</span> String)</b></dt><dd>

1285	1335

1286 <p>	1336 <p>

1287 The name of the library defined by the file using a "library"	1337 The name of the library defined by the file using a "library"

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

1289 "library" and "part of" directives are present, then the	1339 "library" and "part of" directives are present, then the

1290 "library" directive takes precedence.	1340 "library" directive takes precedence.

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

1292 nor "part of" directives.	1342 nor "part of" directives.

1293 </p>	1343 </p>

1294 </dd><dt class="field"><b><i>outline ( <a href="#type_Outline">Outline </a> )</i></b></dt><dd>	1344 </dd><dt class="field"><b>outline (<a href="#type_Outline">Outline</a> )</b></dt><dd>

1295	1345

1296 <p>	1346 <p>

1297 The outline associated with the file.	1347 The outline associated with the file.

1298 </p>	1348 </p>

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

1300 "event": "analysis.overrides"	1350 "event": "analysis.overrides"

1301 "params": {	1351 "params": {

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

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

1304 }	1354 }

1305 }</pre></div>	1355 }</pre></div>

1306 <p>	1356 <p>

1307 Reports the overriding members in a file.	1357 Reports the overriding members in a file.

1308 </p>	1358 </p>

1309 <p>	1359 <p>

1310 This notification is not subscribed to by default. Clients	1360 This notification is not subscribed to by default. Clients

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

1312 the list of services passed in an analysis.setSubscriptions	1362 the list of services passed in an analysis.setSubscriptions

1313 request.	1363 request.

1314 </p>	1364 </p>

1315	1365

1316 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1366 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1317	1367

1318 <p>	1368 <p>

1319 The file with which the overrides are associated.	1369 The file with which the overrides are associated.

1320 </p>	1370 </p>

1321 </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Overri de">Override</a>> )</i></b></dt><dd>	1371 </dd><dt class="field"><b>overrides (List<<a href="#type_Override"> Override</a>>)</b></dt><dd>

1322	1372

1323 <p>	1373 <p>

1324 The overrides associated with the file.	1374 The overrides associated with the file.

1325 </p>	1375 </p>

1326 </dd></dl></dd></dl>	1376 </dd></dl></dd></dl>

1327 <h2 class="domain"><a name="domain_completion">Domain: completion</a></h2>	1377 <h2 class="domain"><a name="domain_completion">completion domain</a></h2>

1328 <p>	1378 <p>

1329 The code completion domain contains commands related to	1379 The code completion domain contains commands related to

1330 getting code completion suggestions.	1380 getting code completion suggestions.

1331 </p>	1381 </p>

1332	1382

1333	1383

1334 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSugg estions">completion.getSuggestions</a> (<a href="#request_completion.getSuggesti ons">#</a>)</dt><dd><div class="box"><pre>request: {	1384 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSugg estions">completion.getSuggestions</a> (<a href="#request_completion.getSuggesti ons">#</a>)</dt><dd><div class="box"><pre>request: {

1335 "id": String	1385 "id": String

1336 "method": "completion.getSuggestions"	1386 "method": "completion.getSuggestions"

1337 "params": {	1387 "params": {

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

1339 "<b>offset</b>": int	1389 "<b>offset</b>": int

1340 }	1390 }

1341 }</pre><br><pre>response: {	1391 }</pre><br><pre>response: {

1342 "<b>id</b>": String	1392 "<b>id</b>": String

1343 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1393 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1344 "result": {	1394 "result": {

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

1346 }	1396 }

1347 }</pre></div>	1397 }</pre></div>

1348 <p>	1398 <p>

1349 Request that completion suggestions for the given offset in	1399 Request that completion suggestions for the given offset in

1350 the given file be returned.	1400 the given file be returned.

1351 </p>	1401 </p>

1352	1402

1353	1403

1354 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1404 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1355	1405

1356 <p>	1406 <p>

1357 The file containing the point at which suggestions are	1407 The file containing the point at which suggestions are

1358 to be made.	1408 to be made.

1359 </p>	1409 </p>

1360 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1410 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1361	1411

1362 <p>	1412 <p>

1363 The offset within the file at which suggestions are to	1413 The offset within the file at which suggestions are to

1364 be made.	1414 be made.

1365 </p>	1415 </p>

1366 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_CompletionId">CompletionId</a> )</i></b></dt><dd>	1416 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _CompletionId">CompletionId</a>)</b></dt><dd>

1367	1417

1368 <p>	1418 <p>

1369 The identifier used to associate results with this	1419 The identifier used to associate results with this

1370 completion request.	1420 completion request.

1371 </p>	1421 </p>

1372 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_completion.results">completion.results</a> (<a href="#not ification_completion.results">#</a>)</dt><dd><div class="box"><pre>notification: {	1422 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_completion.results">completion.results</a> (<a href="#not ification_completion.results">#</a>)</dt><dd><div class="box"><pre>notification: {

1373 "event": "completion.results"	1423 "event": "completion.results"

1374 "params": {	1424 "params": {

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

1376 "<b>replacementOffset</b>": int	1426 "<b>replacementOffset</b>": int

1377 "<b>replacementLength</b>": int	1427 "<b>replacementLength</b>": int

1378 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug gestion</a>>	1428 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug gestion</a>>

1379 "<b>isLast</b>": bool	1429 "<b>isLast</b>": bool

1380 }	1430 }

1381 }</pre></div>	1431 }</pre></div>

1382 <p>	1432 <p>

1383 Reports the completion suggestions that should be presented	1433 Reports the completion suggestions that should be presented

1384 to the user. The set of suggestions included in the	1434 to the user. The set of suggestions included in the

1385 notification is always a complete list that supersedes any	1435 notification is always a complete list that supersedes any

1386 previously reported suggestions.	1436 previously reported suggestions.

1387 </p>	1437 </p>

1388	1438

1389 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Complet ionId">CompletionId</a> )</i></b></dt><dd>	1439 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_Completion Id">CompletionId</a>)</b></dt><dd>

1390	1440

1391 <p>	1441 <p>

1392 The id associated with the completion.	1442 The id associated with the completion.

1393 </p>	1443 </p>

1394 </dd><dt class="field"><b><i>replacementOffset ( int )</i></b></dt><dd >	1444 </dd><dt class="field"><b>replacementOffset (int)</b></dt><dd>

1395	1445

1396 <p>	1446 <p>

1397 The offset of the start of the text to be	1447 The offset of the start of the text to be

1398 replaced. This will be different than the offset used	1448 replaced. This will be different than the offset used

1399 to request the completion suggestions if there was a	1449 to request the completion suggestions if there was a

1400 portion of an identifier before the original	1450 portion of an identifier before the original

1401 offset. In particular, the replacementOffset will be	1451 offset. In particular, the replacementOffset will be

1402 the offset of the beginning of said identifier.	1452 the offset of the beginning of said identifier.

1403 </p>	1453 </p>

1404 </dd><dt class="field"><b><i>replacementLength ( int )</i></b></dt><dd >	1454 </dd><dt class="field"><b>replacementLength (int)</b></dt><dd>

1405	1455

1406 <p>	1456 <p>

1407 The length of the text to be replaced if the remainder	1457 The length of the text to be replaced if the remainder

1408 of the identifier containing the cursor is to be	1458 of the identifier containing the cursor is to be

1409 replaced when the suggestion is applied (that is, the	1459 replaced when the suggestion is applied (that is, the

1410 number of characters in the existing identifier).	1460 number of characters in the existing identifier).

1411 </p>	1461 </p>

1412 </dd><dt class="field"><b><i>results ( List<<a href="#type_Completi onSuggestion">CompletionSuggestion</a>> )</i></b></dt><dd>	1462 </dd><dt class="field"><b>results (List<<a href="#type_CompletionSu ggestion">CompletionSuggestion</a>>)</b></dt><dd>

1413	1463

1414 <p>	1464 <p>

1415 The completion suggestions being reported. The	1465 The completion suggestions being reported. The

1416 notification contains all possible completions at the	1466 notification contains all possible completions at the

1417 requested cursor position, even those that do not match	1467 requested cursor position, even those that do not match

1418 the characters the user has already typed. This allows	1468 the characters the user has already typed. This allows

1419 the client to respond to further keystrokes from the	1469 the client to respond to further keystrokes from the

1420 user without having to make additional requests.	1470 user without having to make additional requests.

1421 </p>	1471 </p>

1422 </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd>	1472 </dd><dt class="field"><b>isLast (bool)</b></dt><dd>

1423	1473

1424 <p>	1474 <p>

1425 True if this is that last set of results that will be	1475 True if this is that last set of results that will be

1426 returned for the indicated completion.	1476 returned for the indicated completion.

1427 </p>	1477 </p>

1428 </dd></dl></dd></dl>	1478 </dd></dl></dd></dl>

1429 <h2 class="domain"><a name="domain_search">Domain: search</a></h2>	1479 <h2 class="domain"><a name="domain_search">search domain</a></h2>

1430 <p>	1480 <p>

1431 The search domain contains commands related to searches that	1481 The search domain contains commands related to searches that

1432 can be performed against the code base.	1482 can be performed against the code base.

1433 </p>	1483 </p>

1434	1484

1435	1485

1436	1486

1437	1487

1438	1488

1439	1489

(...skipping 17 matching lines...) Expand all Loading...
1457 Perform a search for references to the element defined or	1507 Perform a search for references to the element defined or

1458 referenced at the given offset in the given file.	1508 referenced at the given offset in the given file.

1459 </p>	1509 </p>

1460 <p>	1510 <p>

1461 An identifier is returned immediately, and individual	1511 An identifier is returned immediately, and individual

1462 results will be returned via the search.results notification	1512 results will be returned via the search.results notification

1463 as they become available.	1513 as they become available.

1464 </p>	1514 </p>

1465	1515

1466	1516

1467 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1517 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1468	1518

1469 <p>	1519 <p>

1470 The file containing the declaration of or reference to	1520 The file containing the declaration of or reference to

1471 the element used to define the search.	1521 the element used to define the search.

1472 </p>	1522 </p>

1473 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1523 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1474	1524

1475 <p>	1525 <p>

1476 The offset within the file of the declaration of or	1526 The offset within the file of the declaration of or

1477 reference to the element.	1527 reference to the element.

1478 </p>	1528 </p>

1479 </dd><dt class="field"><b><i>includePotential ( bool )</i></b></dt><dd >	1529 </dd><dt class="field"><b>includePotential (bool)</b></dt><dd>

1480	1530

1481 <p>	1531 <p>

1482 True if potential matches are to be included in the	1532 True if potential matches are to be included in the

1483 results.	1533 results.

1484 </p>	1534 </p>

1485 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <span style ="color:#999999">optional</span> <a href="#type_SearchId">SearchId</a> )</i></b> </dt><dd>	1535 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<span style="c olor:#999999">optional</span> <a href="#type_SearchId">SearchId</a>)</b></dt><dd >

1486	1536

1487 <p>	1537 <p>

1488 The identifier used to associate results with this	1538 The identifier used to associate results with this

1489 search request.	1539 search request.

1490 </p>	1540 </p>

1491 <p>	1541 <p>

1492 If no element was found at the given location, this	1542 If no element was found at the given location, this

1493 field will be absent, and no results will be reported	1543 field will be absent, and no results will be reported

1494 via the search.results notification.	1544 via the search.results notification.

1495 </p>	1545 </p>

1496 </dd><dt class="field"><b><i>element ( <span style="color:#999999">opt ional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd>	1546 </dd><dt class="field"><b>element (<span style="color:#999999">optiona l</span> <a href="#type_Element">Element</a>)</b></dt><dd>

1497	1547

1498 <p>	1548 <p>

1499 The element referenced or defined at the given offset	1549 The element referenced or defined at the given offset

1500 and whose references will be returned in the search	1550 and whose references will be returned in the search

1501 results.	1551 results.

1502 </p>	1552 </p>

1503 <p>	1553 <p>

1504 If no element was found at the given location, this	1554 If no element was found at the given location, this

1505 field will be absent.	1555 field will be absent.

1506 </p>	1556 </p>

(...skipping 14 matching lines...) Expand all Loading...
1521 Perform a search for declarations of members whose name is	1571 Perform a search for declarations of members whose name is

1522 equal to the given name.	1572 equal to the given name.

1523 </p>	1573 </p>

1524 <p>	1574 <p>

1525 An identifier is returned immediately, and individual	1575 An identifier is returned immediately, and individual

1526 results will be returned via the search.results notification	1576 results will be returned via the search.results notification

1527 as they become available.	1577 as they become available.

1528 </p>	1578 </p>

1529	1579

1530	1580

1531 <h4>Parameters</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt ><dd>	1581 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>

1532	1582

1533 <p>	1583 <p>

1534 The name of the declarations to be found.	1584 The name of the declarations to be found.

1535 </p>	1585 </p>

1536 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1586 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>

1537	1587

1538 <p>	1588 <p>

1539 The identifier used to associate results with this	1589 The identifier used to associate results with this

1540 search request.	1590 search request.

1541 </p>	1591 </p>

1542 </dd></dl></dd><dt class="request"><a name="request_search.findMemberR eferences">search.findMemberReferences</a> (<a href="#request_search.findMemberR eferences">#</a>)</dt><dd><div class="box"><pre>request: {	1592 </dd></dl></dd><dt class="request"><a name="request_search.findMemberR eferences">search.findMemberReferences</a> (<a href="#request_search.findMemberR eferences">#</a>)</dt><dd><div class="box"><pre>request: {

1543 "id": String	1593 "id": String

1544 "method": "search.findMemberReferences"	1594 "method": "search.findMemberReferences"

1545 "params": {	1595 "params": {

1546 "<b>name</b>": String	1596 "<b>name</b>": String

(...skipping 11 matching lines...) Expand all Loading...
1558 that there is a member defined with the given name, so it is	1608 that there is a member defined with the given name, so it is

1559 able to find references to undefined members as well.	1609 able to find references to undefined members as well.

1560 </p>	1610 </p>

1561 <p>	1611 <p>

1562 An identifier is returned immediately, and individual	1612 An identifier is returned immediately, and individual

1563 results will be returned via the search.results notification	1613 results will be returned via the search.results notification

1564 as they become available.	1614 as they become available.

1565 </p>	1615 </p>

1566	1616

1567	1617

1568 <h4>Parameters</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt ><dd>	1618 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>

1569	1619

1570 <p>	1620 <p>

1571 The name of the references to be found.	1621 The name of the references to be found.

1572 </p>	1622 </p>

1573 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1623 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>

1574	1624

1575 <p>	1625 <p>

1576 The identifier used to associate results with this	1626 The identifier used to associate results with this

1577 search request.	1627 search request.

1578 </p>	1628 </p>

1579 </dd></dl></dd><dt class="request"><a name="request_search.findTopLeve lDeclarations">search.findTopLevelDeclarations</a> (<a href="#request_search.fin dTopLevelDeclarations">#</a>)</dt><dd><div class="box"><pre>request: {	1629 </dd></dl></dd><dt class="request"><a name="request_search.findTopLeve lDeclarations">search.findTopLevelDeclarations</a> (<a href="#request_search.fin dTopLevelDeclarations">#</a>)</dt><dd><div class="box"><pre>request: {

1580 "id": String	1630 "id": String

1581 "method": "search.findTopLevelDeclarations"	1631 "method": "search.findTopLevelDeclarations"

1582 "params": {	1632 "params": {

1583 "<b>pattern</b>": String	1633 "<b>pattern</b>": String

(...skipping 10 matching lines...) Expand all Loading...
1594 (classes, typedefs, getters, setters, functions and fields)	1644 (classes, typedefs, getters, setters, functions and fields)

1595 whose name matches the given pattern.	1645 whose name matches the given pattern.

1596 </p>	1646 </p>

1597 <p>	1647 <p>

1598 An identifier is returned immediately, and individual	1648 An identifier is returned immediately, and individual

1599 results will be returned via the search.results notification	1649 results will be returned via the search.results notification

1600 as they become available.	1650 as they become available.

1601 </p>	1651 </p>

1602	1652

1603	1653

1604 <h4>Parameters</h4><dl><dt class="field"><b><i>pattern ( String )</i></b>< /dt><dd>	1654 <h4>parameters:</h4><dl><dt class="field"><b>pattern (String)</b></dt><dd>

1605	1655

1606 <p>	1656 <p>

1607 The regular expression used to match the names of the	1657 The regular expression used to match the names of the

1608 declarations to be found.	1658 declarations to be found.

1609 </p>	1659 </p>

1610 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1660 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>

1611	1661

1612 <p>	1662 <p>

1613 The identifier used to associate results with this	1663 The identifier used to associate results with this

1614 search request.	1664 search request.

1615 </p>	1665 </p>

1616 </dd></dl></dd><dt class="request"><a name="request_search.getTypeHier archy">search.getTypeHierarchy</a> (<a href="#request_search.getTypeHierarchy"># </a>)</dt><dd><div class="box"><pre>request: {	1666 </dd></dl></dd><dt class="request"><a name="request_search.getTypeHier archy">search.getTypeHierarchy</a> (<a href="#request_search.getTypeHierarchy"># </a>)</dt><dd><div class="box"><pre>request: {

1617 "id": String	1667 "id": String

1618 "method": "search.getTypeHierarchy"	1668 "method": "search.getTypeHierarchy"

1619 "params": {	1669 "params": {

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

1621 "<b>offset</b>": int	1671 "<b>offset</b>": int

1622 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool	1672 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool

1623 }	1673 }

1624 }</pre><br><pre>response: {	1674 }</pre><br><pre>response: {

1625 "id": String	1675 "id": String

1626 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1676 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1627 "result": {	1677 "result": {

1628 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List&lt ;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>>	1678 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List&lt ;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>>

1629 }	1679 }

1630 }</pre></div>	1680 }</pre></div>

1631 <p>	1681 <p>

1632 Return the type hierarchy of the class declared or	1682 Return the type hierarchy of the class declared or

1633 referenced at the given location.	1683 referenced at the given location.

1634 </p>	1684 </p>

1635	1685

1636	1686

1637 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1687 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1638	1688

1639 <p>	1689 <p>

1640 The file containing the declaration or reference to the	1690 The file containing the declaration or reference to the

1641 type for which a hierarchy is being requested.	1691 type for which a hierarchy is being requested.

1642 </p>	1692 </p>

1643 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1693 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1644	1694

1645 <p>	1695 <p>

1646 The offset of the name of the type within the file.	1696 The offset of the name of the type within the file.

1647 </p>	1697 </p>

1648 </dd><dt class="field"><b><i>superOnly ( <span style="color:#999999">o ptional</span> bool )</i></b></dt><dd>	1698 </dd><dt class="field"><b>superOnly (<span style="color:#999999">optio nal</span> bool)</b></dt><dd>

1649	1699

1650 <p>	1700 <p>

1651 True if the client is only requesting superclasses and	1701 True if the client is only requesting superclasses and

1652 interfaces hierarchy.	1702 interfaces hierarchy.

1653 </p>	1703 </p>

1654 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hierarchyItems ( <span style="color:#999999">optional</span> List<<a href="#type_TypeHierarch yItem">TypeHierarchyItem</a>> )</i></b></dt><dd>	1704 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hierarchyItems (<s pan style="color:#999999">optional</span> List<<a href="#type_TypeHierarchyIt em">TypeHierarchyItem</a>>)</b></dt><dd>

1655	1705

1656 <p>	1706 <p>

1657 A list of the types in the requested hierarchy. The	1707 A list of the types in the requested hierarchy. The

1658 first element of the list is the item representing the	1708 first element of the list is the item representing the

1659 type for which the hierarchy was requested. The index of	1709 type for which the hierarchy was requested. The index of

1660 other elements of the list is unspecified, but	1710 other elements of the list is unspecified, but

1661 correspond to the integers used to reference supertype	1711 correspond to the integers used to reference supertype

1662 and subtype items within the items.	1712 and subtype items within the items.

1663 </p>	1713 </p>

1664 <p>	1714 <p>

(...skipping 11 matching lines...) Expand all Loading...
1676 }	1726 }

1677 }</pre></div>	1727 }</pre></div>

1678 <p>	1728 <p>

1679 Reports some or all of the results of performing a requested	1729 Reports some or all of the results of performing a requested

1680 search. Unlike other notifications, this notification	1730 search. Unlike other notifications, this notification

1681 contains search results that should be added to any	1731 contains search results that should be added to any

1682 previously received search results associated with the same	1732 previously received search results associated with the same

1683 search id.	1733 search id.

1684 </p>	1734 </p>

1685	1735

1686 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchI d">SearchId</a> )</i></b></dt><dd>	1736 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId"> SearchId</a>)</b></dt><dd>

1687	1737

1688 <p>	1738 <p>

1689 The id associated with the search.	1739 The id associated with the search.

1690 </p>	1740 </p>

1691 </dd><dt class="field"><b><i>results ( List<<a href="#type_SearchRe sult">SearchResult</a>> )</i></b></dt><dd>	1741 </dd><dt class="field"><b>results (List<<a href="#type_SearchResult ">SearchResult</a>>)</b></dt><dd>

1692	1742

1693 <p>	1743 <p>

1694 The search results being reported.	1744 The search results being reported.

1695 </p>	1745 </p>

1696 </dd><dt class="field"><b><i>isLast ( bool )</i></b></dt><dd>	1746 </dd><dt class="field"><b>isLast (bool)</b></dt><dd>

1697	1747

1698 <p>	1748 <p>

1699 True if this is that last set of results that will be	1749 True if this is that last set of results that will be

1700 returned for the indicated search.	1750 returned for the indicated search.

1701 </p>	1751 </p>

1702 </dd></dl></dd></dl>	1752 </dd></dl></dd></dl>

1703 <h2 class="domain"><a name="domain_edit">Domain: edit</a></h2>	1753 <h2 class="domain"><a name="domain_edit">edit domain</a></h2>

1704 <p>	1754 <p>

1705 The edit domain contains commands related to edits that can be	1755 The edit domain contains commands related to edits that can be

1706 applied to the code.	1756 applied to the code.

1707 </p>	1757 </p>

1708	1758

1709	1759

1710	1760

1711	1761

1712	1762

1713	1763

(...skipping 28 matching lines...) Expand all Loading...
1742 <p>	1792 <p>

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

1744 currently subject to analysis (e.g. because it is not associated with	1794 currently subject to analysis (e.g. because it is not associated with

1745 any analysis root specified to analysis.setAnalysisRoots), an error of	1795 any analysis root specified to analysis.setAnalysisRoots), an error of

1746 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source	1796 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source

1747 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>	1797 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>

1748 will be generated.	1798 will be generated.

1749 </p>	1799 </p>

1750	1800

1751	1801

1752 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1802 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1753	1803

1754 <p>	1804 <p>

1755 The file containing the code to be formatted.	1805 The file containing the code to be formatted.

1756 </p>	1806 </p>

1757 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>	1807 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>

1758	1808

1759 <p>	1809 <p>

1760 The offset of the current selection in the file.	1810 The offset of the current selection in the file.

1761 </p>	1811 </p>

1762 </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd>	1812 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>

1763	1813

1764 <p>	1814 <p>

1765 The length of the current selection in the file.	1815 The length of the current selection in the file.

1766 </p>	1816 </p>

1767 </dd><dt class="field"><b><i>lineLength ( <span style="color:#999999"> optional</span> int )</i></b></dt><dd>	1817 </dd><dt class="field"><b>lineLength (<span style="color:#999999">opti onal</span> int)</b></dt><dd>

1768	1818

1769 <p>	1819 <p>

1770 The line length to be used by the formatter.	1820 The line length to be used by the formatter.

1771 </p>	1821 </p>

1772 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edits ( List< <a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd>	1822 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd>

1773	1823

1774 <p>	1824 <p>

1775 The edit(s) to be applied in order to format the code. The list	1825 The edit(s) to be applied in order to format the code. The list

1776 will be empty if the code was already formatted (there are no	1826 will be empty if the code was already formatted (there are no

1777 changes).	1827 changes).

1778 </p>	1828 </p>

1779 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>	1829 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>

1780	1830

1781 <p>	1831 <p>

1782 The offset of the selection after formatting the code.	1832 The offset of the selection after formatting the code.

1783 </p>	1833 </p>

1784 </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd>	1834 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>

1785	1835

1786 <p>	1836 <p>

1787 The length of the selection after formatting the code.	1837 The length of the selection after formatting the code.

1788 </p>	1838 </p>

1789 </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">e dit.getAssists</a> (<a href="#request_edit.getAssists">#</a>)</dt><dd><div class ="box"><pre>request: {	1839 </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">e dit.getAssists</a> (<a href="#request_edit.getAssists">#</a>)</dt><dd><div class ="box"><pre>request: {

1790 "id": String	1840 "id": String

1791 "method": "edit.getAssists"	1841 "method": "edit.getAssists"

1792 "params": {	1842 "params": {

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

1794 "<b>offset</b>": int	1844 "<b>offset</b>": int

1795 "<b>length</b>": int	1845 "<b>length</b>": int

1796 }	1846 }

1797 }</pre><br><pre>response: {	1847 }</pre><br><pre>response: {

1798 "id": String	1848 "id": String

1799 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1849 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1800 "result": {	1850 "result": {

1801 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>>	1851 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>>

1802 }	1852 }

1803 }</pre></div>	1853 }</pre></div>

1804 <p>	1854 <p>

1805 Return the set of assists that are available at the given	1855 Return the set of assists that are available at the given

1806 location. An assist is distinguished from a refactoring	1856 location. An assist is distinguished from a refactoring

1807 primarily by the fact that it affects a single file and does	1857 primarily by the fact that it affects a single file and does

1808 not require user input in order to be performed.	1858 not require user input in order to be performed.

1809 </p>	1859 </p>

1810	1860

1811	1861

1812 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1862 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1813	1863

1814 <p>	1864 <p>

1815 The file containing the code for which assists are being	1865 The file containing the code for which assists are being

1816 requested.	1866 requested.

1817 </p>	1867 </p>

1818 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1868 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1819	1869

1820 <p>	1870 <p>

1821 The offset of the code for which assists are being	1871 The offset of the code for which assists are being

1822 requested.	1872 requested.

1823 </p>	1873 </p>

1824 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	1874 </dd><dt class="field"><b>length (int)</b></dt><dd>

1825	1875

1826 <p>	1876 <p>

1827 The length of the code for which assists are being	1877 The length of the code for which assists are being

1828 requested.	1878 requested.

1829 </p>	1879 </p>

1830 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>assists ( List&l t;<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd>	1880 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists (List<< a href="#type_SourceChange">SourceChange</a>>)</b></dt><dd>

1831	1881

1832 <p>	1882 <p>

1833 The assists that are available at the given location.	1883 The assists that are available at the given location.

1834 </p>	1884 </p>

1835 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableR efactorings">edit.getAvailableRefactorings</a> (<a href="#request_edit.getAvaila bleRefactorings">#</a>)</dt><dd><div class="box"><pre>request: {	1885 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableR efactorings">edit.getAvailableRefactorings</a> (<a href="#request_edit.getAvaila bleRefactorings">#</a>)</dt><dd><div class="box"><pre>request: {

1836 "id": String	1886 "id": String

1837 "method": "edit.getAvailableRefactorings"	1887 "method": "edit.getAvailableRefactorings"

1838 "params": {	1888 "params": {

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

1840 "<b>offset</b>": int	1890 "<b>offset</b>": int

1841 "<b>length</b>": int	1891 "<b>length</b>": int

1842 }	1892 }

1843 }</pre><br><pre>response: {	1893 }</pre><br><pre>response: {

1844 "id": String	1894 "id": String

1845 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1895 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1846 "result": {	1896 "result": {

1847 "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>& gt;	1897 "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>& gt;

1848 }	1898 }

1849 }</pre></div>	1899 }</pre></div>

1850 <p>	1900 <p>

1851 Get a list of the kinds of refactorings that are valid for	1901 Get a list of the kinds of refactorings that are valid for

1852 the given selection in the given file.	1902 the given selection in the given file.

1853 </p>	1903 </p>

1854	1904

1855	1905

1856 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1906 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1857	1907

1858 <p>	1908 <p>

1859 The file containing the code on which the refactoring	1909 The file containing the code on which the refactoring

1860 would be based.	1910 would be based.

1861 </p>	1911 </p>

1862 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1912 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1863	1913

1864 <p>	1914 <p>

1865 The offset of the code on which the refactoring would be	1915 The offset of the code on which the refactoring would be

1866 based.	1916 based.

1867 </p>	1917 </p>

1868 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	1918 </dd><dt class="field"><b>length (int)</b></dt><dd>

1869	1919

1870 <p>	1920 <p>

1871 The length of the code on which the refactoring would be	1921 The length of the code on which the refactoring would be

1872 based.	1922 based.

1873 </p>	1923 </p>

1874 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( List< <a href="#type_RefactoringKind">RefactoringKind</a>> )</i></b></dt><dd>	1924 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds (List<<a href="#type_RefactoringKind">RefactoringKind</a>>)</b></dt><dd>

1875	1925

1876 <p>	1926 <p>

1877 The kinds of refactorings that are valid for the given	1927 The kinds of refactorings that are valid for the given

1878 selection.	1928 selection.

1879 </p>	1929 </p>

1880 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edi t.getFixes</a> (<a href="#request_edit.getFixes">#</a>)</dt><dd><div class="box" ><pre>request: {	1930 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edi t.getFixes</a> (<a href="#request_edit.getFixes">#</a>)</dt><dd><div class="box" ><pre>request: {

1881 "id": String	1931 "id": String

1882 "method": "edit.getFixes"	1932 "method": "edit.getFixes"

1883 "params": {	1933 "params": {

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

1885 "<b>offset</b>": int	1935 "<b>offset</b>": int

1886 }	1936 }

1887 }</pre><br><pre>response: {	1937 }</pre><br><pre>response: {

1888 "id": String	1938 "id": String

1889 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1939 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1890 "result": {	1940 "result": {

1891 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>>	1941 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>>

1892 }	1942 }

1893 }</pre></div>	1943 }</pre></div>

1894 <p>	1944 <p>

1895 Return the set of fixes that are available for the errors at	1945 Return the set of fixes that are available for the errors at

1896 a given offset in a given file.	1946 a given offset in a given file.

1897 </p>	1947 </p>

1898	1948

1899	1949

1900 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1950 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

1901	1951

1902 <p>	1952 <p>

1903 The file containing the errors for which fixes are being	1953 The file containing the errors for which fixes are being

1904 requested.	1954 requested.

1905 </p>	1955 </p>

1906 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	1956 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1907	1957

1908 <p>	1958 <p>

1909 The offset used to select the errors for which fixes	1959 The offset used to select the errors for which fixes

1910 will be returned.	1960 will be returned.

1911 </p>	1961 </p>

1912 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List< <a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</i></b></dt><dd>	1962 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes (List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>)</b></dt><dd>

1913	1963

1914 <p>	1964 <p>

1915 The fixes that are available for the errors at the given offset.	1965 The fixes that are available for the errors at the given offset.

1916 </p>	1966 </p>

1917 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactorin g">edit.getRefactoring</a> (<a href="#request_edit.getRefactoring">#</a>)</dt><d d><div class="box"><pre>request: {	1967 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactorin g">edit.getRefactoring</a> (<a href="#request_edit.getRefactoring">#</a>)</dt><d d><div class="box"><pre>request: {

1918 "id": String	1968 "id": String

1919 "method": "edit.getRefactoring"	1969 "method": "edit.getRefactoring"

1920 "params": {	1970 "params": {

1921 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>	1971 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>

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

(...skipping 17 matching lines...) Expand all Loading...
1940 <p>	1990 <p>

1941 Get the changes required to perform a refactoring.	1991 Get the changes required to perform a refactoring.

1942 </p>	1992 </p>

1943 <p>	1993 <p>

1944 If another refactoring request is received during the processing	1994 If another refactoring request is received during the processing

1945 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>	1995 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>

1946 will be generated.	1996 will be generated.

1947 </p>	1997 </p>

1948	1998

1949	1999

1950 <h4>Parameters</h4><dl><dt class="field"><b><i>kind ( <a href="#type_Refac toringKind">RefactoringKind</a> )</i></b></dt><dd>	2000 <h4>parameters:</h4><dl><dt class="field"><b>kind (<a href="#type_Refactor ingKind">RefactoringKind</a>)</b></dt><dd>

1951	2001

1952 <p>	2002 <p>

1953 The kind of refactoring to be performed.	2003 The kind of refactoring to be performed.

1954 </p>	2004 </p>

1955 </dd><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath< /a> )</i></b></dt><dd>	2005 </dd><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>) </b></dt><dd>

1956	2006

1957 <p>	2007 <p>

1958 The file containing the code involved in the	2008 The file containing the code involved in the

1959 refactoring.	2009 refactoring.

1960 </p>	2010 </p>

1961 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	2011 </dd><dt class="field"><b>offset (int)</b></dt><dd>

1962	2012

1963 <p>	2013 <p>

1964 The offset of the region involved in the refactoring.	2014 The offset of the region involved in the refactoring.

1965 </p>	2015 </p>

1966 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	2016 </dd><dt class="field"><b>length (int)</b></dt><dd>

1967	2017

1968 <p>	2018 <p>

1969 The length of the region involved in the refactoring.	2019 The length of the region involved in the refactoring.

1970 </p>	2020 </p>

1971 </dd><dt class="field"><b><i>validateOnly ( bool )</i></b></dt><dd>	2021 </dd><dt class="field"><b>validateOnly (bool)</b></dt><dd>

1972	2022

1973 <p>	2023 <p>

1974 True if the client is only requesting that the values of	2024 True if the client is only requesting that the values of

1975 the options be validated and no change be generated.	2025 the options be validated and no change be generated.

1976 </p>	2026 </p>

1977 </dd><dt class="field"><b><i>options ( <span style="color:#999999">opt ional</span> <a href="#type_RefactoringOptions">RefactoringOptions</a> )</i></b> </dt><dd>	2027 </dd><dt class="field"><b>options (<span style="color:#999999">optiona l</span> <a href="#type_RefactoringOptions">RefactoringOptions</a>)</b></dt><dd>

1978	2028

1979 <p>	2029 <p>

1980 Data used to provide values provided by the user. The	2030 Data used to provide values provided by the user. The

1981 structure of the data is dependent on the kind of	2031 structure of the data is dependent on the kind of

1982 refactoring being performed. The data that is expected is	2032 refactoring being performed. The data that is expected is

1983 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as	2033 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as

1984 “Options”. This field can be omitted if the refactoring	2034 “Options”. This field can be omitted if the refactoring

1985 does not require any options or if the values of those	2035 does not require any options or if the values of those

1986 options are not known.	2036 options are not known.

1987 </p>	2037 </p>

1988 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>initialProblems ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b ></dt><dd>	2038 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems (L ist<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><d d>

1989	2039

1990 <p>	2040 <p>

1991 The initial status of the refactoring, i.e. problems related to	2041 The initial status of the refactoring, i.e. problems related to

1992 the context in which the refactoring is requested.	2042 the context in which the refactoring is requested.

1993 The array will be empty if there are no known problems.	2043 The array will be empty if there are no known problems.

1994 </p>	2044 </p>

1995 </dd><dt class="field"><b><i>optionsProblems ( List<<a href="#type_ RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>	2045 </dd><dt class="field"><b>optionsProblems (List<<a href="#type_Refa ctoringProblem">RefactoringProblem</a>>)</b></dt><dd>

1996	2046

1997 <p>	2047 <p>

1998 The options validation status, i.e. problems in the given options,	2048 The options validation status, i.e. problems in the given options,

1999 such as light-weight validation of a new name, flags	2049 such as light-weight validation of a new name, flags

2000 compatibility, etc.	2050 compatibility, etc.

2001 The array will be empty if there are no known problems.	2051 The array will be empty if there are no known problems.

2002 </p>	2052 </p>

2003 </dd><dt class="field"><b><i>finalProblems ( List<<a href="#type_Re factoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>	2053 </dd><dt class="field"><b>finalProblems (List<<a href="#type_Refact oringProblem">RefactoringProblem</a>>)</b></dt><dd>

2004	2054

2005 <p>	2055 <p>

2006 The final status of the refactoring, i.e. problems identified in	2056 The final status of the refactoring, i.e. problems identified in

2007 the result of a full, potentially expensive validation and / or	2057 the result of a full, potentially expensive validation and / or

2008 change creation.	2058 change creation.

2009 The array will be empty if there are no known problems.	2059 The array will be empty if there are no known problems.

2010 </p>	2060 </p>

2011 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op tional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a> )</i>< /b></dt><dd>	2061 </dd><dt class="field"><b>feedback (<span style="color:#999999">option al</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</b></dt>< dd>

2012	2062

2013 <p>	2063 <p>

2014 Data used to provide feedback to the user. The structure	2064 Data used to provide feedback to the user. The structure

2015 of the data is dependent on the kind of refactoring	2065 of the data is dependent on the kind of refactoring

2016 being created. The data that is returned is documented	2066 being created. The data that is returned is documented

2017 in the section titled <a href="#refactorings">Refactorings</a>, la beled as	2067 in the section titled <a href="#refactorings">Refactorings</a>, la beled as

2018 “Feedback”.	2068 “Feedback”.

2019 </p>	2069 </p>

2020 </dd><dt class="field"><b><i>change ( <span style="color:#999999">opti onal</span> <a href="#type_SourceChange">SourceChange</a> )</i></b></dt><dd>	2070 </dd><dt class="field"><b>change (<span style="color:#999999">optional </span> <a href="#type_SourceChange">SourceChange</a>)</b></dt><dd>

2021	2071

2022 <p>	2072 <p>

2023 The changes that are to be applied to affect the	2073 The changes that are to be applied to affect the

2024 refactoring. This field will be omitted if there are	2074 refactoring. This field will be omitted if there are

2025 problems that prevent a set of changes from being	2075 problems that prevent a set of changes from being

2026 computed, such as having no options specified for a	2076 computed, such as having no options specified for a

2027 refactoring that requires them, or if only validation	2077 refactoring that requires them, or if only validation

2028 was requested.	2078 was requested.

2029 </p>	2079 </p>

2030 </dd><dt class="field"><b><i>potentialEdits ( <span style="color:#9999 99">optional</span> List<String> )</i></b></dt><dd>	2080 </dd><dt class="field"><b>potentialEdits (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>

2031	2081

2032 <p>	2082 <p>

2033 The ids of source edits that are not known to be valid. An edit is	2083 The ids of source edits that are not known to be valid. An edit is

2034 not known to be valid if there was insufficient type information	2084 not known to be valid if there was insufficient type information

2035 for the server to be able to determine whether or not the code	2085 for the server to be able to determine whether or not the code

2036 needs to be modified, such as when a member is being renamed and	2086 needs to be modified, such as when a member is being renamed and

2037 there is a reference to a member from an unknown type. This field	2087 there is a reference to a member from an unknown type. This field

2038 will be omitted if the change field is omitted or if there are no	2088 will be omitted if the change field is omitted or if there are no

2039 potential edits for the refactoring.	2089 potential edits for the refactoring.

2040 </p>	2090 </p>

(...skipping 18 matching lines...) Expand all Loading...
2059 If a request is made for a file that does not exist, does not belong	2109 If a request is made for a file that does not exist, does not belong

2060 to an analysis root or is not a Dart file,	2110 to an analysis root or is not a Dart file,

2061 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.	2111 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.

2062 </p>	2112 </p>

2063 <p>	2113 <p>

2064 If the Dart file has scan or parse errors,	2114 If the Dart file has scan or parse errors,

2065 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.	2115 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.

2066 </p>	2116 </p>

2067	2117

2068	2118

2069 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	2119 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

2070	2120

2071 <p>	2121 <p>

2072 The Dart file to sort.	2122 The Dart file to sort.

2073 </p>	2123 </p>

2074 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href=" #type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd>	2124 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd>

2075	2125

2076 <p>	2126 <p>

2077 The file edit that is to be applied to the given file to effect	2127 The file edit that is to be applied to the given file to effect

2078 the sorting.	2128 the sorting.

2079 </p>	2129 </p>

2080 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec tives">edit.organizeDirectives</a> (<a href="#request_edit.organizeDirectives"># </a>)</dt><dd><div class="box"><pre>request: {	2130 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec tives">edit.organizeDirectives</a> (<a href="#request_edit.organizeDirectives"># </a>)</dt><dd><div class="box"><pre>request: {

2081 "id": String	2131 "id": String

2082 "method": "edit.organizeDirectives"	2132 "method": "edit.organizeDirectives"

2083 "params": {	2133 "params": {

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

(...skipping 16 matching lines...) Expand all Loading...
2101 <tt>FILE_NOT_ANALYZED</tt> will be generated.	2151 <tt>FILE_NOT_ANALYZED</tt> will be generated.

2102 </p>	2152 </p>

2103 <p>	2153 <p>

2104 If directives of the Dart file cannot be organized, for example	2154 If directives of the Dart file cannot be organized, for example

2105 because it has scan or parse errors, or by other reasons,	2155 because it has scan or parse errors, or by other reasons,

2106 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message	2156 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message

2107 will provide details about the reason.	2157 will provide details about the reason.

2108 </p>	2158 </p>

2109	2159

2110	2160

2111 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	2161 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

2112	2162

2113 <p>	2163 <p>

2114 The Dart file to organize directives in.	2164 The Dart file to organize directives in.

2115 </p>	2165 </p>

2116 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href=" #type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd>	2166 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd>

2117	2167

2118 <p>	2168 <p>

2119 The file edit that is to be applied to the given file to effect	2169 The file edit that is to be applied to the given file to effect

2120 the organizing.	2170 the organizing.

2121 </p>	2171 </p>

2122 </dd></dl></dd></dl>	2172 </dd></dl></dd></dl>

2123 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>	2173 <h2 class="domain"><a name="domain_execution">execution domain</a></h2>

2124 <p>	2174 <p>

2125 The execution domain contains commands related to providing an execution	2175 The execution domain contains commands related to providing an execution

2126 or debugging experience.	2176 or debugging experience.

2127 </p>	2177 </p>

2128	2178

2129	2179

2130	2180

2131	2181

2132	2182

2133 <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createCo ntext">execution.createContext</a> (<a href="#request_execution.createContext"># </a>)</dt><dd><div class="box"><pre>request: {	2183 <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createCo ntext">execution.createContext</a> (<a href="#request_execution.createContext"># </a>)</dt><dd><div class="box"><pre>request: {

(...skipping 10 matching lines...) Expand all Loading...
2144 }	2194 }

2145 }</pre></div>	2195 }</pre></div>

2146 <p>	2196 <p>

2147 Create an execution context for the executable file with the given	2197 Create an execution context for the executable file with the given

2148 path. The context that is created will persist until	2198 path. The context that is created will persist until

2149 execution.deleteContext is used to delete it. Clients, therefore, are	2199 execution.deleteContext is used to delete it. Clients, therefore, are

2150 responsible for managing the lifetime of execution contexts.	2200 responsible for managing the lifetime of execution contexts.

2151 </p>	2201 </p>

2152	2202

2153	2203

2154 <h4>Parameters</h4><dl><dt class="field"><b><i>contextRoot ( <a href="#typ e_FilePath">FilePath</a> )</i></b></dt><dd>	2204 <h4>parameters:</h4><dl><dt class="field"><b>contextRoot (<a href="#type_F ilePath">FilePath</a>)</b></dt><dd>

2155	2205

2156 <p>	2206 <p>

2157 The path of the Dart or HTML file that will be launched, or the	2207 The path of the Dart or HTML file that will be launched, or the

2158 path of the directory containing the file.	2208 path of the directory containing the file.

2159 </p>	2209 </p>

2160 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>	2210 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _ExecutionContextId">ExecutionContextId</a>)</b></dt><dd>

2161	2211

2162 <p>	2212 <p>

2163 The identifier used to refer to the execution context that was	2213 The identifier used to refer to the execution context that was

2164 created.	2214 created.

2165 </p>	2215 </p>

2166 </dd></dl></dd><dt class="request"><a name="request_execution.deleteCo ntext">execution.deleteContext</a> (<a href="#request_execution.deleteContext"># </a>)</dt><dd><div class="box"><pre>request: {	2216 </dd></dl></dd><dt class="request"><a name="request_execution.deleteCo ntext">execution.deleteContext</a> (<a href="#request_execution.deleteContext"># </a>)</dt><dd><div class="box"><pre>request: {

2167 "<b>id</b>": String	2217 "<b>id</b>": String

2168 "method": "execution.deleteContext"	2218 "method": "execution.deleteContext"

2169 "params": {	2219 "params": {

2170 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	2220 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

2171 }	2221 }

2172 }</pre><br><pre>response: {	2222 }</pre><br><pre>response: {

2173 "id": String	2223 "id": String

2174 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	2224 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

2175 }</pre></div>	2225 }</pre></div>

2176 <p>	2226 <p>

2177 Delete the execution context with the given identifier. The context id	2227 Delete the execution context with the given identifier. The context id

2178 is no longer valid after this command. The server is allowed to re-use	2228 is no longer valid after this command. The server is allowed to re-use

2179 ids when they are no longer valid.	2229 ids when they are no longer valid.

2180 </p>	2230 </p>

2181	2231

2182 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>	2232 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC ontextId">ExecutionContextId</a>)</b></dt><dd>

2183	2233

2184 <p>	2234 <p>

2185 The identifier of the execution context that is to be deleted.	2235 The identifier of the execution context that is to be deleted.

2186 </p>	2236 </p>

2187 </dd></dl></dd><dt class="request"><a name="request_execution.mapUri"> execution.mapUri</a> (<a href="#request_execution.mapUri">#</a>)</dt><dd><div cl ass="box"><pre>request: {	2237 </dd></dl></dd><dt class="request"><a name="request_execution.mapUri"> execution.mapUri</a> (<a href="#request_execution.mapUri">#</a>)</dt><dd><div cl ass="box"><pre>request: {

2188 "<b>id</b>": String	2238 "<b>id</b>": String

2189 "method": "execution.mapUri"	2239 "method": "execution.mapUri"

2190 "params": {	2240 "params": {

2191 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	2241 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

2192 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>	2242 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>

(...skipping 30 matching lines...) Expand all Loading...
2223 does not exist or something other than a file), then an error of type	2273 does not exist or something other than a file), then an error of type

2224 <tt>INVALID_PARAMETER</tt> will be generated.	2274 <tt>INVALID_PARAMETER</tt> will be generated.

2225 </p>	2275 </p>

2226 <p>	2276 <p>

2227 If the contextRoot used to create the execution context does not	2277 If the contextRoot used to create the execution context does not

2228 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will	2278 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will

2229 be generated.	2279 be generated.

2230 </p>	2280 </p>

2231	2281

2232	2282

2233 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>	2283 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC ontextId">ExecutionContextId</a>)</b></dt><dd>

2234	2284

2235 <p>	2285 <p>

2236 The identifier of the execution context in which the URI is to be	2286 The identifier of the execution context in which the URI is to be

2237 mapped.	2287 mapped.

2238 </p>	2288 </p>

2239 </dd><dt class="field"><b><i>file ( <span style="color:#999999">option al</span> <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>	2289 </dd><dt class="field"><b>file (<span style="color:#999999">optional</ span> <a href="#type_FilePath">FilePath</a>)</b></dt><dd>

2240	2290

2241 <p>	2291 <p>

2242 The path of the file to be mapped into a URI.	2292 The path of the file to be mapped into a URI.

2243 </p>	2293 </p>

2244 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>	2294 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s pan> String)</b></dt><dd>

2245	2295

2246 <p>	2296 <p>

2247 The URI to be mapped into a file path.	2297 The URI to be mapped into a file path.

2248 </p>	2298 </p>

2249 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>file ( <span sty le="color:#999999">optional</span> <a href="#type_FilePath">FilePath</a> )</i></ b></dt><dd>	2299 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>file (<span style= "color:#999999">optional</span> <a href="#type_FilePath">FilePath</a>)</b></dt>< dd>

2250	2300

2251 <p>	2301 <p>

2252 The file to which the URI was mapped. This field is omitted if the	2302 The file to which the URI was mapped. This field is omitted if the

2253 uri field was not given in the request.	2303 uri field was not given in the request.

2254 </p>	2304 </p>

2255 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>	2305 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s pan> String)</b></dt><dd>

2256	2306

2257 <p>	2307 <p>

2258 The URI to which the file path was mapped. This field is omitted	2308 The URI to which the file path was mapped. This field is omitted

2259 if the file field was not given in the request.	2309 if the file field was not given in the request.

2260 </p>	2310 </p>

2261 </dd></dl></dd><dt class="request"><a name="request_execution.setSubsc riptions">execution.setSubscriptions</a> (<a href="#request_execution.setSubscri ptions">#</a>)</dt><dd><div class="box"><pre>request: {	2311 </dd></dl></dd><dt class="request"><a name="request_execution.setSubsc riptions">execution.setSubscriptions</a> (<a href="#request_execution.setSubscri ptions">#</a>)</dt><dd><div class="box"><pre>request: {

2262 "id": String	2312 "id": String

2263 "method": "execution.setSubscriptions"	2313 "method": "execution.setSubscriptions"

2264 "params": {	2314 "params": {

2265 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>	2315 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>

2266 }	2316 }

2267 }</pre><br><pre>response: {	2317 }</pre><br><pre>response: {

2268 "id": String	2318 "id": String

2269 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	2319 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

2270 }</pre></div>	2320 }</pre></div>

2271 <p>	2321 <p>

2272 Subscribe for services. All previous subscriptions are replaced by the	2322 Subscribe for services. All previous subscriptions are replaced by the

2273 given set of services.	2323 given set of services.

2274 </p>	2324 </p>

2275 <p>	2325 <p>

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

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

2278 remain unchanged.	2328 remain unchanged.

2279 </p>	2329 </p>

2280	2330

2281 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ExecutionService">ExecutionService</a>> )</i></b></dt><dd>	2331 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_ExecutionService">ExecutionService</a>>)</b></dt><dd>

2282	2332

2283 <p>	2333 <p>

2284 A list of the services being subscribed to.	2334 A list of the services being subscribed to.

2285 </p>	2335 </p>

2286 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_execution.launchData">execution.launchData</a> (<a href=" #notification_execution.launchData">#</a>)</dt><dd><div class="box"><pre>notific ation: {	2336 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_execution.launchData">execution.launchData</a> (<a href=" #notification_execution.launchData">#</a>)</dt><dd><div class="box"><pre>notific ation: {

2287 "event": "execution.launchData"	2337 "event": "execution.launchData"

2288 "params": {	2338 "params": {

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

2290 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>	2340 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>

2291 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>	2341 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>

2292 }	2342 }

2293 }</pre></div>	2343 }</pre></div>

2294 <p>	2344 <p>

2295 Reports information needed to allow a single file to be launched.	2345 Reports information needed to allow a single file to be launched.

2296 </p>	2346 </p>

2297 <p>	2347 <p>

2298 This notification is not subscribed to by default. Clients can	2348 This notification is not subscribed to by default. Clients can

2299 subscribe by including the value "LAUNCH_DATA" in the list of services	2349 subscribe by including the value "LAUNCH_DATA" in the list of services

2300 passed in an <tt>execution.setSubscriptions</tt> request.	2350 passed in an <tt>execution.setSubscriptions</tt> request.

2301 </p>	2351 </p>

2302	2352

2303 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	2353 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>

2304	2354

2305 <p>	2355 <p>

2306 The file for which launch data is being provided. This will either	2356 The file for which launch data is being provided. This will either

2307 be a Dart library or an HTML file.	2357 be a Dart library or an HTML file.

2308 </p>	2358 </p>

2309 </dd><dt class="field"><b><i>kind ( <span style="color:#999999">option al</span> <a href="#type_ExecutableKind">ExecutableKind</a> )</i></b></dt><dd>	2359 </dd><dt class="field"><b>kind (<span style="color:#999999">optional</ span> <a href="#type_ExecutableKind">ExecutableKind</a>)</b></dt><dd>

2310	2360

2311 <p>	2361 <p>

2312 The kind of the executable file. This field is omitted if the file	2362 The kind of the executable file. This field is omitted if the file

2313 is not a Dart file.	2363 is not a Dart file.

2314 </p>	2364 </p>

2315 </dd><dt class="field"><b><i>referencedFiles ( <span style="color:#999 999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b> </dt><dd>	2365 </dd><dt class="field"><b>referencedFiles (<span style="color:#999999" >optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd>

2316	2366

2317 <p>	2367 <p>

2318 A list of the Dart files that are referenced by the file. This	2368 A list of the Dart files that are referenced by the file. This

2319 field is omitted if the file is not an HTML file.	2369 field is omitted if the file is not an HTML file.

2320 </p>	2370 </p>

2321 </dd></dl></dd></dl>	2371 </dd></dl></dd></dl>

2322 <h2 class="domain"><a name="domain_diagnostic">Domain: diagnostic</a></h2>	2372 <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2>

2323 <p>	2373 <p>

2324 The diagnostic domain contains server diagnostics APIs.	2374 The diagnostic domain contains server diagnostics APIs.

2325 </p>	2375 </p>

2326	2376

2327 <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiag nostics">diagnostic.getDiagnostics</a> (<a href="#request_diagnostic.getDiagnost ics">#</a>)</dt><dd><div class="box"><pre>request: {	2377 <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiag nostics">diagnostic.getDiagnostics</a> (<a href="#request_diagnostic.getDiagnost ics">#</a>)</dt><dd><div class="box"><pre>request: {

2328 "id": String	2378 "id": String

2329 "method": "diagnostic.getDiagnostics"	2379 "method": "diagnostic.getDiagnostics"

2330 }</pre><br><pre>response: {	2380 }</pre><br><pre>response: {

2331 "id": String	2381 "id": String

2332 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	2382 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

2333 "result": {	2383 "result": {

2334 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>>	2384 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>>

2335 }	2385 }

2336 }</pre></div>	2386 }</pre></div>

2337 <p>Return server diagnostics.</p>	2387 <p>Return server diagnostics.</p>

2338	2388

2339 <h4>Returns</h4><dl><dt class="field"><b><i>contexts ( List<<a href="#t ype_ContextData">ContextData</a>> )</i></b></dt><dd>	2389 <h4>returns:</h4><dl><dt class="field"><b>contexts (List<<a href="#type _ContextData">ContextData</a>>)</b></dt><dd>

2340	2390

2341 <p>The list of analysis contexts.</p>	2391 <p>The list of analysis contexts.</p>

2342 </dd></dl></dd></dl>	2392 </dd></dl></dd></dl>

2343	2393

2344 <h2 class="domain"><a name="types">Types</a></h2>	2394 <h2 class="domain"><a name="types">Types</a></h2>

2345 <p>	2395 <p>

2346 This section contains descriptions of the data types referenced	2396 This section contains descriptions of the data types referenced

2347 in the API’s of the various domains.	2397 in the API’s of the various domains.

2348 </p>	2398 </p>

2349	2399

(...skipping 60 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2410 A directive to begin overlaying the contents of a file. The	2460 A directive to begin overlaying the contents of a file. The

2411 supplied content will be used for analysis in place of the	2461 supplied content will be used for analysis in place of the

2412 file contents in the filesystem.	2462 file contents in the filesystem.

2413 </p>	2463 </p>

2414 <p>	2464 <p>

2415 If this directive is used on a file that already has a file	2465 If this directive is used on a file that already has a file

2416 content overlay, the old overlay is discarded and replaced	2466 content overlay, the old overlay is discarded and replaced

2417 with the new one.	2467 with the new one.

2418 </p>	2468 </p>

2419	2469

2420 <dl><dt class="field"><b><i>type = "add"</i></b></dt><dd></dd><dt class="f ield"><b><i>content ( String )</i></b></dt><dd>	2470 <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field">< b>content (String)</b></dt><dd>

2421	2471

2422 <p>	2472 <p>

2423 The new content of the file.	2473 The new content of the file.

2424 </p>	2474 </p>

2425 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>	2475 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>

2426 <p>	2476 <p>

2427 An indication of an error, warning, or hint that was produced	2477 An indication of an error, warning, or hint that was produced

2428 by the analysis.	2478 by the analysis.

2429 </p>	2479 </p>

2430	2480

2431 <dl><dt class="field"><b><i>severity ( <a href="#type_AnalysisErrorSeverit y">AnalysisErrorSeverity</a> )</i></b></dt><dd>	2481 <dl><dt class="field"><b>severity (<a href="#type_AnalysisErrorSeverity">A nalysisErrorSeverity</a>)</b></dt><dd>

2432	2482

2433 <p>	2483 <p>

2434 The severity of the error.	2484 The severity of the error.

2435 </p>	2485 </p>

2436 </dd><dt class="field"><b><i>type ( <a href="#type_AnalysisErrorType"> AnalysisErrorType</a> )</i></b></dt><dd>	2486 </dd><dt class="field"><b>type (<a href="#type_AnalysisErrorType">Anal ysisErrorType</a>)</b></dt><dd>

2437	2487

2438 <p>	2488 <p>

2439 The type of the error.	2489 The type of the error.

2440 </p>	2490 </p>

2441 </dd><dt class="field"><b><i>location ( <a href="#type_Location">Locat ion</a> )</i></b></dt><dd>	2491 </dd><dt class="field"><b>location (<a href="#type_Location">Location< /a>)</b></dt><dd>

2442	2492

2443 <p>	2493 <p>

2444 The location associated with the error.	2494 The location associated with the error.

2445 </p>	2495 </p>

2446 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>	2496 </dd><dt class="field"><b>message (String)</b></dt><dd>

2447	2497

2448 <p>	2498 <p>

2449 The message to be displayed for this error. The message	2499 The message to be displayed for this error. The message

2450 should indicate what is wrong with the code and why it is	2500 should indicate what is wrong with the code and why it is

2451 wrong.	2501 wrong.

2452 </p>	2502 </p>

2453 </dd><dt class="field"><b><i>correction ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	2503 </dd><dt class="field"><b>correction (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

2454	2504

2455 <p>	2505 <p>

2456 The correction message to be displayed for this error. The	2506 The correction message to be displayed for this error. The

2457 correction message should indicate how the user can fix	2507 correction message should indicate how the user can fix

2458 the error. The field is omitted if there is no correction	2508 the error. The field is omitted if there is no correction

2459 message associated with the error code.	2509 message associated with the error code.

2460 </p>	2510 </p>

2461 </dd><dt class="field"><b><i>code ( String )</i></b></dt><dd>	2511 </dd><dt class="field"><b>code (String)</b></dt><dd>

2462	2512

2463 <p>	2513 <p>

2464 The name, as a string, of the error code associated with this erro r.	2514 The name, as a string, of the error code associated with this erro r.

2465 </p>	2515 </p>

2466 </dd><dt class="field"><b><i>hasFix ( <span style="color:#999999">opti onal</span> bool )</i></b></dt><dd>	2516 </dd><dt class="field"><b>hasFix (<span style="color:#999999">optional </span> bool)</b></dt><dd>

2467	2517

2468 <p>	2518 <p>

2469 A hint to indicate to interested clients that this error has	2519 A hint to indicate to interested clients that this error has

2470 an associated fix (or fixes). The absence of this field implies	2520 an associated fix (or fixes). The absence of this field implies

2471 there are not known to be fixes. Note that since the operation	2521 there are not known to be fixes. Note that since the operation

2472 to calculate whether fixes apply needs to be performant it is	2522 to calculate whether fixes apply needs to be performant it is

2473 possible that complicated tests will be skipped and a false	2523 possible that complicated tests will be skipped and a false

2474 negative returned. For this reason, this attribute should be	2524 negative returned. For this reason, this attribute should be

2475 treated as a "hint". Despite the possibility of false negatives,	2525 treated as a "hint". Despite the possibility of false negatives,

2476 no false positives should be returned. If a client sees this	2526 no false positives should be returned. If a client sees this

2477 flag set they can proceed with the confidence that there are in	2527 flag set they can proceed with the confidence that there are in

2478 fact associated fixes.	2528 fact associated fixes.

2479 </p>	2529 </p>

2480 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF ixes">AnalysisErrorFixes: object</a></dt><dd>	2530 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF ixes">AnalysisErrorFixes: object</a></dt><dd>

2481 <p>	2531 <p>

2482 A list of fixes associated with a specific error	2532 A list of fixes associated with a specific error

2483 </p>	2533 </p>

2484	2534

2485 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis Error</a> )</i></b></dt><dd>	2535 <dl><dt class="field"><b>error (<a href="#type_AnalysisError">AnalysisErro r</a>)</b></dt><dd>

2486	2536

2487 <p>	2537 <p>

2488 The error with which the fixes are associated.	2538 The error with which the fixes are associated.

2489 </p>	2539 </p>

2490 </dd><dt class="field"><b><i>fixes ( List<<a href="#type_SourceChan ge">SourceChange</a>> )</i></b></dt><dd>	2540 </dd><dt class="field"><b>fixes (List<<a href="#type_SourceChange"> SourceChange</a>>)</b></dt><dd>

2491	2541

2492 <p>	2542 <p>

2493 The fixes associated with the error.	2543 The fixes associated with the error.

2494 </p>	2544 </p>

2495 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS everity">AnalysisErrorSeverity: String</a></dt><dd>	2545 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS everity">AnalysisErrorSeverity: String</a></dt><dd>

2496 <p>	2546 <p>

2497 An enumeration of the possible severities of analysis	2547 An enumeration of the possible severities of analysis

2498 errors.	2548 errors.

2499 </p>	2549 </p>

2500	2550

2501 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorT ype">AnalysisErrorType: String</a></dt><dd>	2551 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorT ype">AnalysisErrorType: String</a></dt><dd>

2502 <p>	2552 <p>

2503 An enumeration of the possible types of analysis errors.	2553 An enumeration of the possible types of analysis errors.

2504 </p>	2554 </p>

2505	2555

2506 <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><d t class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt cla ss="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></ dt><dd>	2556 <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><d t class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt cla ss="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></ dt><dd>

2507 <p>	2557 <p>

2508 A set of options controlling what kind of analysis is to be	2558 A set of options controlling what kind of analysis is to be

2509 performed. If the value of a field is omitted the value of the	2559 performed. If the value of a field is omitted the value of the

2510 option will not be changed.	2560 option will not be changed.

2511 </p>	2561 </p>

2512	2562

2513 <dl><dt class="field"><b><i>enableAsync ( <span style="color:#999999">opti onal</span> bool )</i></b></dt><dd>	2563 <dl><dt class="field"><b>enableAsync (<span style="color:#999999">optional </span> bool)</b></dt><dd>

2514	2564

2515 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2565 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>

2516 <p>	2566 <p>

2517 True if the client wants to enable support for the	2567 True if the client wants to enable support for the

2518 proposed async feature.	2568 proposed async feature.

2519 </p>	2569 </p>

2520 </dd><dt class="field"><b><i>enableDeferredLoading ( <span style="colo r:#999999">optional</span> bool )</i></b></dt><dd>	2570 </dd><dt class="field"><b>enableDeferredLoading (<span style="color:#9 99999">optional</span> bool)</b></dt><dd>

2521	2571

2522 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2572 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>

2523 <p>	2573 <p>

2524 True if the client wants to enable support for the	2574 True if the client wants to enable support for the

2525 proposed deferred loading feature.	2575 proposed deferred loading feature.

2526 </p>	2576 </p>

2527 </dd><dt class="field"><b><i>enableEnums ( <span style="color:#999999" >optional</span> bool )</i></b></dt><dd>	2577 </dd><dt class="field"><b>enableEnums (<span style="color:#999999">opt ional</span> bool)</b></dt><dd>

2528	2578

2529 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2579 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>

2530 <p>	2580 <p>

2531 True if the client wants to enable support for the	2581 True if the client wants to enable support for the

2532 proposed enum feature.	2582 proposed enum feature.

2533 </p>	2583 </p>

2534 </dd><dt class="field"><b><i>enableNullAwareOperators ( <span style="c olor:#999999">optional</span> bool )</i></b></dt><dd>	2584 </dd><dt class="field"><b>enableNullAwareOperators (<span style="color :#999999">optional</span> bool)</b></dt><dd>

2535	2585

2536 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2586 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>

2537 <p>	2587 <p>

2538 True if the client wants to enable support for the	2588 True if the client wants to enable support for the

2539 proposed "null aware operators" feature.	2589 proposed "null aware operators" feature.

2540 </p>	2590 </p>

2541 </dd><dt class="field"><b><i>enableSuperMixins ( <span style="color:#9 99999">optional</span> bool )</i></b></dt><dd>	2591 </dd><dt class="field"><b>enableSuperMixins (<span style="color:#99999 9">optional</span> bool)</b></dt><dd>

2542	2592

2543 <p>	2593 <p>

2544 True if the client wants to enable support for the	2594 True if the client wants to enable support for the

2545 proposed "less restricted mixins" proposal (DEP 34).	2595 proposed "less restricted mixins" proposal (DEP 34).

2546 </p>	2596 </p>

2547 </dd><dt class="field"><b><i>generateDart2jsHints ( <span style="color :#999999">optional</span> bool )</i></b></dt><dd>	2597 </dd><dt class="field"><b>generateDart2jsHints (<span style="color:#99 9999">optional</span> bool)</b></dt><dd>

2548	2598

2549 <p>	2599 <p>

2550 True if hints that are specific to dart2js should be	2600 True if hints that are specific to dart2js should be

2551 generated. This option is ignored if generateHints is false.	2601 generated. This option is ignored if generateHints is false.

2552 </p>	2602 </p>

2553 </dd><dt class="field"><b><i>generateHints ( <span style="color:#99999 9">optional</span> bool )</i></b></dt><dd>	2603 </dd><dt class="field"><b>generateHints (<span style="color:#999999">o ptional</span> bool)</b></dt><dd>

2554	2604

2555 <p>	2605 <p>

2556 True if hints should be generated as part of generating	2606 True if hints should be generated as part of generating

2557 errors and warnings.	2607 errors and warnings.

2558 </p>	2608 </p>

2559 </dd><dt class="field"><b><i>generateLints ( <span style="color:#99999 9">optional</span> bool )</i></b></dt><dd>	2609 </dd><dt class="field"><b>generateLints (<span style="color:#999999">o ptional</span> bool)</b></dt><dd>

2560	2610

2561 <p>	2611 <p>

2562 True if lints should be generated as part of generating	2612 True if lints should be generated as part of generating

2563 errors and warnings.	2613 errors and warnings.

2564 </p>	2614 </p>

2565 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>	2615 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>

2566 <p>	2616 <p>

2567 An enumeration of the services provided by the analysis domain that	2617 An enumeration of the services provided by the analysis domain that

2568 are related to a specific list of files.	2618 are related to a specific list of files.

2569 </p>	2619 </p>

2570	2620

2571 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd>	2621 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd>

2572	2622

2573 <p>	2623 <p>

2574 This service is not currently implemented and will become a	2624 This service is not currently implemented and will become a

2575 GeneralAnalysisService in a future release.	2625 GeneralAnalysisService in a future release.

2576 </p>	2626 </p>

2577 </dd><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</d t><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt cl ass="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></d t><dd>	2627 </dd><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</d t><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt cl ass="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></d t><dd>

2578 <p>	2628 <p>

2579 An indication of the current state of analysis.	2629 An indication of the current state of analysis.

2580 </p>	2630 </p>

2581	2631

2582 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd>	2632 <dl><dt class="field"><b>isAnalyzing (bool)</b></dt><dd>

2583	2633

2584 <p>True if analysis is currently being performed.</p>	2634 <p>True if analysis is currently being performed.</p>

2585 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>	2635 </dd><dt class="field"><b>analysisTarget (<span style="color:#999999"> optional</span> String)</b></dt><dd>

2586	2636

2587 <p>	2637 <p>

2588 The name of the current target of analysis. This field is	2638 The name of the current target of analysis. This field is

2589 omitted if analyzing is false.	2639 omitted if analyzing is false.

2590 </p>	2640 </p>

2591 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>	2641 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>

2592 <p>	2642 <p>

2593 A directive to modify an existing file content overlay. One or more	2643 A directive to modify an existing file content overlay. One or more

2594 ranges of text are deleted from the old file content overlay and	2644 ranges of text are deleted from the old file content overlay and

2595 replaced with new text.	2645 replaced with new text.

2596 </p>	2646 </p>

2597 <p>	2647 <p>

2598 The edits are applied in the order in which they occur in the list.	2648 The edits are applied in the order in which they occur in the list.

2599 This means that the offset of each edit must be correct under the	2649 This means that the offset of each edit must be correct under the

2600 assumption that all previous edits have been applied.	2650 assumption that all previous edits have been applied.

2601 </p>	2651 </p>

2602 <p>	2652 <p>

2603 It is an error to use this overlay on a file that does not yet have	2653 It is an error to use this overlay on a file that does not yet have

2604 a file content overlay or that has had its overlay removed via	2654 a file content overlay or that has had its overlay removed via

2605 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.	2655 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.

2606 </p>	2656 </p>

2607 <p>	2657 <p>

2608 If any of the edits cannot be applied due to its offset or	2658 If any of the edits cannot be applied due to its offset or

2609 length being out of range, an INVALID_OVERLAY_CHANGE error	2659 length being out of range, an INVALID_OVERLAY_CHANGE error

2610 will be reported.	2660 will be reported.

2611 </p>	2661 </p>

2612	2662

2613 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class ="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</ i></b></dt><dd>	2663 <dl><dt class="field"><b>type = "change"</b></dt><dd></dd><dt class="field "><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd>

2614	2664

2615 <p>	2665 <p>

2616 The edits to be applied to the file.	2666 The edits to be applied to the file.

2617 </p>	2667 </p>

2618 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd>	2668 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd>

2619	2669

2620 <p>	2670 <p>

2621 An identifier used to associate completion results with a	2671 An identifier used to associate completion results with a

2622 completion request.	2672 completion request.

2623 </p>	2673 </p>

2624 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple tionSuggestion: object</a></dt><dd>	2674 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple tionSuggestion: object</a></dt><dd>

2625 <p>	2675 <p>

2626 A suggestion for how to complete partially entered text. Many	2676 A suggestion for how to complete partially entered text. Many

2627 of the fields are optional, depending on the kind of element	2677 of the fields are optional, depending on the kind of element

2628 being suggested.	2678 being suggested.

2629 </p>	2679 </p>

2630	2680

2631 <dl><dt class="field"><b><i>kind ( <a href="#type_CompletionSuggestionKind ">CompletionSuggestionKind</a> )</i></b></dt><dd>	2681 <dl><dt class="field"><b>kind (<a href="#type_CompletionSuggestionKind">Co mpletionSuggestionKind</a>)</b></dt><dd>

2632	2682

2633 <p>	2683 <p>

2634 The kind of element being suggested.	2684 The kind of element being suggested.

2635 </p>	2685 </p>

2636 </dd><dt class="field"><b><i>relevance ( int )</i></b></dt><dd>	2686 </dd><dt class="field"><b>relevance (int)</b></dt><dd>

2637	2687

2638 <p>	2688 <p>

2639 The relevance of this completion suggestion	2689 The relevance of this completion suggestion

2640 where a higher number indicates a higher relevance.	2690 where a higher number indicates a higher relevance.

2641 </p>	2691 </p>

2642 </dd><dt class="field"><b><i>completion ( String )</i></b></dt><dd>	2692 </dd><dt class="field"><b>completion (String)</b></dt><dd>

2643	2693

2644 <p>	2694 <p>

2645 The identifier to be inserted if the suggestion is	2695 The identifier to be inserted if the suggestion is

2646 selected. If the suggestion is for a method or function,	2696 selected. If the suggestion is for a method or function,

2647 the client might want to additionally insert a template	2697 the client might want to additionally insert a template

2648 for the parameters. The information required in order to	2698 for the parameters. The information required in order to

2649 do so is contained in other fields.	2699 do so is contained in other fields.

2650 </p>	2700 </p>

2651 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>	2701 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>

2652	2702

2653 <p>	2703 <p>

2654 The offset, relative to the beginning of the completion,	2704 The offset, relative to the beginning of the completion,

2655 of where the selection should be placed after insertion.	2705 of where the selection should be placed after insertion.

2656 </p>	2706 </p>

2657 </dd><dt class="field"><b><i>selectionLength ( int )</i></b></dt><dd>	2707 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>

2658	2708

2659 <p>	2709 <p>

2660 The number of characters that should be selected after	2710 The number of characters that should be selected after

2661 insertion.	2711 insertion.

2662 </p>	2712 </p>

2663 </dd><dt class="field"><b><i>isDeprecated ( bool )</i></b></dt><dd>	2713 </dd><dt class="field"><b>isDeprecated (bool)</b></dt><dd>

2664	2714

2665 <p>	2715 <p>

2666 True if the suggested element is deprecated.	2716 True if the suggested element is deprecated.

2667 </p>	2717 </p>

2668 </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd>	2718 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd>

2669	2719

2670 <p>	2720 <p>

2671 True if the element is not known to be valid for the	2721 True if the element is not known to be valid for the

2672 target. This happens if the type of the target is dynamic.	2722 target. This happens if the type of the target is dynamic.

2673 </p>	2723 </p>

2674 </dd><dt class="field"><b><i>docSummary ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	2724 </dd><dt class="field"><b>docSummary (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

2675	2725

2676 <p>	2726 <p>

2677 An abbreviated version of the Dartdoc associated with the	2727 An abbreviated version of the Dartdoc associated with the

2678 element being suggested, This field is omitted if there is	2728 element being suggested, This field is omitted if there is

2679 no Dartdoc associated with the element.	2729 no Dartdoc associated with the element.

2680 </p>	2730 </p>

2681 </dd><dt class="field"><b><i>docComplete ( <span style="color:#999999" >optional</span> String )</i></b></dt><dd>	2731 </dd><dt class="field"><b>docComplete (<span style="color:#999999">opt ional</span> String)</b></dt><dd>

2682	2732

2683 <p>	2733 <p>

2684 The Dartdoc associated with the element being suggested,	2734 The Dartdoc associated with the element being suggested,

2685 This field is omitted if there is no Dartdoc associated	2735 This field is omitted if there is no Dartdoc associated

2686 with the element.	2736 with the element.

2687 </p>	2737 </p>

2688 </dd><dt class="field"><b><i>declaringType ( <span style="color:#99999 9">optional</span> String )</i></b></dt><dd>	2738 </dd><dt class="field"><b>declaringType (<span style="color:#999999">o ptional</span> String)</b></dt><dd>

2689	2739

2690 <p>	2740 <p>

2691 The class that declares the element being suggested. This	2741 The class that declares the element being suggested. This

2692 field is omitted if the suggested element is not a member	2742 field is omitted if the suggested element is not a member

2693 of a class.	2743 of a class.

2694 </p>	2744 </p>

2695 </dd><dt class="field"><b><i>element ( <span style="color:#999999">opt ional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd>	2745 </dd><dt class="field"><b>element (<span style="color:#999999">optiona l</span> <a href="#type_Element">Element</a>)</b></dt><dd>

2696	2746

2697 <p>	2747 <p>

2698 Information about the element reference being suggested.	2748 Information about the element reference being suggested.

2699 </p>	2749 </p>

2700 </dd><dt class="field"><b><i>returnType ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	2750 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

2701	2751

2702 <p>	2752 <p>

2703 The return type of the getter, function or method	2753 The return type of the getter, function or method

2704 or the type of the field being suggested.	2754 or the type of the field being suggested.

2705 This field is omitted if the suggested element	2755 This field is omitted if the suggested element

2706 is not a getter, function or method.	2756 is not a getter, function or method.

2707 </p>	2757 </p>

2708 </dd><dt class="field"><b><i>parameterNames ( <span style="color:#9999 99">optional</span> List<String> )</i></b></dt><dd>	2758 </dd><dt class="field"><b>parameterNames (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>

2709	2759

2710 <p>	2760 <p>

2711 The names of the parameters of the function or method	2761 The names of the parameters of the function or method

2712 being suggested. This field is omitted if the suggested	2762 being suggested. This field is omitted if the suggested

2713 element is not a setter, function or method.	2763 element is not a setter, function or method.

2714 </p>	2764 </p>

2715 </dd><dt class="field"><b><i>parameterTypes ( <span style="color:#9999 99">optional</span> List<String> )</i></b></dt><dd>	2765 </dd><dt class="field"><b>parameterTypes (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>

2716	2766

2717 <p>	2767 <p>

2718 The types of the parameters of the function or method	2768 The types of the parameters of the function or method

2719 being suggested. This field is omitted if the	2769 being suggested. This field is omitted if the

2720 parameterNames field is omitted.	2770 parameterNames field is omitted.

2721 </p>	2771 </p>

2722 </dd><dt class="field"><b><i>requiredParameterCount ( <span style="col or:#999999">optional</span> int )</i></b></dt><dd>	2772 </dd><dt class="field"><b>requiredParameterCount (<span style="color:# 999999">optional</span> int)</b></dt><dd>

2723	2773

2724 <p>	2774 <p>

2725 The number of required parameters for the function or	2775 The number of required parameters for the function or

2726 method being suggested. This field is omitted if the	2776 method being suggested. This field is omitted if the

2727 parameterNames field is omitted.	2777 parameterNames field is omitted.

2728 </p>	2778 </p>

2729 </dd><dt class="field"><b><i>hasNamedParameters ( <span style="color:# 999999">optional</span> bool )</i></b></dt><dd>	2779 </dd><dt class="field"><b>hasNamedParameters (<span style="color:#9999 99">optional</span> bool)</b></dt><dd>

2730	2780

2731 <p>	2781 <p>

2732 True if the function or method being suggested has at	2782 True if the function or method being suggested has at

2733 least one named parameter. This field is omitted if the	2783 least one named parameter. This field is omitted if the

2734 parameterNames field is omitted.	2784 parameterNames field is omitted.

2735 </p>	2785 </p>

2736 </dd><dt class="field"><b><i>parameterName ( <span style="color:#99999 9">optional</span> String )</i></b></dt><dd>	2786 </dd><dt class="field"><b>parameterName (<span style="color:#999999">o ptional</span> String)</b></dt><dd>

2737	2787

2738 <p>	2788 <p>

2739 The name of the optional parameter being suggested. This	2789 The name of the optional parameter being suggested. This

2740 field is omitted if the suggestion is not the addition of	2790 field is omitted if the suggestion is not the addition of

2741 an optional argument within an argument list.	2791 an optional argument within an argument list.

2742 </p>	2792 </p>

2743 </dd><dt class="field"><b><i>parameterType ( <span style="color:#99999 9">optional</span> String )</i></b></dt><dd>	2793 </dd><dt class="field"><b>parameterType (<span style="color:#999999">o ptional</span> String)</b></dt><dd>

2744	2794

2745 <p>	2795 <p>

2746 The type of the options parameter being suggested. This	2796 The type of the options parameter being suggested. This

2747 field is omitted if the parameterName field is omitted.	2797 field is omitted if the parameterName field is omitted.

2748 </p>	2798 </p>

2749 </dd><dt class="field"><b><i>importUri ( <span style="color:#999999">o ptional</span> String )</i></b></dt><dd>	2799 </dd><dt class="field"><b>importUri (<span style="color:#999999">optio nal</span> String)</b></dt><dd>

2750	2800

2751 <p>	2801 <p>

2752 The import to be added if the suggestion is out of scope	2802 The import to be added if the suggestion is out of scope

2753 and needs an import to be added to be in scope.	2803 and needs an import to be added to be in scope.

2754 </p>	2804 </p>

2755 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>	2805 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>

2756 <p>	2806 <p>

2757 An enumeration of the kinds of elements that can be included	2807 An enumeration of the kinds of elements that can be included

2758 in a completion suggestion.	2808 in a completion suggestion.

2759 </p>	2809 </p>

(...skipping 33 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2793 <p>	2843 <p>

2794 A named argument for the current callsite is being suggested.	2844 A named argument for the current callsite is being suggested.

2795 For suggestions of this kind, the completion is	2845 For suggestions of this kind, the completion is

2796 the named argument identifier including a trailing ':' and space.	2846 the named argument identifier including a trailing ':' and space.

2797 </p>	2847 </p>

2798 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMET ER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextDa ta: object</a></dt><dd>	2848 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMET ER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextDa ta: object</a></dt><dd>

2799 <p>	2849 <p>

2800 Information about an analysis context.	2850 Information about an analysis context.

2801 </p>	2851 </p>

2802	2852

2803 <dl><dt class="field"><b><i>name ( String )</i></b></dt><dd>	2853 <dl><dt class="field"><b>name (String)</b></dt><dd>

2804	2854

2805 <p>	2855 <p>

2806 The name of the context.	2856 The name of the context.

2807 </p>	2857 </p>

2808 </dd><dt class="field"><b><i>explicitFileCount ( int )</i></b></dt><dd >	2858 </dd><dt class="field"><b>explicitFileCount (int)</b></dt><dd>

2809	2859

2810 <p>	2860 <p>

2811 Explicitly analyzed files.	2861 Explicitly analyzed files.

2812 </p>	2862 </p>

2813 </dd><dt class="field"><b><i>implicitFileCount ( int )</i></b></dt><dd >	2863 </dd><dt class="field"><b>implicitFileCount (int)</b></dt><dd>

2814	2864

2815 <p>	2865 <p>

2816 Implicitly analyzed files.	2866 Implicitly analyzed files.

2817 </p>	2867 </p>

2818 </dd><dt class="field"><b><i>workItemQueueLength ( int )</i></b></dt>< dd>	2868 </dd><dt class="field"><b>workItemQueueLength (int)</b></dt><dd>

2819	2869

2820 <p>	2870 <p>

2821 The number of work items in the queue.	2871 The number of work items in the queue.

2822 </p>	2872 </p>

2823 </dd><dt class="field"><b><i>cacheEntryExceptions ( List<String> )</i></b></dt><dd>	2873 </dd><dt class="field"><b>cacheEntryExceptions (List<String>)</b ></dt><dd>

2824	2874

2825 <p>	2875 <p>

2826 Exceptions associated with cache entries.	2876 Exceptions associated with cache entries.

2827 </p>	2877 </p>

2828 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme nt: object</a></dt><dd>	2878 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme nt: object</a></dt><dd>

2829 <p>	2879 <p>

2830 Information about an element (something that can be declared	2880 Information about an element (something that can be declared

2831 in code).	2881 in code).

2832 </p>	2882 </p>

2833	2883

2834 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd>	2884 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a> )</b></dt><dd>

2835	2885

2836 <p>	2886 <p>

2837 The kind of the element.	2887 The kind of the element.

2838 </p>	2888 </p>

2839 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>	2889 </dd><dt class="field"><b>name (String)</b></dt><dd>

2840	2890

2841 <p>	2891 <p>

2842 The name of the element. This is typically used as the	2892 The name of the element. This is typically used as the

2843 label in the outline.	2893 label in the outline.

2844 </p>	2894 </p>

2845 </dd><dt class="field"><b><i>location ( <span style="color:#999999">op tional</span> <a href="#type_Location">Location</a> )</i></b></dt><dd>	2895 </dd><dt class="field"><b>location (<span style="color:#999999">option al</span> <a href="#type_Location">Location</a>)</b></dt><dd>

2846	2896

2847 <p>	2897 <p>

2848 The location of the name in the declaration of the	2898 The location of the name in the declaration of the

2849 element.	2899 element.

2850 </p>	2900 </p>

2851 </dd><dt class="field"><b><i>flags ( int )</i></b></dt><dd>	2901 </dd><dt class="field"><b>flags (int)</b></dt><dd>

2852	2902

2853 <p>	2903 <p>

2854 A bit-map containing the following flags:	2904 A bit-map containing the following flags:

2855 </p>	2905 </p>

2856 <ul>	2906 <ul>

2857 <li>0x01 - set if the element is explicitly or implicitly abstract </li>	2907 <li>0x01 - set if the element is explicitly or implicitly abstract </li>

2858 <li>0x02 - set if the element was declared to be ‘const’</li>	2908 <li>0x02 - set if the element was declared to be ‘const’</li>

2859 <li>0x04 - set if the element was declared to be ‘final’</li>	2909 <li>0x04 - set if the element was declared to be ‘final’</li>

2860 <li>0x08 - set if the element is a static member of a class or is a top-level function or field</li>	2910 <li>0x08 - set if the element is a static member of a class or is a top-level function or field</li>

2861 <li>0x10 - set if the element is private</li>	2911 <li>0x10 - set if the element is private</li>

2862 <li>0x20 - set if the element is deprecated</li>	2912 <li>0x20 - set if the element is deprecated</li>

2863 </ul>	2913 </ul>

2864 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	2914 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

2865	2915

2866 <p>	2916 <p>

2867 The parameter list for the element. If the element is not	2917 The parameter list for the element. If the element is not

2868 a method or function this field will not be defined. If	2918 a method or function this field will not be defined. If

2869 the element doesn't have parameters (e.g. getter), this field	2919 the element doesn't have parameters (e.g. getter), this field

2870 will not be defined. If the element has zero parameters, this	2920 will not be defined. If the element has zero parameters, this

2871 field will have a value of "()".	2921 field will have a value of "()".

2872 </p>	2922 </p>

2873 </dd><dt class="field"><b><i>returnType ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	2923 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

2874	2924

2875 <p>	2925 <p>

2876 The return type of the element. If the element is not a	2926 The return type of the element. If the element is not a

2877 method or function this field will not be defined. If the	2927 method or function this field will not be defined. If the

2878 element does not have a declared return type, this field	2928 element does not have a declared return type, this field

2879 will contain an empty string.	2929 will contain an empty string.

2880 </p>	2930 </p>

2881 </dd><dt class="field"><b><i>typeParameters ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>	2931 </dd><dt class="field"><b>typeParameters (<span style="color:#999999"> optional</span> String)</b></dt><dd>

2882	2932

2883 <p>	2933 <p>

2884 The type parameter list for the element. If the element doesn't	2934 The type parameter list for the element. If the element doesn't

2885 have type parameters, this field will not be defined.	2935 have type parameters, this field will not be defined.

2886 </p>	2936 </p>

2887 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>	2937 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>

2888 <p>	2938 <p>

2889 An enumeration of the kinds of elements.	2939 An enumeration of the kinds of elements.

2890 </p>	2940 </p>

2891	2941

2892 <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">FUN CTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><d t class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="valu e">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt c lass="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="valu e">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dd>	2942 <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">FUN CTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><d t class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="valu e">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt c lass="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="valu e">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dd>

2893	2943

2894 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>	2944 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>

2895 </dd><dt class="value">UNIT_TEST_TEST</dt><dd>	2945 </dd><dt class="value">UNIT_TEST_TEST</dt><dd>

2896	2946

2897 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>	2947 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>

2898 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition "><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>	2948 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition "><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

2899 <p>	2949 <p>

2900 A description of an executable file.	2950 A description of an executable file.

2901 </p>	2951 </p>

2902	2952

2903 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>	2953 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>

2904	2954

2905 <p>	2955 <p>

2906 The path of the executable file.	2956 The path of the executable file.

2907 </p>	2957 </p>

2908 </dd><dt class="field"><b><i>kind ( <a href="#type_ExecutableKind">Exe cutableKind</a> )</i></b></dt><dd>	2958 </dd><dt class="field"><b>kind (<a href="#type_ExecutableKind">Executa bleKind</a>)</b></dt><dd>

2909	2959

2910 <p>	2960 <p>

2911 The kind of the executable file.	2961 The kind of the executable file.

2912 </p>	2962 </p>

2913 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd>	2963 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd>

2914 <p>	2964 <p>

2915 An enumeration of the kinds of executable files.	2965 An enumeration of the kinds of executable files.

2916 </p>	2966 </p>

2917	2967

2918 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v alue">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeD efinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt> <dd>	2968 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v alue">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeD efinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt> <dd>

(...skipping 25 matching lines...) Expand all Loading...
2944 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>	2994 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>

2945 <p>	2995 <p>

2946 An enumeration of the kinds of folding regions.	2996 An enumeration of the kinds of folding regions.

2947 </p>	2997 </p>

2948	2998

2949 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd>	2999 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name ="type_FoldingRegion">FoldingRegion: object</a></dt><dd>

2950 <p>	3000 <p>

2951 A description of a region that can be folded.	3001 A description of a region that can be folded.

2952 </p>	3002 </p>

2953	3003

2954 <dl><dt class="field"><b><i>kind ( <a href="#type_FoldingKind">FoldingKind </a> )</i></b></dt><dd>	3004 <dl><dt class="field"><b>kind (<a href="#type_FoldingKind">FoldingKind</a> )</b></dt><dd>

2955	3005

2956 <p>	3006 <p>

2957 The kind of the region.	3007 The kind of the region.

2958 </p>	3008 </p>

2959 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3009 </dd><dt class="field"><b>offset (int)</b></dt><dd>

2960	3010

2961 <p>	3011 <p>

2962 The offset of the region to be folded.	3012 The offset of the region to be folded.

2963 </p>	3013 </p>

2964 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3014 </dd><dt class="field"><b>length (int)</b></dt><dd>

2965	3015

2966 <p>	3016 <p>

2967 The length of the region to be folded.	3017 The length of the region to be folded.

2968 </p>	3018 </p>

2969 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi sService">GeneralAnalysisService: String</a></dt><dd>	3019 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi sService">GeneralAnalysisService: String</a></dt><dd>

2970 <p>	3020 <p>

2971 An enumeration of the services provided by the analysis domain that ar e	3021 An enumeration of the services provided by the analysis domain that ar e

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

2973 </p>	3023 </p>

2974	3024

2975 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>	3025 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>

2976 <p>	3026 <p>

2977 A description of a region that could have special highlighting	3027 A description of a region that could have special highlighting

2978 associated with it.	3028 associated with it.

2979 </p>	3029 </p>

2980	3030

2981 <dl><dt class="field"><b><i>type ( <a href="#type_HighlightRegionType">Hig hlightRegionType</a> )</i></b></dt><dd>	3031 <dl><dt class="field"><b>type (<a href="#type_HighlightRegionType">Highlig htRegionType</a>)</b></dt><dd>

2982	3032

2983 <p>	3033 <p>

2984 The type of highlight associated with the region.	3034 The type of highlight associated with the region.

2985 </p>	3035 </p>

2986 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3036 </dd><dt class="field"><b>offset (int)</b></dt><dd>

2987	3037

2988 <p>	3038 <p>

2989 The offset of the region to be highlighted.	3039 The offset of the region to be highlighted.

2990 </p>	3040 </p>

2991 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3041 </dd><dt class="field"><b>length (int)</b></dt><dd>

2992	3042

2993 <p>	3043 <p>

2994 The length of the region to be highlighted.	3044 The length of the region to be highlighted.

2995 </p>	3045 </p>

2996 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio nType">HighlightRegionType: String</a></dt><dd>	3046 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio nType">HighlightRegionType: String</a></dt><dd>

2997 <p>	3047 <p>

2998 An enumeration of the kinds of highlighting that can be	3048 An enumeration of the kinds of highlighting that can be

2999 applied to files.	3049 applied to files.

3000 </p>	3050 </p>

3001	3051

(...skipping 142 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3144	3194

3145 <p>Only for version 2 of highlight.</p>	3195 <p>Only for version 2 of highlight.</p>

3146 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>	3196 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>

3147	3197

3148 <p>Only for version 2 of highlight.</p>	3198 <p>Only for version 2 of highlight.</p>

3149 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati on">HoverInformation: object</a></dt><dd>	3199 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati on">HoverInformation: object</a></dt><dd>

3150 <p>	3200 <p>

3151 The hover information associated with a specific location.	3201 The hover information associated with a specific location.

3152 </p>	3202 </p>

3153	3203

3154 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3204 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3155	3205

3156 <p>	3206 <p>

3157 The offset of the range of characters that encompasses the	3207 The offset of the range of characters that encompasses the

3158 cursor position and has the same hover information as the	3208 cursor position and has the same hover information as the

3159 cursor position.	3209 cursor position.

3160 </p>	3210 </p>

3161 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3211 </dd><dt class="field"><b>length (int)</b></dt><dd>

3162	3212

3163 <p>	3213 <p>

3164 The length of the range of characters that encompasses the	3214 The length of the range of characters that encompasses the

3165 cursor position and has the same hover information as the	3215 cursor position and has the same hover information as the

3166 cursor position.	3216 cursor position.

3167 </p>	3217 </p>

3168 </dd><dt class="field"><b><i>containingLibraryPath ( <span style="colo r:#999999">optional</span> String )</i></b></dt><dd>	3218 </dd><dt class="field"><b>containingLibraryPath (<span style="color:#9 99999">optional</span> String)</b></dt><dd>

3169	3219

3170 <p>	3220 <p>

3171 The path to the defining compilation unit of the library	3221 The path to the defining compilation unit of the library

3172 in which the referenced element is declared. This data is	3222 in which the referenced element is declared. This data is

3173 omitted if there is no referenced element, or if the	3223 omitted if there is no referenced element, or if the

3174 element is declared inside an HTML file.	3224 element is declared inside an HTML file.

3175 </p>	3225 </p>

3176 </dd><dt class="field"><b><i>containingLibraryName ( <span style="colo r:#999999">optional</span> String )</i></b></dt><dd>	3226 </dd><dt class="field"><b>containingLibraryName (<span style="color:#9 99999">optional</span> String)</b></dt><dd>

3177	3227

3178 <p>	3228 <p>

3179 The name of the library in which the referenced element is	3229 The name of the library in which the referenced element is

3180 declared. This data is omitted if there is no referenced	3230 declared. This data is omitted if there is no referenced

3181 element, or if the element is declared inside an HTML	3231 element, or if the element is declared inside an HTML

3182 file.	3232 file.

3183 </p>	3233 </p>

3184 </dd><dt class="field"><b><i>containingClassDescription ( <span style= "color:#999999">optional</span> String )</i></b></dt><dd>	3234 </dd><dt class="field"><b>containingClassDescription (<span style="col or:#999999">optional</span> String)</b></dt><dd>

3185	3235

3186 <p>	3236 <p>

3187 A human-readable description of the class declaring the element	3237 A human-readable description of the class declaring the element

3188 being referenced. This data is omitted if there is no referenced	3238 being referenced. This data is omitted if there is no referenced

3189 element, or if the element is not a class member.	3239 element, or if the element is not a class member.

3190 </p>	3240 </p>

3191 </dd><dt class="field"><b><i>dartdoc ( <span style="color:#999999">opt ional</span> String )</i></b></dt><dd>	3241 </dd><dt class="field"><b>dartdoc (<span style="color:#999999">optiona l</span> String)</b></dt><dd>

3192	3242

3193 <p>	3243 <p>

3194 The dartdoc associated with the referenced element. Other	3244 The dartdoc associated with the referenced element. Other

3195 than the removal of the comment delimiters, including	3245 than the removal of the comment delimiters, including

3196 leading asterisks in the case of a block comment, the	3246 leading asterisks in the case of a block comment, the

3197 dartdoc is unprocessed markdown. This data is omitted if	3247 dartdoc is unprocessed markdown. This data is omitted if

3198 there is no referenced element, or if the element has no	3248 there is no referenced element, or if the element has no

3199 dartdoc.	3249 dartdoc.

3200 </p>	3250 </p>

3201 </dd><dt class="field"><b><i>elementDescription ( <span style="color:# 999999">optional</span> String )</i></b></dt><dd>	3251 </dd><dt class="field"><b>elementDescription (<span style="color:#9999 99">optional</span> String)</b></dt><dd>

3202	3252

3203 <p>	3253 <p>

3204 A human-readable description of the element being	3254 A human-readable description of the element being

3205 referenced. This data is omitted if there is no referenced	3255 referenced. This data is omitted if there is no referenced

3206 element.	3256 element.

3207 </p>	3257 </p>

3208 </dd><dt class="field"><b><i>elementKind ( <span style="color:#999999" >optional</span> String )</i></b></dt><dd>	3258 </dd><dt class="field"><b>elementKind (<span style="color:#999999">opt ional</span> String)</b></dt><dd>

3209	3259

3210 <p>	3260 <p>

3211 A human-readable description of the kind of element being	3261 A human-readable description of the kind of element being

3212 referenced (such as “class” or “function type	3262 referenced (such as “class” or “function type

3213 alias”). This data is omitted if there is no referenced	3263 alias”). This data is omitted if there is no referenced

3214 element.	3264 element.

3215 </p>	3265 </p>

3216 </dd><dt class="field"><b><i>parameter ( <span style="color:#999999">o ptional</span> String )</i></b></dt><dd>	3266 </dd><dt class="field"><b>parameter (<span style="color:#999999">optio nal</span> String)</b></dt><dd>

3217	3267

3218 <p>	3268 <p>

3219 A human-readable description of the parameter	3269 A human-readable description of the parameter

3220 corresponding to the expression being hovered over. This	3270 corresponding to the expression being hovered over. This

3221 data is omitted if the location is not in an argument to a	3271 data is omitted if the location is not in an argument to a

3222 function.	3272 function.

3223 </p>	3273 </p>

3224 </dd><dt class="field"><b><i>propagatedType ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>	3274 </dd><dt class="field"><b>propagatedType (<span style="color:#999999"> optional</span> String)</b></dt><dd>

3225	3275

3226 <p>	3276 <p>

3227 The name of the propagated type of the expression. This	3277 The name of the propagated type of the expression. This

3228 data is omitted if the location does not correspond to an	3278 data is omitted if the location does not correspond to an

3229 expression or if there is no propagated type information.	3279 expression or if there is no propagated type information.

3230 </p>	3280 </p>

3231 </dd><dt class="field"><b><i>staticType ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	3281 </dd><dt class="field"><b>staticType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

3232	3282

3233 <p>	3283 <p>

3234 The name of the static type of the expression. This data	3284 The name of the static type of the expression. This data

3235 is omitted if the location does not correspond to an	3285 is omitted if the location does not correspond to an

3236 expression.	3286 expression.

3237 </p>	3287 </p>

3238 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla ss">ImplementedClass: object</a></dt><dd>	3288 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla ss">ImplementedClass: object</a></dt><dd>

3239 <p>	3289 <p>

3240 A description of a class that is implemented or extended.	3290 A description of a class that is implemented or extended.

3241 </p>	3291 </p>

3242	3292

3243 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3293 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3244	3294

3245 <p>	3295 <p>

3246 The offset of the name of the implemented class.	3296 The offset of the name of the implemented class.

3247 </p>	3297 </p>

3248 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3298 </dd><dt class="field"><b>length (int)</b></dt><dd>

3249	3299

3250 <p>	3300 <p>

3251 The length of the name of the implemented class.	3301 The length of the name of the implemented class.

3252 </p>	3302 </p>

3253 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem ber">ImplementedMember: object</a></dt><dd>	3303 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem ber">ImplementedMember: object</a></dt><dd>

3254 <p>	3304 <p>

3255 A description of a class member that is implemented or overridden.	3305 A description of a class member that is implemented or overridden.

3256 </p>	3306 </p>

3257	3307

3258 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3308 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3259	3309

3260 <p>	3310 <p>

3261 The offset of the name of the implemented member.	3311 The offset of the name of the implemented member.

3262 </p>	3312 </p>

3263 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3313 </dd><dt class="field"><b>length (int)</b></dt><dd>

3264	3314

3265 <p>	3315 <p>

3266 The length of the name of the implemented member.	3316 The length of the name of the implemented member.

3267 </p>	3317 </p>

3268 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou p">LinkedEditGroup: object</a></dt><dd>	3318 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou p">LinkedEditGroup: object</a></dt><dd>

3269 <p>	3319 <p>

3270 A collection of positions that should be linked (edited	3320 A collection of positions that should be linked (edited

3271 simultaneously) for the purposes of updating code after a	3321 simultaneously) for the purposes of updating code after a

3272 source change. For example, if a set of edits introduced a	3322 source change. For example, if a set of edits introduced a

3273 new variable name, the group would contain all of the	3323 new variable name, the group would contain all of the

3274 positions of the variable name so that if the client wanted	3324 positions of the variable name so that if the client wanted

3275 to let the user edit the variable name after the operation,	3325 to let the user edit the variable name after the operation,

3276 all occurrences of the name could be edited simultaneously.	3326 all occurrences of the name could be edited simultaneously.

3277 </p>	3327 </p>

3278	3328

3279 <dl><dt class="field"><b><i>positions ( List<<a href="#type_Position">P osition</a>> )</i></b></dt><dd>	3329 <dl><dt class="field"><b>positions (List<<a href="#type_Position">Posit ion</a>>)</b></dt><dd>

3280	3330

3281 <p>	3331 <p>

3282 The positions of the regions that should be edited	3332 The positions of the regions that should be edited

3283 simultaneously.	3333 simultaneously.

3284 </p>	3334 </p>

3285 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3335 </dd><dt class="field"><b>length (int)</b></dt><dd>

3286	3336

3287 <p>	3337 <p>

3288 The length of the regions that should be edited	3338 The length of the regions that should be edited

3289 simultaneously.	3339 simultaneously.

3290 </p>	3340 </p>

3291 </dd><dt class="field"><b><i>suggestions ( List<<a href="#type_Link edEditSuggestion">LinkedEditSuggestion</a>> )</i></b></dt><dd>	3341 </dd><dt class="field"><b>suggestions (List<<a href="#type_LinkedEd itSuggestion">LinkedEditSuggestion</a>>)</b></dt><dd>

3292	3342

3293 <p>	3343 <p>

3294 Pre-computed suggestions for what every region might	3344 Pre-computed suggestions for what every region might

3295 want to be changed to.	3345 want to be changed to.

3296 </p>	3346 </p>

3297 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estion">LinkedEditSuggestion: object</a></dt><dd>	3347 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estion">LinkedEditSuggestion: object</a></dt><dd>

3298 <p>	3348 <p>

3299 A suggestion of a value that could be used to replace all of	3349 A suggestion of a value that could be used to replace all of

3300 the linked edit regions in a LinkedEditGroup.	3350 the linked edit regions in a LinkedEditGroup.

3301 </p>	3351 </p>

3302	3352

3303 <dl><dt class="field"><b><i>value ( String )</i></b></dt><dd>	3353 <dl><dt class="field"><b>value (String)</b></dt><dd>

3304	3354

3305 <p>	3355 <p>

3306 The value that could be used to replace all of the linked	3356 The value that could be used to replace all of the linked

3307 edit regions.	3357 edit regions.

3308 </p>	3358 </p>

3309 </dd><dt class="field"><b><i>kind ( <a href="#type_LinkedEditSuggestio nKind">LinkedEditSuggestionKind</a> )</i></b></dt><dd>	3359 </dd><dt class="field"><b>kind (<a href="#type_LinkedEditSuggestionKin d">LinkedEditSuggestionKind</a>)</b></dt><dd>

3310	3360

3311 <p>	3361 <p>

3312 The kind of value being proposed.	3362 The kind of value being proposed.

3313 </p>	3363 </p>

3314 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estionKind">LinkedEditSuggestionKind: String</a></dt><dd>	3364 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estionKind">LinkedEditSuggestionKind: String</a></dt><dd>

3315 <p>	3365 <p>

3316 An enumeration of the kind of values that can be suggested	3366 An enumeration of the kind of values that can be suggested

3317 for a linked edit.	3367 for a linked edit.

3318 </p>	3368 </p>

3319	3369

3320 <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="typeDefini tion"><a name="type_Location">Location: object</a></dt><dd>	3370 <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="typeDefini tion"><a name="type_Location">Location: object</a></dt><dd>

3321 <p>	3371 <p>

3322 A location (character range) within a file.	3372 A location (character range) within a file.

3323 </p>	3373 </p>

3324	3374

3325 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>	3375 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>

3326	3376

3327 <p>	3377 <p>

3328 The file containing the range.	3378 The file containing the range.

3329 </p>	3379 </p>

3330 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3380 </dd><dt class="field"><b>offset (int)</b></dt><dd>

3331	3381

3332 <p>	3382 <p>

3333 The offset of the range.	3383 The offset of the range.

3334 </p>	3384 </p>

3335 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3385 </dd><dt class="field"><b>length (int)</b></dt><dd>

3336	3386

3337 <p>	3387 <p>

3338 The length of the range.	3388 The length of the range.

3339 </p>	3389 </p>

3340 </dd><dt class="field"><b><i>startLine ( int )</i></b></dt><dd>	3390 </dd><dt class="field"><b>startLine (int)</b></dt><dd>

3341	3391

3342 <p>	3392 <p>

3343 The one-based index of the line containing the first	3393 The one-based index of the line containing the first

3344 character of the range.	3394 character of the range.

3345 </p>	3395 </p>

3346 </dd><dt class="field"><b><i>startColumn ( int )</i></b></dt><dd>	3396 </dd><dt class="field"><b>startColumn (int)</b></dt><dd>

3347	3397

3348 <p>	3398 <p>

3349 The one-based index of the column containing the first	3399 The one-based index of the column containing the first

3350 character of the range.	3400 character of the range.

3351 </p>	3401 </p>

3352 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi on">NavigationRegion: object</a></dt><dd>	3402 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi on">NavigationRegion: object</a></dt><dd>

3353 <p>	3403 <p>

3354 A description of a region from which the user can navigate to	3404 A description of a region from which the user can navigate to

3355 the declaration of an element.	3405 the declaration of an element.

3356 </p>	3406 </p>

3357	3407

3358 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3408 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3359	3409

3360 <p>	3410 <p>

3361 The offset of the region from which the user can navigate.	3411 The offset of the region from which the user can navigate.

3362 </p>	3412 </p>

3363 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3413 </dd><dt class="field"><b>length (int)</b></dt><dd>

3364	3414

3365 <p>	3415 <p>

3366 The length of the region from which the user can navigate.	3416 The length of the region from which the user can navigate.

3367 </p>	3417 </p>

3368 </dd><dt class="field"><b><i>targets ( List<int> )</i></b></dt>< dd>	3418 </dd><dt class="field"><b>targets (List<int>)</b></dt><dd>

3369	3419

3370 <p>	3420 <p>

3371 The indexes of the targets (in the enclosing navigation response)	3421 The indexes of the targets (in the enclosing navigation response)

3372 to which the given region is bound. By opening the target, clients	3422 to which the given region is bound. By opening the target, clients

3373 can implement one form of navigation. This list cannot be empty.	3423 can implement one form of navigation. This list cannot be empty.

3374 </p>	3424 </p>

3375 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>	3425 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>

3376 <p>	3426 <p>

3377 A description of a target to which the user can navigate.	3427 A description of a target to which the user can navigate.

3378 </p>	3428 </p>

3379	3429

3380 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd>	3430 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a> )</b></dt><dd>

3381	3431

3382 <p>	3432 <p>

3383 The kind of the element.	3433 The kind of the element.

3384 </p>	3434 </p>

3385 </dd><dt class="field"><b><i>fileIndex ( int )</i></b></dt><dd>	3435 </dd><dt class="field"><b>fileIndex (int)</b></dt><dd>

3386	3436

3387 <p>	3437 <p>

3388 The index of the file (in the enclosing navigation response) to	3438 The index of the file (in the enclosing navigation response) to

3389 navigate to.	3439 navigate to.

3390 </p>	3440 </p>

3391 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3441 </dd><dt class="field"><b>offset (int)</b></dt><dd>

3392	3442

3393 <p>	3443 <p>

3394 The offset of the region from which the user can navigate.	3444 The offset of the region from which the user can navigate.

3395 </p>	3445 </p>

3396 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3446 </dd><dt class="field"><b>length (int)</b></dt><dd>

3397	3447

3398 <p>	3448 <p>

3399 The length of the region from which the user can navigate.	3449 The length of the region from which the user can navigate.

3400 </p>	3450 </p>

3401 </dd><dt class="field"><b><i>startLine ( int )</i></b></dt><dd>	3451 </dd><dt class="field"><b>startLine (int)</b></dt><dd>

3402	3452

3403 <p>	3453 <p>

3404 The one-based index of the line containing the first	3454 The one-based index of the line containing the first

3405 character of the region.	3455 character of the region.

3406 </p>	3456 </p>

3407 </dd><dt class="field"><b><i>startColumn ( int )</i></b></dt><dd>	3457 </dd><dt class="field"><b>startColumn (int)</b></dt><dd>

3408	3458

3409 <p>	3459 <p>

3410 The one-based index of the column containing the first	3460 The one-based index of the column containing the first

3411 character of the region.	3461 character of the region.

3412 </p>	3462 </p>

3413 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd>	3463 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd>

3414 <p>	3464 <p>

3415 A description of the references to a single element within a	3465 A description of the references to a single element within a

3416 single file.	3466 single file.

3417 </p>	3467 </p>

3418	3468

3419 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd>	3469 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>

3420	3470

3421 <p>	3471 <p>

3422 The element that was referenced.	3472 The element that was referenced.

3423 </p>	3473 </p>

3424 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt>< dd>	3474 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>

3425	3475

3426 <p>	3476 <p>

3427 The offsets of the name of the referenced element within	3477 The offsets of the name of the referenced element within

3428 the file.	3478 the file.

3429 </p>	3479 </p>

3430 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3480 </dd><dt class="field"><b>length (int)</b></dt><dd>

3431	3481

3432 <p>	3482 <p>

3433 The length of the name of the referenced element.	3483 The length of the name of the referenced element.

3434 </p>	3484 </p>

3435 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli ne: object</a></dt><dd>	3485 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli ne: object</a></dt><dd>

3436 <p>	3486 <p>

3437 An node in the outline structure of a file.	3487 An node in the outline structure of a file.

3438 </p>	3488 </p>

3439	3489

3440 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd>	3490 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>

3441	3491

3442 <p>	3492 <p>

3443 A description of the element represented by this node.	3493 A description of the element represented by this node.

3444 </p>	3494 </p>

3445 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3495 </dd><dt class="field"><b>offset (int)</b></dt><dd>

3446	3496

3447 <p>	3497 <p>

3448 The offset of the first character of the element. This is	3498 The offset of the first character of the element. This is

3449 different than the offset in the Element, which if the	3499 different than the offset in the Element, which if the

3450 offset of the name of the element. It can be used, for	3500 offset of the name of the element. It can be used, for

3451 example, to map locations in the file back to an outline.	3501 example, to map locations in the file back to an outline.

3452 </p>	3502 </p>

3453 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3503 </dd><dt class="field"><b>length (int)</b></dt><dd>

3454	3504

3455 <p>	3505 <p>

3456 The length of the element.	3506 The length of the element.

3457 </p>	3507 </p>

3458 </dd><dt class="field"><b><i>children ( <span style="color:#999999">op tional</span> List<<a href="#type_Outline">Outline</a>> )</i></b></dt><dd>	3508 </dd><dt class="field"><b>children (<span style="color:#999999">option al</span> List<<a href="#type_Outline">Outline</a>>)</b></dt><dd>

3459	3509

3460 <p>	3510 <p>

3461 The children of the node. The field will be omitted if the	3511 The children of the node. The field will be omitted if the

3462 node has no children.	3512 node has no children.

3463 </p>	3513 </p>

3464 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over ride: object</a></dt><dd>	3514 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over ride: object</a></dt><dd>

3465 <p>	3515 <p>

3466 A description of a member that overrides an inherited member.	3516 A description of a member that overrides an inherited member.

3467 </p>	3517 </p>

3468	3518

3469 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3519 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3470	3520

3471 <p>	3521 <p>

3472 The offset of the name of the overriding member.	3522 The offset of the name of the overriding member.

3473 </p>	3523 </p>

3474 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3524 </dd><dt class="field"><b>length (int)</b></dt><dd>

3475	3525

3476 <p>	3526 <p>

3477 The length of the name of the overriding member.	3527 The length of the name of the overriding member.

3478 </p>	3528 </p>

3479 </dd><dt class="field"><b><i>superclassMember ( <span style="color:#99 9999">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a> )</i ></b></dt><dd>	3529 </dd><dt class="field"><b>superclassMember (<span style="color:#999999 ">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a>)</b></dt ><dd>

3480	3530

3481 <p>	3531 <p>

3482 The member inherited from a superclass that is overridden	3532 The member inherited from a superclass that is overridden

3483 by the overriding member. The field is omitted if there is	3533 by the overriding member. The field is omitted if there is

3484 no superclass member, in which case there must be at least	3534 no superclass member, in which case there must be at least

3485 one interface member.	3535 one interface member.

3486 </p>	3536 </p>

3487 </dd><dt class="field"><b><i>interfaceMembers ( <span style="color:#99 9999">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember< /a>> )</i></b></dt><dd>	3537 </dd><dt class="field"><b>interfaceMembers (<span style="color:#999999 ">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember</a>& gt;)</b></dt><dd>

3488	3538

3489 <p>	3539 <p>

3490 The members inherited from interfaces that are overridden	3540 The members inherited from interfaces that are overridden

3491 by the overriding member. The field is omitted if there	3541 by the overriding member. The field is omitted if there

3492 are no interface members, in which case there must be a	3542 are no interface members, in which case there must be a

3493 superclass member.	3543 superclass member.

3494 </p>	3544 </p>

3495 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb er">OverriddenMember: object</a></dt><dd>	3545 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb er">OverriddenMember: object</a></dt><dd>

3496 <p>	3546 <p>

3497 A description of a member that is being overridden.	3547 A description of a member that is being overridden.

3498 </p>	3548 </p>

3499	3549

3500 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd>	3550 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>

3501	3551

3502 <p>	3552 <p>

3503 The element that is being overridden.	3553 The element that is being overridden.

3504 </p>	3554 </p>

3505 </dd><dt class="field"><b><i>className ( String )</i></b></dt><dd>	3555 </dd><dt class="field"><b>className (String)</b></dt><dd>

3506	3556

3507 <p>	3557 <p>

3508 The name of the class in which the member is defined.	3558 The name of the class in which the member is defined.

3509 </p>	3559 </p>

3510 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd>	3560 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd>

3511 <p>	3561 <p>

3512 A position within a file.	3562 A position within a file.

3513 </p>	3563 </p>

3514	3564

3515 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>	3565 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>

3516	3566

3517 <p>	3567 <p>

3518 The file containing the position.	3568 The file containing the position.

3519 </p>	3569 </p>

3520 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3570 </dd><dt class="field"><b>offset (int)</b></dt><dd>

3521	3571

3522 <p>	3572 <p>

3523 The offset of the position.	3573 The offset of the position.

3524 </p>	3574 </p>

3525 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub Status: object</a></dt><dd>	3575 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub Status: object</a></dt><dd>

3526 <p>	3576 <p>

3527 An indication of the current state of pub execution.	3577 An indication of the current state of pub execution.

3528 </p>	3578 </p>

3529	3579

3530 <dl><dt class="field"><b><i>isListingPackageDirs ( bool )</i></b></dt><dd>	3580 <dl><dt class="field"><b>isListingPackageDirs (bool)</b></dt><dd>

3531	3581

3532 <p>	3582 <p>

3533 True if the server is currently running pub to produce a list of	3583 True if the server is currently running pub to produce a list of

3534 package directories.	3584 package directories.

3535 </p>	3585 </p>

3536 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>	3586 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>

3537 <p>	3587 <p>

3538 An enumeration of the kinds of refactorings that can be	3588 An enumeration of the kinds of refactorings that can be

3539 created.	3589 created.

3540 </p>	3590 </p>

3541	3591

3542 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_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">RENA ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition">< a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a>< /dt><dd>	3592 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE RT_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">RENA ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition">< a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a>< /dt><dd>

3543 <p>	3593 <p>

3544 A description of a parameter in a method refactoring.	3594 A description of a parameter in a method refactoring.

3545 </p>	3595 </p>

3546	3596

3547 <dl><dt class="field"><b><i>id ( <span style="color:#999999">optional</spa n> String )</i></b></dt><dd>	3597 <dl><dt class="field"><b>id (<span style="color:#999999">optional</span> S tring)</b></dt><dd>

3548	3598

3549 <p>	3599 <p>

3550 The unique identifier of the parameter.	3600 The unique identifier of the parameter.

3551 Clients may omit this field for the parameters they want to add.	3601 Clients may omit this field for the parameters they want to add.

3552 </p>	3602 </p>

3553 </dd><dt class="field"><b><i>kind ( <a href="#type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind</a> )</i></b></dt><dd>	3603 </dd><dt class="field"><b>kind (<a href="#type_RefactoringMethodParame terKind">RefactoringMethodParameterKind</a>)</b></dt><dd>

3554	3604

3555 <p>	3605 <p>

3556 The kind of the parameter.	3606 The kind of the parameter.

3557 </p>	3607 </p>

3558 </dd><dt class="field"><b><i>type ( String )</i></b></dt><dd>	3608 </dd><dt class="field"><b>type (String)</b></dt><dd>

3559	3609

3560 <p>	3610 <p>

3561 The type that should be given to the parameter, or the return type	3611 The type that should be given to the parameter, or the return type

3562 of the parameter's function type.	3612 of the parameter's function type.

3563 </p>	3613 </p>

3564 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>	3614 </dd><dt class="field"><b>name (String)</b></dt><dd>

3565	3615

3566 <p>	3616 <p>

3567 The name that should be given to the parameter.	3617 The name that should be given to the parameter.

3568 </p>	3618 </p>

3569 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	3619 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

3570	3620

3571 <p>	3621 <p>

3572 The parameter list of the parameter's function type.	3622 The parameter list of the parameter's function type.

3573 If the parameter is not of a function type, this field will	3623 If the parameter is not of a function type, this field will

3574 not be defined. If the function type has zero parameters, this	3624 not be defined. If the function type has zero parameters, this

3575 field will have a value of "()".	3625 field will have a value of "()".

3576 </p>	3626 </p>

3577 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee dback">RefactoringFeedback: object</a></dt><dd>	3627 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee dback">RefactoringFeedback: object</a></dt><dd>

3578 <p>	3628 <p>

3579 An abstract superclass of all refactoring feedbacks.	3629 An abstract superclass of all refactoring feedbacks.

3580 </p>	3630 </p>

3581	3631

3582 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions" >RefactoringOptions: object</a></dt><dd>	3632 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions" >RefactoringOptions: object</a></dt><dd>

3583 <p>	3633 <p>

3584 An abstract superclass of all refactoring options.	3634 An abstract superclass of all refactoring options.

3585 </p>	3635 </p>

3586	3636

3587 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd>	3637 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd>

3588 <p>	3638 <p>

3589 An enumeration of the kinds of parameters.	3639 An enumeration of the kinds of parameters.

3590 </p>	3640 </p>

3591	3641

3592 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto ringProblem">RefactoringProblem: object</a></dt><dd>	3642 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto ringProblem">RefactoringProblem: object</a></dt><dd>

3593 <p>	3643 <p>

3594 A description of a problem related to a refactoring.	3644 A description of a problem related to a refactoring.

3595 </p>	3645 </p>

3596	3646

3597 <dl><dt class="field"><b><i>severity ( <a href="#type_RefactoringProblemSe verity">RefactoringProblemSeverity</a> )</i></b></dt><dd>	3647 <dl><dt class="field"><b>severity (<a href="#type_RefactoringProblemSeveri ty">RefactoringProblemSeverity</a>)</b></dt><dd>

3598	3648

3599 <p>	3649 <p>

3600 The severity of the problem being represented.	3650 The severity of the problem being represented.

3601 </p>	3651 </p>

3602 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>	3652 </dd><dt class="field"><b>message (String)</b></dt><dd>

3603	3653

3604 <p>	3654 <p>

3605 A human-readable description of the problem being	3655 A human-readable description of the problem being

3606 represented.	3656 represented.

3607 </p>	3657 </p>

3608 </dd><dt class="field"><b><i>location ( <span style="color:#999999">op tional</span> <a href="#type_Location">Location</a> )</i></b></dt><dd>	3658 </dd><dt class="field"><b>location (<span style="color:#999999">option al</span> <a href="#type_Location">Location</a>)</b></dt><dd>

3609	3659

3610 <p>	3660 <p>

3611 The location of the problem being represented.	3661 The location of the problem being represented.

3612 This field is omitted unless there is a specific location	3662 This field is omitted unless there is a specific location

3613 associated with the problem (such as a location where an element	3663 associated with the problem (such as a location where an element

3614 being renamed will be shadowed).	3664 being renamed will be shadowed).

3615 </p>	3665 </p>

3616 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd>	3666 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd>

3617 <p>	3667 <p>

3618 An enumeration of the severities of problems that can be	3668 An enumeration of the severities of problems that can be

3619 returned by the refactoring requests.	3669 returned by the refactoring requests.

3620 </p>	3670 </p>

3621	3671

3622 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"> <a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>	3672 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"> <a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>

3623 <p>	3673 <p>

3624 A directive to remove an existing file content overlay.	3674 A directive to remove an existing file content overlay.

3625 After processing this directive, the file contents will once	3675 After processing this directive, the file contents will once

3626 again be read from the file system.	3676 again be read from the file system.

3627 </p>	3677 </p>

3628 <p>	3678 <p>

3629 If this directive is used on a file that doesn't currently	3679 If this directive is used on a file that doesn't currently

3630 have a content overlay, it has no effect.	3680 have a content overlay, it has no effect.

3631 </p>	3681 </p>

3632	3682

3633 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a> </dt><dd>	3683 <dl><dt class="field"><b>type = "remove"</b></dt><dd></dd></dl></dd><dt cl ass="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><d d>

3634 <p>	3684 <p>

3635 An indication of a problem with the execution of the server,	3685 An indication of a problem with the execution of the server,

3636 typically in response to a request.	3686 typically in response to a request.

3637 </p>	3687 </p>

3638	3688

3639 <dl><dt class="field"><b><i>code ( <a href="#type_RequestErrorCode">Reques tErrorCode</a> )</i></b></dt><dd>	3689 <dl><dt class="field"><b>code (<a href="#type_RequestErrorCode">RequestErr orCode</a>)</b></dt><dd>

3640	3690

3641 <p>	3691 <p>

3642 A code that uniquely identifies the error that occurred.	3692 A code that uniquely identifies the error that occurred.

3643 </p>	3693 </p>

3644 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>	3694 </dd><dt class="field"><b>message (String)</b></dt><dd>

3645	3695

3646 <p>	3696 <p>

3647 A short description of the error.	3697 A short description of the error.

3648 </p>	3698 </p>

3649 </dd><dt class="field"><b><i>stackTrace ( <span style="color:#999999"> optional</span> String )</i></b></dt><dd>	3699 </dd><dt class="field"><b>stackTrace (<span style="color:#999999">opti onal</span> String)</b></dt><dd>

3650	3700

3651 <p>	3701 <p>

3652 The stack trace associated with processing the request,	3702 The stack trace associated with processing the request,

3653 used for debugging the server.	3703 used for debugging the server.

3654 </p>	3704 </p>

3655 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>	3705 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>

3656 <p>	3706 <p>

3657 An enumeration of the types of errors that can occur in the	3707 An enumeration of the types of errors that can occur in the

3658 execution of the server.	3708 execution of the server.

3659 </p>	3709 </p>

(...skipping 167 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3827	3877

3828 <p>	3878 <p>

3829 An identifier used to associate search results with a search	3879 An identifier used to associate search results with a search

3830 request.	3880 request.

3831 </p>	3881 </p>

3832 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>	3882 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>

3833 <p>	3883 <p>

3834 A single result from a search request.	3884 A single result from a search request.

3835 </p>	3885 </p>

3836	3886

3837 <dl><dt class="field"><b><i>location ( <a href="#type_Location">Location</ a> )</i></b></dt><dd>	3887 <dl><dt class="field"><b>location (<a href="#type_Location">Location</a>)< /b></dt><dd>

3838	3888

3839 <p>	3889 <p>

3840 The location of the code that matched the search criteria.	3890 The location of the code that matched the search criteria.

3841 </p>	3891 </p>

3842 </dd><dt class="field"><b><i>kind ( <a href="#type_SearchResultKind">S earchResultKind</a> )</i></b></dt><dd>	3892 </dd><dt class="field"><b>kind (<a href="#type_SearchResultKind">Searc hResultKind</a>)</b></dt><dd>

3843	3893

3844 <p>	3894 <p>

3845 The kind of element that was found or the kind of	3895 The kind of element that was found or the kind of

3846 reference that was found.	3896 reference that was found.

3847 </p>	3897 </p>

3848 </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd>	3898 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd>

3849	3899

3850 <p>	3900 <p>

3851 True if the result is a potential match but cannot be	3901 True if the result is a potential match but cannot be

3852 confirmed to be a match. For example, if all references to	3902 confirmed to be a match. For example, if all references to

3853 a method m defined in some class were requested, and a	3903 a method m defined in some class were requested, and a

3854 reference to a method m from an unknown class were found,	3904 reference to a method m from an unknown class were found,

3855 it would be marked as being a potential match.	3905 it would be marked as being a potential match.

3856 </p>	3906 </p>

3857 </dd><dt class="field"><b><i>path ( List<<a href="#type_Element">El ement</a>> )</i></b></dt><dd>	3907 </dd><dt class="field"><b>path (List<<a href="#type_Element">Elemen t</a>>)</b></dt><dd>

3858	3908

3859 <p>	3909 <p>

3860 The elements that contain the result, starting with the	3910 The elements that contain the result, starting with the

3861 most immediately enclosing ancestor and ending with the	3911 most immediately enclosing ancestor and ending with the

3862 library.	3912 library.

3863 </p>	3913 </p>

3864 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi nd">SearchResultKind: String</a></dt><dd>	3914 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi nd">SearchResultKind: String</a></dt><dd>

3865 <p>	3915 <p>

3866 An enumeration of the kinds of search results returned by the	3916 An enumeration of the kinds of search results returned by the

3867 search domain.	3917 search domain.

(...skipping 38 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3906 <p>	3956 <p>

3907 An enumeration of the services provided by the server domain.	3957 An enumeration of the services provided by the server domain.

3908 </p>	3958 </p>

3909	3959

3910 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n ame="type_SourceChange">SourceChange: object</a></dt><dd>	3960 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n ame="type_SourceChange">SourceChange: object</a></dt><dd>

3911 <p>	3961 <p>

3912 A description of a set of edits that implement a single	3962 A description of a set of edits that implement a single

3913 conceptual change.	3963 conceptual change.

3914 </p>	3964 </p>

3915	3965

3916 <dl><dt class="field"><b><i>message ( String )</i></b></dt><dd>	3966 <dl><dt class="field"><b>message (String)</b></dt><dd>

3917	3967

3918 <p>	3968 <p>

3919 A human-readable description of the change to be applied.	3969 A human-readable description of the change to be applied.

3920 </p>	3970 </p>

3921 </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceFile Edit">SourceFileEdit</a>> )</i></b></dt><dd>	3971 </dd><dt class="field"><b>edits (List<<a href="#type_SourceFileEdit ">SourceFileEdit</a>>)</b></dt><dd>

3922	3972

3923 <p>	3973 <p>

3924 A list of the edits used to effect the change, grouped by	3974 A list of the edits used to effect the change, grouped by

3925 file.	3975 file.

3926 </p>	3976 </p>

3927 </dd><dt class="field"><b><i>linkedEditGroups ( List<<a href="#type _LinkedEditGroup">LinkedEditGroup</a>> )</i></b></dt><dd>	3977 </dd><dt class="field"><b>linkedEditGroups (List<<a href="#type_Lin kedEditGroup">LinkedEditGroup</a>>)</b></dt><dd>

3928	3978

3929 <p>	3979 <p>

3930 A list of the linked editing groups used to customize	3980 A list of the linked editing groups used to customize

3931 the changes that were made.	3981 the changes that were made.

3932 </p>	3982 </p>

3933 </dd><dt class="field"><b><i>selection ( <span style="color:#999999">o ptional</span> <a href="#type_Position">Position</a> )</i></b></dt><dd>	3983 </dd><dt class="field"><b>selection (<span style="color:#999999">optio nal</span> <a href="#type_Position">Position</a>)</b></dt><dd>

3934	3984

3935 <p>	3985 <p>

3936 The position that should be selected after the edits	3986 The position that should be selected after the edits

3937 have been applied.	3987 have been applied.

3938 </p>	3988 </p>

3939 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So urceEdit: object</a></dt><dd>	3989 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So urceEdit: object</a></dt><dd>

3940 <p>	3990 <p>

3941 A description of a single change to a single file.	3991 A description of a single change to a single file.

3942 </p>	3992 </p>

3943	3993

3944 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>	3994 <dl><dt class="field"><b>offset (int)</b></dt><dd>

3945	3995

3946 <p>	3996 <p>

3947 The offset of the region to be modified.	3997 The offset of the region to be modified.

3948 </p>	3998 </p>

3949 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	3999 </dd><dt class="field"><b>length (int)</b></dt><dd>

3950	4000

3951 <p>	4001 <p>

3952 The length of the region to be modified.	4002 The length of the region to be modified.

3953 </p>	4003 </p>

3954 </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd>	4004 </dd><dt class="field"><b>replacement (String)</b></dt><dd>

3955	4005

3956 <p>	4006 <p>

3957 The code that is to replace the specified region in the	4007 The code that is to replace the specified region in the

3958 original code.	4008 original code.

3959 </p>	4009 </p>

3960 </dd><dt class="field"><b><i>id ( <span style="color:#999999">optional </span> String )</i></b></dt><dd>	4010 </dd><dt class="field"><b>id (<span style="color:#999999">optional</sp an> String)</b></dt><dd>

3961	4011

3962 <p>	4012 <p>

3963 An identifier that uniquely identifies this source edit from other	4013 An identifier that uniquely identifies this source edit from other

3964 edits in the same response. This field is omitted unless a	4014 edits in the same response. This field is omitted unless a

3965 containing structure needs to be able to identify the edit for	4015 containing structure needs to be able to identify the edit for

3966 some reason.	4016 some reason.

3967 </p>	4017 </p>

3968 <p>	4018 <p>

3969 For example, some refactoring operations can produce edits that	4019 For example, some refactoring operations can produce edits that

3970 might not be appropriate (referred to as potential edits). Such	4020 might not be appropriate (referred to as potential edits). Such

3971 edits will have an id so that they can be referenced. Edits in	4021 edits will have an id so that they can be referenced. Edits in

3972 the same response that do not need to be referenced will not have	4022 the same response that do not need to be referenced will not have

3973 an id.	4023 an id.

3974 </p>	4024 </p>

3975 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd>	4025 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd>

3976 <p>	4026 <p>

3977 A description of a set of changes to a single file.	4027 A description of a set of changes to a single file.

3978 </p>	4028 </p>

3979	4029

3980 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> ) </i></b></dt><dd>	4030 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>

3981	4031

3982 <p>	4032 <p>

3983 The file containing the code to be modified.	4033 The file containing the code to be modified.

3984 </p>	4034 </p>

3985 </dd><dt class="field"><b><i>fileStamp ( long )</i></b></dt><dd>	4035 </dd><dt class="field"><b>fileStamp (long)</b></dt><dd>

3986	4036

3987 <p>	4037 <p>

3988 The modification stamp of the file at the moment when the change	4038 The modification stamp of the file at the moment when the change

3989 was created, in milliseconds since the "Unix epoch". Will be -1 if	4039 was created, in milliseconds since the "Unix epoch". Will be -1 if

3990 the file did not exist and should be created. The client may use	4040 the file did not exist and should be created. The client may use

3991 this field to make sure that the file was not changed since then,	4041 this field to make sure that the file was not changed since then,

3992 so it is safe to apply the change.	4042 so it is safe to apply the change.

3993 </p>	4043 </p>

3994 </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit ">SourceEdit</a>> )</i></b></dt><dd>	4044 </dd><dt class="field"><b>edits (List<<a href="#type_SourceEdit">So urceEdit</a>>)</b></dt><dd>

3995	4045

3996 <p>	4046 <p>

3997 A list of the edits used to effect the change.	4047 A list of the edits used to effect the change.

3998 </p>	4048 </p>

3999 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI tem">TypeHierarchyItem: object</a></dt><dd>	4049 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI tem">TypeHierarchyItem: object</a></dt><dd>

4000 <p>	4050 <p>

4001 A representation of a class in a type hierarchy.	4051 A representation of a class in a type hierarchy.

4002 </p>	4052 </p>

4003	4053

4004 <dl><dt class="field"><b><i>classElement ( <a href="#type_Element">Element </a> )</i></b></dt><dd>	4054 <dl><dt class="field"><b>classElement (<a href="#type_Element">Element</a> )</b></dt><dd>

4005	4055

4006 <p>	4056 <p>

4007 The class element represented by this item.	4057 The class element represented by this item.

4008 </p>	4058 </p>

4009 </dd><dt class="field"><b><i>displayName ( <span style="color:#999999" >optional</span> String )</i></b></dt><dd>	4059 </dd><dt class="field"><b>displayName (<span style="color:#999999">opt ional</span> String)</b></dt><dd>

4010	4060

4011 <p>	4061 <p>

4012 The name to be displayed for the class. This field will be	4062 The name to be displayed for the class. This field will be

4013 omitted if the display name is the same as the name of the	4063 omitted if the display name is the same as the name of the

4014 element. The display name is different if there is	4064 element. The display name is different if there is

4015 additional type information to be displayed, such as type	4065 additional type information to be displayed, such as type

4016 arguments.	4066 arguments.

4017 </p>	4067 </p>

4018 </dd><dt class="field"><b><i>memberElement ( <span style="color:#99999 9">optional</span> <a href="#type_Element">Element</a> )</i></b></dt><dd>	4068 </dd><dt class="field"><b>memberElement (<span style="color:#999999">o ptional</span> <a href="#type_Element">Element</a>)</b></dt><dd>

4019	4069

4020 <p>	4070 <p>

4021 The member in the class corresponding to the member on	4071 The member in the class corresponding to the member on

4022 which the hierarchy was requested. This field will be	4072 which the hierarchy was requested. This field will be

4023 omitted if the hierarchy was not requested for a member or	4073 omitted if the hierarchy was not requested for a member or

4024 if the class does not have a corresponding member.	4074 if the class does not have a corresponding member.

4025 </p>	4075 </p>

4026 </dd><dt class="field"><b><i>superclass ( <span style="color:#999999"> optional</span> int )</i></b></dt><dd>	4076 </dd><dt class="field"><b>superclass (<span style="color:#999999">opti onal</span> int)</b></dt><dd>

4027	4077

4028 <p>	4078 <p>

4029 The index of the item representing the superclass of	4079 The index of the item representing the superclass of

4030 this class. This field will be omitted if this item	4080 this class. This field will be omitted if this item

4031 represents the class Object.	4081 represents the class Object.

4032 </p>	4082 </p>

4033 </dd><dt class="field"><b><i>interfaces ( List<int> )</i></b></d t><dd>	4083 </dd><dt class="field"><b>interfaces (List<int>)</b></dt><dd>

4034	4084

4035 <p>	4085 <p>

4036 The indexes of the items representing the interfaces	4086 The indexes of the items representing the interfaces

4037 implemented by this class. The list will be empty if	4087 implemented by this class. The list will be empty if

4038 there are no implemented interfaces.	4088 there are no implemented interfaces.

4039 </p>	4089 </p>

4040 </dd><dt class="field"><b><i>mixins ( List<int> )</i></b></dt><d d>	4090 </dd><dt class="field"><b>mixins (List<int>)</b></dt><dd>

4041	4091

4042 <p>	4092 <p>

4043 The indexes of the items representing the mixins	4093 The indexes of the items representing the mixins

4044 referenced by this class. The list will be empty if	4094 referenced by this class. The list will be empty if

4045 there are no classes mixed in to this class.	4095 there are no classes mixed in to this class.

4046 </p>	4096 </p>

4047 </dd><dt class="field"><b><i>subclasses ( List<int> )</i></b></d t><dd>	4097 </dd><dt class="field"><b>subclasses (List<int>)</b></dt><dd>

4048	4098

4049 <p>	4099 <p>

4050 The indexes of the items representing the subtypes of	4100 The indexes of the items representing the subtypes of

4051 this class. The list will be empty if there are no	4101 this class. The list will be empty if there are no

4052 subtypes or if this item represents a supertype of the	4102 subtypes or if this item represents a supertype of the

4053 pivot type.	4103 pivot type.

4054 </p>	4104 </p>

4055 </dd></dl></dd></dl>	4105 </dd></dl></dd></dl>

4056	4106

4057 <h2><a name="refactorings">Refactorings</a></h2>	4107 <h2><a name="refactorings">Refactorings</a></h2>

(...skipping 15 matching lines...) Expand all Loading...
4073	4123

4074 <dl><dt class="refactoring">CONVERT_GETTER_TO_METHOD</dt><dd>	4124 <dl><dt class="refactoring">CONVERT_GETTER_TO_METHOD</dt><dd>

4075 <p>	4125 <p>

4076 Convert a getter into a method by removing the keyword get	4126 Convert a getter into a method by removing the keyword get

4077 and adding an empty parameter list.	4127 and adding an empty parameter list.

4078 </p>	4128 </p>

4079 <p>	4129 <p>

4080 It is an error if the range contains anything other than all	4130 It is an error if the range contains anything other than all

4081 or part of the name of a single getter.	4131 or part of the name of a single getter.

4082 </p>	4132 </p>

4083 <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="ref actoring">CONVERT_METHOD_TO_GETTER</dt><dd>	4133 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><p>none</p></dd><dt class="r efactoring">CONVERT_METHOD_TO_GETTER</dt><dd>

4084 <p>	4134 <p>

4085 Convert a method into a getter by adding the keyword get and	4135 Convert a method into a getter by adding the keyword get and

4086 removing the parameter list.	4136 removing the parameter list.

4087 </p>	4137 </p>

4088 <p>	4138 <p>

4089 It is an error if the range contains anything other than all	4139 It is an error if the range contains anything other than all

4090 or part of the name of a single method or if the method has	4140 or part of the name of a single method or if the method has

4091 a non-empty parameter list.	4141 a non-empty parameter list.

4092 </p>	4142 </p>

4093 <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="ref actoring">EXTRACT_LOCAL_VARIABLE</dt><dd>	4143 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><p>none</p></dd><dt class="r efactoring">EXTRACT_LOCAL_VARIABLE</dt><dd>

4094 <p>	4144 <p>

4095 Create a local variable initialized by the expression that covers	4145 Create a local variable initialized by the expression that covers

4096 the specified selection.	4146 the specified selection.

4097 </p>	4147 </p>

4098 <p>	4148 <p>

4099 It is an error if the selection range is not covered by a	4149 It is an error if the selection range is not covered by a

4100 complete expression.	4150 complete expression.

4101 </p>	4151 </p>

4102	4152

4103	4153

4104 <h4>Feedback</h4><dl><dt class="field"><b><i>coveringExpressionOffsets ( < span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>	4154 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets (<spa n style="color:#999999">optional</span> List<int>)</b></dt><dd>

4105	4155

4106 <p>	4156 <p>

4107 The offsets of the expressions that cover the specified	4157 The offsets of the expressions that cover the specified

4108 selection, from the down most to the up most.	4158 selection, from the down most to the up most.

4109 </p>	4159 </p>

4110 </dd><dt class="field"><b><i>coveringExpressionLengths ( <span style=" color:#999999">optional</span> List<int> )</i></b></dt><dd>	4160 </dd><dt class="field"><b>coveringExpressionLengths (<span style="colo r:#999999">optional</span> List<int>)</b></dt><dd>

4111	4161

4112 <p>	4162 <p>

4113 The lengths of the expressions that cover the specified	4163 The lengths of the expressions that cover the specified

4114 selection, from the down most to the up most.	4164 selection, from the down most to the up most.

4115 </p>	4165 </p>

4116 </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt> <dd>	4166 </dd><dt class="field"><b>names (List<String>)</b></dt><dd>

4117	4167

4118 <p>	4168 <p>

4119 The proposed names for the local variable.	4169 The proposed names for the local variable.

4120 </p>	4170 </p>

4121 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt>< dd>	4171 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>

4122	4172

4123 <p>	4173 <p>

4124 The offsets of the expressions that would be replaced by	4174 The offsets of the expressions that would be replaced by

4125 a reference to the variable.	4175 a reference to the variable.

4126 </p>	4176 </p>

4127 </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt>< dd>	4177 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd>

4128	4178

4129 <p>	4179 <p>

4130 The lengths of the expressions that would be replaced by	4180 The lengths of the expressions that would be replaced by

4131 a reference to the variable. The lengths correspond to	4181 a reference to the variable. The lengths correspond to

4132 the offsets. In other words, for a given expression, if	4182 the offsets. In other words, for a given expression, if

4133 the offset of that expression is offsets[i], then the	4183 the offset of that expression is offsets[i], then the

4134 length of that expression is lengths[i].	4184 length of that expression is lengths[i].

4135 </p>	4185 </p>

4136 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>name ( String )< /i></b></dt><dd>	4186 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name (String)</b>< /dt><dd>

4137	4187

4138 <p>	4188 <p>

4139 The name that the local variable should be given.	4189 The name that the local variable should be given.

4140 </p>	4190 </p>

4141 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd>	4191 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd>

4142	4192

4143 <p>	4193 <p>

4144 True if all occurrences of the expression within the	4194 True if all occurrences of the expression within the

4145 scope in which the variable will be defined should be	4195 scope in which the variable will be defined should be

4146 replaced by a reference to the local variable. The	4196 replaced by a reference to the local variable. The

4147 expression used to initiate the refactoring will always	4197 expression used to initiate the refactoring will always

4148 be replaced.	4198 be replaced.

4149 </p>	4199 </p>

4150 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>	4200 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>

4151 <p>	4201 <p>

4152 Create a method whose body is the specified expression or	4202 Create a method whose body is the specified expression or

4153 list of statements, possibly augmented with a return	4203 list of statements, possibly augmented with a return

4154 statement.	4204 statement.

4155 </p>	4205 </p>

4156 <p>	4206 <p>

4157 It is an error if the range contains anything other than a	4207 It is an error if the range contains anything other than a

4158 complete expression (no partial expressions are allowed) or	4208 complete expression (no partial expressions are allowed) or

4159 a complete sequence of statements.	4209 a complete sequence of statements.

4160 </p>	4210 </p>

4161	4211

4162	4212

4163 <h4>Feedback</h4><dl><dt class="field"><b><i>offset ( int )</i></b></dt><d d>	4213 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd>

4164	4214

4165 <p>	4215 <p>

4166 The offset to the beginning of the expression or	4216 The offset to the beginning of the expression or

4167 statements that will be extracted.	4217 statements that will be extracted.

4168 </p>	4218 </p>

4169 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	4219 </dd><dt class="field"><b>length (int)</b></dt><dd>

4170	4220

4171 <p>	4221 <p>

4172 The length of the expression or statements that will be	4222 The length of the expression or statements that will be

4173 extracted.	4223 extracted.

4174 </p>	4224 </p>

4175 </dd><dt class="field"><b><i>returnType ( String )</i></b></dt><dd>	4225 </dd><dt class="field"><b>returnType (String)</b></dt><dd>

4176	4226

4177 <p>	4227 <p>

4178 The proposed return type for the method.	4228 The proposed return type for the method.

4179 If the returned element does not have a declared return type,	4229 If the returned element does not have a declared return type,

4180 this field will contain an empty string.	4230 this field will contain an empty string.

4181 </p>	4231 </p>

4182 </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt> <dd>	4232 </dd><dt class="field"><b>names (List<String>)</b></dt><dd>

4183	4233

4184 <p>	4234 <p>

4185 The proposed names for the method.	4235 The proposed names for the method.

4186 </p>	4236 </p>

4187 </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd>	4237 </dd><dt class="field"><b>canCreateGetter (bool)</b></dt><dd>

4188	4238

4189 <p>	4239 <p>

4190 True if a getter could be created rather than a method.	4240 True if a getter could be created rather than a method.

4191 </p>	4241 </p>

4192 </dd><dt class="field"><b><i>parameters ( List<<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>	4242 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd>

4193	4243

4194 <p>	4244 <p>

4195 The proposed parameters for the method.	4245 The proposed parameters for the method.

4196 </p>	4246 </p>

4197 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt>< dd>	4247 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>

4198	4248

4199 <p>	4249 <p>

4200 The offsets of the expressions or statements that would	4250 The offsets of the expressions or statements that would

4201 be replaced by an invocation of the method.	4251 be replaced by an invocation of the method.

4202 </p>	4252 </p>

4203 </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt>< dd>	4253 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd>

4204	4254

4205 <p>	4255 <p>

4206 The lengths of the expressions or statements that would	4256 The lengths of the expressions or statements that would

4207 be replaced by an invocation of the method. The lengths	4257 be replaced by an invocation of the method. The lengths

4208 correspond to the offsets. In other words, for a given	4258 correspond to the offsets. In other words, for a given

4209 expression (or block of statements), if the offset of	4259 expression (or block of statements), if the offset of

4210 that expression is offsets[i], then the length of that	4260 that expression is offsets[i], then the length of that

4211 expression is lengths[i].	4261 expression is lengths[i].

4212 </p>	4262 </p>

4213 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>returnType ( Str ing )</i></b></dt><dd>	4263 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType (String )</b></dt><dd>

4214	4264

4215 <p>	4265 <p>

4216 The return type that should be defined for the method.	4266 The return type that should be defined for the method.

4217 </p>	4267 </p>

4218 </dd><dt class="field"><b><i>createGetter ( bool )</i></b></dt><dd>	4268 </dd><dt class="field"><b>createGetter (bool)</b></dt><dd>

4219	4269

4220 <p>	4270 <p>

4221 True if a getter should be created rather than a	4271 True if a getter should be created rather than a

4222 method. It is an error if this field is true and the	4272 method. It is an error if this field is true and the

4223 list of parameters is non-empty.	4273 list of parameters is non-empty.

4224 </p>	4274 </p>

4225 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd>	4275 </dd><dt class="field"><b>name (String)</b></dt><dd>

4226	4276

4227 <p>	4277 <p>

4228 The name that the method should be given.	4278 The name that the method should be given.

4229 </p>	4279 </p>

4230 </dd><dt class="field"><b><i>parameters ( List<<a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>	4280 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd>

4231	4281

4232 <p>	4282 <p>

4233 The parameters that should be defined for the method.	4283 The parameters that should be defined for the method.

4234 </p>	4284 </p>

4235 <p>	4285 <p>

4236 It is an error if a REQUIRED or NAMED parameter follows a	4286 It is an error if a REQUIRED or NAMED parameter follows a

4237 POSITIONAL parameter.	4287 POSITIONAL parameter.

4238 It is an error if a REQUIRED or POSITIONAL parameter follows a	4288 It is an error if a REQUIRED or POSITIONAL parameter follows a

4239 NAMED parameter.	4289 NAMED parameter.

4240 </p>	4290 </p>

4241 <ul>	4291 <ul>

4242 <li>	4292 <li>

4243 To change the order and/or update proposed parameters, add	4293 To change the order and/or update proposed parameters, add

4244 parameters with the same identifiers as proposed.	4294 parameters with the same identifiers as proposed.

4245 </li>	4295 </li>

4246 <li>To add new parameters, omit their identifier.</li>	4296 <li>To add new parameters, omit their identifier.</li>

4247 <li>To remove some parameters, omit them in this list.</li>	4297 <li>To remove some parameters, omit them in this list.</li>

4248 </ul>	4298 </ul>

4249 </dd><dt class="field"><b><i>extractAll ( bool )</i></b></dt><dd>	4299 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd>

4250	4300

4251 <p>	4301 <p>

4252 True if all occurrences of the expression or statements	4302 True if all occurrences of the expression or statements

4253 should be replaced by an invocation of the method. The	4303 should be replaced by an invocation of the method. The

4254 expression or statements used to initiate the	4304 expression or statements used to initiate the

4255 refactoring will always be replaced.	4305 refactoring will always be replaced.

4256 </p>	4306 </p>

4257 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>	4307 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>

4258 <p>	4308 <p>

4259 Inline the initializer expression of a local variable in	4309 Inline the initializer expression of a local variable in

4260 place of any references to that variable.	4310 place of any references to that variable.

4261 </p>	4311 </p>

4262 <p>	4312 <p>

4263 It is an error if the range contains anything other than all	4313 It is an error if the range contains anything other than all

4264 or part of the name of a single local variable.	4314 or part of the name of a single local variable.

4265 </p>	4315 </p>

4266	4316

4267 <h4>Feedback</h4><dl><dt class="field"><b><i>name ( String )</i></b></dt>< dd>	4317 <h4>Feedback:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>

4268	4318

4269 <p>	4319 <p>

4270 The name of the variable being inlined.	4320 The name of the variable being inlined.

4271 </p>	4321 </p>

4272 </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd>	4322 </dd><dt class="field"><b>occurrences (int)</b></dt><dd>

4273	4323

4274 <p>	4324 <p>

4275 The number of times the variable occurs.	4325 The number of times the variable occurs.

4276 </p>	4326 </p>

4277 </dd></dl><h4>Options</h4><p>none</p></dd><dt class="refactoring">INLI NE_METHOD</dt><dd>	4327 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INL INE_METHOD</dt><dd>

4278 <p>	4328 <p>

4279 Inline a method in place of one or all references to that	4329 Inline a method in place of one or all references to that

4280 method.	4330 method.

4281 </p>	4331 </p>

4282 <p>	4332 <p>

4283 It is an error if the range contains anything other than all	4333 It is an error if the range contains anything other than all

4284 or part of the name of a single method.	4334 or part of the name of a single method.

4285 </p>	4335 </p>

4286	4336

4287	4337

4288 <h4>Feedback</h4><dl><dt class="field"><b><i>className ( <span style="colo r:#999999">optional</span> String )</i></b></dt><dd>	4338 <h4>Feedback:</h4><dl><dt class="field"><b>className (<span style="color:# 999999">optional</span> String)</b></dt><dd>

4289	4339

4290 <p>	4340 <p>

4291 The name of the class enclosing the method being inlined.	4341 The name of the class enclosing the method being inlined.

4292 If not a class member is being inlined, this field will be absent.	4342 If not a class member is being inlined, this field will be absent.

4293 </p>	4343 </p>

4294 </dd><dt class="field"><b><i>methodName ( String )</i></b></dt><dd>	4344 </dd><dt class="field"><b>methodName (String)</b></dt><dd>

4295	4345

4296 <p>	4346 <p>

4297 The name of the method (or function) being inlined.	4347 The name of the method (or function) being inlined.

4298 </p>	4348 </p>

4299 </dd><dt class="field"><b><i>isDeclaration ( bool )</i></b></dt><dd>	4349 </dd><dt class="field"><b>isDeclaration (bool)</b></dt><dd>

4300	4350

4301 <p>	4351 <p>

4302 True if the declaration of the method is selected.	4352 True if the declaration of the method is selected.

4303 So all references should be inlined.	4353 So all references should be inlined.

4304 </p>	4354 </p>

4305 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>deleteSource ( b ool )</i></b></dt><dd>	4355 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource (bool )</b></dt><dd>

4306	4356

4307 <p>	4357 <p>

4308 True if the method being inlined should be removed.	4358 True if the method being inlined should be removed.

4309 It is an error if this field is true and inlineAll is false.	4359 It is an error if this field is true and inlineAll is false.

4310 </p>	4360 </p>

4311 </dd><dt class="field"><b><i>inlineAll ( bool )</i></b></dt><dd>	4361 </dd><dt class="field"><b>inlineAll (bool)</b></dt><dd>

4312	4362

4313 <p>	4363 <p>

4314 True if all invocations of the method should be inlined,	4364 True if all invocations of the method should be inlined,

4315 or false if only the invocation site used to create this	4365 or false if only the invocation site used to create this

4316 refactoring should be inlined.	4366 refactoring should be inlined.

4317 </p>	4367 </p>

4318 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>	4368 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>

4319 <p>	4369 <p>

4320 Move the given file and update all of the references to that file	4370 Move the given file and update all of the references to that file

4321 and from it. The move operation is supported in general case - for	4371 and from it. The move operation is supported in general case - for

4322 renaming a file in the same folder, moving it to a different folder	4372 renaming a file in the same folder, moving it to a different folder

4323 or both.	4373 or both.

4324 </p>	4374 </p>

4325 <p>	4375 <p>

4326 The refactoring must be activated before an actual file moving	4376 The refactoring must be activated before an actual file moving

4327 operation is performed.	4377 operation is performed.

4328 </p>	4378 </p>

4329 <p>	4379 <p>

4330 The "offset" and "length" fields from the request are ignored, but the	4380 The "offset" and "length" fields from the request are ignored, but the

4331 file specified in the request specifies the file to be moved.	4381 file specified in the request specifies the file to be moved.

4332 </p>	4382 </p>

4333	4383

4334 <h4>Feedback</h4><p>none</p><h4>Options</h4><dl><dt class="field"><b><i>ne wFile ( <a href="#type_FilePath">FilePath</a> )</i></b></dt><dd>	4384 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>new File (<a href="#type_FilePath">FilePath</a>)</b></dt><dd>

4335	4385

4336 <p>	4386 <p>

4337 The new file path to which the given file is being moved.	4387 The new file path to which the given file is being moved.

4338 </p>	4388 </p>

4339 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>	4389 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>

4340 <p>	4390 <p>

4341 Rename a given element and all of the references to that	4391 Rename a given element and all of the references to that

4342 element.	4392 element.

4343 </p>	4393 </p>

4344 <p>	4394 <p>

4345 It is an error if the range contains anything other than all	4395 It is an error if the range contains anything other than all

4346 or part of the name of a single function (including methods,	4396 or part of the name of a single function (including methods,

4347 getters and setters), variable (including fields, parameters	4397 getters and setters), variable (including fields, parameters

4348 and local variables), class or function type.	4398 and local variables), class or function type.

4349 </p>	4399 </p>

4350	4400

4351	4401

4352 <h4>Feedback</h4><dl><dt class="field"><b><i>offset ( int )</i></b></dt><d d>	4402 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd>

4353	4403

4354 <p>	4404 <p>

4355 The offset to the beginning of the name selected to be	4405 The offset to the beginning of the name selected to be

4356 renamed.	4406 renamed.

4357 </p>	4407 </p>

4358 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>	4408 </dd><dt class="field"><b>length (int)</b></dt><dd>

4359	4409

4360 <p>	4410 <p>

4361 The length of the name selected to be renamed.	4411 The length of the name selected to be renamed.

4362 </p>	4412 </p>

4363 </dd><dt class="field"><b><i>elementKindName ( String )</i></b></dt><d d>	4413 </dd><dt class="field"><b>elementKindName (String)</b></dt><dd>

4364	4414

4365 <p>	4415 <p>

4366 The human-readable description of the kind of element being	4416 The human-readable description of the kind of element being

4367 renamed (such as “class” or “function type	4417 renamed (such as “class” or “function type

4368 alias”).	4418 alias”).

4369 </p>	4419 </p>

4370 </dd><dt class="field"><b><i>oldName ( String )</i></b></dt><dd>	4420 </dd><dt class="field"><b>oldName (String)</b></dt><dd>

4371	4421

4372 <p>	4422 <p>

4373 The old name of the element before the refactoring.	4423 The old name of the element before the refactoring.

4374 </p>	4424 </p>

4375 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>newName ( String )</i></b></dt><dd>	4425 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName (String)</ b></dt><dd>

4376	4426

4377 <p>	4427 <p>

4378 The name that the element should have after the	4428 The name that the element should have after the

4379 refactoring.	4429 refactoring.

4380 </p>	4430 </p>

4381 </dd></dl></dd></dl>	4431 </dd></dl></dd></dl>

4382 <h2>Errors</h2>	4432 <h2>Errors</h2>

4383 <p>	4433 <p>

4384 This section contains a list of all of the errors that are	4434 This section contains a list of all of the errors that are

4385 produced by the server and the data that is returned with each.	4435 produced by the server and the data that is returned with each.

4386 </p>	4436 </p>

4387 <p>	4437 <p>

4388 TBD	4438 TODO: TBD

4389 </p>	4439 </p>

4390 <h2 class="domain"><a name="index">Index</a></h2>	4440 <h2 class="domain"><a name="index">Index</a></h2>

4391 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class=" subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href=" #request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre f="#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.getReachable Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a> </li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript ions</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></l i><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.imp lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in validate</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>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re sults">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_searc h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r equest_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="#reque st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=" #request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori ng">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="su bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</ a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic"> ↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag nostic.getDiagnostics">getDiagnostics</a></li></ul></div><h3>Types (<a href="#ty pes">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay"> AddContentOverlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></l i><li><a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href= "#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_A nalysisErrorType">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_Completio nId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSug gestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestio nKind</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></l i><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_E xecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">Exe cutionContextId</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 hre f="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysis Service">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion">High lightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType< /a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a hre f="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Implement edMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEd itGroup</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_NavigationR egion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">NavigationT arget</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_Pos ition">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a h ref="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Refacto ringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions" >RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">Ref actoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refactori ngProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContent Overlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a hre f="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId" >SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a h ref="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerS ervice">ServerService</a></li><li><a href="#type_SourceChange">SourceChange</a>< /li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceF ileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierar chyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3> <div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CO NVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTE R">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARI ABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">E XTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LO CAL_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="#refacto ring_RENAME">RENAME</a></li></ul></div>	4441 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class=" subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href=" #request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre f="#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.getReachable Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a> </li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript ions</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></l i><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.imp lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in validate</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>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re sults">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_searc h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r equest_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="#reque st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=" #request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori ng">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="su bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</ a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic"> ↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag nostic.getDiagnostics">getDiagnostics</a></li></ul></div><h3>Types (<a href="#ty pes">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay"> AddContentOverlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></l i><li><a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href= "#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_A nalysisErrorType">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_Completio nId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSug gestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestio nKind</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></l i><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_E xecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">Exe cutionContextId</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 hre f="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysis Service">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion">High lightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType< /a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a hre f="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Implement edMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEd itGroup</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_NavigationR egion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">NavigationT arget</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_Pos ition">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a h ref="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Refacto ringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions" >RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">Ref actoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refactori ngProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContent Overlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a hre f="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId" >SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a h ref="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerS ervice">ServerService</a></li><li><a href="#type_SourceChange">SourceChange</a>< /li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceF ileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierar chyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3> <div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CO NVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTE R">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARI ABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">E XTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LO CAL_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="#refacto ring_RENAME">RENAME</a></li></ul></div>

4392	4442

4393	4443

4394 </body></html>	4444 </body></html>

OLD	NEW

« no previous file with comments | « no previous file | pkg/analysis_server/tool/spec/codegen_java_types.dart » ('j') | no next file with comments »