pkg/analysis_server/doc/api.html - Issue 1033473002: Anchor and create a link near Notifications and Requests definitions in the Analysis Server Spec

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

Issue 1033473002: Anchor and create a link near Notifications and Requests definitions in the Analysis Server Spec (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 5 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
1 <html><head>	1 <html><head>

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

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

4 <style>body {	4 <style>body {

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

6 padding-left: 5%;	6 padding-left: 5%;

7 padding-right: 5%;	7 padding-right: 5%;

8 }	8 }

9 h1 {	9 h1 {

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

(...skipping 209 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
220 <p>	220 <p>

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

222 the server.	222 the server.

223 </p>	223 </p>

224	224

225	225

226	226

227	227

228	228

229	229

230 <h3>Requests</h3><dl><dt class="request">server.getVersion</dt><dd><div clas s="box"><pre>request: {	230 <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: {

231 "id": String	231 "id": String

232 "method": "server.getVersion"	232 "method": "server.getVersion"

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

234 "id": String	234 "id": String

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

236 "result": {	236 "result": {

237 "<b>version</b>": String	237 "<b>version</b>": String

238 }	238 }

239 }</pre></div>	239 }</pre></div>

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

241	241

242 <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt ><dd>	242 <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt ><dd>

243	243

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

245 </dd></dl></dd><dt class="request">server.shutdown</dt><dd><div class= "box"><pre>request: {	245 </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: {

246 "id": String	246 "id": String

247 "method": "server.shutdown"	247 "method": "server.shutdown"

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

249 "id": String	249 "id": String

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

251 }</pre></div>	251 }</pre></div>

252 <p>	252 <p>

253 Cleanly shutdown the analysis server. Requests that are	253 Cleanly shutdown the analysis server. Requests that are

254 received after this request will not be processed. Requests	254 received after this request will not be processed. Requests

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

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

257 further responses or notifications will be sent after the	257 further responses or notifications will be sent after the

258 response to this request has been sent.	258 response to this request has been sent.

259 </p>	259 </p>

260 </dd><dt class="request">server.setSubscriptions</dt><dd><div class="box"> <pre>request: {	260 </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: {

261 "id": String	261 "id": String

262 "method": "server.setSubscriptions"	262 "method": "server.setSubscriptions"

263 "params": {	263 "params": {

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

265 }	265 }

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

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

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

269 }</pre></div>	269 }</pre></div>

270 <p>	270 <p>

271 Subscribe for services. All previous subscriptions are	271 Subscribe for services. All previous subscriptions are

272 replaced by the given set of services.	272 replaced by the given set of services.

273 </p>	273 </p>

274 <p>	274 <p>

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

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

277 subscriptions will remain unchanged.	277 subscriptions will remain unchanged.

278 </p>	278 </p>

279	279

280 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd>	280 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd>

281	281

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

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

284 "event": "server.connected"	284 "event": "server.connected"

285 "params": {	285 "params": {

286 "<b>version</b>": String	286 "<b>version</b>": String

287 }	287 }

288 }</pre></div>	288 }</pre></div>

289 <p>	289 <p>

290 Reports that the server is running. This notification is	290 Reports that the server is running. This notification is

291 issued once after the server has started running but before	291 issued once after the server has started running but before

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

293 started correctly.	293 started correctly.

294 </p>	294 </p>

295 <p>	295 <p>

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

297 notification.	297 notification.

298 </p>	298 </p>

299	299

300 <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b>< /dt><dd>	300 <h4>Parameters</h4><dl><dt class="field"><b><i>version ( String )</i></b>< /dt><dd>

301	301

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

303 </dd></dl></dd><dt class="notification">server.error</dt><dd><div clas s="box"><pre>notification: {	303 </dd></dl></dd><dt class="notification"><a name="notification_server.e rror">server.error</a> (<a href="#notification_server.error">#</a>)</dt><dd><div class="box"><pre>notification: {

304 "event": "server.error"	304 "event": "server.error"

305 "params": {	305 "params": {

306 "<b>isFatal</b>": bool	306 "<b>isFatal</b>": bool

307 "<b>message</b>": String	307 "<b>message</b>": String

308 "<b>stackTrace</b>": String	308 "<b>stackTrace</b>": String

309 }	309 }

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

311 <p>	311 <p>

312 Reports that an unexpected error has occurred while	312 Reports that an unexpected error has occurred while

313 executing the server. This notification is not used for	313 executing the server. This notification is not used for

(...skipping 19 matching lines...) Expand all Loading...
333 <p>	333 <p>

334 The error message indicating what kind of error was	334 The error message indicating what kind of error was

335 encountered.	335 encountered.

336 </p>	336 </p>

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

338	338

339 <p>	339 <p>

340 The stack trace associated with the generation of the	340 The stack trace associated with the generation of the

341 error, used for debugging the server.	341 error, used for debugging the server.

342 </p>	342 </p>

343 </dd></dl></dd><dt class="notification">server.status</dt><dd><div cla ss="box"><pre>notification: {	343 </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: {

344 "event": "server.status"	344 "event": "server.status"

345 "params": {	345 "params": {

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

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

348 }	348 }

349 }</pre></div>	349 }</pre></div>

350 <p>	350 <p>

351 Reports the current status of the server. Parameters are	351 Reports the current status of the server. Parameters are

352 omitted if there has been no change in the status	352 omitted if there has been no change in the status

353 represented by that parameter.	353 represented by that parameter.

(...skipping 36 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
390	390

391	391

392	392

393	393

394	394

395	395

396	396

397	397

398	398

399	399

400 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: {	400 <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: {

401 "id": String	401 "id": String

402 "method": "analysis.getErrors"	402 "method": "analysis.getErrors"

403 "params": {	403 "params": {

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

405 }	405 }

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

407 "id": String	407 "id": String

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

409 "result": {	409 "result": {

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

(...skipping 31 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
442 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	442 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

443	443

444 <p>	444 <p>

445 The file for which errors are being requested.	445 The file for which errors are being requested.

446 </p>	446 </p>

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

448	448

449 <p>	449 <p>

450 The errors associated with the file.	450 The errors associated with the file.

451 </p>	451 </p>

452 </dd></dl></dd><dt class="request">analysis.getHover</dt><dd><div clas s="box"><pre>request: {	452 </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: {

453 "id": String	453 "id": String

454 "method": "analysis.getHover"	454 "method": "analysis.getHover"

455 "params": {	455 "params": {

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

457 "<b>offset</b>": int	457 "<b>offset</b>": int

458 }	458 }

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

460 "id": String	460 "id": String

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

462 "result": {	462 "result": {

(...skipping 21 matching lines...) Expand all Loading...
484 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd>	484 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd>

485	485

486 <p>	486 <p>

487 The hover information associated with the	487 The hover information associated with the

488 location. The list will be empty if no information	488 location. The list will be empty if no information

489 could be determined for the location. The list can	489 could be determined for the location. The list can

490 contain multiple items if the file is being analyzed	490 contain multiple items if the file is being analyzed

491 in multiple contexts in conflicting ways (such as a	491 in multiple contexts in conflicting ways (such as a

492 part that is included in multiple libraries).	492 part that is included in multiple libraries).

493 </p>	493 </p>

494 </dd></dl></dd><dt class="request">analysis.getLibraryDependencies</dt ><dd><div class="box"><pre>request: {	494 </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: {

495 "id": String	495 "id": String

496 "method": "analysis.getLibraryDependencies"	496 "method": "analysis.getLibraryDependencies"

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

498 "id": String	498 "id": String

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

500 "result": {	500 "result": {

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

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

503 }	503 }

504 }</pre></div>	504 }</pre></div>

505 <p>	505 <p>

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

507 and package URI resolution.	507 and package URI resolution.

508 </p>	508 </p>

509	509

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

511	511

512 <p>	512 <p>

513 A list of the paths of library elements referenced by	513 A list of the paths of library elements referenced by

514 files in existing analysis roots.	514 files in existing analysis roots.

515 </p>	515 </p>

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

517	517

518 <p>	518 <p>

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

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

521 package URI resolution.	521 package URI resolution.

522 </p>	522 </p>

523 </dd></dl></dd><dt class="request">analysis.getNavigation</dt><dd><d iv class="box"><pre>request: {	523 </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: {

524 "id": String	524 "id": String

525 "method": "analysis.getNavigation"	525 "method": "analysis.getNavigation"

526 "params": {	526 "params": {

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

528 "<b>offset</b>": int	528 "<b>offset</b>": int

529 "<b>length</b>": int	529 "<b>length</b>": int

530 }	530 }

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

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

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

(...skipping 51 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
585 <p>	585 <p>

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

587 navigation regions.	587 navigation regions.

588 </p>	588 </p>

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

590	590

591 <p>	591 <p>

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

593 the file.	593 the file.

594 </p>	594 </p>

595 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: {	595 </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: {

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

597 "method": "analysis.reanalyze"	597 "method": "analysis.reanalyze"

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

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

600 }	600 }

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

602 "id": String	602 "id": String

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

604 }</pre></div>	604 }</pre></div>

605 <p>	605 <p>

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

607 analysis roots. This will cause all previously computed analysis	607 analysis roots. This will cause all previously computed analysis

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

609 notifications to be re-sent.	609 notifications to be re-sent.

610 </p>	610 </p>

611 <p>	611 <p>

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

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

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

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

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

617 </p>	617 </p>

618	618

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

620	620

621 <p>	621 <p>

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

623 </p>	623 </p>

624 </dd></dl></dd><dt class="request">analysis.setAnalysisRoots</dt><dd>< div class="box"><pre>request: {	624 </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: {

625 "id": String	625 "id": String

626 "method": "analysis.setAnalysisRoots"	626 "method": "analysis.setAnalysisRoots"

627 "params": {	627 "params": {

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

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

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

631 }	631 }

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

633 "id": String	633 "id": String

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

(...skipping 56 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
691 a "--package_root" parameter to the Dart VM when	691 a "--package_root" parameter to the Dart VM when

692 executing any Dart file inside the source directory.	692 executing any Dart file inside the source directory.

693 </p>	693 </p>

694 <p>	694 <p>

695 Files in any directories that are not overridden by this	695 Files in any directories that are not overridden by this

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

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

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

699 normal pubspec.yaml mechanism should always be used.	699 normal pubspec.yaml mechanism should always be used.

700 </p>	700 </p>

701 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd>< div class="box"><pre>request: {	701 </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: {

702 "id": String	702 "id": String

703 "method": "analysis.setPriorityFiles"	703 "method": "analysis.setPriorityFiles"

704 "params": {	704 "params": {

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

706 }	706 }

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

708 "id": String	708 "id": String

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

710 }</pre></div>	710 }</pre></div>

711 <p>	711 <p>

(...skipping 20 matching lines...) Expand all Loading...
732 but remains in the set of requested priority files so that	732 but remains in the set of requested priority files so that

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

734 actual priority files.	734 actual priority files.

735 </p>	735 </p>

736	736

737 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>	737 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>

738	738

739 <p>	739 <p>

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

741 </p>	741 </p>

742 </dd></dl></dd><dt class="request">analysis.setSubscriptions</dt><dd>< div class="box"><pre>request: {	742 </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: {

743 "id": String	743 "id": String

744 "method": "analysis.setSubscriptions"	744 "method": "analysis.setSubscriptions"

745 "params": {	745 "params": {

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

747 }	747 }

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

749 "id": String	749 "id": String

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

751 }</pre></div>	751 }</pre></div>

752 <p>	752 <p>

(...skipping 29 matching lines...) Expand all Loading...
782 services. If there is an error, then the existing	782 services. If there is an error, then the existing

783 subscriptions will remain unchanged.	783 subscriptions will remain unchanged.

784 </p>	784 </p>

785	785

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

787	787

788 <p>	788 <p>

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

790 subscribed to the service.	790 subscribed to the service.

791 </p>	791 </p>

792 </dd></dl></dd><dt class="request">analysis.updateContent</dt><dd><div class="box"><pre>request: {	792 </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: {

793 "id": String	793 "id": String

794 "method": "analysis.updateContent"	794 "method": "analysis.updateContent"

795 "params": {	795 "params": {

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

797 }	797 }

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

799 "id": String	799 "id": String

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

801 "result": {	801 "result": {

802 }	802 }

803 }</pre></div>	803 }</pre></div>

804 <p>	804 <p>

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

806 previously updated but not included in this update remain	806 previously updated but not included in this update remain

807 unchanged. This effectively represents an overlay of the	807 unchanged. This effectively represents an overlay of the

808 filesystem. The files whose content is overridden are	808 filesystem. The files whose content is overridden are

809 therefore seen by server as being files with the given	809 therefore seen by server as being files with the given

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

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

812 filesystem.	812 filesystem.

813 </p>	813 </p>

814	814

815	815

816 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map<<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</ a> \| <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> \| <a href="#t ype_RemoveContentOverlay">RemoveContentOverlay</a>> )</i></b></dt><dd>	816 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map<<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</ a> \| <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> \| <a href="#t ype_RemoveContentOverlay">RemoveContentOverlay</a>> )</i></b></dt><dd>

817	817

818 <p>	818 <p>

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

820 description of the content change.	820 description of the content change.

821 </p>	821 </p>

822 </dd></dl><h4>Returns</h4><dl></dl></dd><dt class="request">analysis.u pdateOptions</dt><dd><div class="box"><pre>request: {	822 </dd></dl><h4>Returns</h4><dl></dl></dd><dt class="request"><a name="r equest_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_ana lysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: {

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

824 "method": "analysis.updateOptions"	824 "method": "analysis.updateOptions"

825 "params": {	825 "params": {

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

827 }	827 }

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

829 "id": String	829 "id": String

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

831 }</pre></div>	831 }</pre></div>

832 <p>	832 <p>

833 Update the options controlling analysis based on the given	833 Update the options controlling analysis based on the given

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

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

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

837 silently ignored.	837 silently ignored.

838 </p>	838 </p>

839	839

840 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An alysisOptions">AnalysisOptions</a> )</i></b></dt><dd>	840 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An alysisOptions">AnalysisOptions</a> )</i></b></dt><dd>

841	841

842 <p>	842 <p>

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

844 </p>	844 </p>

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

846 "event": "analysis.errors"	846 "event": "analysis.errors"

847 "params": {	847 "params": {

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

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

850 }	850 }

851 }</pre></div>	851 }</pre></div>

852 <p>	852 <p>

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

854 errors included in the notification is always a complete	854 errors included in the notification is always a complete

855 list that supersedes any previously reported errors.	855 list that supersedes any previously reported errors.

856 </p>	856 </p>

857 <p>	857 <p>

858 It is only possible to unsubscribe from this notification by	858 It is only possible to unsubscribe from this notification by

859 using the command-line flag --no-error-notification.	859 using the command-line flag --no-error-notification.

860 </p>	860 </p>

861	861

862 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	862 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

863	863

864 <p>	864 <p>

865 The file containing the errors.	865 The file containing the errors.

866 </p>	866 </p>

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

868	868

869 <p>	869 <p>

870 The errors contained in the file.	870 The errors contained in the file.

871 </p>	871 </p>

872 </dd></dl></dd><dt class="notification">analysis.flushResults</dt><dd> <div class="box"><pre>notification: {	872 </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: {

873 "event": "analysis.flushResults"	873 "event": "analysis.flushResults"

874 "params": {	874 "params": {

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

876 }	876 }

877 }</pre></div>	877 }</pre></div>

878 <p>	878 <p>

879 Reports that any analysis results that were previously	879 Reports that any analysis results that were previously

880 associated with the given files should be considered to be	880 associated with the given files should be considered to be

881 invalid because those files are no longer being analyzed,	881 invalid because those files are no longer being analyzed,

882 either because the analysis root that contained it is no	882 either because the analysis root that contained it is no

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

884 </p>	884 </p>

885 <p>	885 <p>

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

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

888 clients should assume that the file is once again being	888 clients should assume that the file is once again being

889 analyzed and the information should be processed.	889 analyzed and the information should be processed.

890 </p>	890 </p>

891 <p>	891 <p>

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

893 notification.	893 notification.

894 </p>	894 </p>

895	895

896 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>	896 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t ype_FilePath">FilePath</a>> )</i></b></dt><dd>

897	897

898 <p>	898 <p>

899 The files that are no longer being analyzed.	899 The files that are no longer being analyzed.

900 </p>	900 </p>

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

902 "event": "analysis.folding"	902 "event": "analysis.folding"

903 "params": {	903 "params": {

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

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

906 }	906 }

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

908 <p>	908 <p>

909 Reports the folding regions associated with a given	909 Reports the folding regions associated with a given

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

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

(...skipping 10 matching lines...) Expand all Loading...
922 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	922 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

923	923

924 <p>	924 <p>

925 The file containing the folding regions.	925 The file containing the folding regions.

926 </p>	926 </p>

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

928	928

929 <p>	929 <p>

930 The folding regions contained in the file.	930 The folding regions contained in the file.

931 </p>	931 </p>

932 </dd></dl></dd><dt class="notification">analysis.highlights</dt><dd><d iv class="box"><pre>notification: {	932 </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: {

933 "event": "analysis.highlights"	933 "event": "analysis.highlights"

934 "params": {	934 "params": {

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

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

937 }	937 }

938 }</pre></div>	938 }</pre></div>

939 <p>	939 <p>

940 Reports the highlight regions associated with a given file.	940 Reports the highlight regions associated with a given file.

941 </p>	941 </p>

942 <p>	942 <p>

(...skipping 11 matching lines...) Expand all Loading...
954 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Highligh tRegion">HighlightRegion</a>> )</i></b></dt><dd>	954 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Highligh tRegion">HighlightRegion</a>> )</i></b></dt><dd>

955	955

956 <p>	956 <p>

957 The highlight regions contained in the file. Each	957 The highlight regions contained in the file. Each

958 highlight region represents a particular syntactic or	958 highlight region represents a particular syntactic or

959 semantic meaning associated with some range. Note that	959 semantic meaning associated with some range. Note that

960 the highlight regions that are returned can overlap	960 the highlight regions that are returned can overlap

961 other highlight regions if there is more than one	961 other highlight regions if there is more than one

962 meaning associated with a particular region.	962 meaning associated with a particular region.

963 </p>	963 </p>

964 </dd></dl></dd><dt class="notification">analysis.invalidate</dt><dd><d iv class="box"><pre>notification: {	964 </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: {

965 "event": "analysis.invalidate"	965 "event": "analysis.invalidate"

966 "params": {	966 "params": {

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

968 "<b>offset</b>": int	968 "<b>offset</b>": int

969 "<b>length</b>": int	969 "<b>length</b>": int

970 "<b>delta</b>": int	970 "<b>delta</b>": int

971 }	971 }

972 }</pre></div>	972 }</pre></div>

973 <p>	973 <p>

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

(...skipping 20 matching lines...) Expand all Loading...
995 <p>	995 <p>

996 The length of the invalidated region.	996 The length of the invalidated region.

997 </p>	997 </p>

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

999	999

1000 <p>	1000 <p>

1001 The delta to be applied to the offsets in information that follows	1001 The delta to be applied to the offsets in information that follows

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

1003 need to be re-requested.	1003 need to be re-requested.

1004 </p>	1004 </p>

1005 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: {	1005 </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: {

1006 "event": "analysis.navigation"	1006 "event": "analysis.navigation"

1007 "params": {	1007 "params": {

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

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

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

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

1012 }	1012 }

1013 }</pre></div>	1013 }</pre></div>

1014 <p>	1014 <p>

1015 Reports the navigation targets associated with a given file.	1015 Reports the navigation targets associated with a given file.

(...skipping 31 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1047 They are referenced by <tt>NavigationRegion</tt>s by their	1047 They are referenced by <tt>NavigationRegion</tt>s by their

1048 index in this array.	1048 index in this array.

1049 </p>	1049 </p>

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

1051	1051

1052 <p>	1052 <p>

1053 The files containing navigation targets referenced in the file.	1053 The files containing navigation targets referenced in the file.

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

1055 index in this array.	1055 index in this array.

1056 </p>	1056 </p>

1057 </dd></dl></dd><dt class="notification">analysis.occurrences</dt><dd>< div class="box"><pre>notification: {	1057 </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: {

1058 "event": "analysis.occurrences"	1058 "event": "analysis.occurrences"

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

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

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

1062 }	1062 }

1063 }</pre></div>	1063 }</pre></div>

1064 <p>	1064 <p>

1065 Reports the occurrences of references to elements within a	1065 Reports the occurrences of references to elements within a

1066 single file.	1066 single file.

1067 </p>	1067 </p>

1068 <p>	1068 <p>

1069 This notification is not subscribed to by default. Clients	1069 This notification is not subscribed to by default. Clients

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

1071 in the list of services passed in an	1071 in the list of services passed in an

1072 analysis.setSubscriptions request.	1072 analysis.setSubscriptions request.

1073 </p>	1073 </p>

1074	1074

1075 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1075 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

1076	1076

1077 <p>	1077 <p>

1078 The file in which the references occur.	1078 The file in which the references occur.

1079 </p>	1079 </p>

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

1081	1081

1082 <p>	1082 <p>

1083 The occurrences of references to elements within the	1083 The occurrences of references to elements within the

1084 file.	1084 file.

1085 </p>	1085 </p>

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

1087 "event": "analysis.outline"	1087 "event": "analysis.outline"

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

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

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

1091 }	1091 }

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

1093 <p>	1093 <p>

1094 Reports the outline associated with a single file.	1094 Reports the outline associated with a single file.

1095 </p>	1095 </p>

1096 <p>	1096 <p>

1097 This notification is not subscribed to by default. Clients	1097 This notification is not subscribed to by default. Clients

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

1099 the list of services passed in an analysis.setSubscriptions	1099 the list of services passed in an analysis.setSubscriptions

1100 request.	1100 request.

1101 </p>	1101 </p>

1102	1102

1103 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>	1103 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

1104	1104

1105 <p>	1105 <p>

1106 The file with which the outline is associated.	1106 The file with which the outline is associated.

1107 </p>	1107 </p>

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

1109	1109

1110 <p>	1110 <p>

1111 The outline associated with the file.	1111 The outline associated with the file.

1112 </p>	1112 </p>

1113 </dd></dl></dd><dt class="notification">analysis.overrides</dt><dd><di v class="box"><pre>notification: {	1113 </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: {

1114 "event": "analysis.overrides"	1114 "event": "analysis.overrides"

1115 "params": {	1115 "params": {

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

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

1118 }	1118 }

1119 }</pre></div>	1119 }</pre></div>

1120 <p>	1120 <p>

1121 Reports the overridding members in a file.	1121 Reports the overridding members in a file.

1122 </p>	1122 </p>

1123 <p>	1123 <p>

(...skipping 14 matching lines...) Expand all Loading...
1138 The overrides associated with the file.	1138 The overrides associated with the file.

1139 </p>	1139 </p>

1140 </dd></dl></dd></dl>	1140 </dd></dl></dd></dl>

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

1142 <p>	1142 <p>

1143 The code completion domain contains commands related to	1143 The code completion domain contains commands related to

1144 getting code completion suggestions.	1144 getting code completion suggestions.

1145 </p>	1145 </p>

1146	1146

1147	1147

1148 <h3>Requests</h3><dl><dt class="request">completion.getSuggestions</dt><dd>< div class="box"><pre>request: {	1148 <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: {

1149 "id": String	1149 "id": String

1150 "method": "completion.getSuggestions"	1150 "method": "completion.getSuggestions"

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

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

1153 "<b>offset</b>": int	1153 "<b>offset</b>": int

1154 }	1154 }

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

1156 "<b>id</b>": String	1156 "<b>id</b>": String

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

1158 "result": {	1158 "result": {

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

1177 The offset within the file at which suggestions are to	1177 The offset within the file at which suggestions are to

1178 be made.	1178 be made.

1179 </p>	1179 </p>

1180 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_CompletionId">CompletionId</a> )</i></b></dt><dd>	1180 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_CompletionId">CompletionId</a> )</i></b></dt><dd>

1181	1181

1182 <p>	1182 <p>

1183 The identifier used to associate results with this	1183 The identifier used to associate results with this

1184 completion request.	1184 completion request.

1185 </p>	1185 </p>

1186 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >completion.results</dt><dd><div class="box"><pre>notification: {	1186 </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: {

1187 "event": "completion.results"	1187 "event": "completion.results"

1188 "params": {	1188 "params": {

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

1190 "<b>replacementOffset</b>": int	1190 "<b>replacementOffset</b>": int

1191 "<b>replacementLength</b>": int	1191 "<b>replacementLength</b>": int

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

1193 "<b>isLast</b>": bool	1193 "<b>isLast</b>": bool

1194 }	1194 }

1195 }</pre></div>	1195 }</pre></div>

1196 <p>	1196 <p>

(...skipping 47 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1244 <p>	1244 <p>

1245 The search domain contains commands related to searches that	1245 The search domain contains commands related to searches that

1246 can be performed against the code base.	1246 can be performed against the code base.

1247 </p>	1247 </p>

1248	1248

1249	1249

1250	1250

1251	1251

1252	1252

1253	1253

1254 <h3>Requests</h3><dl><dt class="request">search.findElementReferences</dt><d d><div class="box"><pre>request: {	1254 <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: {

1255 "id": String	1255 "id": String

1256 "method": "search.findElementReferences"	1256 "method": "search.findElementReferences"

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

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

1259 "<b>offset</b>": int	1259 "<b>offset</b>": int

1260 "<b>includePotential</b>": bool	1260 "<b>includePotential</b>": bool

1261 }	1261 }

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

1263 "<b>id</b>": String	1263 "<b>id</b>": String

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

(...skipping 46 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1311	1311

1312 <p>	1312 <p>

1313 The element referenced or defined at the given offset	1313 The element referenced or defined at the given offset

1314 and whose references will be returned in the search	1314 and whose references will be returned in the search

1315 results.	1315 results.

1316 </p>	1316 </p>

1317 <p>	1317 <p>

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

1319 field will be absent.	1319 field will be absent.

1320 </p>	1320 </p>

1321 </dd></dl></dd><dt class="request">search.findMemberDeclarations</dt>< dd><div class="box"><pre>request: {	1321 </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: {

1322 "id": String	1322 "id": String

1323 "method": "search.findMemberDeclarations"	1323 "method": "search.findMemberDeclarations"

1324 "params": {	1324 "params": {

1325 "<b>name</b>": String	1325 "<b>name</b>": String

1326 }	1326 }

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

1328 "<b>id</b>": String	1328 "<b>id</b>": String

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

1330 "result": {	1330 "result": {

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

(...skipping 14 matching lines...) Expand all Loading...
1346	1346

1347 <p>	1347 <p>

1348 The name of the declarations to be found.	1348 The name of the declarations to be found.

1349 </p>	1349 </p>

1350 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1350 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>

1351	1351

1352 <p>	1352 <p>

1353 The identifier used to associate results with this	1353 The identifier used to associate results with this

1354 search request.	1354 search request.

1355 </p>	1355 </p>

1356 </dd></dl></dd><dt class="request">search.findMemberReferences</dt><dd ><div class="box"><pre>request: {	1356 </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: {

1357 "id": String	1357 "id": String

1358 "method": "search.findMemberReferences"	1358 "method": "search.findMemberReferences"

1359 "params": {	1359 "params": {

1360 "<b>name</b>": String	1360 "<b>name</b>": String

1361 }	1361 }

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

1363 "<b>id</b>": String	1363 "<b>id</b>": String

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

1365 "result": {	1365 "result": {

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

(...skipping 16 matching lines...) Expand all Loading...
1383	1383

1384 <p>	1384 <p>

1385 The name of the references to be found.	1385 The name of the references to be found.

1386 </p>	1386 </p>

1387 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1387 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>

1388	1388

1389 <p>	1389 <p>

1390 The identifier used to associate results with this	1390 The identifier used to associate results with this

1391 search request.	1391 search request.

1392 </p>	1392 </p>

1393 </dd></dl></dd><dt class="request">search.findTopLevelDeclarations</dt ><dd><div class="box"><pre>request: {	1393 </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: {

1394 "id": String	1394 "id": String

1395 "method": "search.findTopLevelDeclarations"	1395 "method": "search.findTopLevelDeclarations"

1396 "params": {	1396 "params": {

1397 "<b>pattern</b>": String	1397 "<b>pattern</b>": String

1398 }	1398 }

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

1400 "<b>id</b>": String	1400 "<b>id</b>": String

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

1402 "result": {	1402 "result": {

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

(...skipping 16 matching lines...) Expand all Loading...
1420 <p>	1420 <p>

1421 The regular expression used to match the names of the	1421 The regular expression used to match the names of the

1422 declarations to be found.	1422 declarations to be found.

1423 </p>	1423 </p>

1424 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>	1424 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_SearchId">SearchId</a> )</i></b></dt><dd>

1425	1425

1426 <p>	1426 <p>

1427 The identifier used to associate results with this	1427 The identifier used to associate results with this

1428 search request.	1428 search request.

1429 </p>	1429 </p>

1430 </dd></dl></dd><dt class="request">search.getTypeHierarchy</dt><dd><di v class="box"><pre>request: {	1430 </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: {

1431 "id": String	1431 "id": String

1432 "method": "search.getTypeHierarchy"	1432 "method": "search.getTypeHierarchy"

1433 "params": {	1433 "params": {

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

1435 "<b>offset</b>": int	1435 "<b>offset</b>": int

1436 }	1436 }

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

1438 "id": String	1438 "id": String

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

1440 "result": {	1440 "result": {

(...skipping 26 matching lines...) Expand all Loading...
1467 other elements of the list is unspecified, but	1467 other elements of the list is unspecified, but

1468 correspond to the integers used to reference supertype	1468 correspond to the integers used to reference supertype

1469 and subtype items within the items.	1469 and subtype items within the items.

1470 </p>	1470 </p>

1471 <p>	1471 <p>

1472 This field will be absent if the code at the given file	1472 This field will be absent if the code at the given file

1473 and offset does not represent a type, or if the file has	1473 and offset does not represent a type, or if the file has

1474 not been sufficiently analyzed to allow a type hierarchy	1474 not been sufficiently analyzed to allow a type hierarchy

1475 to be produced.	1475 to be produced.

1476 </p>	1476 </p>

1477 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >search.results</dt><dd><div class="box"><pre>notification: {	1477 </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: {

1478 "event": "search.results"	1478 "event": "search.results"

1479 "params": {	1479 "params": {

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

1481 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>>	1481 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>>

1482 "<b>isLast</b>": bool	1482 "<b>isLast</b>": bool

1483 }	1483 }

1484 }</pre></div>	1484 }</pre></div>

1485 <p>	1485 <p>

1486 Reports some or all of the results of performing a requested	1486 Reports some or all of the results of performing a requested

1487 search. Unlike other notifications, this notification	1487 search. Unlike other notifications, this notification

(...skipping 23 matching lines...) Expand all Loading...
1511 <p>	1511 <p>

1512 The edit domain contains commands related to edits that can be	1512 The edit domain contains commands related to edits that can be

1513 applied to the code.	1513 applied to the code.

1514 </p>	1514 </p>

1515	1515

1516	1516

1517	1517

1518	1518

1519	1519

1520	1520

1521 <h3>Requests</h3><dl><dt class="request">edit.format</dt><dd><div class="box "><pre>request: {	1521 <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: {

1522 "id": String	1522 "id": String

1523 "method": "edit.format"	1523 "method": "edit.format"

1524 "params": {	1524 "params": {

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

1526 "<b>selectionOffset</b>": int	1526 "<b>selectionOffset</b>": int

1527 "<b>selectionLength</b>": int	1527 "<b>selectionLength</b>": int

1528 }	1528 }

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

1530 "id": String	1530 "id": String

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

(...skipping 46 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1578 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>	1578 </dd><dt class="field"><b><i>selectionOffset ( int )</i></b></dt><dd>

1579	1579

1580 <p>	1580 <p>

1581 The offset of the selection after formatting the code.	1581 The offset of the selection after formatting the code.

1582 </p>	1582 </p>

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

1584	1584

1585 <p>	1585 <p>

1586 The length of the selection after formatting the code.	1586 The length of the selection after formatting the code.

1587 </p>	1587 </p>

1588 </dd></dl></dd><dt class="request">edit.getAssists</dt><dd><div class= "box"><pre>request: {	1588 </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: {

1589 "id": String	1589 "id": String

1590 "method": "edit.getAssists"	1590 "method": "edit.getAssists"

1591 "params": {	1591 "params": {

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

1593 "<b>offset</b>": int	1593 "<b>offset</b>": int

1594 "<b>length</b>": int	1594 "<b>length</b>": int

1595 }	1595 }

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

1597 "id": String	1597 "id": String

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

(...skipping 25 matching lines...) Expand all Loading...
1624	1624

1625 <p>	1625 <p>

1626 The length of the code for which assists are being	1626 The length of the code for which assists are being

1627 requested.	1627 requested.

1628 </p>	1628 </p>

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

1630	1630

1631 <p>	1631 <p>

1632 The assists that are available at the given location.	1632 The assists that are available at the given location.

1633 </p>	1633 </p>

1634 </dd></dl></dd><dt class="request">edit.getAvailableRefactorings</dt>< dd><div class="box"><pre>request: {	1634 </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: {

1635 "id": String	1635 "id": String

1636 "method": "edit.getAvailableRefactorings"	1636 "method": "edit.getAvailableRefactorings"

1637 "params": {	1637 "params": {

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

1639 "<b>offset</b>": int	1639 "<b>offset</b>": int

1640 "<b>length</b>": int	1640 "<b>length</b>": int

1641 }	1641 }

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

1643 "id": String	1643 "id": String

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

(...skipping 24 matching lines...) Expand all Loading...
1669 <p>	1669 <p>

1670 The length of the code on which the refactoring would be	1670 The length of the code on which the refactoring would be

1671 based.	1671 based.

1672 </p>	1672 </p>

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

1674	1674

1675 <p>	1675 <p>

1676 The kinds of refactorings that are valid for the given	1676 The kinds of refactorings that are valid for the given

1677 selection.	1677 selection.

1678 </p>	1678 </p>

1679 </dd></dl></dd><dt class="request">edit.getFixes</dt><dd><div class="b ox"><pre>request: {	1679 </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: {

1680 "id": String	1680 "id": String

1681 "method": "edit.getFixes"	1681 "method": "edit.getFixes"

1682 "params": {	1682 "params": {

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

1684 "<b>offset</b>": int	1684 "<b>offset</b>": int

1685 }	1685 }

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

1687 "id": String	1687 "id": String

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

1689 "result": {	1689 "result": {

(...skipping 16 matching lines...) Expand all Loading...
1706	1706

1707 <p>	1707 <p>

1708 The offset used to select the errors for which fixes	1708 The offset used to select the errors for which fixes

1709 will be returned.	1709 will be returned.

1710 </p>	1710 </p>

1711 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List< <a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</i></b></dt><dd>	1711 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List< <a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>> )</i></b></dt><dd>

1712	1712

1713 <p>	1713 <p>

1714 The fixes that are available for the errors at the given offset.	1714 The fixes that are available for the errors at the given offset.

1715 </p>	1715 </p>

1716 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl ass="box"><pre>request: {	1716 </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: {

1717 "id": String	1717 "id": String

1718 "method": "edit.getRefactoring"	1718 "method": "edit.getRefactoring"

1719 "params": {	1719 "params": {

1720 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>	1720 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>

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

1722 "<b>offset</b>": int	1722 "<b>offset</b>": int

1723 "<b>length</b>": int	1723 "<b>length</b>": int

1724 "<b>validateOnly</b>": bool	1724 "<b>validateOnly</b>": bool

1725 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>	1725 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>

1726 }	1726 }

(...skipping 103 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1830	1830

1831 <p>	1831 <p>

1832 The ids of source edits that are not known to be valid. An edit is	1832 The ids of source edits that are not known to be valid. An edit is

1833 not known to be valid if there was insufficient type information	1833 not known to be valid if there was insufficient type information

1834 for the server to be able to determine whether or not the code	1834 for the server to be able to determine whether or not the code

1835 needs to be modified, such as when a member is being renamed and	1835 needs to be modified, such as when a member is being renamed and

1836 there is a reference to a member from an unknown type. This field	1836 there is a reference to a member from an unknown type. This field

1837 will be omitted if the change field is omitted or if there are no	1837 will be omitted if the change field is omitted or if there are no

1838 potential edits for the refactoring.	1838 potential edits for the refactoring.

1839 </p>	1839 </p>

1840 </dd></dl></dd><dt class="request">edit.sortMembers</dt><dd><div class ="box"><pre>request: {	1840 </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: {

1841 "id": String	1841 "id": String

1842 "method": "edit.sortMembers"	1842 "method": "edit.sortMembers"

1843 "params": {	1843 "params": {

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

1845 }	1845 }

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

1847 "id": String	1847 "id": String

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

1849 "result": {	1849 "result": {

1850 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>	1850 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>

(...skipping 29 matching lines...) Expand all Loading...
1880 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>	1880 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>

1881 <p>	1881 <p>

1882 The execution domain contains commands related to providing an execution	1882 The execution domain contains commands related to providing an execution

1883 or debugging experience.	1883 or debugging experience.

1884 </p>	1884 </p>

1885	1885

1886	1886

1887	1887

1888	1888

1889	1889

1890 <h3>Requests</h3><dl><dt class="request">execution.createContext</dt><dd><di v class="box"><pre>request: {	1890 <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: {

1891 "id": String	1891 "id": String

1892 "method": "execution.createContext"	1892 "method": "execution.createContext"

1893 "params": {	1893 "params": {

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

1895 }	1895 }

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

1897 "<b>id</b>": String	1897 "<b>id</b>": String

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

1899 "result": {	1899 "result": {

1900 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	1900 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

(...skipping 12 matching lines...) Expand all Loading...
1913 <p>	1913 <p>

1914 The path of the Dart or HTML file that will be launched, or the	1914 The path of the Dart or HTML file that will be launched, or the

1915 path of the directory containing the file.	1915 path of the directory containing the file.

1916 </p>	1916 </p>

1917 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>	1917 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>id ( <a href="#t ype_ExecutionContextId">ExecutionContextId</a> )</i></b></dt><dd>

1918	1918

1919 <p>	1919 <p>

1920 The identifier used to refer to the execution context that was	1920 The identifier used to refer to the execution context that was

1921 created.	1921 created.

1922 </p>	1922 </p>

1923 </dd></dl></dd><dt class="request">execution.deleteContext</dt><dd><di v class="box"><pre>request: {	1923 </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: {

1924 "<b>id</b>": String	1924 "<b>id</b>": String

1925 "method": "execution.deleteContext"	1925 "method": "execution.deleteContext"

1926 "params": {	1926 "params": {

1927 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	1927 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

1928 }	1928 }

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

1930 "id": String	1930 "id": String

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

1932 }</pre></div>	1932 }</pre></div>

1933 <p>	1933 <p>

1934 Delete the execution context with the given identifier. The context id	1934 Delete the execution context with the given identifier. The context id

1935 is no longer valid after this command. The server is allowed to re-use	1935 is no longer valid after this command. The server is allowed to re-use

1936 ids when they are no longer valid.	1936 ids when they are no longer valid.

1937 </p>	1937 </p>

1938	1938

1939 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>	1939 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_Executi onContextId">ExecutionContextId</a> )</i></b></dt><dd>

1940	1940

1941 <p>	1941 <p>

1942 The identifier of the execution context that is to be deleted.	1942 The identifier of the execution context that is to be deleted.

1943 </p>	1943 </p>

1944 </dd></dl></dd><dt class="request">execution.mapUri</dt><dd><div class ="box"><pre>request: {	1944 </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: {

1945 "<b>id</b>": String	1945 "<b>id</b>": String

1946 "method": "execution.mapUri"	1946 "method": "execution.mapUri"

1947 "params": {	1947 "params": {

1948 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>	1948 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a>

1949 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>	1949 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>

1950 "<b>uri</b>": <span style="color:#999999">optional</span> String	1950 "<b>uri</b>": <span style="color:#999999">optional</span> String

1951 }	1951 }

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

1953 "id": String	1953 "id": String

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

(...skipping 53 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
2008 <p>	2008 <p>

2009 The file to which the URI was mapped. This field is omitted if the	2009 The file to which the URI was mapped. This field is omitted if the

2010 uri field was not given in the request.	2010 uri field was not given in the request.

2011 </p>	2011 </p>

2012 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>	2012 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona l</span> String )</i></b></dt><dd>

2013	2013

2014 <p>	2014 <p>

2015 The URI to which the file path was mapped. This field is omitted	2015 The URI to which the file path was mapped. This field is omitted

2016 if the file field was not given in the request.	2016 if the file field was not given in the request.

2017 </p>	2017 </p>

2018 </dd></dl></dd><dt class="request">execution.setSubscriptions</dt><dd> <div class="box"><pre>request: {	2018 </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: {

2019 "id": String	2019 "id": String

2020 "method": "execution.setSubscriptions"	2020 "method": "execution.setSubscriptions"

2021 "params": {	2021 "params": {

2022 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>	2022 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe rvice</a>>

2023 }	2023 }

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

2025 "id": String	2025 "id": String

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

2027 }</pre></div>	2027 }</pre></div>

2028 <p>	2028 <p>

2029 Subscribe for services. All previous subscriptions are replaced by the	2029 Subscribe for services. All previous subscriptions are replaced by the

2030 given set of services.	2030 given set of services.

2031 </p>	2031 </p>

2032 <p>	2032 <p>

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

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

2035 remain unchanged.	2035 remain unchanged.

2036 </p>	2036 </p>

2037	2037

2038 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ExecutionService">ExecutionService</a>> )</i></b></dt><dd>	2038 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ExecutionService">ExecutionService</a>> )</i></b></dt><dd>

2039	2039

2040 <p>	2040 <p>

2041 A list of the services being subscribed to.	2041 A list of the services being subscribed to.

2042 </p>	2042 </p>

2043 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >execution.launchData</dt><dd><div class="box"><pre>notification: {	2043 </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: {

2044 "event": "execution.launchData"	2044 "event": "execution.launchData"

2045 "params": {	2045 "params": {

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

2047 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>	2047 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex ecutableKind">ExecutableKind</a>

2048 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>	2048 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l t;<a href="#type_FilePath">FilePath</a>>

2049 }	2049 }

2050 }</pre></div>	2050 }</pre></div>

2051 <p>	2051 <p>

2052 Reports information needed to allow a single file to be launched.	2052 Reports information needed to allow a single file to be launched.

2053 </p>	2053 </p>

(...skipping 1717 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3771 <p>	3771 <p>

3772 This section contains a list of all of the errors that are	3772 This section contains a list of all of the errors that are

3773 produced by the server and the data that is returned with each.	3773 produced by the server and the data that is returned with each.

3774 </p>	3774 </p>

3775 <p>	3775 <p>

3776 TBD	3776 TBD

3777 </p>	3777 </p>

3778	3778

3779	3779

3780 </body></html>	3780 </body></html>

OLD	NEW

« no previous file with comments | « no previous file | pkg/analysis_server/tool/spec/to_html.dart » ('j') | no next file with comments »