pkg/analysis_server/doc/api.html - Issue 2800283002: updates to the analysis server generated spec doc

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

Issue 2800283002: updates to the analysis server generated spec doc (Closed)

Patch Set: Created 3 years, 8 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 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co de+Pro\|Roboto:500,400italic,300,400" type="text/css"><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: 'Roboto', sans-serif;	5 font-family: 'Roboto', sans-serif;

6 max-width: 800px;	6 max-width: 800px;

7 margin: 0 auto;	7 margin: 0 auto;

8 padding: 0 16px;	8 padding: 0 16px;

9 font-size: 16px;	9 font-size: 16px;

10 line-height: 1.5;	10 line-height: 1.5;

11 color: #111;	11 color: #111;

12 background-color: #fdfdfd;	12 background-color: #fdfdfd;

13 font-weight: 300;	13 font-weight: 300;

14 -webkit-font-smoothing: auto;	14 -webkit-font-smoothing: auto;

15 }	15 }

16	16

17 h1 {

18 text-align: center;

19 }

20

21 h2, h3, h4, h5 {	17 h2, h3, h4, h5 {

22 margin-bottom: 0;	18 margin-bottom: 0;

23 }	19 }

24	20

25 h2.domain {	21 h2.domain {

26 border-bottom: 1px solid rgb(200, 200, 200);	22 border-bottom: 1px solid rgb(200, 200, 200);

27 margin-bottom: 0.5em;	23 margin-bottom: 0.5em;

28 }	24 }

29	25

30 h4 {	26 h4 {

(...skipping 55 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
86 }	82 }

87	83

88 a {	84 a {

89 text-decoration: none;	85 text-decoration: none;

90 }	86 }

91	87

92 a:focus, a:hover {	88 a:focus, a:hover {

93 text-decoration: underline;	89 text-decoration: underline;

94 }	90 }

95	91

	92 .deprecated {

	93 text-decoration: line-through;

	94 }

	95

96 /* Styles for index */	96 /* Styles for index */

97	97

98 .subindex ul {	98 .subindex ul {

99 padding-left: 0;	99 padding-left: 0;

100 margin-left: 0;	100 margin-left: 0;

101	101

102 -webkit-margin-before: 0;	102 -webkit-margin-before: 0;

103 -webkit-margin-start: 0;	103 -webkit-margin-start: 0;

104 -webkit-padding-start: 0;	104 -webkit-padding-start: 0;

105	105

(...skipping 105 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
211 field is the ‘params’ field, whose structure is dependent on the	211 field is the ‘params’ field, whose structure is dependent on the

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

213 described with each notification.	213 described with each notification.

214 </p>	214 </p>

215 <p>	215 <p>

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

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

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

219 the server supports an API before using it.	219 the server supports an API before using it.

220 </p>	220 </p>

221 <h3>Eventual Consistency</h3>

222 <p>

223 TODO: TBD

224 </p>

225 <h3>Domains</h3>	221 <h3>Domains</h3>

226 <p>	222 <p>

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

228 specified in a separate section below:	224 in a separate section below. The specifications of the API’s refer to data

229 </p>	225 structures beyond the standard JSON primitives. These data structures are

230 <ul>

231 <li><a href="#domain_server">Server</a></li>

232 <li><a href="#domain_analysis">Analysis</a></li>

233 <li><a href="#domain_completion">Completion</a></li>

234 <li><a href="#domain_search">Search</a></li>

235 <li><a href="#domain_edit">Edit</a></li>

236 <li><a href="#domain_execution">Execution</a></li>

237 <li><a href="#domain_diagnostic">Diagnostic</a></li>

238 </ul>

239 <p>

240 The specifications of the API’s refer to data structures beyond

241 the standard JSON primitives. These data structures are

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

243 </p>	227 </p>

244 <p>	228

245 To get an overview of the API, you can consult the <a href="#index">index< /a>.	229 <p><a href="#domain_server">Server</a></p><ul><li><a href="#request_server.getVe rsion">server.getVersion</a></li>

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

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

	232 </ul>

	233

	234 <p><a href="#domain_analysis">Analysis</a></p><ul><li><a href="#request_analysis .getErrors">analysis.getErrors</a></li>

	235 <li><a href="#request_analysis.getHover">analysis.getHover</a></li>

	236 <li><a href="#request_analysis.getReachableSources">analysis.getReachableSources </a></li>

	237 <li><a href="#request_analysis.getLibraryDependencies">analysis.getLibraryDepend encies</a></li>

	238 <li><a href="#request_analysis.getNavigation">analysis.getNavigation</a></li>

	239 <li><a href="#request_analysis.reanalyze">analysis.reanalyze</a></li>

	240 <li><a href="#request_analysis.setAnalysisRoots">analysis.setAnalysisRoots</a></ li>

	241 <li><a href="#request_analysis.setGeneralSubscriptions">analysis.setGeneralSubsc riptions</a></li>

	242 <li><a href="#request_analysis.setPriorityFiles">analysis.setPriorityFiles</a></ li>

	243 <li><a href="#request_analysis.setSubscriptions">analysis.setSubscriptions</a></ li>

	244 <li><a href="#request_analysis.updateContent">analysis.updateContent</a></li>

	245 <li><a class="deprecated" href="#request_analysis.updateOptions">analysis.update Options</a></li>

	246 </ul>

	247

	248 <p><a href="#domain_completion">Completion</a></p><ul><li><a href="#request_comp letion.getSuggestions">completion.getSuggestions</a></li>

	249 </ul>

	250

	251 <p><a href="#domain_search">Search</a></p><ul><li><a href="#request_search.findE lementReferences">search.findElementReferences</a></li>

	252 <li><a href="#request_search.findMemberDeclarations">search.findMemberDeclaratio ns</a></li>

	253 <li><a href="#request_search.findMemberReferences">search.findMemberReferences</ a></li>

	254 <li><a href="#request_search.findTopLevelDeclarations">search.findTopLevelDeclar ations</a></li>

	255 <li><a href="#request_search.getTypeHierarchy">search.getTypeHierarchy</a></li>

	256 </ul>

	257

	258 <p><a href="#domain_edit">Edit</a></p><ul><li><a href="#request_edit.format">edi t.format</a></li>

	259 <li><a href="#request_edit.getAssists">edit.getAssists</a></li>

	260 <li><a href="#request_edit.getAvailableRefactorings">edit.getAvailableRefactorin gs</a></li>

	261 <li><a href="#request_edit.getFixes">edit.getFixes</a></li>

	262 <li><a href="#request_edit.getRefactoring">edit.getRefactoring</a></li>

	263 <li><a href="#request_edit.getStatementCompletion">edit.getStatementCompletion</ a></li>

	264 <li><a href="#request_edit.sortMembers">edit.sortMembers</a></li>

	265 <li><a href="#request_edit.organizeDirectives">edit.organizeDirectives</a></li>

	266 </ul>

	267

	268 <p><a href="#domain_execution">Execution</a></p><ul><li><a href="#request_execut ion.createContext">execution.createContext</a></li>

	269 <li><a href="#request_execution.deleteContext">execution.deleteContext</a></li>

	270 <li><a href="#request_execution.mapUri">execution.mapUri</a></li>

	271 <li><a class="deprecated" href="#request_execution.setSubscriptions">execution.s etSubscriptions</a></li>

	272 </ul>

	273

	274 <p><a href="#domain_diagnostic">Diagnostic</a></p><ul><li><a href="#request_diag nostic.getDiagnostics">diagnostic.getDiagnostics</a></li>

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

	276 </ul>

	277

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

248 <p>	279 <p>

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

250 </p>	281 </p>

251 <h4>Options</h4>	282 <h4>Options</h4>

252 <blockquote>	283 <blockquote>

253 <dl>	284 <dl>

254 <dt>--client-id</dt>	285 <dt>--client-id</dt>

255 <dd>	286 <dd>

256 <p>	287 <p>

(...skipping 15 matching lines...) Expand all Loading...
272 the server. Used when generating error reports.	303 the server. Used when generating error reports.

273 </p>	304 </p>

274 <p>	305 <p>

275 Clients are strongly encouraged to provide this information in	306 Clients are strongly encouraged to provide this information in

276 order to improve the quality of information that can be provided	307 order to improve the quality of information that can be provided

277 to them.	308 to them.

278 </p>	309 </p>

279 </dd>	310 </dd>

280 </dl>	311 </dl>

281 <dl>	312 <dl>

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

283 <dd>	314 <dd>

284 <p><b>Deprecated</b></p>	315 <p><b>@deprecated:</b> clients should no longer pass this option in</p>

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

286 flag is not specified then notifications will be sent for all	317 flag is not specified then notifications will be sent for all

287 errors produced for all files in the actual analysis roots.	318 errors produced for all files in the actual analysis roots.

288 </dd>	319 </dd>

289 </dl>	320 </dl>

290 <dl>	321 <dl>

291 <dt>--no-index</dt>	322 <dt>--no-index</dt>

292 <dd>	323 <dd>

293 Disable the server from generating an index. If this flag is passed and an	324 Disable the server from generating an index. If this flag is passed and an

294 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED< /tt>,	325 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED< /tt>,

295 will be thrown. The set of API calls that require an index include:	326 will be thrown. The set of API calls that require an index include:

296 refactoring calls, code completions and searching.	327 refactoring calls, code completions and searching.

297	328

298 </dd>	329 </dd>

299 </dl>	330 </dl>

300 <dl>	331 <dl>

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

302 <dd>	333 <dd>

303 <p><b>Deprecated</b></p>	334 <p><b>@deprecated:</b> clients should no longer pass this option in</p>

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

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

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

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

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

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

310 <ul>	341 <ul>

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

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

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

314 </ul>	345 </ul>

315 </dd>	346 </dd>

316 </dl>	347 </dl>

317 </blockquote>	348 </blockquote>

	349 <h1>Domains</h1>

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

319 <p>	351 <p>

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

321 the server.	353 the server.

322 </p>	354 </p>

323	355

324	356

325	357

326	358

327	359

328	360

329 <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: {	361 <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion" >server.getVersion</a></dt><dd><div class="box"><pre>request: {

330 "id": String	362 "id": String

331 "method": "server.getVersion"	363 "method": "server.getVersion"

332 }</pre><br><pre>response: {	364 }</pre><br><pre>response: {

333 "id": String	365 "id": String

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

335 "result": {	367 "result": {

336 "<b>version</b>": String	368 "<b>version</b>": String

337 }	369 }

338 }</pre></div>	370 }</pre></div>

339 <p>Return the version number of the analysis server.</p>	371 <p>Return the version number of the analysis server.</p>

340	372

341 <h4>returns:</h4><dl><dt class="field"><b>version (String)</b></dt><dd>	373 <h4>returns:</h4><dl><dt class="field"><b>version: String</b></dt><dd>

342	374

343 <p>The version number of the analysis server.</p>	375 <p>The version number of the analysis server.</p>

344 </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: {	376 </dd></dl></dd><dt class="request"><a name="request_server.shutdown">s erver.shutdown</a></dt><dd><div class="box"><pre>request: {

345 "id": String	377 "id": String

346 "method": "server.shutdown"	378 "method": "server.shutdown"

347 }</pre><br><pre>response: {	379 }</pre><br><pre>response: {

348 "id": String	380 "id": String

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

350 }</pre></div>	382 }</pre></div>

351 <p>	383 <p>

352 Cleanly shutdown the analysis server. Requests that are	384 Cleanly shutdown the analysis server. Requests that are

353 received after this request will not be processed. Requests	385 received after this request will not be processed. Requests

354 that were received before this request, but for which a	386 that were received before this request, but for which a

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

356 further responses or notifications will be sent after the	388 further responses or notifications will be sent after the

357 response to this request has been sent.	389 response to this request has been sent.

358 </p>	390 </p>

359 </dd><dt class="request"><a name="request_server.setSubscriptions">server. setSubscriptions</a> (<a href="#request_server.setSubscriptions">#</a>)</dt><dd> <div class="box"><pre>request: {	391 </dd><dt class="request"><a name="request_server.setSubscriptions">server. setSubscriptions</a></dt><dd><div class="box"><pre>request: {

360 "id": String	392 "id": String

361 "method": "server.setSubscriptions"	393 "method": "server.setSubscriptions"

362 "params": {	394 "params": {

363 "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService< /a>>	395 "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService< /a>>

364 }	396 }

365 }</pre><br><pre>response: {	397 }</pre><br><pre>response: {

366 "id": String	398 "id": String

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

368 }</pre></div>	400 }</pre></div>

369 <p>	401 <p>

370 Subscribe for services. All previous subscriptions are	402 Subscribe for services. All previous subscriptions are

371 replaced by the given set of services.	403 replaced by the given set of services.

372 </p>	404 </p>

373 <p>	405 <p>

374 It is an error if any of the elements in the list are not	406 It is an error if any of the elements in the list are not

375 valid services. If there is an error, then the current	407 valid services. If there is an error, then the current

376 subscriptions will remain unchanged.	408 subscriptions will remain unchanged.

377 </p>	409 </p>

378	410

379 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_ServerService">ServerService</a>>)</b></dt><dd>	411 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre f="#type_ServerService">ServerService</a>></b></dt><dd>

380	412

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

382 </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: {	414 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_server.connected">server.connected</a></dt><dd><div class ="box"><pre>notification: {

383 "event": "server.connected"	415 "event": "server.connected"

384 "params": {	416 "params": {

385 "<b>version</b>": String	417 "<b>version</b>": String

386 "<b>pid</b>": int	418 "<b>pid</b>": int

387 "<b>sessionId</b>": <span style="color:#999999">optional</span> String	419 "<b>sessionId</b>": <span style="color:#999999">optional</span> String

388 }	420 }

389 }</pre></div>	421 }</pre></div>

390 <p>	422 <p>

391 Reports that the server is running. This notification is	423 Reports that the server is running. This notification is

392 issued once after the server has started running but before	424 issued once after the server has started running but before

393 any requests are processed to let the client know that it	425 any requests are processed to let the client know that it

394 started correctly.	426 started correctly.

395 </p>	427 </p>

396 <p>	428 <p>

397 It is not possible to subscribe to or unsubscribe from this	429 It is not possible to subscribe to or unsubscribe from this

398 notification.	430 notification.

399 </p>	431 </p>

400	432

401 <h4>parameters:</h4><dl><dt class="field"><b>version (String)</b></dt><dd>	433 <h4>parameters:</h4><dl><dt class="field"><b>version: String</b></dt><dd>

402	434

403 <p>The version number of the analysis server.</p>	435 <p>The version number of the analysis server.</p>

404 </dd><dt class="field"><b>pid (int)</b></dt><dd>	436 </dd><dt class="field"><b>pid: int</b></dt><dd>

405	437

406 <p>The process id of the analysis server process.</p>	438 <p>The process id of the analysis server process.</p>

407 </dd><dt class="field"><b>sessionId (<span style="color:#999999">option al</span> String)</b></dt><dd>	439 </dd><dt class="field"><b>sessionId: String<span style="color:#999999"> (@optional)</span></b></dt><dd>

408	440

409 <p>The session id for this session.</p>	441 <p>The session id for this session.</p>

410 </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: {	442 </dd></dl></dd><dt class="notification"><a name="notification_server.er ror">server.error</a></dt><dd><div class="box"><pre>notification: {

411 "event": "server.error"	443 "event": "server.error"

412 "params": {	444 "params": {

413 "<b>isFatal</b>": bool	445 "<b>isFatal</b>": bool

414 "<b>message</b>": String	446 "<b>message</b>": String

415 "<b>stackTrace</b>": String	447 "<b>stackTrace</b>": String

416 }	448 }

417 }</pre></div>	449 }</pre></div>

418 <p>	450 <p>

419 Reports that an unexpected error has occurred while	451 Reports that an unexpected error has occurred while

420 executing the server. This notification is not used for	452 executing the server. This notification is not used for

421 problems with specific requests (which are returned as part	453 problems with specific requests (which are returned as part

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

423 performing other tasks, such as analysis or preparing	455 performing other tasks, such as analysis or preparing

424 notifications.	456 notifications.

425 </p>	457 </p>

426 <p>	458 <p>

427 It is not possible to subscribe to or unsubscribe from this	459 It is not possible to subscribe to or unsubscribe from this

428 notification.	460 notification.

429 </p>	461 </p>

430	462

431 <h4>parameters:</h4><dl><dt class="field"><b>isFatal (bool)</b></dt><dd>	463 <h4>parameters:</h4><dl><dt class="field"><b>isFatal: bool</b></dt><dd>

432	464

433 <p>	465 <p>

434 True if the error is a fatal error, meaning that the	466 True if the error is a fatal error, meaning that the

435 server will shutdown automatically after sending this	467 server will shutdown automatically after sending this

436 notification.	468 notification.

437 </p>	469 </p>

438 </dd><dt class="field"><b>message (String)</b></dt><dd>	470 </dd><dt class="field"><b>message: String</b></dt><dd>

439	471

440 <p>	472 <p>

441 The error message indicating what kind of error was	473 The error message indicating what kind of error was

442 encountered.	474 encountered.

443 </p>	475 </p>

444 </dd><dt class="field"><b>stackTrace (String)</b></dt><dd>	476 </dd><dt class="field"><b>stackTrace: String</b></dt><dd>

445	477

446 <p>	478 <p>

447 The stack trace associated with the generation of the	479 The stack trace associated with the generation of the

448 error, used for debugging the server.	480 error, used for debugging the server.

449 </p>	481 </p>

450 </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: {	482 </dd></dl></dd><dt class="notification"><a name="notification_server.s tatus">server.status</a></dt><dd><div class="box"><pre>notification: {

451 "event": "server.status"	483 "event": "server.status"

452 "params": {	484 "params": {

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

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

455 }	487 }

456 }</pre></div>	488 }</pre></div>

457 <p>	489 <p>

458 Reports the current status of the server. Parameters are	490 Reports the current status of the server. Parameters are

459 omitted if there has been no change in the status	491 omitted if there has been no change in the status

460 represented by that parameter.	492 represented by that parameter.

461 </p>	493 </p>

462 <p>	494 <p>

463 This notification is not subscribed to by default. Clients	495 This notification is not subscribed to by default. Clients

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

465 the list of services passed in a server.setSubscriptions	497 the list of services passed in a server.setSubscriptions

466 request.	498 request.

467 </p>	499 </p>

468	500

469 <h4>parameters:</h4><dl><dt class="field"><b>analysis (<span style="color: #999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a>)</b>< /dt><dd>	501 <h4>parameters:</h4><dl><dt class="field"><b>analysis: <a href="#type_Anal ysisStatus">AnalysisStatus</a><span style="color:#999999"> (@optional)</span></b ></dt><dd>

470	502

471 <p>	503 <p>

472 The current status of analysis, including whether	504 The current status of analysis, including whether

473 analysis is being performed and if so what is being	505 analysis is being performed and if so what is being

474 analyzed.	506 analyzed.

475 </p>	507 </p>

476 </dd><dt class="field"><b>pub (<span style="color:#999999">optional</s pan> <a href="#type_PubStatus">PubStatus</a>)</b></dt><dd>	508 </dd><dt class="field"><b>pub: <a href="#type_PubStatus">PubStatus</a> <span style="color:#999999"> (@optional)</span></b></dt><dd>

477	509

478 <p>	510 <p>

479 The current status of pub execution, indicating whether we are	511 The current status of pub execution, indicating whether we are

480 currently running pub.	512 currently running pub.

481 </p>	513 </p>

482 </dd></dl></dd></dl>	514 </dd></dl></dd></dl>

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

484 <p>	516 <p>

485 The analysis domain contains API’s related to the analysis of	517 The analysis domain contains API’s related to the analysis of

486 files.	518 files.

(...skipping 14 matching lines...) Expand all Loading...
501	533

502	534

503	535

504	536

505	537

506	538

507	539

508	540

509	541

510	542

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

512 "id": String	544 "id": String

513 "method": "analysis.getErrors"	545 "method": "analysis.getErrors"

514 "params": {	546 "params": {

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

516 }	548 }

517 }</pre><br><pre>response: {	549 }</pre><br><pre>response: {

518 "id": String	550 "id": String

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

520 "result": {	552 "result": {

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

(...skipping 21 matching lines...) Expand all Loading...
543 </p>	575 </p>

544 <p>	576 <p>

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

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

547 is not associated with any analysis root specified to	579 is not associated with any analysis root specified to

548 analysis.setAnalysisRoots), an error of type	580 analysis.setAnalysisRoots), an error of type

549 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.	581 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.

550 </p>	582 </p>

551	583

552	584

553 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	585 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

554	586

555 <p>	587 <p>

556 The file for which errors are being requested.	588 The file for which errors are being requested.

557 </p>	589 </p>

558 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors (List<<a href="#type_AnalysisError">AnalysisError</a>>)</b></dt><dd>	590 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors: List<<a href="#type_AnalysisError">AnalysisError</a>></b></dt><dd>

559	591

560 <p>	592 <p>

561 The errors associated with the file.	593 The errors associated with the file.

562 </p>	594 </p>

563 </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: {	595 </dd></dl></dd><dt class="request"><a name="request_analysis.getHover" >analysis.getHover</a></dt><dd><div class="box"><pre>request: {

564 "id": String	596 "id": String

565 "method": "analysis.getHover"	597 "method": "analysis.getHover"

566 "params": {	598 "params": {

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

568 "<b>offset</b>": int	600 "<b>offset</b>": int

569 }	601 }

570 }</pre><br><pre>response: {	602 }</pre><br><pre>response: {

571 "id": String	603 "id": String

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

573 "result": {	605 "result": {

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

575 }	607 }

576 }</pre></div>	608 }</pre></div>

577 <p>	609 <p>

578 Return the hover information associate with the given	610 Return the hover information associate with the given

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

580 available at the time this request is processed the	612 available at the time this request is processed the

581 information will be omitted from the response.	613 information will be omitted from the response.

582 </p>	614 </p>

583	615

584	616

585 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	617 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

586	618

587 <p>	619 <p>

588 The file in which hover information is being requested.	620 The file in which hover information is being requested.

589 </p>	621 </p>

590 </dd><dt class="field"><b>offset (int)</b></dt><dd>	622 </dd><dt class="field"><b>offset: int</b></dt><dd>

591	623

592 <p>	624 <p>

593 The offset for which hover information is being requested.	625 The offset for which hover information is being requested.

594 </p>	626 </p>

595 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers (List<<a href="#type_HoverInformation">HoverInformation</a>>)</b></dt><dd>	627 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers: List<<a href="#type_HoverInformation">HoverInformation</a>></b></dt><dd>

596	628

597 <p>	629 <p>

598 The hover information associated with the	630 The hover information associated with the

599 location. The list will be empty if no information	631 location. The list will be empty if no information

600 could be determined for the location. The list can	632 could be determined for the location. The list can

601 contain multiple items if the file is being analyzed	633 contain multiple items if the file is being analyzed

602 in multiple contexts in conflicting ways (such as a	634 in multiple contexts in conflicting ways (such as a

603 part that is included in multiple libraries).	635 part that is included in multiple libraries).

604 </p>	636 </p>

605 </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: {	637 </dd></dl></dd><dt class="request"><a name="request_analysis.getReacha bleSources">analysis.getReachableSources</a></dt><dd><div class="box"><pre>reque st: {

606 "id": String	638 "id": String

607 "method": "analysis.getReachableSources"	639 "method": "analysis.getReachableSources"

608 "params": {	640 "params": {

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

610 }	642 }

611 }</pre><br><pre>response: {	643 }</pre><br><pre>response: {

612 "id": String	644 "id": String

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

614 "result": {	646 "result": {

615 "<b>sources</b>": Map<String, List<String>>	647 "<b>sources</b>": Map<String, List<String>>

616 }	648 }

617 }</pre></div>	649 }</pre></div>

618 <p>	650 <p>

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

620 </p>	652 </p>

621 <p>	653 <p>

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

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

624 is not associated with any analysis root specified to	656 is not associated with any analysis root specified to

625 analysis.setAnalysisRoots), an error of type	657 analysis.setAnalysisRoots), an error of type

626 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.	658 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated.

627 </p>	659 </p>

628	660

629	661

630 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	662 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

631	663

632 <p>	664 <p>

633 The file for which reachable source information is being requested .	665 The file for which reachable source information is being requested .

634 </p>	666 </p>

635 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources (Map<St ring, List<String>>)</b></dt><dd>	667 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources: Map<St ring, List<String>></b></dt><dd>

636	668

637 <p>	669 <p>

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

639 a file "foo.dart" that imports "bar.dart" would have the correspon ding mapping	671 a file "foo.dart" that imports "bar.dart" would have the correspon ding mapping

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

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

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

643 for its presence in the resulting key set.	675 for its presence in the resulting key set.

644 </p>	676 </p>

645 </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: {	677 </dd></dl></dd><dt class="request"><a name="request_analysis.getLibrar yDependencies">analysis.getLibraryDependencies</a></dt><dd><div class="box"><pre >request: {

646 "id": String	678 "id": String

647 "method": "analysis.getLibraryDependencies"	679 "method": "analysis.getLibraryDependencies"

648 }</pre><br><pre>response: {	680 }</pre><br><pre>response: {

649 "id": String	681 "id": String

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

651 "result": {	683 "result": {

652 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>>	684 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>>

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

654 }	686 }

655 }</pre></div>	687 }</pre></div>

656 <p>	688 <p>

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

658 and package URI resolution.	690 and package URI resolution.

659 </p>	691 </p>

660 <p>	692 <p>

661 Clients that are only using the libraries field should consider using th e	693 Clients that are only using the libraries field should consider using th e

662 analyzedFiles notification instead.	694 analyzedFiles notification instead.

663 </p>	695 </p>

664	696

665 <h4>returns:</h4><dl><dt class="field"><b>libraries (List<<a href="#typ e_FilePath">FilePath</a>>)</b></dt><dd>	697 <h4>returns:</h4><dl><dt class="field"><b>libraries: List<<a href="#typ e_FilePath">FilePath</a>></b></dt><dd>

666	698

667 <p>	699 <p>

668 A list of the paths of library elements referenced by	700 A list of the paths of library elements referenced by

669 files in existing analysis roots.	701 files in existing analysis roots.

670 </p>	702 </p>

671 </dd><dt class="field"><b>packageMap (Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>>)</b></dt><dd>	703 </dd><dt class="field"><b>packageMap: Map<String, Map<String, List<<a href="#type_FilePath">FilePath</a>>>></b></dt><dd>

672	704

673 <p>	705 <p>

674 A mapping from context source roots to package maps which map	706 A mapping from context source roots to package maps which map

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

676 package URI resolution.	708 package URI resolution.

677 </p>	709 </p>

678 </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: {	710 </dd></dl></dd><dt class="request"><a name="request_analysis.getNavi gation">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {

679 "id": String	711 "id": String

680 "method": "analysis.getNavigation"	712 "method": "analysis.getNavigation"

681 "params": {	713 "params": {

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

683 "<b>offset</b>": int	715 "<b>offset</b>": int

684 "<b>length</b>": int	716 "<b>length</b>": int

685 }	717 }

686 }</pre><br><pre>response: {	718 }</pre><br><pre>response: {

687 "id": String	719 "id": String

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

(...skipping 23 matching lines...) Expand all Loading...
712 </p>	744 </p>

713 <p>	745 <p>

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

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

716 is not associated with any analysis root specified to	748 is not associated with any analysis root specified to

717 analysis.setAnalysisRoots), an error of type	749 analysis.setAnalysisRoots), an error of type

718 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.	750 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated.

719 </p>	751 </p>

720	752

721	753

722 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	754 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

723	755

724 <p>	756 <p>

725 The file in which navigation information is being requested.	757 The file in which navigation information is being requested.

726 </p>	758 </p>

727 </dd><dt class="field"><b>offset (int)</b></dt><dd>	759 </dd><dt class="field"><b>offset: int</b></dt><dd>

728	760

729 <p>	761 <p>

730 The offset of the region for which navigation information is being	762 The offset of the region for which navigation information is being

731 requested.	763 requested.

732 </p>	764 </p>

733 </dd><dt class="field"><b>length (int)</b></dt><dd>	765 </dd><dt class="field"><b>length: int</b></dt><dd>

734	766

735 <p>	767 <p>

736 The length of the region for which navigation information is being	768 The length of the region for which navigation information is being

737 requested.	769 requested.

738 </p>	770 </p>

739 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files (List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd>	771 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files: List<<a href="#type_FilePath">FilePath</a>></b></dt><dd>

740	772

741 <p>	773 <p>

742 A list of the paths of files that are referenced by the navigation	774 A list of the paths of files that are referenced by the navigation

743 targets.	775 targets.

744 </p>	776 </p>

745 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa rget">NavigationTarget</a>>)</b></dt><dd>	777 </dd><dt class="field"><b>targets: List<<a href="#type_NavigationTa rget">NavigationTarget</a>></b></dt><dd>

746	778

747 <p>	779 <p>

748 A list of the navigation targets that are referenced by the	780 A list of the navigation targets that are referenced by the

749 navigation regions.	781 navigation regions.

750 </p>	782 </p>

751 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe gion">NavigationRegion</a>>)</b></dt><dd>	783 </dd><dt class="field"><b>regions: List<<a href="#type_NavigationRe gion">NavigationRegion</a>></b></dt><dd>

752	784

753 <p>	785 <p>

754 A list of the navigation regions within the requested region of	786 A list of the navigation regions within the requested region of

755 the file.	787 the file.

756 </p>	788 </p>

757 </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: {	789 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze ">analysis.reanalyze</a></dt><dd><div class="box"><pre>request: {

758 "id": String	790 "id": String

759 "method": "analysis.reanalyze"	791 "method": "analysis.reanalyze"

760 "params": {	792 "params": {

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

762 }	794 }

763 }</pre><br><pre>response: {	795 }</pre><br><pre>response: {

764 "id": String	796 "id": String

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

766 }</pre></div>	798 }</pre></div>

767 <p>	799 <p>

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

769 analysis roots. This will cause all previously computed analysis	801 analysis roots. This will cause all previously computed analysis

770 results to be discarded and recomputed, and will cause all subscribed	802 results to be discarded and recomputed, and will cause all subscribed

771 notifications to be re-sent.	803 notifications to be re-sent.

772 </p>	804 </p>

773 <p>	805 <p>

774 If no analysis roots are provided, then all current analysis roots	806 If no analysis roots are provided, then all current analysis roots

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

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

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

778 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.	810 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated.

779 </p>	811 </p>

780	812

781 <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>	813 <h4>parameters:</h4><dl><dt class="field"><b>roots: List<<a href="#type _FilePath">FilePath</a>><span style="color:#999999"> (@optional)</span></b></ dt><dd>

782	814

783 <p>	815 <p>

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

785 </p>	817 </p>

786 </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: {	818 </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalys isRoots">analysis.setAnalysisRoots</a></dt><dd><div class="box"><pre>request: {

787 "id": String	819 "id": String

788 "method": "analysis.setAnalysisRoots"	820 "method": "analysis.setAnalysisRoots"

789 "params": {	821 "params": {

790 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>>	822 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>>

791 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>>	823 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>>

792 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>>	824 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>>

793 }	825 }

794 }</pre><br><pre>response: {	826 }</pre><br><pre>response: {

795 "id": String	827 "id": String

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

(...skipping 24 matching lines...) Expand all Loading...
821 </p>	853 </p>

822 <p>	854 <p>

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

824 in the directory containing the file for a pubspec.yaml	856 in the directory containing the file for a pubspec.yaml

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

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

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

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

829 </p>	861 </p>

830	862

831 <h4>parameters:</h4><dl><dt class="field"><b>included (List<<a href="#t ype_FilePath">FilePath</a>>)</b></dt><dd>	863 <h4>parameters:</h4><dl><dt class="field"><b>included: List<<a href="#t ype_FilePath">FilePath</a>></b></dt><dd>

832	864

833 <p>	865 <p>

834 A list of the files and directories that should be	866 A list of the files and directories that should be

835 analyzed.	867 analyzed.

836 </p>	868 </p>

837 </dd><dt class="field"><b>excluded (List<<a href="#type_FilePath">F ilePath</a>>)</b></dt><dd>	869 </dd><dt class="field"><b>excluded: List<<a href="#type_FilePath">F ilePath</a>></b></dt><dd>

838	870

839 <p>	871 <p>

840 A list of the files and directories within the	872 A list of the files and directories within the

841 included directories that should not be analyzed.	873 included directories that should not be analyzed.

842 </p>	874 </p>

843 </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>	875 </dd><dt class="field"><b>packageRoots: Map<<a href="#type_FilePath ">FilePath</a>, <a href="#type_FilePath">FilePath</a>><span style="color:#999 999"> (@optional)</span></b></dt><dd>

844	876

845 <p>	877 <p>

846 A mapping from source directories to package roots	878 A mapping from source directories to package roots

847 that should override the normal package: URI resolution	879 that should override the normal package: URI resolution

848 mechanism.	880 mechanism.

849 </p>	881 </p>

850 <p>	882 <p>

851 If a package root is a directory, then	883 If a package root is a directory, then

852 the analyzer will behave as though the associated	884 the analyzer will behave as though the associated

853 source directory in the map contains a special	885 source directory in the map contains a special

(...skipping 10 matching lines...) Expand all Loading...
864 as a "--packages" parameter to the Dart VM when	896 as a "--packages" parameter to the Dart VM when

865 executing any Dart file inside the source directory.	897 executing any Dart file inside the source directory.

866 </p>	898 </p>

867 <p>	899 <p>

868 Files in any directories that are not overridden by this	900 Files in any directories that are not overridden by this

869 mapping have their package: URI's resolved using the	901 mapping have their package: URI's resolved using the

870 normal pubspec.yaml mechanism. If this field is absent,	902 normal pubspec.yaml mechanism. If this field is absent,

871 or the empty map is specified, that indicates that the	903 or the empty map is specified, that indicates that the

872 normal pubspec.yaml mechanism should always be used.	904 normal pubspec.yaml mechanism should always be used.

873 </p>	905 </p>

874 </dd></dl></dd><dt class="request"><a name="request_analysis.setGenera lSubscriptions">analysis.setGeneralSubscriptions</a> (<a href="#request_analysis .setGeneralSubscriptions">#</a>)</dt><dd><div class="box"><pre>request: {	906 </dd></dl></dd><dt class="request"><a name="request_analysis.setGenera lSubscriptions">analysis.setGeneralSubscriptions</a></dt><dd><div class="box"><p re>request: {

875 "id": String	907 "id": String

876 "method": "analysis.setGeneralSubscriptions"	908 "method": "analysis.setGeneralSubscriptions"

877 "params": {	909 "params": {

878 "<b>subscriptions</b>": List<<a href="#type_GeneralAnalysisService">Gener alAnalysisService</a>>	910 "<b>subscriptions</b>": List<<a href="#type_GeneralAnalysisService">Gener alAnalysisService</a>>

879 }	911 }

880 }</pre><br><pre>response: {	912 }</pre><br><pre>response: {

881 "id": String	913 "id": String

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

883 }</pre></div>	915 }</pre></div>

884 <p>	916 <p>

885 Subscribe for general services (that is, services that are not	917 Subscribe for general services (that is, services that are not

886 specific to individual files). All previous subscriptions are replaced	918 specific to individual files). All previous subscriptions are replaced

887 by the given set of services.	919 by the given set of services.

888 </p>	920 </p>

889 <p>	921 <p>

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

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

892 remain unchanged.	924 remain unchanged.

893 </p>	925 </p>

894	926

895 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_GeneralAnalysisService">GeneralAnalysisService</a>>)</b></dt><dd>	927 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre f="#type_GeneralAnalysisService">GeneralAnalysisService</a>></b></dt><dd>

896	928

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

898 </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: {	930 </dd></dl></dd><dt class="request"><a name="request_analysis.setPriori tyFiles">analysis.setPriorityFiles</a></dt><dd><div class="box"><pre>request: {

899 "id": String	931 "id": String

900 "method": "analysis.setPriorityFiles"	932 "method": "analysis.setPriorityFiles"

901 "params": {	933 "params": {

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

903 }	935 }

904 }</pre><br><pre>response: {	936 }</pre><br><pre>response: {

905 "id": String	937 "id": String

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

907 }</pre></div>	939 }</pre></div>

908 <p>	940 <p>

(...skipping 15 matching lines...) Expand all Loading...
924 analysis.setSubscriptions for a description of files that	956 analysis.setSubscriptions for a description of files that

925 are subject to analysis.)	957 are subject to analysis.)

926 </p>	958 </p>

927 <p>	959 <p>

928 If a requested priority file is a directory it is ignored,	960 If a requested priority file is a directory it is ignored,

929 but remains in the set of requested priority files so that	961 but remains in the set of requested priority files so that

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

931 actual priority files.	963 actual priority files.

932 </p>	964 </p>

933	965

934 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type _FilePath">FilePath</a>>)</b></dt><dd>	966 <h4>parameters:</h4><dl><dt class="field"><b>files: List<<a href="#type _FilePath">FilePath</a>></b></dt><dd>

935	967

936 <p>	968 <p>

937 The files that are to be a priority for analysis.	969 The files that are to be a priority for analysis.

938 </p>	970 </p>

939 </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: {	971 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscr iptions">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: {

940 "id": String	972 "id": String

941 "method": "analysis.setSubscriptions"	973 "method": "analysis.setSubscriptions"

942 "params": {	974 "params": {

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

944 }	976 }

945 }</pre><br><pre>response: {	977 }</pre><br><pre>response: {

946 "id": String	978 "id": String

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

948 }</pre></div>	980 }</pre></div>

949 <p>	981 <p>

(...skipping 23 matching lines...) Expand all Loading...
973 but remains in the set of requested subscriptions so that if	1005 but remains in the set of requested subscriptions so that if

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

975 actual subscriptions.	1007 actual subscriptions.

976 </p>	1008 </p>

977 <p>	1009 <p>

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

979 services. If there is an error, then the existing	1011 services. If there is an error, then the existing

980 subscriptions will remain unchanged.	1012 subscriptions will remain unchanged.

981 </p>	1013 </p>

982	1014

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

984	1016

985 <p>	1017 <p>

986 A table mapping services to a list of the files being	1018 A table mapping services to a list of the files being

987 subscribed to the service.	1019 subscribed to the service.

988 </p>	1020 </p>

989 </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: {	1021 </dd></dl></dd><dt class="request"><a name="request_analysis.updateCon tent">analysis.updateContent</a></dt><dd><div class="box"><pre>request: {

990 "id": String	1022 "id": String

991 "method": "analysis.updateContent"	1023 "method": "analysis.updateContent"

992 "params": {	1024 "params": {

993 "<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>>	1025 "<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>>

994 }	1026 }

995 }</pre><br><pre>response: {	1027 }</pre><br><pre>response: {

996 "id": String	1028 "id": String

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

998 "result": {	1030 "result": {

999 }	1031 }

1000 }</pre></div>	1032 }</pre></div>

1001 <p>	1033 <p>

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

1003 previously updated but not included in this update remain	1035 previously updated but not included in this update remain

1004 unchanged. This effectively represents an overlay of the	1036 unchanged. This effectively represents an overlay of the

1005 filesystem. The files whose content is overridden are	1037 filesystem. The files whose content is overridden are

1006 therefore seen by server as being files with the given	1038 therefore seen by server as being files with the given

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

1008 if the file path represents the path to a directory on the	1040 if the file path represents the path to a directory on the

1009 filesystem.	1041 filesystem.

1010 </p>	1042 </p>

1011	1043

1012	1044

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

1014	1046

1015 <p>	1047 <p>

1016 A table mapping the files whose content has changed to a	1048 A table mapping the files whose content has changed to a

1017 description of the content change.	1049 description of the content change.

1018 </p>	1050 </p>

1019 </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: {	1051 </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request deprecated "><a name="request_analysis.updateOptions">analysis.updateOptions</a></dt><dd><d iv class="box"><pre>request: {

1020 "id": String	1052 "id": String

1021 "method": "analysis.updateOptions"	1053 "method": "analysis.updateOptions"

1022 "params": {	1054 "params": {

1023 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>	1055 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>

1024 }	1056 }

1025 }</pre><br><pre>response: {	1057 }</pre><br><pre>response: {

1026 "id": String	1058 "id": String

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

1028 }</pre></div>	1060 }</pre></div>

1029 <p><b><i>Deprecated</i></b>: all of the options can be set by users in	1061 <p><b><i>@deprecated:</i></b> all of the options can be set by users in

1030 an analysis options file.</p>	1062 an analysis options file.</p>

1031 <p>	1063 <p>

1032 Update the options controlling analysis based on the given	1064 Update the options controlling analysis based on the given

1033 set of options. Any options that are not included in the	1065 set of options. Any options that are not included in the

1034 analysis options will not be changed. If there are options	1066 analysis options will not be changed. If there are options

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

1036 silently ignored.	1068 silently ignored.

1037 </p>	1069 </p>

1038	1070

1039 <h4>parameters:</h4><dl><dt class="field"><b>options (<a href="#type_Analy sisOptions">AnalysisOptions</a>)</b></dt><dd>	1071 <h4>parameters:</h4><dl><dt class="field"><b>options: <a href="#type_Analy sisOptions">AnalysisOptions</a></b></dt><dd>

1040	1072

1041 <p>	1073 <p>

1042 The options that are to be used to control analysis.	1074 The options that are to be used to control analysis.

1043 </p>	1075 </p>

1044 </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: {	1076 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a></dt><d d><div class="box"><pre>notification: {

1045 "event": "analysis.analyzedFiles"	1077 "event": "analysis.analyzedFiles"

1046 "params": {	1078 "params": {

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

1048 }	1080 }

1049 }</pre></div>	1081 }</pre></div>

1050 <p>	1082 <p>

1051 Reports the paths of the files that are being analyzed.	1083 Reports the paths of the files that are being analyzed.

1052 </p>	1084 </p>

1053 <p>	1085 <p>

1054 This notification is not subscribed to by default. Clients can	1086 This notification is not subscribed to by default. Clients can

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

1056 of services passed in an analysis.setGeneralSubscriptions request.	1088 of services passed in an analysis.setGeneralSubscriptions request.

1057 </p>	1089 </p>

1058	1090

1059 <h4>parameters:</h4><dl><dt class="field"><b>directories (List<<a href= "#type_FilePath">FilePath</a>>)</b></dt><dd>	1091 <h4>parameters:</h4><dl><dt class="field"><b>directories: List<<a href= "#type_FilePath">FilePath</a>></b></dt><dd>

1060	1092

1061 <p>	1093 <p>

1062 A list of the paths of the files that are being analyzed.	1094 A list of the paths of the files that are being analyzed.

1063 </p>	1095 </p>

1064 </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: {	1096 </dd></dl></dd><dt class="notification"><a name="notification_analys is.errors">analysis.errors</a></dt><dd><div class="box"><pre>notification: {

1065 "event": "analysis.errors"	1097 "event": "analysis.errors"

1066 "params": {	1098 "params": {

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

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

1069 }	1101 }

1070 }</pre></div>	1102 }</pre></div>

1071 <p>	1103 <p>

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

1073 errors included in the notification is always a complete	1105 errors included in the notification is always a complete

1074 list that supersedes any previously reported errors.	1106 list that supersedes any previously reported errors.

1075 </p>	1107 </p>

1076	1108

1077 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1109 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1078	1110

1079 <p>	1111 <p>

1080 The file containing the errors.	1112 The file containing the errors.

1081 </p>	1113 </p>

1082 </dd><dt class="field"><b>errors (List<<a href="#type_AnalysisError ">AnalysisError</a>>)</b></dt><dd>	1114 </dd><dt class="field"><b>errors: List<<a href="#type_AnalysisError ">AnalysisError</a>></b></dt><dd>

1083	1115

1084 <p>	1116 <p>

1085 The errors contained in the file.	1117 The errors contained in the file.

1086 </p>	1118 </p>

1087 </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: {	1119 </dd></dl></dd><dt class="notification"><a name="notification_analysis .flushResults">analysis.flushResults</a></dt><dd><div class="box"><pre>notificat ion: {

1088 "event": "analysis.flushResults"	1120 "event": "analysis.flushResults"

1089 "params": {	1121 "params": {

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

1091 }	1123 }

1092 }</pre></div>	1124 }</pre></div>

1093 <p>	1125 <p>

1094 Reports that any analysis results that were previously	1126 Reports that any analysis results that were previously

1095 associated with the given files should be considered to be	1127 associated with the given files should be considered to be

1096 invalid because those files are no longer being analyzed,	1128 invalid because those files are no longer being analyzed,

1097 either because the analysis root that contained it is no	1129 either because the analysis root that contained it is no

1098 longer being analyzed or because the file no longer exists.	1130 longer being analyzed or because the file no longer exists.

1099 </p>	1131 </p>

1100 <p>	1132 <p>

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

1102 time a notification with results for the file is received,	1134 time a notification with results for the file is received,

1103 clients should assume that the file is once again being	1135 clients should assume that the file is once again being

1104 analyzed and the information should be processed.	1136 analyzed and the information should be processed.

1105 </p>	1137 </p>

1106 <p>	1138 <p>

1107 It is not possible to subscribe to or unsubscribe from this	1139 It is not possible to subscribe to or unsubscribe from this

1108 notification.	1140 notification.

1109 </p>	1141 </p>

1110	1142

1111 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type _FilePath">FilePath</a>>)</b></dt><dd>	1143 <h4>parameters:</h4><dl><dt class="field"><b>files: List<<a href="#type _FilePath">FilePath</a>></b></dt><dd>

1112	1144

1113 <p>	1145 <p>

1114 The files that are no longer being analyzed.	1146 The files that are no longer being analyzed.

1115 </p>	1147 </p>

1116 </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: {	1148 </dd></dl></dd><dt class="notification"><a name="notification_analysis .folding">analysis.folding</a></dt><dd><div class="box"><pre>notification: {

1117 "event": "analysis.folding"	1149 "event": "analysis.folding"

1118 "params": {	1150 "params": {

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

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

1121 }	1153 }

1122 }</pre></div>	1154 }</pre></div>

1123 <p>	1155 <p>

1124 Reports the folding regions associated with a given	1156 Reports the folding regions associated with a given

1125 file. Folding regions can be nested, but will not be	1157 file. Folding regions can be nested, but will not be

1126 overlapping. Nesting occurs when a foldable element, such as	1158 overlapping. Nesting occurs when a foldable element, such as

1127 a method, is nested inside another foldable element such as	1159 a method, is nested inside another foldable element such as

1128 a class.	1160 a class.

1129 </p>	1161 </p>

1130 <p>	1162 <p>

1131 This notification is not subscribed to by default. Clients	1163 This notification is not subscribed to by default. Clients

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

1133 the list of services passed in an analysis.setSubscriptions	1165 the list of services passed in an analysis.setSubscriptions

1134 request.	1166 request.

1135 </p>	1167 </p>

1136	1168

1137 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1169 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1138	1170

1139 <p>	1171 <p>

1140 The file containing the folding regions.	1172 The file containing the folding regions.

1141 </p>	1173 </p>

1142 </dd><dt class="field"><b>regions (List<<a href="#type_FoldingRegio n">FoldingRegion</a>>)</b></dt><dd>	1174 </dd><dt class="field"><b>regions: List<<a href="#type_FoldingRegio n">FoldingRegion</a>></b></dt><dd>

1143	1175

1144 <p>	1176 <p>

1145 The folding regions contained in the file.	1177 The folding regions contained in the file.

1146 </p>	1178 </p>

1147 </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: {	1179 </dd></dl></dd><dt class="notification"><a name="notification_analysis .highlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification: {

1148 "event": "analysis.highlights"	1180 "event": "analysis.highlights"

1149 "params": {	1181 "params": {

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

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

1152 }	1184 }

1153 }</pre></div>	1185 }</pre></div>

1154 <p>	1186 <p>

1155 Reports the highlight regions associated with a given file.	1187 Reports the highlight regions associated with a given file.

1156 </p>	1188 </p>

1157 <p>	1189 <p>

1158 This notification is not subscribed to by default. Clients	1190 This notification is not subscribed to by default. Clients

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

1160 in the list of services passed in an	1192 in the list of services passed in an

1161 analysis.setSubscriptions request.	1193 analysis.setSubscriptions request.

1162 </p>	1194 </p>

1163	1195

1164 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1196 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1165	1197

1166 <p>	1198 <p>

1167 The file containing the highlight regions.	1199 The file containing the highlight regions.

1168 </p>	1200 </p>

1169 </dd><dt class="field"><b>regions (List<<a href="#type_HighlightReg ion">HighlightRegion</a>>)</b></dt><dd>	1201 </dd><dt class="field"><b>regions: List<<a href="#type_HighlightReg ion">HighlightRegion</a>></b></dt><dd>

1170	1202

1171 <p>	1203 <p>

1172 The highlight regions contained in the file. Each	1204 The highlight regions contained in the file. Each

1173 highlight region represents a particular syntactic or	1205 highlight region represents a particular syntactic or

1174 semantic meaning associated with some range. Note that	1206 semantic meaning associated with some range. Note that

1175 the highlight regions that are returned can overlap	1207 the highlight regions that are returned can overlap

1176 other highlight regions if there is more than one	1208 other highlight regions if there is more than one

1177 meaning associated with a particular region.	1209 meaning associated with a particular region.

1178 </p>	1210 </p>

1179 </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: {	1211 </dd></dl></dd><dt class="notification"><a name="notification_analysis .implemented">analysis.implemented</a></dt><dd><div class="box"><pre>notificatio n: {

1180 "event": "analysis.implemented"	1212 "event": "analysis.implemented"

1181 "params": {	1213 "params": {

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

1183 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass< /a>>	1215 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass< /a>>

1184 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe r</a>>	1216 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe r</a>>

1185 }	1217 }

1186 }</pre></div>	1218 }</pre></div>

1187 <p>	1219 <p>

1188 Reports the classes that are implemented or extended and	1220 Reports the classes that are implemented or extended and

1189 class members that are implemented or overridden in a file.	1221 class members that are implemented or overridden in a file.

1190 </p>	1222 </p>

1191 <p>	1223 <p>

1192 This notification is not subscribed to by default. Clients	1224 This notification is not subscribed to by default. Clients

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

1194 the list of services passed in an analysis.setSubscriptions	1226 the list of services passed in an analysis.setSubscriptions

1195 request.	1227 request.

1196 </p>	1228 </p>

1197	1229

1198 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1230 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1199	1231

1200 <p>	1232 <p>

1201 The file with which the implementations are associated.	1233 The file with which the implementations are associated.

1202 </p>	1234 </p>

1203 </dd><dt class="field"><b>classes (List<<a href="#type_ImplementedC lass">ImplementedClass</a>>)</b></dt><dd>	1235 </dd><dt class="field"><b>classes: List<<a href="#type_ImplementedC lass">ImplementedClass</a>></b></dt><dd>

1204	1236

1205 <p>	1237 <p>

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

1207 </p>	1239 </p>

1208 </dd><dt class="field"><b>members (List<<a href="#type_ImplementedM ember">ImplementedMember</a>>)</b></dt><dd>	1240 </dd><dt class="field"><b>members: List<<a href="#type_ImplementedM ember">ImplementedMember</a>></b></dt><dd>

1209	1241

1210 <p>	1242 <p>

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

1212 </p>	1244 </p>

1213 </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: {	1245 </dd></dl></dd><dt class="notification"><a name="notification_analysis .invalidate">analysis.invalidate</a></dt><dd><div class="box"><pre>notification: {

1214 "event": "analysis.invalidate"	1246 "event": "analysis.invalidate"

1215 "params": {	1247 "params": {

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

1217 "<b>offset</b>": int	1249 "<b>offset</b>": int

1218 "<b>length</b>": int	1250 "<b>length</b>": int

1219 "<b>delta</b>": int	1251 "<b>delta</b>": int

1220 }	1252 }

1221 }</pre></div>	1253 }</pre></div>

1222 <p>	1254 <p>

1223 Reports that the navigation information associated with a region of a	1255 Reports that the navigation information associated with a region of a

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

1225 </p>	1257 </p>

1226 <p>	1258 <p>

1227 This notification is not subscribed to by default. Clients can	1259 This notification is not subscribed to by default. Clients can

1228 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of	1260 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of

1229 services passed in an analysis.setSubscriptions request.	1261 services passed in an analysis.setSubscriptions request.

1230 </p>	1262 </p>

1231	1263

1232 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1264 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1233	1265

1234 <p>	1266 <p>

1235 The file whose information has been invalidated.	1267 The file whose information has been invalidated.

1236 </p>	1268 </p>

1237 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1269 </dd><dt class="field"><b>offset: int</b></dt><dd>

1238	1270

1239 <p>	1271 <p>

1240 The offset of the invalidated region.	1272 The offset of the invalidated region.

1241 </p>	1273 </p>

1242 </dd><dt class="field"><b>length (int)</b></dt><dd>	1274 </dd><dt class="field"><b>length: int</b></dt><dd>

1243	1275

1244 <p>	1276 <p>

1245 The length of the invalidated region.	1277 The length of the invalidated region.

1246 </p>	1278 </p>

1247 </dd><dt class="field"><b>delta (int)</b></dt><dd>	1279 </dd><dt class="field"><b>delta: int</b></dt><dd>

1248	1280

1249 <p>	1281 <p>

1250 The delta to be applied to the offsets in information that follows	1282 The delta to be applied to the offsets in information that follows

1251 the invalidated region in order to update it so that it doesn't	1283 the invalidated region in order to update it so that it doesn't

1252 need to be re-requested.	1284 need to be re-requested.

1253 </p>	1285 </p>

1254 </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: {	1286 </dd></dl></dd><dt class="notification"><a name="notification_analysis .navigation">analysis.navigation</a></dt><dd><div class="box"><pre>notification: {

1255 "event": "analysis.navigation"	1287 "event": "analysis.navigation"

1256 "params": {	1288 "params": {

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

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

1259 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget< /a>>	1291 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget< /a>>

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

1261 }	1293 }

1262 }</pre></div>	1294 }</pre></div>

1263 <p>	1295 <p>

1264 Reports the navigation targets associated with a given file.	1296 Reports the navigation targets associated with a given file.

1265 </p>	1297 </p>

1266 <p>	1298 <p>

1267 This notification is not subscribed to by default. Clients	1299 This notification is not subscribed to by default. Clients

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

1269 in the list of services passed in an	1301 in the list of services passed in an

1270 analysis.setSubscriptions request.	1302 analysis.setSubscriptions request.

1271 </p>	1303 </p>

1272	1304

1273 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1305 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1274	1306

1275 <p>	1307 <p>

1276 The file containing the navigation regions.	1308 The file containing the navigation regions.

1277 </p>	1309 </p>

1278 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe gion">NavigationRegion</a>>)</b></dt><dd>	1310 </dd><dt class="field"><b>regions: List<<a href="#type_NavigationRe gion">NavigationRegion</a>></b></dt><dd>

1279	1311

1280 <p>	1312 <p>

1281 The navigation regions contained in the file.	1313 The navigation regions contained in the file.

1282 The regions are sorted by their offsets.	1314 The regions are sorted by their offsets.

1283 Each navigation region represents a list of targets	1315 Each navigation region represents a list of targets

1284 associated with some range. The lists will usually	1316 associated with some range. The lists will usually

1285 contain a single target, but can contain more in the	1317 contain a single target, but can contain more in the

1286 case of a part that is included in multiple libraries	1318 case of a part that is included in multiple libraries

1287 or in Dart code that is compiled against multiple	1319 or in Dart code that is compiled against multiple

1288 versions of a package. Note that the navigation	1320 versions of a package. Note that the navigation

1289 regions that are returned do not overlap other	1321 regions that are returned do not overlap other

1290 navigation regions.	1322 navigation regions.

1291 </p>	1323 </p>

1292 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa rget">NavigationTarget</a>>)</b></dt><dd>	1324 </dd><dt class="field"><b>targets: List<<a href="#type_NavigationTa rget">NavigationTarget</a>></b></dt><dd>

1293	1325

1294 <p>	1326 <p>

1295 The navigation targets referenced in the file.	1327 The navigation targets referenced in the file.

1296 They are referenced by <tt>NavigationRegion</tt>s by their	1328 They are referenced by <tt>NavigationRegion</tt>s by their

1297 index in this array.	1329 index in this array.

1298 </p>	1330 </p>

1299 </dd><dt class="field"><b>files (List<<a href="#type_FilePath">File Path</a>>)</b></dt><dd>	1331 </dd><dt class="field"><b>files: List<<a href="#type_FilePath">File Path</a>></b></dt><dd>

1300	1332

1301 <p>	1333 <p>

1302 The files containing navigation targets referenced in the file.	1334 The files containing navigation targets referenced in the file.

1303 They are referenced by <tt>NavigationTarget</tt>s by their	1335 They are referenced by <tt>NavigationTarget</tt>s by their

1304 index in this array.	1336 index in this array.

1305 </p>	1337 </p>

1306 </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: {	1338 </dd></dl></dd><dt class="notification"><a name="notification_analysis .occurrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notificatio n: {

1307 "event": "analysis.occurrences"	1339 "event": "analysis.occurrences"

1308 "params": {	1340 "params": {

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

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

1311 }	1343 }

1312 }</pre></div>	1344 }</pre></div>

1313 <p>	1345 <p>

1314 Reports the occurrences of references to elements within a	1346 Reports the occurrences of references to elements within a

1315 single file.	1347 single file.

1316 </p>	1348 </p>

1317 <p>	1349 <p>

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

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

1320 in the list of services passed in an	1352 in the list of services passed in an

1321 analysis.setSubscriptions request.	1353 analysis.setSubscriptions request.

1322 </p>	1354 </p>

1323	1355

1324 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1356 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1325	1357

1326 <p>	1358 <p>

1327 The file in which the references occur.	1359 The file in which the references occur.

1328 </p>	1360 </p>

1329 </dd><dt class="field"><b>occurrences (List<<a href="#type_Occurren ces">Occurrences</a>>)</b></dt><dd>	1361 </dd><dt class="field"><b>occurrences: List<<a href="#type_Occurren ces">Occurrences</a>></b></dt><dd>

1330	1362

1331 <p>	1363 <p>

1332 The occurrences of references to elements within the	1364 The occurrences of references to elements within the

1333 file.	1365 file.

1334 </p>	1366 </p>

1335 </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: {	1367 </dd></dl></dd><dt class="notification"><a name="notification_analysis .outline">analysis.outline</a></dt><dd><div class="box"><pre>notification: {

1336 "event": "analysis.outline"	1368 "event": "analysis.outline"

1337 "params": {	1369 "params": {

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

1339 "<b>kind</b>": <a href="#type_FileKind">FileKind</a>	1371 "<b>kind</b>": <a href="#type_FileKind">FileKind</a>

1340 "<b>libraryName</b>": <span style="color:#999999">optional</span> String	1372 "<b>libraryName</b>": <span style="color:#999999">optional</span> String

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

1342 }	1374 }

1343 }</pre></div>	1375 }</pre></div>

1344 <p>	1376 <p>

1345 Reports the outline associated with a single file.	1377 Reports the outline associated with a single file.

1346 </p>	1378 </p>

1347 <p>	1379 <p>

1348 This notification is not subscribed to by default. Clients	1380 This notification is not subscribed to by default. Clients

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

1350 the list of services passed in an analysis.setSubscriptions	1382 the list of services passed in an analysis.setSubscriptions

1351 request.	1383 request.

1352 </p>	1384 </p>

1353	1385

1354 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1386 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1355	1387

1356 <p>	1388 <p>

1357 The file with which the outline is associated.	1389 The file with which the outline is associated.

1358 </p>	1390 </p>

1359 </dd><dt class="field"><b>kind (<a href="#type_FileKind">FileKind</a>) </b></dt><dd>	1391 </dd><dt class="field"><b>kind: <a href="#type_FileKind">FileKind</a>< /b></dt><dd>

1360	1392

1361 <p>	1393 <p>

1362 The kind of the file.	1394 The kind of the file.

1363 </p>	1395 </p>

1364 </dd><dt class="field"><b>libraryName (<span style="color:#999999">opt ional</span> String)</b></dt><dd>	1396 </dd><dt class="field"><b>libraryName: String<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

1365	1397

1366 <p>	1398 <p>

1367 The name of the library defined by the file using a "library"	1399 The name of the library defined by the file using a "library"

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

1369 "library" and "part of" directives are present, then the	1401 "library" and "part of" directives are present, then the

1370 "library" directive takes precedence.	1402 "library" directive takes precedence.

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

1372 nor "part of" directives.	1404 nor "part of" directives.

1373 </p>	1405 </p>

1374 </dd><dt class="field"><b>outline (<a href="#type_Outline">Outline</a> )</b></dt><dd>	1406 </dd><dt class="field"><b>outline: <a href="#type_Outline">Outline</a> </b></dt><dd>

1375	1407

1376 <p>	1408 <p>

1377 The outline associated with the file.	1409 The outline associated with the file.

1378 </p>	1410 </p>

1379 </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: {	1411 </dd></dl></dd><dt class="notification"><a name="notification_analysis .overrides">analysis.overrides</a></dt><dd><div class="box"><pre>notification: {

1380 "event": "analysis.overrides"	1412 "event": "analysis.overrides"

1381 "params": {	1413 "params": {

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

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

1384 }	1416 }

1385 }</pre></div>	1417 }</pre></div>

1386 <p>	1418 <p>

1387 Reports the overriding members in a file.	1419 Reports the overriding members in a file.

1388 </p>	1420 </p>

1389 <p>	1421 <p>

1390 This notification is not subscribed to by default. Clients	1422 This notification is not subscribed to by default. Clients

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

1392 the list of services passed in an analysis.setSubscriptions	1424 the list of services passed in an analysis.setSubscriptions

1393 request.	1425 request.

1394 </p>	1426 </p>

1395	1427

1396 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1428 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1397	1429

1398 <p>	1430 <p>

1399 The file with which the overrides are associated.	1431 The file with which the overrides are associated.

1400 </p>	1432 </p>

1401 </dd><dt class="field"><b>overrides (List<<a href="#type_Override"> Override</a>>)</b></dt><dd>	1433 </dd><dt class="field"><b>overrides: List<<a href="#type_Override"> Override</a>></b></dt><dd>

1402	1434

1403 <p>	1435 <p>

1404 The overrides associated with the file.	1436 The overrides associated with the file.

1405 </p>	1437 </p>

1406 </dd></dl></dd></dl>	1438 </dd></dl></dd></dl>

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

1408 <p>	1440 <p>

1409 The code completion domain contains commands related to	1441 The code completion domain contains commands related to

1410 getting code completion suggestions.	1442 getting code completion suggestions.

1411 </p>	1443 </p>

1412	1444

1413	1445

1414 <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: {	1446 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSugg estions">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: {

1415 "id": String	1447 "id": String

1416 "method": "completion.getSuggestions"	1448 "method": "completion.getSuggestions"

1417 "params": {	1449 "params": {

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

1419 "<b>offset</b>": int	1451 "<b>offset</b>": int

1420 }	1452 }

1421 }</pre><br><pre>response: {	1453 }</pre><br><pre>response: {

1422 "<b>id</b>": String	1454 "<b>id</b>": String

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

1424 "result": {	1456 "result": {

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

1426 }	1458 }

1427 }</pre></div>	1459 }</pre></div>

1428 <p>	1460 <p>

1429 Request that completion suggestions for the given offset in	1461 Request that completion suggestions for the given offset in

1430 the given file be returned.	1462 the given file be returned.

1431 </p>	1463 </p>

1432	1464

1433	1465

1434 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1466 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1435	1467

1436 <p>	1468 <p>

1437 The file containing the point at which suggestions are	1469 The file containing the point at which suggestions are

1438 to be made.	1470 to be made.

1439 </p>	1471 </p>

1440 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1472 </dd><dt class="field"><b>offset: int</b></dt><dd>

1441	1473

1442 <p>	1474 <p>

1443 The offset within the file at which suggestions are to	1475 The offset within the file at which suggestions are to

1444 be made.	1476 be made.

1445 </p>	1477 </p>

1446 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _CompletionId">CompletionId</a>)</b></dt><dd>	1478 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _CompletionId">CompletionId</a></b></dt><dd>

1447	1479

1448 <p>	1480 <p>

1449 The identifier used to associate results with this	1481 The identifier used to associate results with this

1450 completion request.	1482 completion request.

1451 </p>	1483 </p>

1452 </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: {	1484 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_completion.results">completion.results</a></dt><dd><div c lass="box"><pre>notification: {

1453 "event": "completion.results"	1485 "event": "completion.results"

1454 "params": {	1486 "params": {

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

1456 "<b>replacementOffset</b>": int	1488 "<b>replacementOffset</b>": int

1457 "<b>replacementLength</b>": int	1489 "<b>replacementLength</b>": int

1458 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug gestion</a>>	1490 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug gestion</a>>

1459 "<b>isLast</b>": bool	1491 "<b>isLast</b>": bool

1460 }	1492 }

1461 }</pre></div>	1493 }</pre></div>

1462 <p>	1494 <p>

1463 Reports the completion suggestions that should be presented	1495 Reports the completion suggestions that should be presented

1464 to the user. The set of suggestions included in the	1496 to the user. The set of suggestions included in the

1465 notification is always a complete list that supersedes any	1497 notification is always a complete list that supersedes any

1466 previously reported suggestions.	1498 previously reported suggestions.

1467 </p>	1499 </p>

1468	1500

1469 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_Completion Id">CompletionId</a>)</b></dt><dd>	1501 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_Completion Id">CompletionId</a></b></dt><dd>

1470	1502

1471 <p>	1503 <p>

1472 The id associated with the completion.	1504 The id associated with the completion.

1473 </p>	1505 </p>

1474 </dd><dt class="field"><b>replacementOffset (int)</b></dt><dd>	1506 </dd><dt class="field"><b>replacementOffset: int</b></dt><dd>

1475	1507

1476 <p>	1508 <p>

1477 The offset of the start of the text to be	1509 The offset of the start of the text to be

1478 replaced. This will be different than the offset used	1510 replaced. This will be different than the offset used

1479 to request the completion suggestions if there was a	1511 to request the completion suggestions if there was a

1480 portion of an identifier before the original	1512 portion of an identifier before the original

1481 offset. In particular, the replacementOffset will be	1513 offset. In particular, the replacementOffset will be

1482 the offset of the beginning of said identifier.	1514 the offset of the beginning of said identifier.

1483 </p>	1515 </p>

1484 </dd><dt class="field"><b>replacementLength (int)</b></dt><dd>	1516 </dd><dt class="field"><b>replacementLength: int</b></dt><dd>

1485	1517

1486 <p>	1518 <p>

1487 The length of the text to be replaced if the remainder	1519 The length of the text to be replaced if the remainder

1488 of the identifier containing the cursor is to be	1520 of the identifier containing the cursor is to be

1489 replaced when the suggestion is applied (that is, the	1521 replaced when the suggestion is applied (that is, the

1490 number of characters in the existing identifier).	1522 number of characters in the existing identifier).

1491 </p>	1523 </p>

1492 </dd><dt class="field"><b>results (List<<a href="#type_CompletionSu ggestion">CompletionSuggestion</a>>)</b></dt><dd>	1524 </dd><dt class="field"><b>results: List<<a href="#type_CompletionSu ggestion">CompletionSuggestion</a>></b></dt><dd>

1493	1525

1494 <p>	1526 <p>

1495 The completion suggestions being reported. The	1527 The completion suggestions being reported. The

1496 notification contains all possible completions at the	1528 notification contains all possible completions at the

1497 requested cursor position, even those that do not match	1529 requested cursor position, even those that do not match

1498 the characters the user has already typed. This allows	1530 the characters the user has already typed. This allows

1499 the client to respond to further keystrokes from the	1531 the client to respond to further keystrokes from the

1500 user without having to make additional requests.	1532 user without having to make additional requests.

1501 </p>	1533 </p>

1502 </dd><dt class="field"><b>isLast (bool)</b></dt><dd>	1534 </dd><dt class="field"><b>isLast: bool</b></dt><dd>

1503	1535

1504 <p>	1536 <p>

1505 True if this is that last set of results that will be	1537 True if this is that last set of results that will be

1506 returned for the indicated completion.	1538 returned for the indicated completion.

1507 </p>	1539 </p>

1508 </dd></dl></dd></dl>	1540 </dd></dl></dd></dl>

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

1510 <p>	1542 <p>

1511 The search domain contains commands related to searches that	1543 The search domain contains commands related to searches that

1512 can be performed against the code base.	1544 can be performed against the code base.

1513 </p>	1545 </p>

1514	1546

1515	1547

1516	1548

1517	1549

1518	1550

1519	1551

1520 <h3>Requests</h3><dl><dt class="request"><a name="request_search.findElement References">search.findElementReferences</a> (<a href="#request_search.findEleme ntReferences">#</a>)</dt><dd><div class="box"><pre>request: {	1552 <h3>Requests</h3><dl><dt class="request"><a name="request_search.findElement References">search.findElementReferences</a></dt><dd><div class="box"><pre>reque st: {

1521 "id": String	1553 "id": String

1522 "method": "search.findElementReferences"	1554 "method": "search.findElementReferences"

1523 "params": {	1555 "params": {

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

1525 "<b>offset</b>": int	1557 "<b>offset</b>": int

1526 "<b>includePotential</b>": bool	1558 "<b>includePotential</b>": bool

1527 }	1559 }

1528 }</pre><br><pre>response: {	1560 }</pre><br><pre>response: {

1529 "<b>id</b>": String	1561 "<b>id</b>": String

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

1531 "result": {	1563 "result": {

1532 "<b>id</b>": <span style="color:#999999">optional</span> <a href="#type_Sear chId">SearchId</a>	1564 "<b>id</b>": <span style="color:#999999">optional</span> <a href="#type_Sear chId">SearchId</a>

1533 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type _Element">Element</a>	1565 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type _Element">Element</a>

1534 }	1566 }

1535 }</pre></div>	1567 }</pre></div>

1536 <p>	1568 <p>

1537 Perform a search for references to the element defined or	1569 Perform a search for references to the element defined or

1538 referenced at the given offset in the given file.	1570 referenced at the given offset in the given file.

1539 </p>	1571 </p>

1540 <p>	1572 <p>

1541 An identifier is returned immediately, and individual	1573 An identifier is returned immediately, and individual

1542 results will be returned via the search.results notification	1574 results will be returned via the search.results notification

1543 as they become available.	1575 as they become available.

1544 </p>	1576 </p>

1545	1577

1546	1578

1547 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1579 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1548	1580

1549 <p>	1581 <p>

1550 The file containing the declaration of or reference to	1582 The file containing the declaration of or reference to

1551 the element used to define the search.	1583 the element used to define the search.

1552 </p>	1584 </p>

1553 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1585 </dd><dt class="field"><b>offset: int</b></dt><dd>

1554	1586

1555 <p>	1587 <p>

1556 The offset within the file of the declaration of or	1588 The offset within the file of the declaration of or

1557 reference to the element.	1589 reference to the element.

1558 </p>	1590 </p>

1559 </dd><dt class="field"><b>includePotential (bool)</b></dt><dd>	1591 </dd><dt class="field"><b>includePotential: bool</b></dt><dd>

1560	1592

1561 <p>	1593 <p>

1562 True if potential matches are to be included in the	1594 True if potential matches are to be included in the

1563 results.	1595 results.

1564 </p>	1596 </p>

1565 </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 >	1597 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _SearchId">SearchId</a><span style="color:#999999"> (@optional)</span></b></dt>< dd>

1566	1598

1567 <p>	1599 <p>

1568 The identifier used to associate results with this	1600 The identifier used to associate results with this

1569 search request.	1601 search request.

1570 </p>	1602 </p>

1571 <p>	1603 <p>

1572 If no element was found at the given location, this	1604 If no element was found at the given location, this

1573 field will be absent, and no results will be reported	1605 field will be absent, and no results will be reported

1574 via the search.results notification.	1606 via the search.results notification.

1575 </p>	1607 </p>

1576 </dd><dt class="field"><b>element (<span style="color:#999999">optiona l</span> <a href="#type_Element">Element</a>)</b></dt><dd>	1608 </dd><dt class="field"><b>element: <a href="#type_Element">Element</a> <span style="color:#999999"> (@optional)</span></b></dt><dd>

1577	1609

1578 <p>	1610 <p>

1579 The element referenced or defined at the given offset	1611 The element referenced or defined at the given offset

1580 and whose references will be returned in the search	1612 and whose references will be returned in the search

1581 results.	1613 results.

1582 </p>	1614 </p>

1583 <p>	1615 <p>

1584 If no element was found at the given location, this	1616 If no element was found at the given location, this

1585 field will be absent.	1617 field will be absent.

1586 </p>	1618 </p>

1587 </dd></dl></dd><dt class="request"><a name="request_search.findMemberD eclarations">search.findMemberDeclarations</a> (<a href="#request_search.findMem berDeclarations">#</a>)</dt><dd><div class="box"><pre>request: {	1619 </dd></dl></dd><dt class="request"><a name="request_search.findMemberD eclarations">search.findMemberDeclarations</a></dt><dd><div class="box"><pre>req uest: {

1588 "id": String	1620 "id": String

1589 "method": "search.findMemberDeclarations"	1621 "method": "search.findMemberDeclarations"

1590 "params": {	1622 "params": {

1591 "<b>name</b>": String	1623 "<b>name</b>": String

1592 }	1624 }

1593 }</pre><br><pre>response: {	1625 }</pre><br><pre>response: {

1594 "<b>id</b>": String	1626 "<b>id</b>": String

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

1596 "result": {	1628 "result": {

1597 "<b>id</b>": <a href="#type_SearchId">SearchId</a>	1629 "<b>id</b>": <a href="#type_SearchId">SearchId</a>

1598 }	1630 }

1599 }</pre></div>	1631 }</pre></div>

1600 <p>	1632 <p>

1601 Perform a search for declarations of members whose name is	1633 Perform a search for declarations of members whose name is

1602 equal to the given name.	1634 equal to the given name.

1603 </p>	1635 </p>

1604 <p>	1636 <p>

1605 An identifier is returned immediately, and individual	1637 An identifier is returned immediately, and individual

1606 results will be returned via the search.results notification	1638 results will be returned via the search.results notification

1607 as they become available.	1639 as they become available.

1608 </p>	1640 </p>

1609	1641

1610	1642

1611 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>	1643 <h4>parameters:</h4><dl><dt class="field"><b>name: String</b></dt><dd>

1612	1644

1613 <p>	1645 <p>

1614 The name of the declarations to be found.	1646 The name of the declarations to be found.

1615 </p>	1647 </p>

1616 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>	1648 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _SearchId">SearchId</a></b></dt><dd>

1617	1649

1618 <p>	1650 <p>

1619 The identifier used to associate results with this	1651 The identifier used to associate results with this

1620 search request.	1652 search request.

1621 </p>	1653 </p>

1622 </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: {	1654 </dd></dl></dd><dt class="request"><a name="request_search.findMemberR eferences">search.findMemberReferences</a></dt><dd><div class="box"><pre>request : {

1623 "id": String	1655 "id": String

1624 "method": "search.findMemberReferences"	1656 "method": "search.findMemberReferences"

1625 "params": {	1657 "params": {

1626 "<b>name</b>": String	1658 "<b>name</b>": String

1627 }	1659 }

1628 }</pre><br><pre>response: {	1660 }</pre><br><pre>response: {

1629 "<b>id</b>": String	1661 "<b>id</b>": String

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

1631 "result": {	1663 "result": {

1632 "<b>id</b>": <a href="#type_SearchId">SearchId</a>	1664 "<b>id</b>": <a href="#type_SearchId">SearchId</a>

1633 }	1665 }

1634 }</pre></div>	1666 }</pre></div>

1635 <p>	1667 <p>

1636 Perform a search for references to members whose name is	1668 Perform a search for references to members whose name is

1637 equal to the given name. This search does not check to see	1669 equal to the given name. This search does not check to see

1638 that there is a member defined with the given name, so it is	1670 that there is a member defined with the given name, so it is

1639 able to find references to undefined members as well.	1671 able to find references to undefined members as well.

1640 </p>	1672 </p>

1641 <p>	1673 <p>

1642 An identifier is returned immediately, and individual	1674 An identifier is returned immediately, and individual

1643 results will be returned via the search.results notification	1675 results will be returned via the search.results notification

1644 as they become available.	1676 as they become available.

1645 </p>	1677 </p>

1646	1678

1647	1679

1648 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>	1680 <h4>parameters:</h4><dl><dt class="field"><b>name: String</b></dt><dd>

1649	1681

1650 <p>	1682 <p>

1651 The name of the references to be found.	1683 The name of the references to be found.

1652 </p>	1684 </p>

1653 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>	1685 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _SearchId">SearchId</a></b></dt><dd>

1654	1686

1655 <p>	1687 <p>

1656 The identifier used to associate results with this	1688 The identifier used to associate results with this

1657 search request.	1689 search request.

1658 </p>	1690 </p>

1659 </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: {	1691 </dd></dl></dd><dt class="request"><a name="request_search.findTopLeve lDeclarations">search.findTopLevelDeclarations</a></dt><dd><div class="box"><pre >request: {

1660 "id": String	1692 "id": String

1661 "method": "search.findTopLevelDeclarations"	1693 "method": "search.findTopLevelDeclarations"

1662 "params": {	1694 "params": {

1663 "<b>pattern</b>": String	1695 "<b>pattern</b>": String

1664 }	1696 }

1665 }</pre><br><pre>response: {	1697 }</pre><br><pre>response: {

1666 "<b>id</b>": String	1698 "<b>id</b>": String

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

1668 "result": {	1700 "result": {

1669 "<b>id</b>": <a href="#type_SearchId">SearchId</a>	1701 "<b>id</b>": <a href="#type_SearchId">SearchId</a>

1670 }	1702 }

1671 }</pre></div>	1703 }</pre></div>

1672 <p>	1704 <p>

1673 Perform a search for declarations of top-level elements	1705 Perform a search for declarations of top-level elements

1674 (classes, typedefs, getters, setters, functions and fields)	1706 (classes, typedefs, getters, setters, functions and fields)

1675 whose name matches the given pattern.	1707 whose name matches the given pattern.

1676 </p>	1708 </p>

1677 <p>	1709 <p>

1678 An identifier is returned immediately, and individual	1710 An identifier is returned immediately, and individual

1679 results will be returned via the search.results notification	1711 results will be returned via the search.results notification

1680 as they become available.	1712 as they become available.

1681 </p>	1713 </p>

1682	1714

1683	1715

1684 <h4>parameters:</h4><dl><dt class="field"><b>pattern (String)</b></dt><dd>	1716 <h4>parameters:</h4><dl><dt class="field"><b>pattern: String</b></dt><dd>

1685	1717

1686 <p>	1718 <p>

1687 The regular expression used to match the names of the	1719 The regular expression used to match the names of the

1688 declarations to be found.	1720 declarations to be found.

1689 </p>	1721 </p>

1690 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _SearchId">SearchId</a>)</b></dt><dd>	1722 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _SearchId">SearchId</a></b></dt><dd>

1691	1723

1692 <p>	1724 <p>

1693 The identifier used to associate results with this	1725 The identifier used to associate results with this

1694 search request.	1726 search request.

1695 </p>	1727 </p>

1696 </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: {	1728 </dd></dl></dd><dt class="request"><a name="request_search.getTypeHier archy">search.getTypeHierarchy</a></dt><dd><div class="box"><pre>request: {

1697 "id": String	1729 "id": String

1698 "method": "search.getTypeHierarchy"	1730 "method": "search.getTypeHierarchy"

1699 "params": {	1731 "params": {

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

1701 "<b>offset</b>": int	1733 "<b>offset</b>": int

1702 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool	1734 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool

1703 }	1735 }

1704 }</pre><br><pre>response: {	1736 }</pre><br><pre>response: {

1705 "id": String	1737 "id": String

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

1707 "result": {	1739 "result": {

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

1709 }	1741 }

1710 }</pre></div>	1742 }</pre></div>

1711 <p>	1743 <p>

1712 Return the type hierarchy of the class declared or	1744 Return the type hierarchy of the class declared or

1713 referenced at the given location.	1745 referenced at the given location.

1714 </p>	1746 </p>

1715	1747

1716	1748

1717 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1749 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1718	1750

1719 <p>	1751 <p>

1720 The file containing the declaration or reference to the	1752 The file containing the declaration or reference to the

1721 type for which a hierarchy is being requested.	1753 type for which a hierarchy is being requested.

1722 </p>	1754 </p>

1723 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1755 </dd><dt class="field"><b>offset: int</b></dt><dd>

1724	1756

1725 <p>	1757 <p>

1726 The offset of the name of the type within the file.	1758 The offset of the name of the type within the file.

1727 </p>	1759 </p>

1728 </dd><dt class="field"><b>superOnly (<span style="color:#999999">optio nal</span> bool)</b></dt><dd>	1760 </dd><dt class="field"><b>superOnly: bool<span style="color:#999999"> (@optional)</span></b></dt><dd>

1729	1761

1730 <p>	1762 <p>

1731 True if the client is only requesting superclasses and	1763 True if the client is only requesting superclasses and

1732 interfaces hierarchy.	1764 interfaces hierarchy.

1733 </p>	1765 </p>

1734 </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>	1766 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hierarchyItems: Li st<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>><span style="co lor:#999999"> (@optional)</span></b></dt><dd>

1735	1767

1736 <p>	1768 <p>

1737 A list of the types in the requested hierarchy. The	1769 A list of the types in the requested hierarchy. The

1738 first element of the list is the item representing the	1770 first element of the list is the item representing the

1739 type for which the hierarchy was requested. The index of	1771 type for which the hierarchy was requested. The index of

1740 other elements of the list is unspecified, but	1772 other elements of the list is unspecified, but

1741 correspond to the integers used to reference supertype	1773 correspond to the integers used to reference supertype

1742 and subtype items within the items.	1774 and subtype items within the items.

1743 </p>	1775 </p>

1744 <p>	1776 <p>

1745 This field will be absent if the code at the given file	1777 This field will be absent if the code at the given file

1746 and offset does not represent a type, or if the file has	1778 and offset does not represent a type, or if the file has

1747 not been sufficiently analyzed to allow a type hierarchy	1779 not been sufficiently analyzed to allow a type hierarchy

1748 to be produced.	1780 to be produced.

1749 </p>	1781 </p>

1750 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_search.results">search.results</a> (<a href="#notificatio n_search.results">#</a>)</dt><dd><div class="box"><pre>notification: {	1782 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_search.results">search.results</a></dt><dd><div class="bo x"><pre>notification: {

1751 "event": "search.results"	1783 "event": "search.results"

1752 "params": {	1784 "params": {

1753 "<b>id</b>": <a href="#type_SearchId">SearchId</a>	1785 "<b>id</b>": <a href="#type_SearchId">SearchId</a>

1754 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>>	1786 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>>

1755 "<b>isLast</b>": bool	1787 "<b>isLast</b>": bool

1756 }	1788 }

1757 }</pre></div>	1789 }</pre></div>

1758 <p>	1790 <p>

1759 Reports some or all of the results of performing a requested	1791 Reports some or all of the results of performing a requested

1760 search. Unlike other notifications, this notification	1792 search. Unlike other notifications, this notification

1761 contains search results that should be added to any	1793 contains search results that should be added to any

1762 previously received search results associated with the same	1794 previously received search results associated with the same

1763 search id.	1795 search id.

1764 </p>	1796 </p>

1765	1797

1766 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId"> SearchId</a>)</b></dt><dd>	1798 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_SearchId"> SearchId</a></b></dt><dd>

1767	1799

1768 <p>	1800 <p>

1769 The id associated with the search.	1801 The id associated with the search.

1770 </p>	1802 </p>

1771 </dd><dt class="field"><b>results (List<<a href="#type_SearchResult ">SearchResult</a>>)</b></dt><dd>	1803 </dd><dt class="field"><b>results: List<<a href="#type_SearchResult ">SearchResult</a>></b></dt><dd>

1772	1804

1773 <p>	1805 <p>

1774 The search results being reported.	1806 The search results being reported.

1775 </p>	1807 </p>

1776 </dd><dt class="field"><b>isLast (bool)</b></dt><dd>	1808 </dd><dt class="field"><b>isLast: bool</b></dt><dd>

1777	1809

1778 <p>	1810 <p>

1779 True if this is that last set of results that will be	1811 True if this is that last set of results that will be

1780 returned for the indicated search.	1812 returned for the indicated search.

1781 </p>	1813 </p>

1782 </dd></dl></dd></dl>	1814 </dd></dl></dd></dl>

1783 <h2 class="domain"><a name="domain_edit">edit domain</a></h2>	1815 <h2 class="domain"><a name="domain_edit">edit domain</a></h2>

1784 <p>	1816 <p>

1785 The edit domain contains commands related to edits that can be	1817 The edit domain contains commands related to edits that can be

1786 applied to the code.	1818 applied to the code.

1787 </p>	1819 </p>

1788	1820

1789	1821

1790	1822

1791	1823

1792	1824

1793	1825

1794	1826

1795	1827

1796 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit. format</a> (<a href="#request_edit.format">#</a>)</dt><dd><div class="box"><pre> request: {	1828 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit. format</a></dt><dd><div class="box"><pre>request: {

1797 "id": String	1829 "id": String

1798 "method": "edit.format"	1830 "method": "edit.format"

1799 "params": {	1831 "params": {

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

1801 "<b>selectionOffset</b>": int	1833 "<b>selectionOffset</b>": int

1802 "<b>selectionLength</b>": int	1834 "<b>selectionLength</b>": int

1803 "<b>lineLength</b>": <span style="color:#999999">optional</span> int	1835 "<b>lineLength</b>": <span style="color:#999999">optional</span> int

1804 }	1836 }

1805 }</pre><br><pre>response: {	1837 }</pre><br><pre>response: {

1806 "id": String	1838 "id": String

(...skipping 16 matching lines...) Expand all Loading...
1823 <p>	1855 <p>

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

1825 currently subject to analysis (e.g. because it is not associated with	1857 currently subject to analysis (e.g. because it is not associated with

1826 any analysis root specified to analysis.setAnalysisRoots), an error of	1858 any analysis root specified to analysis.setAnalysisRoots), an error of

1827 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source	1859 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source

1828 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>	1860 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt>

1829 will be generated.	1861 will be generated.

1830 </p>	1862 </p>

1831	1863

1832	1864

1833 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1865 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1834	1866

1835 <p>	1867 <p>

1836 The file containing the code to be formatted.	1868 The file containing the code to be formatted.

1837 </p>	1869 </p>

1838 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>	1870 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd>

1839	1871

1840 <p>	1872 <p>

1841 The offset of the current selection in the file.	1873 The offset of the current selection in the file.

1842 </p>	1874 </p>

1843 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>	1875 </dd><dt class="field"><b>selectionLength: int</b></dt><dd>

1844	1876

1845 <p>	1877 <p>

1846 The length of the current selection in the file.	1878 The length of the current selection in the file.

1847 </p>	1879 </p>

1848 </dd><dt class="field"><b>lineLength (<span style="color:#999999">opti onal</span> int)</b></dt><dd>	1880 </dd><dt class="field"><b>lineLength: int<span style="color:#999999"> (@optional)</span></b></dt><dd>

1849	1881

1850 <p>	1882 <p>

1851 The line length to be used by the formatter.	1883 The line length to be used by the formatter.

1852 </p>	1884 </p>

1853 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd>	1885 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits: List<<a href="#type_SourceEdit">SourceEdit</a>></b></dt><dd>

1854	1886

1855 <p>	1887 <p>

1856 The edit(s) to be applied in order to format the code. The list	1888 The edit(s) to be applied in order to format the code. The list

1857 will be empty if the code was already formatted (there are no	1889 will be empty if the code was already formatted (there are no

1858 changes).	1890 changes).

1859 </p>	1891 </p>

1860 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>	1892 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd>

1861	1893

1862 <p>	1894 <p>

1863 The offset of the selection after formatting the code.	1895 The offset of the selection after formatting the code.

1864 </p>	1896 </p>

1865 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>	1897 </dd><dt class="field"><b>selectionLength: int</b></dt><dd>

1866	1898

1867 <p>	1899 <p>

1868 The length of the selection after formatting the code.	1900 The length of the selection after formatting the code.

1869 </p>	1901 </p>

1870 </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: {	1902 </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">e dit.getAssists</a></dt><dd><div class="box"><pre>request: {

1871 "id": String	1903 "id": String

1872 "method": "edit.getAssists"	1904 "method": "edit.getAssists"

1873 "params": {	1905 "params": {

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

1875 "<b>offset</b>": int	1907 "<b>offset</b>": int

1876 "<b>length</b>": int	1908 "<b>length</b>": int

1877 }	1909 }

1878 }</pre><br><pre>response: {	1910 }</pre><br><pre>response: {

1879 "id": String	1911 "id": String

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

1881 "result": {	1913 "result": {

1882 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>>	1914 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>>

1883 }	1915 }

1884 }</pre></div>	1916 }</pre></div>

1885 <p>	1917 <p>

1886 Return the set of assists that are available at the given	1918 Return the set of assists that are available at the given

1887 location. An assist is distinguished from a refactoring	1919 location. An assist is distinguished from a refactoring

1888 primarily by the fact that it affects a single file and does	1920 primarily by the fact that it affects a single file and does

1889 not require user input in order to be performed.	1921 not require user input in order to be performed.

1890 </p>	1922 </p>

1891	1923

1892	1924

1893 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1925 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1894	1926

1895 <p>	1927 <p>

1896 The file containing the code for which assists are being	1928 The file containing the code for which assists are being

1897 requested.	1929 requested.

1898 </p>	1930 </p>

1899 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1931 </dd><dt class="field"><b>offset: int</b></dt><dd>

1900	1932

1901 <p>	1933 <p>

1902 The offset of the code for which assists are being	1934 The offset of the code for which assists are being

1903 requested.	1935 requested.

1904 </p>	1936 </p>

1905 </dd><dt class="field"><b>length (int)</b></dt><dd>	1937 </dd><dt class="field"><b>length: int</b></dt><dd>

1906	1938

1907 <p>	1939 <p>

1908 The length of the code for which assists are being	1940 The length of the code for which assists are being

1909 requested.	1941 requested.

1910 </p>	1942 </p>

1911 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists (List<< a href="#type_SourceChange">SourceChange</a>>)</b></dt><dd>	1943 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists: List<< a href="#type_SourceChange">SourceChange</a>></b></dt><dd>

1912	1944

1913 <p>	1945 <p>

1914 The assists that are available at the given location.	1946 The assists that are available at the given location.

1915 </p>	1947 </p>

1916 </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: {	1948 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableR efactorings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>req uest: {

1917 "id": String	1949 "id": String

1918 "method": "edit.getAvailableRefactorings"	1950 "method": "edit.getAvailableRefactorings"

1919 "params": {	1951 "params": {

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

1921 "<b>offset</b>": int	1953 "<b>offset</b>": int

1922 "<b>length</b>": int	1954 "<b>length</b>": int

1923 }	1955 }

1924 }</pre><br><pre>response: {	1956 }</pre><br><pre>response: {

1925 "id": String	1957 "id": String

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

1927 "result": {	1959 "result": {

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

1929 }	1961 }

1930 }</pre></div>	1962 }</pre></div>

1931 <p>	1963 <p>

1932 Get a list of the kinds of refactorings that are valid for	1964 Get a list of the kinds of refactorings that are valid for

1933 the given selection in the given file.	1965 the given selection in the given file.

1934 </p>	1966 </p>

1935	1967

1936	1968

1937 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	1969 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1938	1970

1939 <p>	1971 <p>

1940 The file containing the code on which the refactoring	1972 The file containing the code on which the refactoring

1941 would be based.	1973 would be based.

1942 </p>	1974 </p>

1943 </dd><dt class="field"><b>offset (int)</b></dt><dd>	1975 </dd><dt class="field"><b>offset: int</b></dt><dd>

1944	1976

1945 <p>	1977 <p>

1946 The offset of the code on which the refactoring would be	1978 The offset of the code on which the refactoring would be

1947 based.	1979 based.

1948 </p>	1980 </p>

1949 </dd><dt class="field"><b>length (int)</b></dt><dd>	1981 </dd><dt class="field"><b>length: int</b></dt><dd>

1950	1982

1951 <p>	1983 <p>

1952 The length of the code on which the refactoring would be	1984 The length of the code on which the refactoring would be

1953 based.	1985 based.

1954 </p>	1986 </p>

1955 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds (List<<a href="#type_RefactoringKind">RefactoringKind</a>>)</b></dt><dd>	1987 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds: List<<a href="#type_RefactoringKind">RefactoringKind</a>></b></dt><dd>

1956	1988

1957 <p>	1989 <p>

1958 The kinds of refactorings that are valid for the given	1990 The kinds of refactorings that are valid for the given

1959 selection.	1991 selection.

1960 </p>	1992 </p>

1961 </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: {	1993 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edi t.getFixes</a></dt><dd><div class="box"><pre>request: {

1962 "id": String	1994 "id": String

1963 "method": "edit.getFixes"	1995 "method": "edit.getFixes"

1964 "params": {	1996 "params": {

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

1966 "<b>offset</b>": int	1998 "<b>offset</b>": int

1967 }	1999 }

1968 }</pre><br><pre>response: {	2000 }</pre><br><pre>response: {

1969 "id": String	2001 "id": String

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

1971 "result": {	2003 "result": {

1972 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>>	2004 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>>

1973 }	2005 }

1974 }</pre></div>	2006 }</pre></div>

1975 <p>	2007 <p>

1976 Return the set of fixes that are available for the errors at	2008 Return the set of fixes that are available for the errors at

1977 a given offset in a given file.	2009 a given offset in a given file.

1978 </p>	2010 </p>

1979	2011

1980	2012

1981 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	2013 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

1982	2014

1983 <p>	2015 <p>

1984 The file containing the errors for which fixes are being	2016 The file containing the errors for which fixes are being

1985 requested.	2017 requested.

1986 </p>	2018 </p>

1987 </dd><dt class="field"><b>offset (int)</b></dt><dd>	2019 </dd><dt class="field"><b>offset: int</b></dt><dd>

1988	2020

1989 <p>	2021 <p>

1990 The offset used to select the errors for which fixes	2022 The offset used to select the errors for which fixes

1991 will be returned.	2023 will be returned.

1992 </p>	2024 </p>

1993 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes (List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>)</b></dt><dd>	2025 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes: List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>></b></dt><dd>

1994	2026

1995 <p>	2027 <p>

1996 The fixes that are available for the errors at the given offset.	2028 The fixes that are available for the errors at the given offset.

1997 </p>	2029 </p>

1998 </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: {	2030 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactorin g">edit.getRefactoring</a></dt><dd><div class="box"><pre>request: {

1999 "id": String	2031 "id": String

2000 "method": "edit.getRefactoring"	2032 "method": "edit.getRefactoring"

2001 "params": {	2033 "params": {

2002 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>	2034 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>

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

2004 "<b>offset</b>": int	2036 "<b>offset</b>": int

2005 "<b>length</b>": int	2037 "<b>length</b>": int

2006 "<b>validateOnly</b>": bool	2038 "<b>validateOnly</b>": bool

2007 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>	2039 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>

2008 }	2040 }

(...skipping 12 matching lines...) Expand all Loading...
2021 <p>	2053 <p>

2022 Get the changes required to perform a refactoring.	2054 Get the changes required to perform a refactoring.

2023 </p>	2055 </p>

2024 <p>	2056 <p>

2025 If another refactoring request is received during the processing	2057 If another refactoring request is received during the processing

2026 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>	2058 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt>

2027 will be generated.	2059 will be generated.

2028 </p>	2060 </p>

2029	2061

2030	2062

2031 <h4>parameters:</h4><dl><dt class="field"><b>kind (<a href="#type_Refactor ingKind">RefactoringKind</a>)</b></dt><dd>	2063 <h4>parameters:</h4><dl><dt class="field"><b>kind: <a href="#type_Refactor ingKind">RefactoringKind</a></b></dt><dd>

2032	2064

2033 <p>	2065 <p>

2034 The kind of refactoring to be performed.	2066 The kind of refactoring to be performed.

2035 </p>	2067 </p>

2036 </dd><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>) </b></dt><dd>	2068 </dd><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a>< /b></dt><dd>

2037	2069

2038 <p>	2070 <p>

2039 The file containing the code involved in the	2071 The file containing the code involved in the

2040 refactoring.	2072 refactoring.

2041 </p>	2073 </p>

2042 </dd><dt class="field"><b>offset (int)</b></dt><dd>	2074 </dd><dt class="field"><b>offset: int</b></dt><dd>

2043	2075

2044 <p>	2076 <p>

2045 The offset of the region involved in the refactoring.	2077 The offset of the region involved in the refactoring.

2046 </p>	2078 </p>

2047 </dd><dt class="field"><b>length (int)</b></dt><dd>	2079 </dd><dt class="field"><b>length: int</b></dt><dd>

2048	2080

2049 <p>	2081 <p>

2050 The length of the region involved in the refactoring.	2082 The length of the region involved in the refactoring.

2051 </p>	2083 </p>

2052 </dd><dt class="field"><b>validateOnly (bool)</b></dt><dd>	2084 </dd><dt class="field"><b>validateOnly: bool</b></dt><dd>

2053	2085

2054 <p>	2086 <p>

2055 True if the client is only requesting that the values of	2087 True if the client is only requesting that the values of

2056 the options be validated and no change be generated.	2088 the options be validated and no change be generated.

2057 </p>	2089 </p>

2058 </dd><dt class="field"><b>options (<span style="color:#999999">optiona l</span> <a href="#type_RefactoringOptions">RefactoringOptions</a>)</b></dt><dd>	2090 </dd><dt class="field"><b>options: <a href="#type_RefactoringOptions"> RefactoringOptions</a><span style="color:#999999"> (@optional)</span></b></dt><d d>

2059	2091

2060 <p>	2092 <p>

2061 Data used to provide values provided by the user. The	2093 Data used to provide values provided by the user. The

2062 structure of the data is dependent on the kind of	2094 structure of the data is dependent on the kind of

2063 refactoring being performed. The data that is expected is	2095 refactoring being performed. The data that is expected is

2064 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as	2096 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as

2065 "Options". This field can be omitted if the refactoring	2097 "Options". This field can be omitted if the refactoring

2066 does not require any options or if the values of those	2098 does not require any options or if the values of those

2067 options are not known.	2099 options are not known.

2068 </p>	2100 </p>

2069 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems (L ist<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><d d>	2101 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems: L ist<<a href="#type_RefactoringProblem">RefactoringProblem</a>></b></dt><dd >

2070	2102

2071 <p>	2103 <p>

2072 The initial status of the refactoring, i.e. problems related to	2104 The initial status of the refactoring, i.e. problems related to

2073 the context in which the refactoring is requested.	2105 the context in which the refactoring is requested.

2074 The array will be empty if there are no known problems.	2106 The array will be empty if there are no known problems.

2075 </p>	2107 </p>

2076 </dd><dt class="field"><b>optionsProblems (List<<a href="#type_Refa ctoringProblem">RefactoringProblem</a>>)</b></dt><dd>	2108 </dd><dt class="field"><b>optionsProblems: List<<a href="#type_Refa ctoringProblem">RefactoringProblem</a>></b></dt><dd>

2077	2109

2078 <p>	2110 <p>

2079 The options validation status, i.e. problems in the given options,	2111 The options validation status, i.e. problems in the given options,

2080 such as light-weight validation of a new name, flags	2112 such as light-weight validation of a new name, flags

2081 compatibility, etc.	2113 compatibility, etc.

2082 The array will be empty if there are no known problems.	2114 The array will be empty if there are no known problems.

2083 </p>	2115 </p>

2084 </dd><dt class="field"><b>finalProblems (List<<a href="#type_Refact oringProblem">RefactoringProblem</a>>)</b></dt><dd>	2116 </dd><dt class="field"><b>finalProblems: List<<a href="#type_Refact oringProblem">RefactoringProblem</a>></b></dt><dd>

2085	2117

2086 <p>	2118 <p>

2087 The final status of the refactoring, i.e. problems identified in	2119 The final status of the refactoring, i.e. problems identified in

2088 the result of a full, potentially expensive validation and / or	2120 the result of a full, potentially expensive validation and / or

2089 change creation.	2121 change creation.

2090 The array will be empty if there are no known problems.	2122 The array will be empty if there are no known problems.

2091 </p>	2123 </p>

2092 </dd><dt class="field"><b>feedback (<span style="color:#999999">option al</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</b></dt>< dd>	2124 </dd><dt class="field"><b>feedback: <a href="#type_RefactoringFeedback ">RefactoringFeedback</a><span style="color:#999999"> (@optional)</span></b></dt ><dd>

2093	2125

2094 <p>	2126 <p>

2095 Data used to provide feedback to the user. The structure	2127 Data used to provide feedback to the user. The structure

2096 of the data is dependent on the kind of refactoring	2128 of the data is dependent on the kind of refactoring

2097 being created. The data that is returned is documented	2129 being created. The data that is returned is documented

2098 in the section titled <a href="#refactorings">Refactorings</a>, la beled as	2130 in the section titled <a href="#refactorings">Refactorings</a>, la beled as

2099 "Feedback".	2131 "Feedback".

2100 </p>	2132 </p>

2101 </dd><dt class="field"><b>change (<span style="color:#999999">optional </span> <a href="#type_SourceChange">SourceChange</a>)</b></dt><dd>	2133 </dd><dt class="field"><b>change: <a href="#type_SourceChange">SourceC hange</a><span style="color:#999999"> (@optional)</span></b></dt><dd>

2102	2134

2103 <p>	2135 <p>

2104 The changes that are to be applied to affect the	2136 The changes that are to be applied to affect the

2105 refactoring. This field will be omitted if there are	2137 refactoring. This field will be omitted if there are

2106 problems that prevent a set of changes from being	2138 problems that prevent a set of changes from being

2107 computed, such as having no options specified for a	2139 computed, such as having no options specified for a

2108 refactoring that requires them, or if only validation	2140 refactoring that requires them, or if only validation

2109 was requested.	2141 was requested.

2110 </p>	2142 </p>

2111 </dd><dt class="field"><b>potentialEdits (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>	2143 </dd><dt class="field"><b>potentialEdits: List<String><span styl e="color:#999999"> (@optional)</span></b></dt><dd>

2112	2144

2113 <p>	2145 <p>

2114 The ids of source edits that are not known to be valid. An edit is	2146 The ids of source edits that are not known to be valid. An edit is

2115 not known to be valid if there was insufficient type information	2147 not known to be valid if there was insufficient type information

2116 for the server to be able to determine whether or not the code	2148 for the server to be able to determine whether or not the code

2117 needs to be modified, such as when a member is being renamed and	2149 needs to be modified, such as when a member is being renamed and

2118 there is a reference to a member from an unknown type. This field	2150 there is a reference to a member from an unknown type. This field

2119 will be omitted if the change field is omitted or if there are no	2151 will be omitted if the change field is omitted or if there are no

2120 potential edits for the refactoring.	2152 potential edits for the refactoring.

2121 </p>	2153 </p>

2122 </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers"> edit.sortMembers</a> (<a href="#request_edit.sortMembers">#</a>)</dt><dd><div cl ass="box"><pre>request: {	2154 </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers"> edit.sortMembers</a></dt><dd><div class="box"><pre>request: {

2123 "id": String	2155 "id": String

2124 "method": "edit.sortMembers"	2156 "method": "edit.sortMembers"

2125 "params": {	2157 "params": {

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

2127 }	2159 }

2128 }</pre><br><pre>response: {	2160 }</pre><br><pre>response: {

2129 "id": String	2161 "id": String

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

2131 "result": {	2163 "result": {

2132 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>	2164 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>

2133 }	2165 }

2134 }</pre></div>	2166 }</pre></div>

2135 <p>	2167 <p>

2136 Sort all of the directives, unit and class members	2168 Sort all of the directives, unit and class members

2137 of the given Dart file.	2169 of the given Dart file.

2138 </p>	2170 </p>

2139 <p>	2171 <p>

2140 If a request is made for a file that does not exist, does not belong	2172 If a request is made for a file that does not exist, does not belong

2141 to an analysis root or is not a Dart file,	2173 to an analysis root or is not a Dart file,

2142 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.	2174 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated.

2143 </p>	2175 </p>

2144 <p>	2176 <p>

2145 If the Dart file has scan or parse errors,	2177 If the Dart file has scan or parse errors,

2146 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.	2178 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated.

2147 </p>	2179 </p>

2148	2180

2149	2181

2150 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	2182 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

2151	2183

2152 <p>	2184 <p>

2153 The Dart file to sort.	2185 The Dart file to sort.

2154 </p>	2186 </p>

2155 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd>	2187 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#ty pe_SourceFileEdit">SourceFileEdit</a></b></dt><dd>

2156	2188

2157 <p>	2189 <p>

2158 The file edit that is to be applied to the given file to effect	2190 The file edit that is to be applied to the given file to effect

2159 the sorting.	2191 the sorting.

2160 </p>	2192 </p>

2161 </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: {	2193 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec tives">edit.organizeDirectives</a></dt><dd><div class="box"><pre>request: {

2162 "id": String	2194 "id": String

2163 "method": "edit.organizeDirectives"	2195 "method": "edit.organizeDirectives"

2164 "params": {	2196 "params": {

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

2166 }	2198 }

2167 }</pre><br><pre>response: {	2199 }</pre><br><pre>response: {

2168 "id": String	2200 "id": String

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

2170 "result": {	2202 "result": {

2171 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>	2203 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>

(...skipping 10 matching lines...) Expand all Loading...
2182 <tt>FILE_NOT_ANALYZED</tt> will be generated.	2214 <tt>FILE_NOT_ANALYZED</tt> will be generated.

2183 </p>	2215 </p>

2184 <p>	2216 <p>

2185 If directives of the Dart file cannot be organized, for example	2217 If directives of the Dart file cannot be organized, for example

2186 because it has scan or parse errors, or by other reasons,	2218 because it has scan or parse errors, or by other reasons,

2187 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message	2219 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message

2188 will provide details about the reason.	2220 will provide details about the reason.

2189 </p>	2221 </p>

2190	2222

2191	2223

2192 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	2224 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

2193	2225

2194 <p>	2226 <p>

2195 The Dart file to organize directives in.	2227 The Dart file to organize directives in.

2196 </p>	2228 </p>

2197 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd>	2229 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#ty pe_SourceFileEdit">SourceFileEdit</a></b></dt><dd>

2198	2230

2199 <p>	2231 <p>

2200 The file edit that is to be applied to the given file to effect	2232 The file edit that is to be applied to the given file to effect

2201 the organizing.	2233 the organizing.

2202 </p>	2234 </p>

2203 </dd></dl></dd></dl>	2235 </dd></dl></dd></dl>

2204 <h2 class="domain"><a name="domain_execution">execution domain</a></h2>	2236 <h2 class="domain"><a name="domain_execution">execution domain</a></h2>

2205 <p>	2237 <p>

2206 The execution domain contains commands related to providing an execution	2238 The execution domain contains commands related to providing an execution

2207 or debugging experience.	2239 or debugging experience.

2208 </p>	2240 </p>

2209	2241

2210	2242

2211	2243

2212	2244

2213	2245

2214 <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: {	2246 <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createCo ntext">execution.createContext</a></dt><dd><div class="box"><pre>request: {

2215 "id": String	2247 "id": String

2216 "method": "execution.createContext"	2248 "method": "execution.createContext"

2217 "params": {	2249 "params": {

2218 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a>	2250 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a>

2219 }	2251 }

2220 }</pre><br><pre>response: {	2252 }</pre><br><pre>response: {

2221 "<b>id</b>": String	2253 "<b>id</b>": String

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

2223 "result": {	2255 "result": {

2224 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	2256 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

2225 }	2257 }

2226 }</pre></div>	2258 }</pre></div>

2227 <p>	2259 <p>

2228 Create an execution context for the executable file with the given	2260 Create an execution context for the executable file with the given

2229 path. The context that is created will persist until	2261 path. The context that is created will persist until

2230 execution.deleteContext is used to delete it. Clients, therefore, are	2262 execution.deleteContext is used to delete it. Clients, therefore, are

2231 responsible for managing the lifetime of execution contexts.	2263 responsible for managing the lifetime of execution contexts.

2232 </p>	2264 </p>

2233	2265

2234	2266

2235 <h4>parameters:</h4><dl><dt class="field"><b>contextRoot (<a href="#type_F ilePath">FilePath</a>)</b></dt><dd>	2267 <h4>parameters:</h4><dl><dt class="field"><b>contextRoot: <a href="#type_F ilePath">FilePath</a></b></dt><dd>

2236	2268

2237 <p>	2269 <p>

2238 The path of the Dart or HTML file that will be launched, or the	2270 The path of the Dart or HTML file that will be launched, or the

2239 path of the directory containing the file.	2271 path of the directory containing the file.

2240 </p>	2272 </p>

2241 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type _ExecutionContextId">ExecutionContextId</a>)</b></dt><dd>	2273 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type _ExecutionContextId">ExecutionContextId</a></b></dt><dd>

2242	2274

2243 <p>	2275 <p>

2244 The identifier used to refer to the execution context that was	2276 The identifier used to refer to the execution context that was

2245 created.	2277 created.

2246 </p>	2278 </p>

2247 </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: {	2279 </dd></dl></dd><dt class="request"><a name="request_execution.deleteCo ntext">execution.deleteContext</a></dt><dd><div class="box"><pre>request: {

2248 "<b>id</b>": String	2280 "<b>id</b>": String

2249 "method": "execution.deleteContext"	2281 "method": "execution.deleteContext"

2250 "params": {	2282 "params": {

2251 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	2283 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

2252 }	2284 }

2253 }</pre><br><pre>response: {	2285 }</pre><br><pre>response: {

2254 "id": String	2286 "id": String

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

2256 }</pre></div>	2288 }</pre></div>

2257 <p>	2289 <p>

2258 Delete the execution context with the given identifier. The context id	2290 Delete the execution context with the given identifier. The context id

2259 is no longer valid after this command. The server is allowed to re-use	2291 is no longer valid after this command. The server is allowed to re-use

2260 ids when they are no longer valid.	2292 ids when they are no longer valid.

2261 </p>	2293 </p>

2262	2294

2263 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC ontextId">ExecutionContextId</a>)</b></dt><dd>	2295 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_ExecutionC ontextId">ExecutionContextId</a></b></dt><dd>

2264	2296

2265 <p>	2297 <p>

2266 The identifier of the execution context that is to be deleted.	2298 The identifier of the execution context that is to be deleted.

2267 </p>	2299 </p>

2268 </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: {	2300 </dd></dl></dd><dt class="request"><a name="request_execution.mapUri"> execution.mapUri</a></dt><dd><div class="box"><pre>request: {

2269 "<b>id</b>": String	2301 "<b>id</b>": String

2270 "method": "execution.mapUri"	2302 "method": "execution.mapUri"

2271 "params": {	2303 "params": {

2272 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	2304 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

2273 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>	2305 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>

2274 "<b>uri</b>": <span style="color:#999999">optional</span> String	2306 "<b>uri</b>": <span style="color:#999999">optional</span> String

2275 }	2307 }

2276 }</pre><br><pre>response: {	2308 }</pre><br><pre>response: {

2277 "id": String	2309 "id": String

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

(...skipping 25 matching lines...) Expand all Loading...
2304 does not exist or something other than a file), then an error of type	2336 does not exist or something other than a file), then an error of type

2305 <tt>INVALID_PARAMETER</tt> will be generated.	2337 <tt>INVALID_PARAMETER</tt> will be generated.

2306 </p>	2338 </p>

2307 <p>	2339 <p>

2308 If the contextRoot used to create the execution context does not	2340 If the contextRoot used to create the execution context does not

2309 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will	2341 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will

2310 be generated.	2342 be generated.

2311 </p>	2343 </p>

2312	2344

2313	2345

2314 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC ontextId">ExecutionContextId</a>)</b></dt><dd>	2346 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_ExecutionC ontextId">ExecutionContextId</a></b></dt><dd>

2315	2347

2316 <p>	2348 <p>

2317 The identifier of the execution context in which the URI is to be	2349 The identifier of the execution context in which the URI is to be

2318 mapped.	2350 mapped.

2319 </p>	2351 </p>

2320 </dd><dt class="field"><b>file (<span style="color:#999999">optional</ span> <a href="#type_FilePath">FilePath</a>)</b></dt><dd>	2352 </dd><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a>< span style="color:#999999"> (@optional)</span></b></dt><dd>

2321	2353

2322 <p>	2354 <p>

2323 The path of the file to be mapped into a URI.	2355 The path of the file to be mapped into a URI.

2324 </p>	2356 </p>

2325 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s pan> String)</b></dt><dd>	2357 </dd><dt class="field"><b>uri: String<span style="color:#999999"> (@op tional)</span></b></dt><dd>

2326	2358

2327 <p>	2359 <p>

2328 The URI to be mapped into a file path.	2360 The URI to be mapped into a file path.

2329 </p>	2361 </p>

2330 </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>	2362 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>file: <a href="#ty pe_FilePath">FilePath</a><span style="color:#999999"> (@optional)</span></b></dt ><dd>

2331	2363

2332 <p>	2364 <p>

2333 The file to which the URI was mapped. This field is omitted if the	2365 The file to which the URI was mapped. This field is omitted if the

2334 uri field was not given in the request.	2366 uri field was not given in the request.

2335 </p>	2367 </p>

2336 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s pan> String)</b></dt><dd>	2368 </dd><dt class="field"><b>uri: String<span style="color:#999999"> (@op tional)</span></b></dt><dd>

2337	2369

2338 <p>	2370 <p>

2339 The URI to which the file path was mapped. This field is omitted	2371 The URI to which the file path was mapped. This field is omitted

2340 if the file field was not given in the request.	2372 if the file field was not given in the request.

2341 </p>	2373 </p>

2342 </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: {	2374 </dd></dl></dd><dt class="request deprecated"><a name="request_executi on.setSubscriptions">execution.setSubscriptions</a></dt><dd><div class="box"><pr e>request: {

2343 "id": String	2375 "id": String

2344 "method": "execution.setSubscriptions"	2376 "method": "execution.setSubscriptions"

2345 "params": {	2377 "params": {

2346 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>	2378 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>

2347 }	2379 }

2348 }</pre><br><pre>response: {	2380 }</pre><br><pre>response: {

2349 "id": String	2381 "id": String

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

2351 }</pre></div>	2383 }</pre></div>

2352 <p>	2384 <p>

2353 <b><i>Deprecated</i></b>: the analysis server no longer fires	2385 <b>@deprecated:</b> the analysis server no longer fires

2354 <tt>LAUNCH_DATA</tt> events.	2386 <tt>LAUNCH_DATA</tt> events.

2355 </p>	2387 </p>

2356 <p>	2388 <p>

2357 Subscribe for services. All previous subscriptions are replaced by the	2389 Subscribe for services. All previous subscriptions are replaced by the

2358 given set of services.	2390 given set of services.

2359 </p>	2391 </p>

2360 <p>	2392 <p>

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

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

2363 remain unchanged.	2395 remain unchanged.

2364 </p>	2396 </p>

2365	2397

2366 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre f="#type_ExecutionService">ExecutionService</a>>)</b></dt><dd>	2398 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre f="#type_ExecutionService">ExecutionService</a>></b></dt><dd>

2367	2399

2368 <p>	2400 <p>

2369 A list of the services being subscribed to.	2401 A list of the services being subscribed to.

2370 </p>	2402 </p>

2371 </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: {	2403 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" ><a name="notification_execution.launchData">execution.launchData</a></dt><dd><d iv class="box"><pre>notification: {

2372 "event": "execution.launchData"	2404 "event": "execution.launchData"

2373 "params": {	2405 "params": {

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

2375 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>	2407 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>

2376 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>	2408 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>

2377 }	2409 }

2378 }</pre></div>	2410 }</pre></div>

2379 <p>	2411 <p>

2380 Reports information needed to allow a single file to be launched.	2412 Reports information needed to allow a single file to be launched.

2381 </p>	2413 </p>

2382 <p>	2414 <p>

2383 This notification is not subscribed to by default. Clients can	2415 This notification is not subscribed to by default. Clients can

2384 subscribe by including the value "LAUNCH_DATA" in the list of services	2416 subscribe by including the value "LAUNCH_DATA" in the list of services

2385 passed in an <tt>execution.setSubscriptions</tt> request.	2417 passed in an <tt>execution.setSubscriptions</tt> request.

2386 </p>	2418 </p>

2387	2419

2388 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath ">FilePath</a>)</b></dt><dd>	2420 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath ">FilePath</a></b></dt><dd>

2389	2421

2390 <p>	2422 <p>

2391 The file for which launch data is being provided. This will either	2423 The file for which launch data is being provided. This will either

2392 be a Dart library or an HTML file.	2424 be a Dart library or an HTML file.

2393 </p>	2425 </p>

2394 </dd><dt class="field"><b>kind (<span style="color:#999999">optional</ span> <a href="#type_ExecutableKind">ExecutableKind</a>)</b></dt><dd>	2426 </dd><dt class="field"><b>kind: <a href="#type_ExecutableKind">Executa bleKind</a><span style="color:#999999"> (@optional)</span></b></dt><dd>

2395	2427

2396 <p>	2428 <p>

2397 The kind of the executable file. This field is omitted if the file	2429 The kind of the executable file. This field is omitted if the file

2398 is not a Dart file.	2430 is not a Dart file.

2399 </p>	2431 </p>

2400 </dd><dt class="field"><b>referencedFiles (<span style="color:#999999" >optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd>	2432 </dd><dt class="field"><b>referencedFiles: List<<a href="#type_File Path">FilePath</a>><span style="color:#999999"> (@optional)</span></b></dt><d d>

2401	2433

2402 <p>	2434 <p>

2403 A list of the Dart files that are referenced by the file. This	2435 A list of the Dart files that are referenced by the file. This

2404 field is omitted if the file is not an HTML file.	2436 field is omitted if the file is not an HTML file.

2405 </p>	2437 </p>

2406 </dd></dl></dd></dl>	2438 </dd></dl></dd></dl>

2407 <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2>	2439 <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2>

2408 <p>	2440 <p>

2409 The diagnostic domain contains server diagnostics APIs.	2441 The diagnostic domain contains server diagnostics APIs.

2410 </p>	2442 </p>

2411	2443

2412	2444

2413 <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: {	2445 <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiag nostics">diagnostic.getDiagnostics</a></dt><dd><div class="box"><pre>request: {

2414 "id": String	2446 "id": String

2415 "method": "diagnostic.getDiagnostics"	2447 "method": "diagnostic.getDiagnostics"

2416 }</pre><br><pre>response: {	2448 }</pre><br><pre>response: {

2417 "id": String	2449 "id": String

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

2419 "result": {	2451 "result": {

2420 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>>	2452 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>>

2421 }	2453 }

2422 }</pre></div>	2454 }</pre></div>

2423 <p>Return server diagnostics.</p>	2455 <p>Return server diagnostics.</p>

2424	2456

2425 <h4>returns:</h4><dl><dt class="field"><b>contexts (List<<a href="#type _ContextData">ContextData</a>>)</b></dt><dd>	2457 <h4>returns:</h4><dl><dt class="field"><b>contexts: List<<a href="#type _ContextData">ContextData</a>></b></dt><dd>

2426	2458

2427 <p>The list of analysis contexts.</p>	2459 <p>The list of analysis contexts.</p>

2428 </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServ erPort">diagnostic.getServerPort</a> (<a href="#request_diagnostic.getServerPort ">#</a>)</dt><dd><div class="box"><pre>request: {	2460 </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServ erPort">diagnostic.getServerPort</a></dt><dd><div class="box"><pre>request: {

2429 "id": String	2461 "id": String

2430 "method": "diagnostic.getServerPort"	2462 "method": "diagnostic.getServerPort"

2431 }</pre><br><pre>response: {	2463 }</pre><br><pre>response: {

2432 "id": String	2464 "id": String

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

2434 "result": {	2466 "result": {

2435 "<b>port</b>": int	2467 "<b>port</b>": int

2436 }	2468 }

2437 }</pre></div>	2469 }</pre></div>

2438 <p>	2470 <p>

2439 Return the port of the diagnostic web server. If the server is not run ning	2471 Return the port of the diagnostic web server. If the server is not run ning

2440 this call will start the server. If unable to start the diagnostic web server,	2472 this call will start the server. If unable to start the diagnostic web server,

2441 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</ tt>.	2473 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</ tt>.

2442 </p>	2474 </p>

2443	2475

2444 <h4>returns:</h4><dl><dt class="field"><b>port (int)</b></dt><dd>	2476 <h4>returns:</h4><dl><dt class="field"><b>port: int</b></dt><dd>

2445	2477

2446 <p>The diagnostic server port.</p>	2478 <p>The diagnostic server port.</p>

2447 </dd></dl></dd></dl>	2479 </dd></dl></dd></dl>

2448	2480

2449 <h2 class="domain"><a name="types">Types</a></h2>	2481 <h2 class="domain"><a name="types">Types</a></h2>

2450 <p>	2482 <p>

2451 This section contains descriptions of the data types referenced	2483 This section contains descriptions of the data types referenced

2452 in the API’s of the various domains.	2484 in the API’s of the various domains.

2453 </p>	2485 </p>

2454	2486

(...skipping 60 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2515 A directive to begin overlaying the contents of a file. The	2547 A directive to begin overlaying the contents of a file. The

2516 supplied content will be used for analysis in place of the	2548 supplied content will be used for analysis in place of the

2517 file contents in the filesystem.	2549 file contents in the filesystem.

2518 </p>	2550 </p>

2519 <p>	2551 <p>

2520 If this directive is used on a file that already has a file	2552 If this directive is used on a file that already has a file

2521 content overlay, the old overlay is discarded and replaced	2553 content overlay, the old overlay is discarded and replaced

2522 with the new one.	2554 with the new one.

2523 </p>	2555 </p>

2524	2556

2525 <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field">< b>content (String)</b></dt><dd>	2557 <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field">< b>content: String</b></dt><dd>

2526	2558

2527 <p>	2559 <p>

2528 The new content of the file.	2560 The new content of the file.

2529 </p>	2561 </p>

2530 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>	2562 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>

2531 <p>	2563 <p>

2532 An indication of an error, warning, or hint that was produced	2564 An indication of an error, warning, or hint that was produced

2533 by the analysis.	2565 by the analysis.

2534 </p>	2566 </p>

2535	2567

2536 <dl><dt class="field"><b>severity (<a href="#type_AnalysisErrorSeverity">A nalysisErrorSeverity</a>)</b></dt><dd>	2568 <dl><dt class="field"><b>severity: <a href="#type_AnalysisErrorSeverity">A nalysisErrorSeverity</a></b></dt><dd>

2537	2569

2538 <p>	2570 <p>

2539 The severity of the error.	2571 The severity of the error.

2540 </p>	2572 </p>

2541 </dd><dt class="field"><b>type (<a href="#type_AnalysisErrorType">Anal ysisErrorType</a>)</b></dt><dd>	2573 </dd><dt class="field"><b>type: <a href="#type_AnalysisErrorType">Anal ysisErrorType</a></b></dt><dd>

2542	2574

2543 <p>	2575 <p>

2544 The type of the error.	2576 The type of the error.

2545 </p>	2577 </p>

2546 </dd><dt class="field"><b>location (<a href="#type_Location">Location< /a>)</b></dt><dd>	2578 </dd><dt class="field"><b>location: <a href="#type_Location">Location< /a></b></dt><dd>

2547	2579

2548 <p>	2580 <p>

2549 The location associated with the error.	2581 The location associated with the error.

2550 </p>	2582 </p>

2551 </dd><dt class="field"><b>message (String)</b></dt><dd>	2583 </dd><dt class="field"><b>message: String</b></dt><dd>

2552	2584

2553 <p>	2585 <p>

2554 The message to be displayed for this error. The message	2586 The message to be displayed for this error. The message

2555 should indicate what is wrong with the code and why it is	2587 should indicate what is wrong with the code and why it is

2556 wrong.	2588 wrong.

2557 </p>	2589 </p>

2558 </dd><dt class="field"><b>correction (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	2590 </dd><dt class="field"><b>correction: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

2559	2591

2560 <p>	2592 <p>

2561 The correction message to be displayed for this error. The	2593 The correction message to be displayed for this error. The

2562 correction message should indicate how the user can fix	2594 correction message should indicate how the user can fix

2563 the error. The field is omitted if there is no correction	2595 the error. The field is omitted if there is no correction

2564 message associated with the error code.	2596 message associated with the error code.

2565 </p>	2597 </p>

2566 </dd><dt class="field"><b>code (String)</b></dt><dd>	2598 </dd><dt class="field"><b>code: String</b></dt><dd>

2567	2599

2568 <p>	2600 <p>

2569 The name, as a string, of the error code associated with this erro r.	2601 The name, as a string, of the error code associated with this erro r.

2570 </p>	2602 </p>

2571 </dd><dt class="field"><b>hasFix (<span style="color:#999999">optional </span> bool)</b></dt><dd>	2603 </dd><dt class="field"><b>hasFix: bool<span style="color:#999999"> (@o ptional)</span></b></dt><dd>

2572	2604

2573 <p>	2605 <p>

2574 A hint to indicate to interested clients that this error has	2606 A hint to indicate to interested clients that this error has

2575 an associated fix (or fixes). The absence of this field implies	2607 an associated fix (or fixes). The absence of this field implies

2576 there are not known to be fixes. Note that since the operation	2608 there are not known to be fixes. Note that since the operation

2577 to calculate whether fixes apply needs to be performant it is	2609 to calculate whether fixes apply needs to be performant it is

2578 possible that complicated tests will be skipped and a false	2610 possible that complicated tests will be skipped and a false

2579 negative returned. For this reason, this attribute should be	2611 negative returned. For this reason, this attribute should be

2580 treated as a "hint". Despite the possibility of false negatives,	2612 treated as a "hint". Despite the possibility of false negatives,

2581 no false positives should be returned. If a client sees this	2613 no false positives should be returned. If a client sees this

2582 flag set they can proceed with the confidence that there are in	2614 flag set they can proceed with the confidence that there are in

2583 fact associated fixes.	2615 fact associated fixes.

2584 </p>	2616 </p>

2585 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF ixes">AnalysisErrorFixes: object</a></dt><dd>	2617 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF ixes">AnalysisErrorFixes: object</a></dt><dd>

2586 <p>	2618 <p>

2587 A list of fixes associated with a specific error	2619 A list of fixes associated with a specific error

2588 </p>	2620 </p>

2589	2621

2590 <dl><dt class="field"><b>error (<a href="#type_AnalysisError">AnalysisErro r</a>)</b></dt><dd>	2622 <dl><dt class="field"><b>error: <a href="#type_AnalysisError">AnalysisErro r</a></b></dt><dd>

2591	2623

2592 <p>	2624 <p>

2593 The error with which the fixes are associated.	2625 The error with which the fixes are associated.

2594 </p>	2626 </p>

2595 </dd><dt class="field"><b>fixes (List<<a href="#type_SourceChange"> SourceChange</a>>)</b></dt><dd>	2627 </dd><dt class="field"><b>fixes: List<<a href="#type_SourceChange"> SourceChange</a>></b></dt><dd>

2596	2628

2597 <p>	2629 <p>

2598 The fixes associated with the error.	2630 The fixes associated with the error.

2599 </p>	2631 </p>

2600 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS everity">AnalysisErrorSeverity: String</a></dt><dd>	2632 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS everity">AnalysisErrorSeverity: String</a></dt><dd>

2601 <p>	2633 <p>

2602 An enumeration of the possible severities of analysis	2634 An enumeration of the possible severities of analysis

2603 errors.	2635 errors.

2604 </p>	2636 </p>

2605	2637

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

2607 <p>	2639 <p>

2608 An enumeration of the possible types of analysis errors.	2640 An enumeration of the possible types of analysis errors.

2609 </p>	2641 </p>

2610	2642

2611 <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>	2643 <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 deprecated"><a name="type_AnalysisOptions">AnalysisOptions: o bject</a></dt><dd>

2612 <p><b><i>Deprecated</i></b>: the only reference to this type has been	2644 <p><b>@deprecated:</b> the only reference to this type has been

2613 deprecated.</p>	2645 deprecated.</p>

2614 <p>	2646 <p>

2615 A set of options controlling what kind of analysis is to be	2647 A set of options controlling what kind of analysis is to be

2616 performed. If the value of a field is omitted the value of the	2648 performed. If the value of a field is omitted the value of the

2617 option will not be changed.	2649 option will not be changed.

2618 </p>	2650 </p>

2619	2651

2620 <dl><dt class="field"><b>enableAsync (<span style="color:#999999">optional </span> bool)</b></dt><dd>	2652 <dl><dt class="field"><b><span class="deprecated">enableAsync</span>: bool <span style="color:#999999"> (@optional)</span></b></dt><dd>

2621	2653

2622 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2654 <p><b>@deprecated:</b> this feature is always enabled.</p>

2623 <p>	2655 <p>

2624 True if the client wants to enable support for the	2656 True if the client wants to enable support for the

2625 proposed async feature.	2657 proposed async feature.

2626 </p>	2658 </p>

2627 </dd><dt class="field"><b>enableDeferredLoading (<span style="color:#9 99999">optional</span> bool)</b></dt><dd>	2659 </dd><dt class="field"><b><span class="deprecated">enableDeferredLoadi ng</span>: bool<span style="color:#999999"> (@optional)</span></b></dt><dd>

2628	2660

2629 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2661 <p><b>@deprecated:</b> this feature is always enabled.</p>

2630 <p>	2662 <p>

2631 True if the client wants to enable support for the	2663 True if the client wants to enable support for the

2632 proposed deferred loading feature.	2664 proposed deferred loading feature.

2633 </p>	2665 </p>

2634 </dd><dt class="field"><b>enableEnums (<span style="color:#999999">opt ional</span> bool)</b></dt><dd>	2666 </dd><dt class="field"><b><span class="deprecated">enableEnums</span>: bool<span style="color:#999999"> (@optional)</span></b></dt><dd>

2635	2667

2636 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2668 <p><b>@deprecated:</b> this feature is always enabled.</p>

2637 <p>	2669 <p>

2638 True if the client wants to enable support for the	2670 True if the client wants to enable support for the

2639 proposed enum feature.	2671 proposed enum feature.

2640 </p>	2672 </p>

2641 </dd><dt class="field"><b>enableNullAwareOperators (<span style="color :#999999">optional</span> bool)</b></dt><dd>	2673 </dd><dt class="field"><b><span class="deprecated">enableNullAwareOper ators</span>: bool<span style="color:#999999"> (@optional)</span></b></dt><dd>

2642	2674

2643 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p>	2675 <p><b>@deprecated:</b> this feature is always enabled.</p>

2644 <p>	2676 <p>

2645 True if the client wants to enable support for the	2677 True if the client wants to enable support for the

2646 proposed "null aware operators" feature.	2678 proposed "null aware operators" feature.

2647 </p>	2679 </p>

2648 </dd><dt class="field"><b>enableSuperMixins (<span style="color:#99999 9">optional</span> bool)</b></dt><dd>	2680 </dd><dt class="field"><b>enableSuperMixins: bool<span style="color:#9 99999"> (@optional)</span></b></dt><dd>

2649	2681

2650 <p>	2682 <p>

2651 True if the client wants to enable support for the	2683 True if the client wants to enable support for the

2652 proposed "less restricted mixins" proposal (DEP 34).	2684 proposed "less restricted mixins" proposal (DEP 34).

2653 </p>	2685 </p>

2654 </dd><dt class="field"><b>generateDart2jsHints (<span style="color:#99 9999">optional</span> bool)</b></dt><dd>	2686 </dd><dt class="field"><b>generateDart2jsHints: bool<span style="color :#999999"> (@optional)</span></b></dt><dd>

2655	2687

2656 <p>	2688 <p>

2657 True if hints that are specific to dart2js should be	2689 True if hints that are specific to dart2js should be

2658 generated. This option is ignored if generateHints is false.	2690 generated. This option is ignored if generateHints is false.

2659 </p>	2691 </p>

2660 </dd><dt class="field"><b>generateHints (<span style="color:#999999">o ptional</span> bool)</b></dt><dd>	2692 </dd><dt class="field"><b>generateHints: bool<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

2661	2693

2662 <p>	2694 <p>

2663 True if hints should be generated as part of generating	2695 True if hints should be generated as part of generating

2664 errors and warnings.	2696 errors and warnings.

2665 </p>	2697 </p>

2666 </dd><dt class="field"><b>generateLints (<span style="color:#999999">o ptional</span> bool)</b></dt><dd>	2698 </dd><dt class="field"><b>generateLints: bool<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

2667	2699

2668 <p>	2700 <p>

2669 True if lints should be generated as part of generating	2701 True if lints should be generated as part of generating

2670 errors and warnings.	2702 errors and warnings.

2671 </p>	2703 </p>

2672 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>	2704 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>

2673 <p>	2705 <p>

2674 An enumeration of the services provided by the analysis domain that	2706 An enumeration of the services provided by the analysis domain that

2675 are related to a specific list of files.	2707 are related to a specific list of files.

2676 </p>	2708 </p>

2677	2709

2678 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd>	2710 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd>

2679	2711

2680 <p>	2712 <p>

2681 This service is not currently implemented and will become a	2713 This service is not currently implemented and will become a

2682 GeneralAnalysisService in a future release.	2714 GeneralAnalysisService in a future release.

2683 </p>	2715 </p>

2684 </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>	2716 </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>

2685 <p>	2717 <p>

2686 An indication of the current state of analysis.	2718 An indication of the current state of analysis.

2687 </p>	2719 </p>

2688	2720

2689 <dl><dt class="field"><b>isAnalyzing (bool)</b></dt><dd>	2721 <dl><dt class="field"><b>isAnalyzing: bool</b></dt><dd>

2690	2722

2691 <p>True if analysis is currently being performed.</p>	2723 <p>True if analysis is currently being performed.</p>

2692 </dd><dt class="field"><b>analysisTarget (<span style="color:#999999"> optional</span> String)</b></dt><dd>	2724 </dd><dt class="field"><b>analysisTarget: String<span style="color:#99 9999"> (@optional)</span></b></dt><dd>

2693	2725

2694 <p>	2726 <p>

2695 The name of the current target of analysis. This field is	2727 The name of the current target of analysis. This field is

2696 omitted if analyzing is false.	2728 omitted if analyzing is false.

2697 </p>	2729 </p>

2698 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>	2730 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>

2699 <p>	2731 <p>

2700 A directive to modify an existing file content overlay. One or more	2732 A directive to modify an existing file content overlay. One or more

2701 ranges of text are deleted from the old file content overlay and	2733 ranges of text are deleted from the old file content overlay and

2702 replaced with new text.	2734 replaced with new text.

2703 </p>	2735 </p>

2704 <p>	2736 <p>

2705 The edits are applied in the order in which they occur in the list.	2737 The edits are applied in the order in which they occur in the list.

2706 This means that the offset of each edit must be correct under the	2738 This means that the offset of each edit must be correct under the

2707 assumption that all previous edits have been applied.	2739 assumption that all previous edits have been applied.

2708 </p>	2740 </p>

2709 <p>	2741 <p>

2710 It is an error to use this overlay on a file that does not yet have	2742 It is an error to use this overlay on a file that does not yet have

2711 a file content overlay or that has had its overlay removed via	2743 a file content overlay or that has had its overlay removed via

2712 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.	2744 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.

2713 </p>	2745 </p>

2714 <p>	2746 <p>

2715 If any of the edits cannot be applied due to its offset or	2747 If any of the edits cannot be applied due to its offset or

2716 length being out of range, an INVALID_OVERLAY_CHANGE error	2748 length being out of range, an INVALID_OVERLAY_CHANGE error

2717 will be reported.	2749 will be reported.

2718 </p>	2750 </p>

2719	2751

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

2721	2753

2722 <p>	2754 <p>

2723 The edits to be applied to the file.	2755 The edits to be applied to the file.

2724 </p>	2756 </p>

2725 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd>	2757 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd>

2726	2758

2727 <p>	2759 <p>

2728 An identifier used to associate completion results with a	2760 An identifier used to associate completion results with a

2729 completion request.	2761 completion request.

2730 </p>	2762 </p>

2731 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple tionSuggestion: object</a></dt><dd>	2763 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple tionSuggestion: object</a></dt><dd>

2732 <p>	2764 <p>

2733 A suggestion for how to complete partially entered text. Many	2765 A suggestion for how to complete partially entered text. Many

2734 of the fields are optional, depending on the kind of element	2766 of the fields are optional, depending on the kind of element

2735 being suggested.	2767 being suggested.

2736 </p>	2768 </p>

2737	2769

2738 <dl><dt class="field"><b>kind (<a href="#type_CompletionSuggestionKind">Co mpletionSuggestionKind</a>)</b></dt><dd>	2770 <dl><dt class="field"><b>kind: <a href="#type_CompletionSuggestionKind">Co mpletionSuggestionKind</a></b></dt><dd>

2739	2771

2740 <p>	2772 <p>

2741 The kind of element being suggested.	2773 The kind of element being suggested.

2742 </p>	2774 </p>

2743 </dd><dt class="field"><b>relevance (int)</b></dt><dd>	2775 </dd><dt class="field"><b>relevance: int</b></dt><dd>

2744	2776

2745 <p>	2777 <p>

2746 The relevance of this completion suggestion	2778 The relevance of this completion suggestion

2747 where a higher number indicates a higher relevance.	2779 where a higher number indicates a higher relevance.

2748 </p>	2780 </p>

2749 </dd><dt class="field"><b>completion (String)</b></dt><dd>	2781 </dd><dt class="field"><b>completion: String</b></dt><dd>

2750	2782

2751 <p>	2783 <p>

2752 The identifier to be inserted if the suggestion is	2784 The identifier to be inserted if the suggestion is

2753 selected. If the suggestion is for a method or function,	2785 selected. If the suggestion is for a method or function,

2754 the client might want to additionally insert a template	2786 the client might want to additionally insert a template

2755 for the parameters. The information required in order to	2787 for the parameters. The information required in order to

2756 do so is contained in other fields.	2788 do so is contained in other fields.

2757 </p>	2789 </p>

2758 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd>	2790 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd>

2759	2791

2760 <p>	2792 <p>

2761 The offset, relative to the beginning of the completion,	2793 The offset, relative to the beginning of the completion,

2762 of where the selection should be placed after insertion.	2794 of where the selection should be placed after insertion.

2763 </p>	2795 </p>

2764 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd>	2796 </dd><dt class="field"><b>selectionLength: int</b></dt><dd>

2765	2797

2766 <p>	2798 <p>

2767 The number of characters that should be selected after	2799 The number of characters that should be selected after

2768 insertion.	2800 insertion.

2769 </p>	2801 </p>

2770 </dd><dt class="field"><b>isDeprecated (bool)</b></dt><dd>	2802 </dd><dt class="field"><b>isDeprecated: bool</b></dt><dd>

2771	2803

2772 <p>	2804 <p>

2773 True if the suggested element is deprecated.	2805 True if the suggested element is deprecated.

2774 </p>	2806 </p>

2775 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd>	2807 </dd><dt class="field"><b>isPotential: bool</b></dt><dd>

2776	2808

2777 <p>	2809 <p>

2778 True if the element is not known to be valid for the	2810 True if the element is not known to be valid for the

2779 target. This happens if the type of the target is dynamic.	2811 target. This happens if the type of the target is dynamic.

2780 </p>	2812 </p>

2781 </dd><dt class="field"><b>docSummary (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	2813 </dd><dt class="field"><b>docSummary: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

2782	2814

2783 <p>	2815 <p>

2784 An abbreviated version of the Dartdoc associated with the	2816 An abbreviated version of the Dartdoc associated with the

2785 element being suggested, This field is omitted if there is	2817 element being suggested, This field is omitted if there is

2786 no Dartdoc associated with the element.	2818 no Dartdoc associated with the element.

2787 </p>	2819 </p>

2788 </dd><dt class="field"><b>docComplete (<span style="color:#999999">opt ional</span> String)</b></dt><dd>	2820 </dd><dt class="field"><b>docComplete: String<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

2789	2821

2790 <p>	2822 <p>

2791 The Dartdoc associated with the element being suggested,	2823 The Dartdoc associated with the element being suggested,

2792 This field is omitted if there is no Dartdoc associated	2824 This field is omitted if there is no Dartdoc associated

2793 with the element.	2825 with the element.

2794 </p>	2826 </p>

2795 </dd><dt class="field"><b>declaringType (<span style="color:#999999">o ptional</span> String)</b></dt><dd>	2827 </dd><dt class="field"><b>declaringType: String<span style="color:#999 999"> (@optional)</span></b></dt><dd>

2796	2828

2797 <p>	2829 <p>

2798 The class that declares the element being suggested. This	2830 The class that declares the element being suggested. This

2799 field is omitted if the suggested element is not a member	2831 field is omitted if the suggested element is not a member

2800 of a class.	2832 of a class.

2801 </p>	2833 </p>

2802 </dd><dt class="field"><b>defaultArgumentListString (<span style="colo r:#999999">optional</span> String)</b></dt><dd>	2834 </dd><dt class="field"><b>defaultArgumentListString: String<span style ="color:#999999"> (@optional)</span></b></dt><dd>

2803	2835

2804 <p>	2836 <p>

2805 A default String for use in generating argument list	2837 A default String for use in generating argument list

2806 source contents on the client side.	2838 source contents on the client side.

2807 </p>	2839 </p>

2808 </dd><dt class="field"><b>defaultArgumentListTextRanges (<span style=" color:#999999">optional</span> List<int>)</b></dt><dd>	2840 </dd><dt class="field"><b>defaultArgumentListTextRanges: List<int&g t;<span style="color:#999999"> (@optional)</span></b></dt><dd>

2809	2841

2810 <p>	2842 <p>

2811 Pairs of offsets and lengths describing 'defaultArgumentListString '	2843 Pairs of offsets and lengths describing 'defaultArgumentListString '

2812 text ranges suitable for use by clients to set up linked edits of	2844 text ranges suitable for use by clients to set up linked edits of

2813 default argument source contents. For example, given an argument	2845 default argument source contents. For example, given an argument

2814 list string 'x, y', the corresponding text range [0, 1, 3, 1],	2846 list string 'x, y', the corresponding text range [0, 1, 3, 1],

2815 indicates two text ranges of length 1, starting at offsets 0 and 3 .	2847 indicates two text ranges of length 1, starting at offsets 0 and 3 .

2816 Clients can use these ranges to treat the 'x' and 'y' values	2848 Clients can use these ranges to treat the 'x' and 'y' values

2817 specially for linked edits.	2849 specially for linked edits.

2818 </p>	2850 </p>

2819 </dd><dt class="field"><b>element (<span style="color:#999999">optiona l</span> <a href="#type_Element">Element</a>)</b></dt><dd>	2851 </dd><dt class="field"><b>element: <a href="#type_Element">Element</a> <span style="color:#999999"> (@optional)</span></b></dt><dd>

2820	2852

2821 <p>	2853 <p>

2822 Information about the element reference being suggested.	2854 Information about the element reference being suggested.

2823 </p>	2855 </p>

2824 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	2856 </dd><dt class="field"><b>returnType: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

2825	2857

2826 <p>	2858 <p>

2827 The return type of the getter, function or method	2859 The return type of the getter, function or method

2828 or the type of the field being suggested.	2860 or the type of the field being suggested.

2829 This field is omitted if the suggested element	2861 This field is omitted if the suggested element

2830 is not a getter, function or method.	2862 is not a getter, function or method.

2831 </p>	2863 </p>

2832 </dd><dt class="field"><b>parameterNames (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>	2864 </dd><dt class="field"><b>parameterNames: List<String><span styl e="color:#999999"> (@optional)</span></b></dt><dd>

2833	2865

2834 <p>	2866 <p>

2835 The names of the parameters of the function or method	2867 The names of the parameters of the function or method

2836 being suggested. This field is omitted if the suggested	2868 being suggested. This field is omitted if the suggested

2837 element is not a setter, function or method.	2869 element is not a setter, function or method.

2838 </p>	2870 </p>

2839 </dd><dt class="field"><b>parameterTypes (<span style="color:#999999"> optional</span> List<String>)</b></dt><dd>	2871 </dd><dt class="field"><b>parameterTypes: List<String><span styl e="color:#999999"> (@optional)</span></b></dt><dd>

2840	2872

2841 <p>	2873 <p>

2842 The types of the parameters of the function or method	2874 The types of the parameters of the function or method

2843 being suggested. This field is omitted if the	2875 being suggested. This field is omitted if the

2844 parameterNames field is omitted.	2876 parameterNames field is omitted.

2845 </p>	2877 </p>

2846 </dd><dt class="field"><b>requiredParameterCount (<span style="color:# 999999">optional</span> int)</b></dt><dd>	2878 </dd><dt class="field"><b>requiredParameterCount: int<span style="colo r:#999999"> (@optional)</span></b></dt><dd>

2847	2879

2848 <p>	2880 <p>

2849 The number of required parameters for the function or	2881 The number of required parameters for the function or

2850 method being suggested. This field is omitted if the	2882 method being suggested. This field is omitted if the

2851 parameterNames field is omitted.	2883 parameterNames field is omitted.

2852 </p>	2884 </p>

2853 </dd><dt class="field"><b>hasNamedParameters (<span style="color:#9999 99">optional</span> bool)</b></dt><dd>	2885 </dd><dt class="field"><b>hasNamedParameters: bool<span style="color:# 999999"> (@optional)</span></b></dt><dd>

2854	2886

2855 <p>	2887 <p>

2856 True if the function or method being suggested has at	2888 True if the function or method being suggested has at

2857 least one named parameter. This field is omitted if the	2889 least one named parameter. This field is omitted if the

2858 parameterNames field is omitted.	2890 parameterNames field is omitted.

2859 </p>	2891 </p>

2860 </dd><dt class="field"><b>parameterName (<span style="color:#999999">o ptional</span> String)</b></dt><dd>	2892 </dd><dt class="field"><b>parameterName: String<span style="color:#999 999"> (@optional)</span></b></dt><dd>

2861	2893

2862 <p>	2894 <p>

2863 The name of the optional parameter being suggested. This	2895 The name of the optional parameter being suggested. This

2864 field is omitted if the suggestion is not the addition of	2896 field is omitted if the suggestion is not the addition of

2865 an optional argument within an argument list.	2897 an optional argument within an argument list.

2866 </p>	2898 </p>

2867 </dd><dt class="field"><b>parameterType (<span style="color:#999999">o ptional</span> String)</b></dt><dd>	2899 </dd><dt class="field"><b>parameterType: String<span style="color:#999 999"> (@optional)</span></b></dt><dd>

2868	2900

2869 <p>	2901 <p>

2870 The type of the options parameter being suggested. This	2902 The type of the options parameter being suggested. This

2871 field is omitted if the parameterName field is omitted.	2903 field is omitted if the parameterName field is omitted.

2872 </p>	2904 </p>

2873 </dd><dt class="field"><b>importUri (<span style="color:#999999">optio nal</span> String)</b></dt><dd>	2905 </dd><dt class="field"><b>importUri: String<span style="color:#999999" > (@optional)</span></b></dt><dd>

2874	2906

2875 <p>	2907 <p>

2876 The import to be added if the suggestion is out of scope	2908 The import to be added if the suggestion is out of scope

2877 and needs an import to be added to be in scope.	2909 and needs an import to be added to be in scope.

2878 </p>	2910 </p>

2879 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>	2911 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>

2880 <p>	2912 <p>

2881 An enumeration of the kinds of elements that can be included	2913 An enumeration of the kinds of elements that can be included

2882 in a completion suggestion.	2914 in a completion suggestion.

2883 </p>	2915 </p>

(...skipping 33 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2917 <p>	2949 <p>

2918 A named argument for the current callsite is being suggested.	2950 A named argument for the current callsite is being suggested.

2919 For suggestions of this kind, the completion is	2951 For suggestions of this kind, the completion is

2920 the named argument identifier including a trailing ':' and space.	2952 the named argument identifier including a trailing ':' and space.

2921 </p>	2953 </p>

2922 </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>	2954 </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>

2923 <p>	2955 <p>

2924 Information about an analysis context.	2956 Information about an analysis context.

2925 </p>	2957 </p>

2926	2958

2927 <dl><dt class="field"><b>name (String)</b></dt><dd>	2959 <dl><dt class="field"><b>name: String</b></dt><dd>

2928	2960

2929 <p>	2961 <p>

2930 The name of the context.	2962 The name of the context.

2931 </p>	2963 </p>

2932 </dd><dt class="field"><b>explicitFileCount (int)</b></dt><dd>	2964 </dd><dt class="field"><b>explicitFileCount: int</b></dt><dd>

2933	2965

2934 <p>	2966 <p>

2935 Explicitly analyzed files.	2967 Explicitly analyzed files.

2936 </p>	2968 </p>

2937 </dd><dt class="field"><b>implicitFileCount (int)</b></dt><dd>	2969 </dd><dt class="field"><b>implicitFileCount: int</b></dt><dd>

2938	2970

2939 <p>	2971 <p>

2940 Implicitly analyzed files.	2972 Implicitly analyzed files.

2941 </p>	2973 </p>

2942 </dd><dt class="field"><b>workItemQueueLength (int)</b></dt><dd>	2974 </dd><dt class="field"><b>workItemQueueLength: int</b></dt><dd>

2943	2975

2944 <p>	2976 <p>

2945 The number of work items in the queue.	2977 The number of work items in the queue.

2946 </p>	2978 </p>

2947 </dd><dt class="field"><b>cacheEntryExceptions (List<String>)</b ></dt><dd>	2979 </dd><dt class="field"><b>cacheEntryExceptions: List<String></b> </dt><dd>

2948	2980

2949 <p>	2981 <p>

2950 Exceptions associated with cache entries.	2982 Exceptions associated with cache entries.

2951 </p>	2983 </p>

2952 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme nt: object</a></dt><dd>	2984 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme nt: object</a></dt><dd>

2953 <p>	2985 <p>

2954 Information about an element (something that can be declared	2986 Information about an element (something that can be declared

2955 in code).	2987 in code).

2956 </p>	2988 </p>

2957	2989

2958 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a> )</b></dt><dd>	2990 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a> </b></dt><dd>

2959	2991

2960 <p>	2992 <p>

2961 The kind of the element.	2993 The kind of the element.

2962 </p>	2994 </p>

2963 </dd><dt class="field"><b>name (String)</b></dt><dd>	2995 </dd><dt class="field"><b>name: String</b></dt><dd>

2964	2996

2965 <p>	2997 <p>

2966 The name of the element. This is typically used as the	2998 The name of the element. This is typically used as the

2967 label in the outline.	2999 label in the outline.

2968 </p>	3000 </p>

2969 </dd><dt class="field"><b>location (<span style="color:#999999">option al</span> <a href="#type_Location">Location</a>)</b></dt><dd>	3001 </dd><dt class="field"><b>location: <a href="#type_Location">Location< /a><span style="color:#999999"> (@optional)</span></b></dt><dd>

2970	3002

2971 <p>	3003 <p>

2972 The location of the name in the declaration of the	3004 The location of the name in the declaration of the

2973 element.	3005 element.

2974 </p>	3006 </p>

2975 </dd><dt class="field"><b>flags (int)</b></dt><dd>	3007 </dd><dt class="field"><b>flags: int</b></dt><dd>

2976	3008

2977 <p>	3009 <p>

2978 A bit-map containing the following flags:	3010 A bit-map containing the following flags:

2979 </p>	3011 </p>

2980 <ul>	3012 <ul>

2981 <li>0x01 - set if the element is explicitly or implicitly abstract </li>	3013 <li>0x01 - set if the element is explicitly or implicitly abstract </li>

2982 <li>0x02 - set if the element was declared to be ‘const’</li>	3014 <li>0x02 - set if the element was declared to be ‘const’</li>

2983 <li>0x04 - set if the element was declared to be ‘final’</li>	3015 <li>0x04 - set if the element was declared to be ‘final’</li>

2984 <li>0x08 - set if the element is a static member of a class or is a top-level function or field</li>	3016 <li>0x08 - set if the element is a static member of a class or is a top-level function or field</li>

2985 <li>0x10 - set if the element is private</li>	3017 <li>0x10 - set if the element is private</li>

2986 <li>0x20 - set if the element is deprecated</li>	3018 <li>0x20 - set if the element is deprecated</li>

2987 </ul>	3019 </ul>

2988 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	3020 </dd><dt class="field"><b>parameters: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

2989	3021

2990 <p>	3022 <p>

2991 The parameter list for the element. If the element is not	3023 The parameter list for the element. If the element is not

2992 a method or function this field will not be defined. If	3024 a method or function this field will not be defined. If

2993 the element doesn't have parameters (e.g. getter), this field	3025 the element doesn't have parameters (e.g. getter), this field

2994 will not be defined. If the element has zero parameters, this	3026 will not be defined. If the element has zero parameters, this

2995 field will have a value of "()".	3027 field will have a value of "()".

2996 </p>	3028 </p>

2997 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	3029 </dd><dt class="field"><b>returnType: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

2998	3030

2999 <p>	3031 <p>

3000 The return type of the element. If the element is not a	3032 The return type of the element. If the element is not a

3001 method or function this field will not be defined. If the	3033 method or function this field will not be defined. If the

3002 element does not have a declared return type, this field	3034 element does not have a declared return type, this field

3003 will contain an empty string.	3035 will contain an empty string.

3004 </p>	3036 </p>

3005 </dd><dt class="field"><b>typeParameters (<span style="color:#999999"> optional</span> String)</b></dt><dd>	3037 </dd><dt class="field"><b>typeParameters: String<span style="color:#99 9999"> (@optional)</span></b></dt><dd>

3006	3038

3007 <p>	3039 <p>

3008 The type parameter list for the element. If the element doesn't	3040 The type parameter list for the element. If the element doesn't

3009 have type parameters, this field will not be defined.	3041 have type parameters, this field will not be defined.

3010 </p>	3042 </p>

3011 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>	3043 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>

3012 <p>	3044 <p>

3013 An enumeration of the kinds of elements.	3045 An enumeration of the kinds of elements.

3014 </p>	3046 </p>

3015	3047

3016 <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>	3048 <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 deprecated">UNIT_TEST_GROUP</dt><dd>

3017	3049

3018 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>	3050 <p><b>@deprecated:</b> support for tests was removed.</p>

3019 </dd><dt class="value">UNIT_TEST_TEST</dt><dd>	3051 </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd>

3020	3052

3021 <p><b><i>Deprecated</i></b>: support for tests was removed.</p>	3053 <p><b>@deprecated:</b> support for tests was removed.</p>

3022 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition "><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>	3054 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition "><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd>

3023 <p>	3055 <p>

3024 A description of an executable file.	3056 A description of an executable file.

3025 </p>	3057 </p>

3026	3058

3027 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>	3059 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></ dt><dd>

3028	3060

3029 <p>	3061 <p>

3030 The path of the executable file.	3062 The path of the executable file.

3031 </p>	3063 </p>

3032 </dd><dt class="field"><b>kind (<a href="#type_ExecutableKind">Executa bleKind</a>)</b></dt><dd>	3064 </dd><dt class="field"><b>kind: <a href="#type_ExecutableKind">Executa bleKind</a></b></dt><dd>

3033	3065

3034 <p>	3066 <p>

3035 The kind of the executable file.	3067 The kind of the executable file.

3036 </p>	3068 </p>

3037 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd>	3069 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind ">ExecutableKind: String</a></dt><dd>

3038 <p>	3070 <p>

3039 An enumeration of the kinds of executable files.	3071 An enumeration of the kinds of executable files.

3040 </p>	3072 </p>

3041	3073

3042 <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>	3074 <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...
3068 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>	3100 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St ring</a></dt><dd>

3069 <p>	3101 <p>

3070 An enumeration of the kinds of folding regions.	3102 An enumeration of the kinds of folding regions.

3071 </p>	3103 </p>

3072	3104

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

3074 <p>	3106 <p>

3075 A description of a region that can be folded.	3107 A description of a region that can be folded.

3076 </p>	3108 </p>

3077	3109

3078 <dl><dt class="field"><b>kind (<a href="#type_FoldingKind">FoldingKind</a> )</b></dt><dd>	3110 <dl><dt class="field"><b>kind: <a href="#type_FoldingKind">FoldingKind</a> </b></dt><dd>

3079	3111

3080 <p>	3112 <p>

3081 The kind of the region.	3113 The kind of the region.

3082 </p>	3114 </p>

3083 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3115 </dd><dt class="field"><b>offset: int</b></dt><dd>

3084	3116

3085 <p>	3117 <p>

3086 The offset of the region to be folded.	3118 The offset of the region to be folded.

3087 </p>	3119 </p>

3088 </dd><dt class="field"><b>length (int)</b></dt><dd>	3120 </dd><dt class="field"><b>length: int</b></dt><dd>

3089	3121

3090 <p>	3122 <p>

3091 The length of the region to be folded.	3123 The length of the region to be folded.

3092 </p>	3124 </p>

3093 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi sService">GeneralAnalysisService: String</a></dt><dd>	3125 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi sService">GeneralAnalysisService: String</a></dt><dd>

3094 <p>	3126 <p>

3095 An enumeration of the services provided by the analysis domain that ar e	3127 An enumeration of the services provided by the analysis domain that ar e

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

3097 </p>	3129 </p>

3098	3130

3099 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>	3131 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd>

3100 <p>	3132 <p>

3101 A description of a region that could have special highlighting	3133 A description of a region that could have special highlighting

3102 associated with it.	3134 associated with it.

3103 </p>	3135 </p>

3104	3136

3105 <dl><dt class="field"><b>type (<a href="#type_HighlightRegionType">Highlig htRegionType</a>)</b></dt><dd>	3137 <dl><dt class="field"><b>type: <a href="#type_HighlightRegionType">Highlig htRegionType</a></b></dt><dd>

3106	3138

3107 <p>	3139 <p>

3108 The type of highlight associated with the region.	3140 The type of highlight associated with the region.

3109 </p>	3141 </p>

3110 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3142 </dd><dt class="field"><b>offset: int</b></dt><dd>

3111	3143

3112 <p>	3144 <p>

3113 The offset of the region to be highlighted.	3145 The offset of the region to be highlighted.

3114 </p>	3146 </p>

3115 </dd><dt class="field"><b>length (int)</b></dt><dd>	3147 </dd><dt class="field"><b>length: int</b></dt><dd>

3116	3148

3117 <p>	3149 <p>

3118 The length of the region to be highlighted.	3150 The length of the region to be highlighted.

3119 </p>	3151 </p>

3120 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio nType">HighlightRegionType: String</a></dt><dd>	3152 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio nType">HighlightRegionType: String</a></dt><dd>

3121 <p>	3153 <p>

3122 An enumeration of the kinds of highlighting that can be	3154 An enumeration of the kinds of highlighting that can be

3123 applied to files.	3155 applied to files.

3124 </p>	3156 </p>

3125	3157

(...skipping 142 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3268	3300

3269 <p>Only for version 2 of highlight.</p>	3301 <p>Only for version 2 of highlight.</p>

3270 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>	3302 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>

3271	3303

3272 <p>Only for version 2 of highlight.</p>	3304 <p>Only for version 2 of highlight.</p>

3273 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati on">HoverInformation: object</a></dt><dd>	3305 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati on">HoverInformation: object</a></dt><dd>

3274 <p>	3306 <p>

3275 The hover information associated with a specific location.	3307 The hover information associated with a specific location.

3276 </p>	3308 </p>

3277	3309

3278 <dl><dt class="field"><b>offset (int)</b></dt><dd>	3310 <dl><dt class="field"><b>offset: int</b></dt><dd>

3279	3311

3280 <p>	3312 <p>

3281 The offset of the range of characters that encompasses the	3313 The offset of the range of characters that encompasses the

3282 cursor position and has the same hover information as the	3314 cursor position and has the same hover information as the

3283 cursor position.	3315 cursor position.

3284 </p>	3316 </p>

3285 </dd><dt class="field"><b>length (int)</b></dt><dd>	3317 </dd><dt class="field"><b>length: int</b></dt><dd>

3286	3318

3287 <p>	3319 <p>

3288 The length of the range of characters that encompasses the	3320 The length of the range of characters that encompasses the

3289 cursor position and has the same hover information as the	3321 cursor position and has the same hover information as the

3290 cursor position.	3322 cursor position.

3291 </p>	3323 </p>

3292 </dd><dt class="field"><b>containingLibraryPath (<span style="color:#9 99999">optional</span> String)</b></dt><dd>	3324 </dd><dt class="field"><b>containingLibraryPath: String<span style="co lor:#999999"> (@optional)</span></b></dt><dd>

3293	3325

3294 <p>	3326 <p>

3295 The path to the defining compilation unit of the library	3327 The path to the defining compilation unit of the library

3296 in which the referenced element is declared. This data is	3328 in which the referenced element is declared. This data is

3297 omitted if there is no referenced element, or if the	3329 omitted if there is no referenced element, or if the

3298 element is declared inside an HTML file.	3330 element is declared inside an HTML file.

3299 </p>	3331 </p>

3300 </dd><dt class="field"><b>containingLibraryName (<span style="color:#9 99999">optional</span> String)</b></dt><dd>	3332 </dd><dt class="field"><b>containingLibraryName: String<span style="co lor:#999999"> (@optional)</span></b></dt><dd>

3301	3333

3302 <p>	3334 <p>

3303 The name of the library in which the referenced element is	3335 The name of the library in which the referenced element is

3304 declared. This data is omitted if there is no referenced	3336 declared. This data is omitted if there is no referenced

3305 element, or if the element is declared inside an HTML	3337 element, or if the element is declared inside an HTML

3306 file.	3338 file.

3307 </p>	3339 </p>

3308 </dd><dt class="field"><b>containingClassDescription (<span style="col or:#999999">optional</span> String)</b></dt><dd>	3340 </dd><dt class="field"><b>containingClassDescription: String<span styl e="color:#999999"> (@optional)</span></b></dt><dd>

3309	3341

3310 <p>	3342 <p>

3311 A human-readable description of the class declaring the element	3343 A human-readable description of the class declaring the element

3312 being referenced. This data is omitted if there is no referenced	3344 being referenced. This data is omitted if there is no referenced

3313 element, or if the element is not a class member.	3345 element, or if the element is not a class member.

3314 </p>	3346 </p>

3315 </dd><dt class="field"><b>dartdoc (<span style="color:#999999">optiona l</span> String)</b></dt><dd>	3347 </dd><dt class="field"><b>dartdoc: String<span style="color:#999999"> (@optional)</span></b></dt><dd>

3316	3348

3317 <p>	3349 <p>

3318 The dartdoc associated with the referenced element. Other	3350 The dartdoc associated with the referenced element. Other

3319 than the removal of the comment delimiters, including	3351 than the removal of the comment delimiters, including

3320 leading asterisks in the case of a block comment, the	3352 leading asterisks in the case of a block comment, the

3321 dartdoc is unprocessed markdown. This data is omitted if	3353 dartdoc is unprocessed markdown. This data is omitted if

3322 there is no referenced element, or if the element has no	3354 there is no referenced element, or if the element has no

3323 dartdoc.	3355 dartdoc.

3324 </p>	3356 </p>

3325 </dd><dt class="field"><b>elementDescription (<span style="color:#9999 99">optional</span> String)</b></dt><dd>	3357 </dd><dt class="field"><b>elementDescription: String<span style="color :#999999"> (@optional)</span></b></dt><dd>

3326	3358

3327 <p>	3359 <p>

3328 A human-readable description of the element being	3360 A human-readable description of the element being

3329 referenced. This data is omitted if there is no referenced	3361 referenced. This data is omitted if there is no referenced

3330 element.	3362 element.

3331 </p>	3363 </p>

3332 </dd><dt class="field"><b>elementKind (<span style="color:#999999">opt ional</span> String)</b></dt><dd>	3364 </dd><dt class="field"><b>elementKind: String<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

3333	3365

3334 <p>	3366 <p>

3335 A human-readable description of the kind of element being	3367 A human-readable description of the kind of element being

3336 referenced (such as "class" or "function type	3368 referenced (such as "class" or "function type

3337 alias"). This data is omitted if there is no referenced	3369 alias"). This data is omitted if there is no referenced

3338 element.	3370 element.

3339 </p>	3371 </p>

3340 </dd><dt class="field"><b>isDeprecated (<span style="color:#999999">op tional</span> bool)</b></dt><dd>	3372 </dd><dt class="field"><b>isDeprecated: bool<span style="color:#999999 "> (@optional)</span></b></dt><dd>

3341	3373

3342 <p>	3374 <p>

3343 True if the referenced element is deprecated.	3375 True if the referenced element is deprecated.

3344 </p>	3376 </p>

3345 </dd><dt class="field"><b>parameter (<span style="color:#999999">optio nal</span> String)</b></dt><dd>	3377 </dd><dt class="field"><b>parameter: String<span style="color:#999999" > (@optional)</span></b></dt><dd>

3346	3378

3347 <p>	3379 <p>

3348 A human-readable description of the parameter	3380 A human-readable description of the parameter

3349 corresponding to the expression being hovered over. This	3381 corresponding to the expression being hovered over. This

3350 data is omitted if the location is not in an argument to a	3382 data is omitted if the location is not in an argument to a

3351 function.	3383 function.

3352 </p>	3384 </p>

3353 </dd><dt class="field"><b>propagatedType (<span style="color:#999999"> optional</span> String)</b></dt><dd>	3385 </dd><dt class="field"><b>propagatedType: String<span style="color:#99 9999"> (@optional)</span></b></dt><dd>

3354	3386

3355 <p>	3387 <p>

3356 The name of the propagated type of the expression. This	3388 The name of the propagated type of the expression. This

3357 data is omitted if the location does not correspond to an	3389 data is omitted if the location does not correspond to an

3358 expression or if there is no propagated type information.	3390 expression or if there is no propagated type information.

3359 </p>	3391 </p>

3360 </dd><dt class="field"><b>staticType (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	3392 </dd><dt class="field"><b>staticType: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

3361	3393

3362 <p>	3394 <p>

3363 The name of the static type of the expression. This data	3395 The name of the static type of the expression. This data

3364 is omitted if the location does not correspond to an	3396 is omitted if the location does not correspond to an

3365 expression.	3397 expression.

3366 </p>	3398 </p>

3367 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla ss">ImplementedClass: object</a></dt><dd>	3399 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla ss">ImplementedClass: object</a></dt><dd>

3368 <p>	3400 <p>

3369 A description of a class that is implemented or extended.	3401 A description of a class that is implemented or extended.

3370 </p>	3402 </p>

3371	3403

3372 <dl><dt class="field"><b>offset (int)</b></dt><dd>	3404 <dl><dt class="field"><b>offset: int</b></dt><dd>

3373	3405

3374 <p>	3406 <p>

3375 The offset of the name of the implemented class.	3407 The offset of the name of the implemented class.

3376 </p>	3408 </p>

3377 </dd><dt class="field"><b>length (int)</b></dt><dd>	3409 </dd><dt class="field"><b>length: int</b></dt><dd>

3378	3410

3379 <p>	3411 <p>

3380 The length of the name of the implemented class.	3412 The length of the name of the implemented class.

3381 </p>	3413 </p>

3382 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem ber">ImplementedMember: object</a></dt><dd>	3414 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem ber">ImplementedMember: object</a></dt><dd>

3383 <p>	3415 <p>

3384 A description of a class member that is implemented or overridden.	3416 A description of a class member that is implemented or overridden.

3385 </p>	3417 </p>

3386	3418

3387 <dl><dt class="field"><b>offset (int)</b></dt><dd>	3419 <dl><dt class="field"><b>offset: int</b></dt><dd>

3388	3420

3389 <p>	3421 <p>

3390 The offset of the name of the implemented member.	3422 The offset of the name of the implemented member.

3391 </p>	3423 </p>

3392 </dd><dt class="field"><b>length (int)</b></dt><dd>	3424 </dd><dt class="field"><b>length: int</b></dt><dd>

3393	3425

3394 <p>	3426 <p>

3395 The length of the name of the implemented member.	3427 The length of the name of the implemented member.

3396 </p>	3428 </p>

3397 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou p">LinkedEditGroup: object</a></dt><dd>	3429 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou p">LinkedEditGroup: object</a></dt><dd>

3398 <p>	3430 <p>

3399 A collection of positions that should be linked (edited	3431 A collection of positions that should be linked (edited

3400 simultaneously) for the purposes of updating code after a	3432 simultaneously) for the purposes of updating code after a

3401 source change. For example, if a set of edits introduced a	3433 source change. For example, if a set of edits introduced a

3402 new variable name, the group would contain all of the	3434 new variable name, the group would contain all of the

3403 positions of the variable name so that if the client wanted	3435 positions of the variable name so that if the client wanted

3404 to let the user edit the variable name after the operation,	3436 to let the user edit the variable name after the operation,

3405 all occurrences of the name could be edited simultaneously.	3437 all occurrences of the name could be edited simultaneously.

3406 </p>	3438 </p>

3407	3439

3408 <dl><dt class="field"><b>positions (List<<a href="#type_Position">Posit ion</a>>)</b></dt><dd>	3440 <dl><dt class="field"><b>positions: List<<a href="#type_Position">Posit ion</a>></b></dt><dd>

3409	3441

3410 <p>	3442 <p>

3411 The positions of the regions that should be edited	3443 The positions of the regions that should be edited

3412 simultaneously.	3444 simultaneously.

3413 </p>	3445 </p>

3414 </dd><dt class="field"><b>length (int)</b></dt><dd>	3446 </dd><dt class="field"><b>length: int</b></dt><dd>

3415	3447

3416 <p>	3448 <p>

3417 The length of the regions that should be edited	3449 The length of the regions that should be edited

3418 simultaneously.	3450 simultaneously.

3419 </p>	3451 </p>

3420 </dd><dt class="field"><b>suggestions (List<<a href="#type_LinkedEd itSuggestion">LinkedEditSuggestion</a>>)</b></dt><dd>	3452 </dd><dt class="field"><b>suggestions: List<<a href="#type_LinkedEd itSuggestion">LinkedEditSuggestion</a>></b></dt><dd>

3421	3453

3422 <p>	3454 <p>

3423 Pre-computed suggestions for what every region might	3455 Pre-computed suggestions for what every region might

3424 want to be changed to.	3456 want to be changed to.

3425 </p>	3457 </p>

3426 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estion">LinkedEditSuggestion: object</a></dt><dd>	3458 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estion">LinkedEditSuggestion: object</a></dt><dd>

3427 <p>	3459 <p>

3428 A suggestion of a value that could be used to replace all of	3460 A suggestion of a value that could be used to replace all of

3429 the linked edit regions in a LinkedEditGroup.	3461 the linked edit regions in a LinkedEditGroup.

3430 </p>	3462 </p>

3431	3463

3432 <dl><dt class="field"><b>value (String)</b></dt><dd>	3464 <dl><dt class="field"><b>value: String</b></dt><dd>

3433	3465

3434 <p>	3466 <p>

3435 The value that could be used to replace all of the linked	3467 The value that could be used to replace all of the linked

3436 edit regions.	3468 edit regions.

3437 </p>	3469 </p>

3438 </dd><dt class="field"><b>kind (<a href="#type_LinkedEditSuggestionKin d">LinkedEditSuggestionKind</a>)</b></dt><dd>	3470 </dd><dt class="field"><b>kind: <a href="#type_LinkedEditSuggestionKin d">LinkedEditSuggestionKind</a></b></dt><dd>

3439	3471

3440 <p>	3472 <p>

3441 The kind of value being proposed.	3473 The kind of value being proposed.

3442 </p>	3474 </p>

3443 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estionKind">LinkedEditSuggestionKind: String</a></dt><dd>	3475 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg estionKind">LinkedEditSuggestionKind: String</a></dt><dd>

3444 <p>	3476 <p>

3445 An enumeration of the kind of values that can be suggested	3477 An enumeration of the kind of values that can be suggested

3446 for a linked edit.	3478 for a linked edit.

3447 </p>	3479 </p>

3448	3480

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

3450 <p>	3482 <p>

3451 A location (character range) within a file.	3483 A location (character range) within a file.

3452 </p>	3484 </p>

3453	3485

3454 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>	3486 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></ dt><dd>

3455	3487

3456 <p>	3488 <p>

3457 The file containing the range.	3489 The file containing the range.

3458 </p>	3490 </p>

3459 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3491 </dd><dt class="field"><b>offset: int</b></dt><dd>

3460	3492

3461 <p>	3493 <p>

3462 The offset of the range.	3494 The offset of the range.

3463 </p>	3495 </p>

3464 </dd><dt class="field"><b>length (int)</b></dt><dd>	3496 </dd><dt class="field"><b>length: int</b></dt><dd>

3465	3497

3466 <p>	3498 <p>

3467 The length of the range.	3499 The length of the range.

3468 </p>	3500 </p>

3469 </dd><dt class="field"><b>startLine (int)</b></dt><dd>	3501 </dd><dt class="field"><b>startLine: int</b></dt><dd>

3470	3502

3471 <p>	3503 <p>

3472 The one-based index of the line containing the first	3504 The one-based index of the line containing the first

3473 character of the range.	3505 character of the range.

3474 </p>	3506 </p>

3475 </dd><dt class="field"><b>startColumn (int)</b></dt><dd>	3507 </dd><dt class="field"><b>startColumn: int</b></dt><dd>

3476	3508

3477 <p>	3509 <p>

3478 The one-based index of the column containing the first	3510 The one-based index of the column containing the first

3479 character of the range.	3511 character of the range.

3480 </p>	3512 </p>

3481 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi on">NavigationRegion: object</a></dt><dd>	3513 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi on">NavigationRegion: object</a></dt><dd>

3482 <p>	3514 <p>

3483 A description of a region from which the user can navigate to	3515 A description of a region from which the user can navigate to

3484 the declaration of an element.	3516 the declaration of an element.

3485 </p>	3517 </p>

3486	3518

3487 <dl><dt class="field"><b>offset (int)</b></dt><dd>	3519 <dl><dt class="field"><b>offset: int</b></dt><dd>

3488	3520

3489 <p>	3521 <p>

3490 The offset of the region from which the user can navigate.	3522 The offset of the region from which the user can navigate.

3491 </p>	3523 </p>

3492 </dd><dt class="field"><b>length (int)</b></dt><dd>	3524 </dd><dt class="field"><b>length: int</b></dt><dd>

3493	3525

3494 <p>	3526 <p>

3495 The length of the region from which the user can navigate.	3527 The length of the region from which the user can navigate.

3496 </p>	3528 </p>

3497 </dd><dt class="field"><b>targets (List<int>)</b></dt><dd>	3529 </dd><dt class="field"><b>targets: List<int></b></dt><dd>

3498	3530

3499 <p>	3531 <p>

3500 The indexes of the targets (in the enclosing navigation response)	3532 The indexes of the targets (in the enclosing navigation response)

3501 to which the given region is bound. By opening the target, clients	3533 to which the given region is bound. By opening the target, clients

3502 can implement one form of navigation. This list cannot be empty.	3534 can implement one form of navigation. This list cannot be empty.

3503 </p>	3535 </p>

3504 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>	3536 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>

3505 <p>	3537 <p>

3506 A description of a target to which the user can navigate.	3538 A description of a target to which the user can navigate.

3507 </p>	3539 </p>

3508	3540

3509 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a> )</b></dt><dd>	3541 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a> </b></dt><dd>

3510	3542

3511 <p>	3543 <p>

3512 The kind of the element.	3544 The kind of the element.

3513 </p>	3545 </p>

3514 </dd><dt class="field"><b>fileIndex (int)</b></dt><dd>	3546 </dd><dt class="field"><b>fileIndex: int</b></dt><dd>

3515	3547

3516 <p>	3548 <p>

3517 The index of the file (in the enclosing navigation response) to	3549 The index of the file (in the enclosing navigation response) to

3518 navigate to.	3550 navigate to.

3519 </p>	3551 </p>

3520 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3552 </dd><dt class="field"><b>offset: int</b></dt><dd>

3521	3553

3522 <p>	3554 <p>

3523 The offset of the region to which the user can navigate.	3555 The offset of the region to which the user can navigate.

3524 </p>	3556 </p>

3525 </dd><dt class="field"><b>length (int)</b></dt><dd>	3557 </dd><dt class="field"><b>length: int</b></dt><dd>

3526	3558

3527 <p>	3559 <p>

3528 The length of the region to which the user can navigate.	3560 The length of the region to which the user can navigate.

3529 </p>	3561 </p>

3530 </dd><dt class="field"><b>startLine (int)</b></dt><dd>	3562 </dd><dt class="field"><b>startLine: int</b></dt><dd>

3531	3563

3532 <p>	3564 <p>

3533 The one-based index of the line containing the first	3565 The one-based index of the line containing the first

3534 character of the region.	3566 character of the region.

3535 </p>	3567 </p>

3536 </dd><dt class="field"><b>startColumn (int)</b></dt><dd>	3568 </dd><dt class="field"><b>startColumn: int</b></dt><dd>

3537	3569

3538 <p>	3570 <p>

3539 The one-based index of the column containing the first	3571 The one-based index of the column containing the first

3540 character of the region.	3572 character of the region.

3541 </p>	3573 </p>

3542 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd>	3574 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd>

3543 <p>	3575 <p>

3544 A description of the references to a single element within a	3576 A description of the references to a single element within a

3545 single file.	3577 single file.

3546 </p>	3578 </p>

3547	3579

3548 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>	3580 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b>< /dt><dd>

3549	3581

3550 <p>	3582 <p>

3551 The element that was referenced.	3583 The element that was referenced.

3552 </p>	3584 </p>

3553 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>	3585 </dd><dt class="field"><b>offsets: List<int></b></dt><dd>

3554	3586

3555 <p>	3587 <p>

3556 The offsets of the name of the referenced element within	3588 The offsets of the name of the referenced element within

3557 the file.	3589 the file.

3558 </p>	3590 </p>

3559 </dd><dt class="field"><b>length (int)</b></dt><dd>	3591 </dd><dt class="field"><b>length: int</b></dt><dd>

3560	3592

3561 <p>	3593 <p>

3562 The length of the name of the referenced element.	3594 The length of the name of the referenced element.

3563 </p>	3595 </p>

3564 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli ne: object</a></dt><dd>	3596 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli ne: object</a></dt><dd>

3565 <p>	3597 <p>

3566 An node in the outline structure of a file.	3598 An node in the outline structure of a file.

3567 </p>	3599 </p>

3568	3600

3569 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>	3601 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b>< /dt><dd>

3570	3602

3571 <p>	3603 <p>

3572 A description of the element represented by this node.	3604 A description of the element represented by this node.

3573 </p>	3605 </p>

3574 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3606 </dd><dt class="field"><b>offset: int</b></dt><dd>

3575	3607

3576 <p>	3608 <p>

3577 The offset of the first character of the element. This is	3609 The offset of the first character of the element. This is

3578 different than the offset in the Element, which if the	3610 different than the offset in the Element, which if the

3579 offset of the name of the element. It can be used, for	3611 offset of the name of the element. It can be used, for

3580 example, to map locations in the file back to an outline.	3612 example, to map locations in the file back to an outline.

3581 </p>	3613 </p>

3582 </dd><dt class="field"><b>length (int)</b></dt><dd>	3614 </dd><dt class="field"><b>length: int</b></dt><dd>

3583	3615

3584 <p>	3616 <p>

3585 The length of the element.	3617 The length of the element.

3586 </p>	3618 </p>

3587 </dd><dt class="field"><b>children (<span style="color:#999999">option al</span> List<<a href="#type_Outline">Outline</a>>)</b></dt><dd>	3619 </dd><dt class="field"><b>children: List<<a href="#type_Outline">Ou tline</a>><span style="color:#999999"> (@optional)</span></b></dt><dd>

3588	3620

3589 <p>	3621 <p>

3590 The children of the node. The field will be omitted if the	3622 The children of the node. The field will be omitted if the

3591 node has no children.	3623 node has no children.

3592 </p>	3624 </p>

3593 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over ride: object</a></dt><dd>	3625 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over ride: object</a></dt><dd>

3594 <p>	3626 <p>

3595 A description of a member that overrides an inherited member.	3627 A description of a member that overrides an inherited member.

3596 </p>	3628 </p>

3597	3629

3598 <dl><dt class="field"><b>offset (int)</b></dt><dd>	3630 <dl><dt class="field"><b>offset: int</b></dt><dd>

3599	3631

3600 <p>	3632 <p>

3601 The offset of the name of the overriding member.	3633 The offset of the name of the overriding member.

3602 </p>	3634 </p>

3603 </dd><dt class="field"><b>length (int)</b></dt><dd>	3635 </dd><dt class="field"><b>length: int</b></dt><dd>

3604	3636

3605 <p>	3637 <p>

3606 The length of the name of the overriding member.	3638 The length of the name of the overriding member.

3607 </p>	3639 </p>

3608 </dd><dt class="field"><b>superclassMember (<span style="color:#999999 ">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a>)</b></dt ><dd>	3640 </dd><dt class="field"><b>superclassMember: <a href="#type_OverriddenM ember">OverriddenMember</a><span style="color:#999999"> (@optional)</span></b></ dt><dd>

3609	3641

3610 <p>	3642 <p>

3611 The member inherited from a superclass that is overridden	3643 The member inherited from a superclass that is overridden

3612 by the overriding member. The field is omitted if there is	3644 by the overriding member. The field is omitted if there is

3613 no superclass member, in which case there must be at least	3645 no superclass member, in which case there must be at least

3614 one interface member.	3646 one interface member.

3615 </p>	3647 </p>

3616 </dd><dt class="field"><b>interfaceMembers (<span style="color:#999999 ">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember</a>& gt;)</b></dt><dd>	3648 </dd><dt class="field"><b>interfaceMembers: List<<a href="#type_Ove rriddenMember">OverriddenMember</a>><span style="color:#999999"> (@optional)< /span></b></dt><dd>

3617	3649

3618 <p>	3650 <p>

3619 The members inherited from interfaces that are overridden	3651 The members inherited from interfaces that are overridden

3620 by the overriding member. The field is omitted if there	3652 by the overriding member. The field is omitted if there

3621 are no interface members, in which case there must be a	3653 are no interface members, in which case there must be a

3622 superclass member.	3654 superclass member.

3623 </p>	3655 </p>

3624 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb er">OverriddenMember: object</a></dt><dd>	3656 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb er">OverriddenMember: object</a></dt><dd>

3625 <p>	3657 <p>

3626 A description of a member that is being overridden.	3658 A description of a member that is being overridden.

3627 </p>	3659 </p>

3628	3660

3629 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b> </dt><dd>	3661 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b>< /dt><dd>

3630	3662

3631 <p>	3663 <p>

3632 The element that is being overridden.	3664 The element that is being overridden.

3633 </p>	3665 </p>

3634 </dd><dt class="field"><b>className (String)</b></dt><dd>	3666 </dd><dt class="field"><b>className: String</b></dt><dd>

3635	3667

3636 <p>	3668 <p>

3637 The name of the class in which the member is defined.	3669 The name of the class in which the member is defined.

3638 </p>	3670 </p>

3639 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd>	3671 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi tion: object</a></dt><dd>

3640 <p>	3672 <p>

3641 A position within a file.	3673 A position within a file.

3642 </p>	3674 </p>

3643	3675

3644 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>	3676 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></ dt><dd>

3645	3677

3646 <p>	3678 <p>

3647 The file containing the position.	3679 The file containing the position.

3648 </p>	3680 </p>

3649 </dd><dt class="field"><b>offset (int)</b></dt><dd>	3681 </dd><dt class="field"><b>offset: int</b></dt><dd>

3650	3682

3651 <p>	3683 <p>

3652 The offset of the position.	3684 The offset of the position.

3653 </p>	3685 </p>

3654 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub Status: object</a></dt><dd>	3686 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub Status: object</a></dt><dd>

3655 <p>	3687 <p>

3656 An indication of the current state of pub execution.	3688 An indication of the current state of pub execution.

3657 </p>	3689 </p>

3658	3690

3659 <dl><dt class="field"><b>isListingPackageDirs (bool)</b></dt><dd>	3691 <dl><dt class="field"><b>isListingPackageDirs: bool</b></dt><dd>

3660	3692

3661 <p>	3693 <p>

3662 True if the server is currently running pub to produce a list of	3694 True if the server is currently running pub to produce a list of

3663 package directories.	3695 package directories.

3664 </p>	3696 </p>

3665 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>	3697 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin d">RefactoringKind: String</a></dt><dd>

3666 <p>	3698 <p>

3667 An enumeration of the kinds of refactorings that can be	3699 An enumeration of the kinds of refactorings that can be

3668 created.	3700 created.

3669 </p>	3701 </p>

3670	3702

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

3672 <p>	3704 <p>

3673 A description of a parameter in a method refactoring.	3705 A description of a parameter in a method refactoring.

3674 </p>	3706 </p>

3675	3707

3676 <dl><dt class="field"><b>id (<span style="color:#999999">optional</span> S tring)</b></dt><dd>	3708 <dl><dt class="field"><b>id: String<span style="color:#999999"> (@optional )</span></b></dt><dd>

3677	3709

3678 <p>	3710 <p>

3679 The unique identifier of the parameter.	3711 The unique identifier of the parameter.

3680 Clients may omit this field for the parameters they want to add.	3712 Clients may omit this field for the parameters they want to add.

3681 </p>	3713 </p>

3682 </dd><dt class="field"><b>kind (<a href="#type_RefactoringMethodParame terKind">RefactoringMethodParameterKind</a>)</b></dt><dd>	3714 </dd><dt class="field"><b>kind: <a href="#type_RefactoringMethodParame terKind">RefactoringMethodParameterKind</a></b></dt><dd>

3683	3715

3684 <p>	3716 <p>

3685 The kind of the parameter.	3717 The kind of the parameter.

3686 </p>	3718 </p>

3687 </dd><dt class="field"><b>type (String)</b></dt><dd>	3719 </dd><dt class="field"><b>type: String</b></dt><dd>

3688	3720

3689 <p>	3721 <p>

3690 The type that should be given to the parameter, or the return type	3722 The type that should be given to the parameter, or the return type

3691 of the parameter's function type.	3723 of the parameter's function type.

3692 </p>	3724 </p>

3693 </dd><dt class="field"><b>name (String)</b></dt><dd>	3725 </dd><dt class="field"><b>name: String</b></dt><dd>

3694	3726

3695 <p>	3727 <p>

3696 The name that should be given to the parameter.	3728 The name that should be given to the parameter.

3697 </p>	3729 </p>

3698 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	3730 </dd><dt class="field"><b>parameters: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

3699	3731

3700 <p>	3732 <p>

3701 The parameter list of the parameter's function type.	3733 The parameter list of the parameter's function type.

3702 If the parameter is not of a function type, this field will	3734 If the parameter is not of a function type, this field will

3703 not be defined. If the function type has zero parameters, this	3735 not be defined. If the function type has zero parameters, this

3704 field will have a value of "()".	3736 field will have a value of "()".

3705 </p>	3737 </p>

3706 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee dback">RefactoringFeedback: object</a></dt><dd>	3738 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee dback">RefactoringFeedback: object</a></dt><dd>

3707 <p>	3739 <p>

3708 An abstract superclass of all refactoring feedbacks.	3740 An abstract superclass of all refactoring feedbacks.

3709 </p>	3741 </p>

3710	3742

3711 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions" >RefactoringOptions: object</a></dt><dd>	3743 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions" >RefactoringOptions: object</a></dt><dd>

3712 <p>	3744 <p>

3713 An abstract superclass of all refactoring options.	3745 An abstract superclass of all refactoring options.

3714 </p>	3746 </p>

3715	3747

3716 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd>	3748 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa rameterKind">RefactoringMethodParameterKind: String</a></dt><dd>

3717 <p>	3749 <p>

3718 An enumeration of the kinds of parameters.	3750 An enumeration of the kinds of parameters.

3719 </p>	3751 </p>

3720	3752

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

3722 <p>	3754 <p>

3723 A description of a problem related to a refactoring.	3755 A description of a problem related to a refactoring.

3724 </p>	3756 </p>

3725	3757

3726 <dl><dt class="field"><b>severity (<a href="#type_RefactoringProblemSeveri ty">RefactoringProblemSeverity</a>)</b></dt><dd>	3758 <dl><dt class="field"><b>severity: <a href="#type_RefactoringProblemSeveri ty">RefactoringProblemSeverity</a></b></dt><dd>

3727	3759

3728 <p>	3760 <p>

3729 The severity of the problem being represented.	3761 The severity of the problem being represented.

3730 </p>	3762 </p>

3731 </dd><dt class="field"><b>message (String)</b></dt><dd>	3763 </dd><dt class="field"><b>message: String</b></dt><dd>

3732	3764

3733 <p>	3765 <p>

3734 A human-readable description of the problem being	3766 A human-readable description of the problem being

3735 represented.	3767 represented.

3736 </p>	3768 </p>

3737 </dd><dt class="field"><b>location (<span style="color:#999999">option al</span> <a href="#type_Location">Location</a>)</b></dt><dd>	3769 </dd><dt class="field"><b>location: <a href="#type_Location">Location< /a><span style="color:#999999"> (@optional)</span></b></dt><dd>

3738	3770

3739 <p>	3771 <p>

3740 The location of the problem being represented.	3772 The location of the problem being represented.

3741 This field is omitted unless there is a specific location	3773 This field is omitted unless there is a specific location

3742 associated with the problem (such as a location where an element	3774 associated with the problem (such as a location where an element

3743 being renamed will be shadowed).	3775 being renamed will be shadowed).

3744 </p>	3776 </p>

3745 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd>	3777 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd>

3746 <p>	3778 <p>

3747 An enumeration of the severities of problems that can be	3779 An enumeration of the severities of problems that can be

(...skipping 40 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3788 If this directive is used on a file that doesn't currently	3820 If this directive is used on a file that doesn't currently

3789 have a content overlay, it has no effect.	3821 have a content overlay, it has no effect.

3790 </p>	3822 </p>

3791	3823

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

3793 <p>	3825 <p>

3794 An indication of a problem with the execution of the server,	3826 An indication of a problem with the execution of the server,

3795 typically in response to a request.	3827 typically in response to a request.

3796 </p>	3828 </p>

3797	3829

3798 <dl><dt class="field"><b>code (<a href="#type_RequestErrorCode">RequestErr orCode</a>)</b></dt><dd>	3830 <dl><dt class="field"><b>code: <a href="#type_RequestErrorCode">RequestErr orCode</a></b></dt><dd>

3799	3831

3800 <p>	3832 <p>

3801 A code that uniquely identifies the error that occurred.	3833 A code that uniquely identifies the error that occurred.

3802 </p>	3834 </p>

3803 </dd><dt class="field"><b>message (String)</b></dt><dd>	3835 </dd><dt class="field"><b>message: String</b></dt><dd>

3804	3836

3805 <p>	3837 <p>

3806 A short description of the error.	3838 A short description of the error.

3807 </p>	3839 </p>

3808 </dd><dt class="field"><b>stackTrace (<span style="color:#999999">opti onal</span> String)</b></dt><dd>	3840 </dd><dt class="field"><b>stackTrace: String<span style="color:#999999 "> (@optional)</span></b></dt><dd>

3809	3841

3810 <p>	3842 <p>

3811 The stack trace associated with processing the request,	3843 The stack trace associated with processing the request,

3812 used for debugging the server.	3844 used for debugging the server.

3813 </p>	3845 </p>

3814 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>	3846 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>

3815 <p>	3847 <p>

3816 An enumeration of the types of errors that can occur in the	3848 An enumeration of the types of errors that can occur in the

3817 execution of the server.	3849 execution of the server.

3818 </p>	3850 </p>

(...skipping 172 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3991	4023

3992 <p>	4024 <p>

3993 An identifier used to associate search results with a search	4025 An identifier used to associate search results with a search

3994 request.	4026 request.

3995 </p>	4027 </p>

3996 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>	4028 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>

3997 <p>	4029 <p>

3998 A single result from a search request.	4030 A single result from a search request.

3999 </p>	4031 </p>

4000	4032

4001 <dl><dt class="field"><b>location (<a href="#type_Location">Location</a>)< /b></dt><dd>	4033 <dl><dt class="field"><b>location: <a href="#type_Location">Location</a></ b></dt><dd>

4002	4034

4003 <p>	4035 <p>

4004 The location of the code that matched the search criteria.	4036 The location of the code that matched the search criteria.

4005 </p>	4037 </p>

4006 </dd><dt class="field"><b>kind (<a href="#type_SearchResultKind">Searc hResultKind</a>)</b></dt><dd>	4038 </dd><dt class="field"><b>kind: <a href="#type_SearchResultKind">Searc hResultKind</a></b></dt><dd>

4007	4039

4008 <p>	4040 <p>

4009 The kind of element that was found or the kind of	4041 The kind of element that was found or the kind of

4010 reference that was found.	4042 reference that was found.

4011 </p>	4043 </p>

4012 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd>	4044 </dd><dt class="field"><b>isPotential: bool</b></dt><dd>

4013	4045

4014 <p>	4046 <p>

4015 True if the result is a potential match but cannot be	4047 True if the result is a potential match but cannot be

4016 confirmed to be a match. For example, if all references to	4048 confirmed to be a match. For example, if all references to

4017 a method m defined in some class were requested, and a	4049 a method m defined in some class were requested, and a

4018 reference to a method m from an unknown class were found,	4050 reference to a method m from an unknown class were found,

4019 it would be marked as being a potential match.	4051 it would be marked as being a potential match.

4020 </p>	4052 </p>

4021 </dd><dt class="field"><b>path (List<<a href="#type_Element">Elemen t</a>>)</b></dt><dd>	4053 </dd><dt class="field"><b>path: List<<a href="#type_Element">Elemen t</a>></b></dt><dd>

4022	4054

4023 <p>	4055 <p>

4024 The elements that contain the result, starting with the	4056 The elements that contain the result, starting with the

4025 most immediately enclosing ancestor and ending with the	4057 most immediately enclosing ancestor and ending with the

4026 library.	4058 library.

4027 </p>	4059 </p>

4028 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi nd">SearchResultKind: String</a></dt><dd>	4060 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi nd">SearchResultKind: String</a></dt><dd>

4029 <p>	4061 <p>

4030 An enumeration of the kinds of search results returned by the	4062 An enumeration of the kinds of search results returned by the

4031 search domain.	4063 search domain.

(...skipping 38 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
4070 <p>	4102 <p>

4071 An enumeration of the services provided by the server domain.	4103 An enumeration of the services provided by the server domain.

4072 </p>	4104 </p>

4073	4105

4074 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n ame="type_SourceChange">SourceChange: object</a></dt><dd>	4106 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n ame="type_SourceChange">SourceChange: object</a></dt><dd>

4075 <p>	4107 <p>

4076 A description of a set of edits that implement a single	4108 A description of a set of edits that implement a single

4077 conceptual change.	4109 conceptual change.

4078 </p>	4110 </p>

4079	4111

4080 <dl><dt class="field"><b>message (String)</b></dt><dd>	4112 <dl><dt class="field"><b>message: String</b></dt><dd>

4081	4113

4082 <p>	4114 <p>

4083 A human-readable description of the change to be applied.	4115 A human-readable description of the change to be applied.

4084 </p>	4116 </p>

4085 </dd><dt class="field"><b>edits (List<<a href="#type_SourceFileEdit ">SourceFileEdit</a>>)</b></dt><dd>	4117 </dd><dt class="field"><b>edits: List<<a href="#type_SourceFileEdit ">SourceFileEdit</a>></b></dt><dd>

4086	4118

4087 <p>	4119 <p>

4088 A list of the edits used to effect the change, grouped by	4120 A list of the edits used to effect the change, grouped by

4089 file.	4121 file.

4090 </p>	4122 </p>

4091 </dd><dt class="field"><b>linkedEditGroups (List<<a href="#type_Lin kedEditGroup">LinkedEditGroup</a>>)</b></dt><dd>	4123 </dd><dt class="field"><b>linkedEditGroups: List<<a href="#type_Lin kedEditGroup">LinkedEditGroup</a>></b></dt><dd>

4092	4124

4093 <p>	4125 <p>

4094 A list of the linked editing groups used to customize	4126 A list of the linked editing groups used to customize

4095 the changes that were made.	4127 the changes that were made.

4096 </p>	4128 </p>

4097 </dd><dt class="field"><b>selection (<span style="color:#999999">optio nal</span> <a href="#type_Position">Position</a>)</b></dt><dd>	4129 </dd><dt class="field"><b>selection: <a href="#type_Position">Position </a><span style="color:#999999"> (@optional)</span></b></dt><dd>

4098	4130

4099 <p>	4131 <p>

4100 The position that should be selected after the edits	4132 The position that should be selected after the edits

4101 have been applied.	4133 have been applied.

4102 </p>	4134 </p>

4103 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So urceEdit: object</a></dt><dd>	4135 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So urceEdit: object</a></dt><dd>

4104 <p>	4136 <p>

4105 A description of a single change to a single file.	4137 A description of a single change to a single file.

4106 </p>	4138 </p>

4107	4139

4108 <dl><dt class="field"><b>offset (int)</b></dt><dd>	4140 <dl><dt class="field"><b>offset: int</b></dt><dd>

4109	4141

4110 <p>	4142 <p>

4111 The offset of the region to be modified.	4143 The offset of the region to be modified.

4112 </p>	4144 </p>

4113 </dd><dt class="field"><b>length (int)</b></dt><dd>	4145 </dd><dt class="field"><b>length: int</b></dt><dd>

4114	4146

4115 <p>	4147 <p>

4116 The length of the region to be modified.	4148 The length of the region to be modified.

4117 </p>	4149 </p>

4118 </dd><dt class="field"><b>replacement (String)</b></dt><dd>	4150 </dd><dt class="field"><b>replacement: String</b></dt><dd>

4119	4151

4120 <p>	4152 <p>

4121 The code that is to replace the specified region in the	4153 The code that is to replace the specified region in the

4122 original code.	4154 original code.

4123 </p>	4155 </p>

4124 </dd><dt class="field"><b>id (<span style="color:#999999">optional</sp an> String)</b></dt><dd>	4156 </dd><dt class="field"><b>id: String<span style="color:#999999"> (@opt ional)</span></b></dt><dd>

4125	4157

4126 <p>	4158 <p>

4127 An identifier that uniquely identifies this source edit from other	4159 An identifier that uniquely identifies this source edit from other

4128 edits in the same response. This field is omitted unless a	4160 edits in the same response. This field is omitted unless a

4129 containing structure needs to be able to identify the edit for	4161 containing structure needs to be able to identify the edit for

4130 some reason.	4162 some reason.

4131 </p>	4163 </p>

4132 <p>	4164 <p>

4133 For example, some refactoring operations can produce edits that	4165 For example, some refactoring operations can produce edits that

4134 might not be appropriate (referred to as potential edits). Such	4166 might not be appropriate (referred to as potential edits). Such

4135 edits will have an id so that they can be referenced. Edits in	4167 edits will have an id so that they can be referenced. Edits in

4136 the same response that do not need to be referenced will not have	4168 the same response that do not need to be referenced will not have

4137 an id.	4169 an id.

4138 </p>	4170 </p>

4139 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd>	4171 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit ">SourceFileEdit: object</a></dt><dd>

4140 <p>	4172 <p>

4141 A description of a set of changes to a single file.	4173 A description of a set of changes to a single file.

4142 </p>	4174 </p>

4143	4175

4144 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b>< /dt><dd>	4176 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></ dt><dd>

4145	4177

4146 <p>	4178 <p>

4147 The file containing the code to be modified.	4179 The file containing the code to be modified.

4148 </p>	4180 </p>

4149 </dd><dt class="field"><b>fileStamp (long)</b></dt><dd>	4181 </dd><dt class="field"><b>fileStamp: long</b></dt><dd>

4150	4182

4151 <p>	4183 <p>

4152 The modification stamp of the file at the moment when the change	4184 The modification stamp of the file at the moment when the change

4153 was created, in milliseconds since the "Unix epoch". Will be -1 if	4185 was created, in milliseconds since the "Unix epoch". Will be -1 if

4154 the file did not exist and should be created. The client may use	4186 the file did not exist and should be created. The client may use

4155 this field to make sure that the file was not changed since then,	4187 this field to make sure that the file was not changed since then,

4156 so it is safe to apply the change.	4188 so it is safe to apply the change.

4157 </p>	4189 </p>

4158 </dd><dt class="field"><b>edits (List<<a href="#type_SourceEdit">So urceEdit</a>>)</b></dt><dd>	4190 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">So urceEdit</a>></b></dt><dd>

4159	4191

4160 <p>	4192 <p>

4161 A list of the edits used to effect the change.	4193 A list of the edits used to effect the change.

4162 </p>	4194 </p>

4163 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI tem">TypeHierarchyItem: object</a></dt><dd>	4195 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI tem">TypeHierarchyItem: object</a></dt><dd>

4164 <p>	4196 <p>

4165 A representation of a class in a type hierarchy.	4197 A representation of a class in a type hierarchy.

4166 </p>	4198 </p>

4167	4199

4168 <dl><dt class="field"><b>classElement (<a href="#type_Element">Element</a> )</b></dt><dd>	4200 <dl><dt class="field"><b>classElement: <a href="#type_Element">Element</a> </b></dt><dd>

4169	4201

4170 <p>	4202 <p>

4171 The class element represented by this item.	4203 The class element represented by this item.

4172 </p>	4204 </p>

4173 </dd><dt class="field"><b>displayName (<span style="color:#999999">opt ional</span> String)</b></dt><dd>	4205 </dd><dt class="field"><b>displayName: String<span style="color:#99999 9"> (@optional)</span></b></dt><dd>

4174	4206

4175 <p>	4207 <p>

4176 The name to be displayed for the class. This field will be	4208 The name to be displayed for the class. This field will be

4177 omitted if the display name is the same as the name of the	4209 omitted if the display name is the same as the name of the

4178 element. The display name is different if there is	4210 element. The display name is different if there is

4179 additional type information to be displayed, such as type	4211 additional type information to be displayed, such as type

4180 arguments.	4212 arguments.

4181 </p>	4213 </p>

4182 </dd><dt class="field"><b>memberElement (<span style="color:#999999">o ptional</span> <a href="#type_Element">Element</a>)</b></dt><dd>	4214 </dd><dt class="field"><b>memberElement: <a href="#type_Element">Eleme nt</a><span style="color:#999999"> (@optional)</span></b></dt><dd>

4183	4215

4184 <p>	4216 <p>

4185 The member in the class corresponding to the member on	4217 The member in the class corresponding to the member on

4186 which the hierarchy was requested. This field will be	4218 which the hierarchy was requested. This field will be

4187 omitted if the hierarchy was not requested for a member or	4219 omitted if the hierarchy was not requested for a member or

4188 if the class does not have a corresponding member.	4220 if the class does not have a corresponding member.

4189 </p>	4221 </p>

4190 </dd><dt class="field"><b>superclass (<span style="color:#999999">opti onal</span> int)</b></dt><dd>	4222 </dd><dt class="field"><b>superclass: int<span style="color:#999999"> (@optional)</span></b></dt><dd>

4191	4223

4192 <p>	4224 <p>

4193 The index of the item representing the superclass of	4225 The index of the item representing the superclass of

4194 this class. This field will be omitted if this item	4226 this class. This field will be omitted if this item

4195 represents the class Object.	4227 represents the class Object.

4196 </p>	4228 </p>

4197 </dd><dt class="field"><b>interfaces (List<int>)</b></dt><dd>	4229 </dd><dt class="field"><b>interfaces: List<int></b></dt><dd>

4198	4230

4199 <p>	4231 <p>

4200 The indexes of the items representing the interfaces	4232 The indexes of the items representing the interfaces

4201 implemented by this class. The list will be empty if	4233 implemented by this class. The list will be empty if

4202 there are no implemented interfaces.	4234 there are no implemented interfaces.

4203 </p>	4235 </p>

4204 </dd><dt class="field"><b>mixins (List<int>)</b></dt><dd>	4236 </dd><dt class="field"><b>mixins: List<int></b></dt><dd>

4205	4237

4206 <p>	4238 <p>

4207 The indexes of the items representing the mixins	4239 The indexes of the items representing the mixins

4208 referenced by this class. The list will be empty if	4240 referenced by this class. The list will be empty if

4209 there are no classes mixed in to this class.	4241 there are no classes mixed in to this class.

4210 </p>	4242 </p>

4211 </dd><dt class="field"><b>subclasses (List<int>)</b></dt><dd>	4243 </dd><dt class="field"><b>subclasses: List<int></b></dt><dd>

4212	4244

4213 <p>	4245 <p>

4214 The indexes of the items representing the subtypes of	4246 The indexes of the items representing the subtypes of

4215 this class. The list will be empty if there are no	4247 this class. The list will be empty if there are no

4216 subtypes or if this item represents a supertype of the	4248 subtypes or if this item represents a supertype of the

4217 pivot type.	4249 pivot type.

4218 </p>	4250 </p>

4219 </dd></dl></dd></dl>	4251 </dd></dl></dd></dl>

4220	4252

4221 <h2><a name="refactorings">Refactorings</a></h2>	4253 <h2><a name="refactorings">Refactorings</a></h2>

(...skipping 36 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
4258 <p>	4290 <p>

4259 Create a local variable initialized by the expression that covers	4291 Create a local variable initialized by the expression that covers

4260 the specified selection.	4292 the specified selection.

4261 </p>	4293 </p>

4262 <p>	4294 <p>

4263 It is an error if the selection range is not covered by a	4295 It is an error if the selection range is not covered by a

4264 complete expression.	4296 complete expression.

4265 </p>	4297 </p>

4266	4298

4267	4299

4268 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets (<spa n style="color:#999999">optional</span> List<int>)</b></dt><dd>	4300 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets: List <int><span style="color:#999999"> (@optional)</span></b></dt><dd>

4269	4301

4270 <p>	4302 <p>

4271 The offsets of the expressions that cover the specified	4303 The offsets of the expressions that cover the specified

4272 selection, from the down most to the up most.	4304 selection, from the down most to the up most.

4273 </p>	4305 </p>

4274 </dd><dt class="field"><b>coveringExpressionLengths (<span style="colo r:#999999">optional</span> List<int>)</b></dt><dd>	4306 </dd><dt class="field"><b>coveringExpressionLengths: List<int><s pan style="color:#999999"> (@optional)</span></b></dt><dd>

4275	4307

4276 <p>	4308 <p>

4277 The lengths of the expressions that cover the specified	4309 The lengths of the expressions that cover the specified

4278 selection, from the down most to the up most.	4310 selection, from the down most to the up most.

4279 </p>	4311 </p>

4280 </dd><dt class="field"><b>names (List<String>)</b></dt><dd>	4312 </dd><dt class="field"><b>names: List<String></b></dt><dd>

4281	4313

4282 <p>	4314 <p>

4283 The proposed names for the local variable.	4315 The proposed names for the local variable.

4284 </p>	4316 </p>

4285 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>	4317 </dd><dt class="field"><b>offsets: List<int></b></dt><dd>

4286	4318

4287 <p>	4319 <p>

4288 The offsets of the expressions that would be replaced by	4320 The offsets of the expressions that would be replaced by

4289 a reference to the variable.	4321 a reference to the variable.

4290 </p>	4322 </p>

4291 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd>	4323 </dd><dt class="field"><b>lengths: List<int></b></dt><dd>

4292	4324

4293 <p>	4325 <p>

4294 The lengths of the expressions that would be replaced by	4326 The lengths of the expressions that would be replaced by

4295 a reference to the variable. The lengths correspond to	4327 a reference to the variable. The lengths correspond to

4296 the offsets. In other words, for a given expression, if	4328 the offsets. In other words, for a given expression, if

4297 the offset of that expression is offsets[i], then the	4329 the offset of that expression is offsets[i], then the

4298 length of that expression is lengths[i].	4330 length of that expression is lengths[i].

4299 </p>	4331 </p>

4300 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name (String)</b>< /dt><dd>	4332 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name: String</b></ dt><dd>

4301	4333

4302 <p>	4334 <p>

4303 The name that the local variable should be given.	4335 The name that the local variable should be given.

4304 </p>	4336 </p>

4305 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd>	4337 </dd><dt class="field"><b>extractAll: bool</b></dt><dd>

4306	4338

4307 <p>	4339 <p>

4308 True if all occurrences of the expression within the	4340 True if all occurrences of the expression within the

4309 scope in which the variable will be defined should be	4341 scope in which the variable will be defined should be

4310 replaced by a reference to the local variable. The	4342 replaced by a reference to the local variable. The

4311 expression used to initiate the refactoring will always	4343 expression used to initiate the refactoring will always

4312 be replaced.	4344 be replaced.

4313 </p>	4345 </p>

4314 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>	4346 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>

4315 <p>	4347 <p>

4316 Create a method whose body is the specified expression or	4348 Create a method whose body is the specified expression or

4317 list of statements, possibly augmented with a return	4349 list of statements, possibly augmented with a return

4318 statement.	4350 statement.

4319 </p>	4351 </p>

4320 <p>	4352 <p>

4321 It is an error if the range contains anything other than a	4353 It is an error if the range contains anything other than a

4322 complete expression (no partial expressions are allowed) or	4354 complete expression (no partial expressions are allowed) or

4323 a complete sequence of statements.	4355 a complete sequence of statements.

4324 </p>	4356 </p>

4325	4357

4326	4358

4327 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd>	4359 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd>

4328	4360

4329 <p>	4361 <p>

4330 The offset to the beginning of the expression or	4362 The offset to the beginning of the expression or

4331 statements that will be extracted.	4363 statements that will be extracted.

4332 </p>	4364 </p>

4333 </dd><dt class="field"><b>length (int)</b></dt><dd>	4365 </dd><dt class="field"><b>length: int</b></dt><dd>

4334	4366

4335 <p>	4367 <p>

4336 The length of the expression or statements that will be	4368 The length of the expression or statements that will be

4337 extracted.	4369 extracted.

4338 </p>	4370 </p>

4339 </dd><dt class="field"><b>returnType (String)</b></dt><dd>	4371 </dd><dt class="field"><b>returnType: String</b></dt><dd>

4340	4372

4341 <p>	4373 <p>

4342 The proposed return type for the method.	4374 The proposed return type for the method.

4343 If the returned element does not have a declared return type,	4375 If the returned element does not have a declared return type,

4344 this field will contain an empty string.	4376 this field will contain an empty string.

4345 </p>	4377 </p>

4346 </dd><dt class="field"><b>names (List<String>)</b></dt><dd>	4378 </dd><dt class="field"><b>names: List<String></b></dt><dd>

4347	4379

4348 <p>	4380 <p>

4349 The proposed names for the method.	4381 The proposed names for the method.

4350 </p>	4382 </p>

4351 </dd><dt class="field"><b>canCreateGetter (bool)</b></dt><dd>	4383 </dd><dt class="field"><b>canCreateGetter: bool</b></dt><dd>

4352	4384

4353 <p>	4385 <p>

4354 True if a getter could be created rather than a method.	4386 True if a getter could be created rather than a method.

4355 </p>	4387 </p>

4356 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd>	4388 </dd><dt class="field"><b>parameters: List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>></b></dt><dd>

4357	4389

4358 <p>	4390 <p>

4359 The proposed parameters for the method.	4391 The proposed parameters for the method.

4360 </p>	4392 </p>

4361 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd>	4393 </dd><dt class="field"><b>offsets: List<int></b></dt><dd>

4362	4394

4363 <p>	4395 <p>

4364 The offsets of the expressions or statements that would	4396 The offsets of the expressions or statements that would

4365 be replaced by an invocation of the method.	4397 be replaced by an invocation of the method.

4366 </p>	4398 </p>

4367 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd>	4399 </dd><dt class="field"><b>lengths: List<int></b></dt><dd>

4368	4400

4369 <p>	4401 <p>

4370 The lengths of the expressions or statements that would	4402 The lengths of the expressions or statements that would

4371 be replaced by an invocation of the method. The lengths	4403 be replaced by an invocation of the method. The lengths

4372 correspond to the offsets. In other words, for a given	4404 correspond to the offsets. In other words, for a given

4373 expression (or block of statements), if the offset of	4405 expression (or block of statements), if the offset of

4374 that expression is offsets[i], then the length of that	4406 that expression is offsets[i], then the length of that

4375 expression is lengths[i].	4407 expression is lengths[i].

4376 </p>	4408 </p>

4377 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType (String )</b></dt><dd>	4409 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType: String </b></dt><dd>

4378	4410

4379 <p>	4411 <p>

4380 The return type that should be defined for the method.	4412 The return type that should be defined for the method.

4381 </p>	4413 </p>

4382 </dd><dt class="field"><b>createGetter (bool)</b></dt><dd>	4414 </dd><dt class="field"><b>createGetter: bool</b></dt><dd>

4383	4415

4384 <p>	4416 <p>

4385 True if a getter should be created rather than a	4417 True if a getter should be created rather than a

4386 method. It is an error if this field is true and the	4418 method. It is an error if this field is true and the

4387 list of parameters is non-empty.	4419 list of parameters is non-empty.

4388 </p>	4420 </p>

4389 </dd><dt class="field"><b>name (String)</b></dt><dd>	4421 </dd><dt class="field"><b>name: String</b></dt><dd>

4390	4422

4391 <p>	4423 <p>

4392 The name that the method should be given.	4424 The name that the method should be given.

4393 </p>	4425 </p>

4394 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd>	4426 </dd><dt class="field"><b>parameters: List<<a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a>></b></dt><dd>

4395	4427

4396 <p>	4428 <p>

4397 The parameters that should be defined for the method.	4429 The parameters that should be defined for the method.

4398 </p>	4430 </p>

4399 <p>	4431 <p>

4400 It is an error if a REQUIRED or NAMED parameter follows a	4432 It is an error if a REQUIRED or NAMED parameter follows a

4401 POSITIONAL parameter.	4433 POSITIONAL parameter.

4402 It is an error if a REQUIRED or POSITIONAL parameter follows a	4434 It is an error if a REQUIRED or POSITIONAL parameter follows a

4403 NAMED parameter.	4435 NAMED parameter.

4404 </p>	4436 </p>

4405 <ul>	4437 <ul>

4406 <li>	4438 <li>

4407 To change the order and/or update proposed parameters, add	4439 To change the order and/or update proposed parameters, add

4408 parameters with the same identifiers as proposed.	4440 parameters with the same identifiers as proposed.

4409 </li>	4441 </li>

4410 <li>To add new parameters, omit their identifier.</li>	4442 <li>To add new parameters, omit their identifier.</li>

4411 <li>To remove some parameters, omit them in this list.</li>	4443 <li>To remove some parameters, omit them in this list.</li>

4412 </ul>	4444 </ul>

4413 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd>	4445 </dd><dt class="field"><b>extractAll: bool</b></dt><dd>

4414	4446

4415 <p>	4447 <p>

4416 True if all occurrences of the expression or statements	4448 True if all occurrences of the expression or statements

4417 should be replaced by an invocation of the method. The	4449 should be replaced by an invocation of the method. The

4418 expression or statements used to initiate the	4450 expression or statements used to initiate the

4419 refactoring will always be replaced.	4451 refactoring will always be replaced.

4420 </p>	4452 </p>

4421 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>	4453 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>

4422 <p>	4454 <p>

4423 Inline the initializer expression of a local variable in	4455 Inline the initializer expression of a local variable in

4424 place of any references to that variable.	4456 place of any references to that variable.

4425 </p>	4457 </p>

4426 <p>	4458 <p>

4427 It is an error if the range contains anything other than all	4459 It is an error if the range contains anything other than all

4428 or part of the name of a single local variable.	4460 or part of the name of a single local variable.

4429 </p>	4461 </p>

4430	4462

4431 <h4>Feedback:</h4><dl><dt class="field"><b>name (String)</b></dt><dd>	4463 <h4>Feedback:</h4><dl><dt class="field"><b>name: String</b></dt><dd>

4432	4464

4433 <p>	4465 <p>

4434 The name of the variable being inlined.	4466 The name of the variable being inlined.

4435 </p>	4467 </p>

4436 </dd><dt class="field"><b>occurrences (int)</b></dt><dd>	4468 </dd><dt class="field"><b>occurrences: int</b></dt><dd>

4437	4469

4438 <p>	4470 <p>

4439 The number of times the variable occurs.	4471 The number of times the variable occurs.

4440 </p>	4472 </p>

4441 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INL INE_METHOD</dt><dd>	4473 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INL INE_METHOD</dt><dd>

4442 <p>	4474 <p>

4443 Inline a method in place of one or all references to that	4475 Inline a method in place of one or all references to that

4444 method.	4476 method.

4445 </p>	4477 </p>

4446 <p>	4478 <p>

4447 It is an error if the range contains anything other than all	4479 It is an error if the range contains anything other than all

4448 or part of the name of a single method.	4480 or part of the name of a single method.

4449 </p>	4481 </p>

4450	4482

4451	4483

4452 <h4>Feedback:</h4><dl><dt class="field"><b>className (<span style="color:# 999999">optional</span> String)</b></dt><dd>	4484 <h4>Feedback:</h4><dl><dt class="field"><b>className: String<span style="c olor:#999999"> (@optional)</span></b></dt><dd>

4453	4485

4454 <p>	4486 <p>

4455 The name of the class enclosing the method being inlined.	4487 The name of the class enclosing the method being inlined.

4456 If not a class member is being inlined, this field will be absent.	4488 If not a class member is being inlined, this field will be absent.

4457 </p>	4489 </p>

4458 </dd><dt class="field"><b>methodName (String)</b></dt><dd>	4490 </dd><dt class="field"><b>methodName: String</b></dt><dd>

4459	4491

4460 <p>	4492 <p>

4461 The name of the method (or function) being inlined.	4493 The name of the method (or function) being inlined.

4462 </p>	4494 </p>

4463 </dd><dt class="field"><b>isDeclaration (bool)</b></dt><dd>	4495 </dd><dt class="field"><b>isDeclaration: bool</b></dt><dd>

4464	4496

4465 <p>	4497 <p>

4466 True if the declaration of the method is selected.	4498 True if the declaration of the method is selected.

4467 So all references should be inlined.	4499 So all references should be inlined.

4468 </p>	4500 </p>

4469 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource (bool )</b></dt><dd>	4501 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource: bool </b></dt><dd>

4470	4502

4471 <p>	4503 <p>

4472 True if the method being inlined should be removed.	4504 True if the method being inlined should be removed.

4473 It is an error if this field is true and inlineAll is false.	4505 It is an error if this field is true and inlineAll is false.

4474 </p>	4506 </p>

4475 </dd><dt class="field"><b>inlineAll (bool)</b></dt><dd>	4507 </dd><dt class="field"><b>inlineAll: bool</b></dt><dd>

4476	4508

4477 <p>	4509 <p>

4478 True if all invocations of the method should be inlined,	4510 True if all invocations of the method should be inlined,

4479 or false if only the invocation site used to create this	4511 or false if only the invocation site used to create this

4480 refactoring should be inlined.	4512 refactoring should be inlined.

4481 </p>	4513 </p>

4482 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>	4514 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>

4483 <p>	4515 <p>

4484 Move the given file and update all of the references to that file	4516 Move the given file and update all of the references to that file

4485 and from it. The move operation is supported in general case - for	4517 and from it. The move operation is supported in general case - for

4486 renaming a file in the same folder, moving it to a different folder	4518 renaming a file in the same folder, moving it to a different folder

4487 or both.	4519 or both.

4488 </p>	4520 </p>

4489 <p>	4521 <p>

4490 The refactoring must be activated before an actual file moving	4522 The refactoring must be activated before an actual file moving

4491 operation is performed.	4523 operation is performed.

4492 </p>	4524 </p>

4493 <p>	4525 <p>

4494 The "offset" and "length" fields from the request are ignored, but the	4526 The "offset" and "length" fields from the request are ignored, but the

4495 file specified in the request specifies the file to be moved.	4527 file specified in the request specifies the file to be moved.

4496 </p>	4528 </p>

4497	4529

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

4499	4531

4500 <p>	4532 <p>

4501 The new file path to which the given file is being moved.	4533 The new file path to which the given file is being moved.

4502 </p>	4534 </p>

4503 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>	4535 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>

4504 <p>	4536 <p>

4505 Rename a given element and all of the references to that	4537 Rename a given element and all of the references to that

4506 element.	4538 element.

4507 </p>	4539 </p>

4508 <p>	4540 <p>

4509 It is an error if the range contains anything other than all	4541 It is an error if the range contains anything other than all

4510 or part of the name of a single function (including methods,	4542 or part of the name of a single function (including methods,

4511 getters and setters), variable (including fields, parameters	4543 getters and setters), variable (including fields, parameters

4512 and local variables), class or function type.	4544 and local variables), class or function type.

4513 </p>	4545 </p>

4514	4546

4515	4547

4516 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd>	4548 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd>

4517	4549

4518 <p>	4550 <p>

4519 The offset to the beginning of the name selected to be	4551 The offset to the beginning of the name selected to be

4520 renamed.	4552 renamed.

4521 </p>	4553 </p>

4522 </dd><dt class="field"><b>length (int)</b></dt><dd>	4554 </dd><dt class="field"><b>length: int</b></dt><dd>

4523	4555

4524 <p>	4556 <p>

4525 The length of the name selected to be renamed.	4557 The length of the name selected to be renamed.

4526 </p>	4558 </p>

4527 </dd><dt class="field"><b>elementKindName (String)</b></dt><dd>	4559 </dd><dt class="field"><b>elementKindName: String</b></dt><dd>

4528	4560

4529 <p>	4561 <p>

4530 The human-readable description of the kind of element being	4562 The human-readable description of the kind of element being

4531 renamed (such as "class" or "function type	4563 renamed (such as "class" or "function type

4532 alias").	4564 alias").

4533 </p>	4565 </p>

4534 </dd><dt class="field"><b>oldName (String)</b></dt><dd>	4566 </dd><dt class="field"><b>oldName: String</b></dt><dd>

4535	4567

4536 <p>	4568 <p>

4537 The old name of the element before the refactoring.	4569 The old name of the element before the refactoring.

4538 </p>	4570 </p>

4539 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName (String)</ b></dt><dd>	4571 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b ></dt><dd>

4540	4572

4541 <p>	4573 <p>

4542 The name that the element should have after the	4574 The name that the element should have after the

4543 refactoring.	4575 refactoring.

4544 </p>	4576 </p>

4545 </dd></dl></dd></dl>	4577 </dd></dl></dd></dl>

4546 <h2>Errors</h2>	4578 <h2>Errors</h2>

4547 <p>	4579 <p>

4548 This section contains a list of all of the errors that are	4580 This section contains a list of all of the errors that are

4549 produced by the server and the data that is returned with each.	4581 produced by the server and the data that is returned with each.

4550 </p>	4582 </p>

4551 <p>	4583 <p>

4552 TODO: TBD	4584 TODO: TBD

4553 </p>	4585 </p>

4554 <h2 class="domain"><a name="index">Index</a></h2>	4586 <h2 class="domain"><a name="index">Index</a></h2>

4555 <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><li><a href="#request_diagnostic.g etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a> )</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a ></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a>< /li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li> <a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath< /a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember"> ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a ></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li> <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a>< /li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="# type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type _RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a ></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId< /a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type _SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a ></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class ="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT _METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM E">RENAME</a></li></ul></div>	4587 <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><li><a href="#request_diagnostic.g etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a> )</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a ></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a>< /li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li> <a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath< /a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember"> ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a ></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li> <a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a>< /li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="# type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type _RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a ></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId< /a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type _SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a ></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class ="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT _METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM E">RENAME</a></li></ul></div>

4556	4588

4557	4589

4558 </body></html>	4590 </body></html>

OLD	NEW