| 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 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 66 When character streams are used as the transport, messages are | 66 When character streams are used as the transport, messages are |
| 67 delineated by newlines. This means, in particular, that the JSON | 67 delineated by newlines. This means, in particular, that the JSON |
| 68 encoding process must not introduce newlines within a | 68 encoding process must not introduce newlines within a |
| 69 message. Note however that newlines are used in this document | 69 message. Note however that newlines are used in this document |
| 70 for readability. | 70 for readability. |
| 71 </p> | 71 </p> |
| 72 <p> | 72 <p> |
| 73 To ease interoperability with Lisp-based clients (which may not | 73 To ease interoperability with Lisp-based clients (which may not |
| 74 be able to easily distinguish between empty lists, empty maps, | 74 be able to easily distinguish between empty lists, empty maps, |
| 75 and null), client-to-server communication is allowed to replace | 75 and null), client-to-server communication is allowed to replace |
| 76 any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. The | 76 any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. |
| 77 server will always properly represent empty lists as | 77 </p> |
| 78 “<tt>[]</tt>” and empty maps as “<tt>{}</tt>”. | 78 <p> |
| 79 In addition, to conserve bytes, all object fields of type "List" |
| 80 are optional; omitting such a field carries the same meaning as |
| 81 sending an empty list. |
| 82 </p> |
| 83 <p> |
| 84 Server-to-client communication will always omit empty lists, and |
| 85 will always represent empty maps as <tt>{}</tt>. |
| 79 </p> | 86 </p> |
| 80 <h3>Communication Structure</h3> | 87 <h3>Communication Structure</h3> |
| 81 <p> | 88 <p> |
| 82 Clients can make a request of the server and the server will | 89 Clients can make a request of the server and the server will |
| 83 provide a response for each request that it receives. While many | 90 provide a response for each request that it receives. While many |
| 84 of the requests that can be made by a client are informational | 91 of the requests that can be made by a client are informational |
| 85 in nature, we have chosen to always return a response so that | 92 in nature, we have chosen to always return a response so that |
| 86 clients can know whether the request was received and was | 93 clients can know whether the request was received and was |
| 87 correct. | 94 correct. |
| 88 </p> | 95 </p> |
| (...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 211 received after this request will not be processed. Requests | 218 received after this request will not be processed. Requests |
| 212 that were received before this request, but for which a | 219 that were received before this request, but for which a |
| 213 response has not yet been sent, will not be responded to. No | 220 response has not yet been sent, will not be responded to. No |
| 214 further responses or notifications will be sent after the | 221 further responses or notifications will be sent after the |
| 215 response to this request has been sent. | 222 response to this request has been sent. |
| 216 </p> | 223 </p> |
| 217 </dd><dt class="request">server.setSubscriptions</dt><dd><div class="box">
<pre>request: { | 224 </dd><dt class="request">server.setSubscriptions</dt><dd><div class="box">
<pre>request: { |
| 218 "id": String | 225 "id": String |
| 219 "method": "server.setSubscriptions" | 226 "method": "server.setSubscriptions" |
| 220 "params": { | 227 "params": { |
| 221 "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService<
/a>> | 228 "<b>subscriptions</b>": <span style="color:#999999">optional</span> List<
<a href="#type_ServerService">ServerService</a>> |
| 222 } | 229 } |
| 223 }</pre><br><pre>response: { | 230 }</pre><br><pre>response: { |
| 224 "id": String | 231 "id": String |
| 225 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 232 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 226 }</pre></div> | 233 }</pre></div> |
| 227 <p> | 234 <p> |
| 228 Subscribe for services. All previous subscriptions are | 235 Subscribe for services. All previous subscriptions are |
| 229 replaced by the given set of services. | 236 replaced by the given set of services. |
| 230 </p> | 237 </p> |
| 231 <p> | 238 <p> |
| 232 It is an error if any of the elements in the list are not | 239 It is an error if any of the elements in the list are not |
| 233 valid services. If there is an error, then the current | 240 valid services. If there is an error, then the current |
| 234 subscriptions will remain unchanged. | 241 subscriptions will remain unchanged. |
| 235 </p> | 242 </p> |
| 236 | 243 |
| 237 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a
href="#type_ServerService">ServerService</a>> )</i></b></dt><dd> | 244 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( <span style
="color:#999999">optional</span> List<<a href="#type_ServerService">ServerSer
vice</a>> )</i></b></dt><dd> |
| 238 | 245 |
| 239 <p>A list of the services being subscribed to.</p> | 246 <p>A list of the services being subscribed to.</p> |
| 240 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>server.connected</dt><dd><div class="box"><pre>notification: { | 247 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>server.connected</dt><dd><div class="box"><pre>notification: { |
| 241 "event": "server.connected" | 248 "event": "server.connected" |
| 242 }</pre></div> | 249 }</pre></div> |
| 243 <p> | 250 <p> |
| 244 Reports that the server is running. This notification is | 251 Reports that the server is running. This notification is |
| 245 issued once after the server has started running but before | 252 issued once after the server has started running but before |
| 246 any requests are processed to let the client know that it | 253 any requests are processed to let the client know that it |
| 247 started correctly. | 254 started correctly. |
| (...skipping 92 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 340 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla
ss="box"><pre>request: { | 347 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla
ss="box"><pre>request: { |
| 341 "id": String | 348 "id": String |
| 342 "method": "analysis.getErrors" | 349 "method": "analysis.getErrors" |
| 343 "params": { | 350 "params": { |
| 344 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 351 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 345 } | 352 } |
| 346 }</pre><br><pre>response: { | 353 }</pre><br><pre>response: { |
| 347 "id": String | 354 "id": String |
| 348 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 355 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 349 "result": { | 356 "result": { |
| 350 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> | 357 "<b>errors</b>": <span style="color:#999999">optional</span> List<<a href
="#type_AnalysisError">AnalysisError</a>> |
| 351 } | 358 } |
| 352 }</pre></div> | 359 }</pre></div> |
| 353 <p> | 360 <p> |
| 354 Return the errors associated with the given file. If the | 361 Return the errors associated with the given file. If the |
| 355 errors for the given file have not yet been computed, or the | 362 errors for the given file have not yet been computed, or the |
| 356 most recently computed errors for the given file are out of | 363 most recently computed errors for the given file are out of |
| 357 date, then the response for this request will be delayed | 364 date, then the response for this request will be delayed |
| 358 until they have been computed. If some or all of the errors | 365 until they have been computed. If some or all of the errors |
| 359 for the file cannot be computed, then the subset of the | 366 for the file cannot be computed, then the subset of the |
| 360 errors that can be computed will be returned and the | 367 errors that can be computed will be returned and the |
| 361 response will contain an error to indicate why the errors | 368 response will contain an error to indicate why the errors |
| 362 could not be computed. | 369 could not be computed. |
| 363 </p> | 370 </p> |
| 364 <p> | 371 <p> |
| 365 This request is intended to be used by clients that cannot | 372 This request is intended to be used by clients that cannot |
| 366 asynchronously apply updated error information. Clients that | 373 asynchronously apply updated error information. Clients that |
| 367 <b>can</b> apply error information as it becomes available | 374 <b>can</b> apply error information as it becomes available |
| 368 should use the information provided by the 'analysis.errors' | 375 should use the information provided by the 'analysis.errors' |
| 369 notification. | 376 notification. |
| 370 </p> | 377 </p> |
| 371 | 378 |
| 372 | 379 |
| 373 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 380 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 374 | 381 |
| 375 <p> | 382 <p> |
| 376 The file for which errors are being requested. | 383 The file for which errors are being requested. |
| 377 </p> | 384 </p> |
| 378 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List<
;<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd> | 385 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( <span s
tyle="color:#999999">optional</span> List<<a href="#type_AnalysisError">Analy
sisError</a>> )</i></b></dt><dd> |
| 379 | 386 |
| 380 <p> | 387 <p> |
| 381 The errors associated with the file. | 388 The errors associated with the file. |
| 382 </p> | 389 </p> |
| 383 </dd></dl></dd><dt class="request">analysis.getHover</dt><dd><div clas
s="box"><pre>request: { | 390 </dd></dl></dd><dt class="request">analysis.getHover</dt><dd><div clas
s="box"><pre>request: { |
| 384 "id": String | 391 "id": String |
| 385 "method": "analysis.getHover" | 392 "method": "analysis.getHover" |
| 386 "params": { | 393 "params": { |
| 387 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 394 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 388 "<b>offset</b>": int | 395 "<b>offset</b>": int |
| 389 } | 396 } |
| 390 }</pre><br><pre>response: { | 397 }</pre><br><pre>response: { |
| 391 "id": String | 398 "id": String |
| 392 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 399 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 393 "result": { | 400 "result": { |
| 394 "<b>hovers</b>": List<<a href="#type_HoverInformation">HoverInformation</
a>> | 401 "<b>hovers</b>": <span style="color:#999999">optional</span> List<<a href
="#type_HoverInformation">HoverInformation</a>> |
| 395 } | 402 } |
| 396 }</pre></div> | 403 }</pre></div> |
| 397 <p> | 404 <p> |
| 398 Return the hover information associate with the given | 405 Return the hover information associate with the given |
| 399 location. If some or all of the hover information is not | 406 location. If some or all of the hover information is not |
| 400 available at the time this request is processed the | 407 available at the time this request is processed the |
| 401 information will be omitted from the response. | 408 information will be omitted from the response. |
| 402 </p> | 409 </p> |
| 403 | 410 |
| 404 | 411 |
| 405 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 412 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 406 | 413 |
| 407 <p> | 414 <p> |
| 408 The file in which hover information is being | 415 The file in which hover information is being |
| 409 requested. | 416 requested. |
| 410 </p> | 417 </p> |
| 411 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 418 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
| 412 | 419 |
| 413 <p> | 420 <p> |
| 414 The offset for which hover information is being | 421 The offset for which hover information is being |
| 415 requested. | 422 requested. |
| 416 </p> | 423 </p> |
| 417 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List<
;<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd> | 424 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( <span s
tyle="color:#999999">optional</span> List<<a href="#type_HoverInformation">Ho
verInformation</a>> )</i></b></dt><dd> |
| 418 | 425 |
| 419 <p> | 426 <p> |
| 420 The hover information associated with the | 427 The hover information associated with the |
| 421 location. The list will be empty if no information | 428 location. The list will be omitted if no information |
| 422 could be determined for the location. The list can | 429 could be determined for the location. The list can |
| 423 contain multiple items if the file is being analyzed | 430 contain multiple items if the file is being analyzed |
| 424 in multiple contexts in conflicting ways (such as a | 431 in multiple contexts in conflicting ways (such as a |
| 425 part that is included in multiple libraries). | 432 part that is included in multiple libraries). |
| 426 </p> | 433 </p> |
| 427 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla
ss="box"><pre>request: { | 434 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla
ss="box"><pre>request: { |
| 428 "id": String | 435 "id": String |
| 429 "method": "analysis.reanalyze" | 436 "method": "analysis.reanalyze" |
| 430 }</pre><br><pre>response: { | 437 }</pre><br><pre>response: { |
| 431 "id": String | 438 "id": String |
| 432 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 439 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 433 }</pre></div> | 440 }</pre></div> |
| 434 <p> | 441 <p> |
| 435 Force the re-analysis of everything contained in the | 442 Force the re-analysis of everything contained in the |
| 436 existing analysis roots. This will cause all previously | 443 existing analysis roots. This will cause all previously |
| 437 computed analysis results to be discarded and recomputed, | 444 computed analysis results to be discarded and recomputed, |
| 438 and will cause all subscribed notifications to be re-sent. | 445 and will cause all subscribed notifications to be re-sent. |
| 439 </p> | 446 </p> |
| 440 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box
"><pre>request: { | 447 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box
"><pre>request: { |
| 441 "id": String | 448 "id": String |
| 442 "method": "analysis.setAnalysisRoots" | 449 "method": "analysis.setAnalysisRoots" |
| 443 "params": { | 450 "params": { |
| 444 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> | 451 "<b>included</b>": <span style="color:#999999">optional</span> List<<a hr
ef="#type_FilePath">FilePath</a>> |
| 445 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> | 452 "<b>excluded</b>": <span style="color:#999999">optional</span> List<<a hr
ef="#type_FilePath">FilePath</a>> |
| 446 } | 453 } |
| 447 }</pre><br><pre>response: { | 454 }</pre><br><pre>response: { |
| 448 "id": String | 455 "id": String |
| 449 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 456 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 450 }</pre></div> | 457 }</pre></div> |
| 451 <p> | 458 <p> |
| 452 Sets the root paths used to determine which files to | 459 Sets the root paths used to determine which files to |
| 453 analyze. The set of files to be analyzed are all of the | 460 analyze. The set of files to be analyzed are all of the |
| 454 files in one of the root paths that are not also in one of | 461 files in one of the root paths that are not also in one of |
| 455 the excluded paths. | 462 the excluded paths. |
| (...skipping 15 matching lines...) Expand all Loading... |
| 471 </p> | 478 </p> |
| 472 <p> | 479 <p> |
| 473 If an included path represents a file, then server will look | 480 If an included path represents a file, then server will look |
| 474 in the directory containing the file for a pubspec.yaml | 481 in the directory containing the file for a pubspec.yaml |
| 475 file. If none is found, then the parents of the directory | 482 file. If none is found, then the parents of the directory |
| 476 will be searched until such a file is found or the root of | 483 will be searched until such a file is found or the root of |
| 477 the file system is reached. If such a file is found, it will | 484 the file system is reached. If such a file is found, it will |
| 478 be used to resolve package: URI’s within the file. | 485 be used to resolve package: URI’s within the file. |
| 479 </p> | 486 </p> |
| 480 | 487 |
| 481 <h4>Parameters</h4><dl><dt class="field"><b><i>included ( List<<a href=
"#type_FilePath">FilePath</a>> )</i></b></dt><dd> | 488 <h4>Parameters</h4><dl><dt class="field"><b><i>included ( <span style="col
or:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )<
/i></b></dt><dd> |
| 482 | 489 |
| 483 <p> | 490 <p> |
| 484 A list of the files and directories that should be | 491 A list of the files and directories that should be |
| 485 analyzed. | 492 analyzed. |
| 486 </p> | 493 </p> |
| 487 </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePat
h">FilePath</a>> )</i></b></dt><dd> | 494 </dd><dt class="field"><b><i>excluded ( <span style="color:#999999">op
tional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><d
d> |
| 488 | 495 |
| 489 <p> | 496 <p> |
| 490 A list of the files and directories within the | 497 A list of the files and directories within the |
| 491 included directories that should not be analyzed. | 498 included directories that should not be analyzed. |
| 492 </p> | 499 </p> |
| 493 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd><
div class="box"><pre>request: { | 500 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd><
div class="box"><pre>request: { |
| 494 "id": String | 501 "id": String |
| 495 "method": "analysis.setPriorityFiles" | 502 "method": "analysis.setPriorityFiles" |
| 496 "params": { | 503 "params": { |
| 497 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 504 "<b>files</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_FilePath">FilePath</a>> |
| 498 } | 505 } |
| 499 }</pre><br><pre>response: { | 506 }</pre><br><pre>response: { |
| 500 "id": String | 507 "id": String |
| 501 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 508 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 502 }</pre></div> | 509 }</pre></div> |
| 503 <p> | 510 <p> |
| 504 Set the priority files to the files in the given list. A | 511 Set the priority files to the files in the given list. A |
| 505 priority file is a file that is given priority when | 512 priority file is a file that is given priority when |
| 506 scheduling which analysis work to do first. The list | 513 scheduling which analysis work to do first. The list |
| 507 typically contains those files that are visible to the user | 514 typically contains those files that are visible to the user |
| (...skipping 11 matching lines...) Expand all Loading... |
| 519 analysis.setSubscriptions for a description of files that | 526 analysis.setSubscriptions for a description of files that |
| 520 are subject to analysis.) | 527 are subject to analysis.) |
| 521 </p> | 528 </p> |
| 522 <p> | 529 <p> |
| 523 If a requested priority file is a directory it is ignored, | 530 If a requested priority file is a directory it is ignored, |
| 524 but remains in the set of requested priority files so that | 531 but remains in the set of requested priority files so that |
| 525 if it later becomes a file it can be included in the set of | 532 if it later becomes a file it can be included in the set of |
| 526 actual priority files. | 533 actual priority files. |
| 527 </p> | 534 </p> |
| 528 | 535 |
| 529 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t
ype_FilePath">FilePath</a>> )</i></b></dt><dd> | 536 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( <span style="color:
#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i>
</b></dt><dd> |
| 530 | 537 |
| 531 <p> | 538 <p> |
| 532 The files that are to be a priority for analysis. | 539 The files that are to be a priority for analysis. |
| 533 </p> | 540 </p> |
| 534 </dd></dl></dd><dt class="request">analysis.setSubscriptions</dt><dd><
div class="box"><pre>request: { | 541 </dd></dl></dd><dt class="request">analysis.setSubscriptions</dt><dd><
div class="box"><pre>request: { |
| 535 "id": String | 542 "id": String |
| 536 "method": "analysis.setSubscriptions" | 543 "method": "analysis.setSubscriptions" |
| 537 "params": { | 544 "params": { |
| 538 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi
ce</a>, List<<a href="#type_FilePath">FilePath</a>>> | 545 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi
ce</a>, List<<a href="#type_FilePath">FilePath</a>>> |
| 539 } | 546 } |
| (...skipping 88 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 628 | 635 |
| 629 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An
alysisOptions">AnalysisOptions</a> )</i></b></dt><dd> | 636 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An
alysisOptions">AnalysisOptions</a> )</i></b></dt><dd> |
| 630 | 637 |
| 631 <p> | 638 <p> |
| 632 The options that are to be used to control analysis. | 639 The options that are to be used to control analysis. |
| 633 </p> | 640 </p> |
| 634 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>analysis.errors</dt><dd><div class="box"><pre>notification: { | 641 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>analysis.errors</dt><dd><div class="box"><pre>notification: { |
| 635 "event": "analysis.errors" | 642 "event": "analysis.errors" |
| 636 "params": { | 643 "params": { |
| 637 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 644 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 638 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> | 645 "<b>errors</b>": <span style="color:#999999">optional</span> List<<a href
="#type_AnalysisError">AnalysisError</a>> |
| 639 } | 646 } |
| 640 }</pre></div> | 647 }</pre></div> |
| 641 <p> | 648 <p> |
| 642 Reports the errors associated with a given file. The set of | 649 Reports the errors associated with a given file. The set of |
| 643 errors included in the notification is always a complete | 650 errors included in the notification is always a complete |
| 644 list that supersedes any previously reported errors. | 651 list that supersedes any previously reported errors. |
| 645 </p> | 652 </p> |
| 646 <p> | 653 <p> |
| 647 It is only possible to unsubscribe from this notification by | 654 It is only possible to unsubscribe from this notification by |
| 648 using the command-line flag --no-error-notification. | 655 using the command-line flag --no-error-notification. |
| 649 </p> | 656 </p> |
| 650 | 657 |
| 651 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 658 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 652 | 659 |
| 653 <p> | 660 <p> |
| 654 The file containing the errors. | 661 The file containing the errors. |
| 655 </p> | 662 </p> |
| 656 </dd><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisE
rror">AnalysisError</a>> )</i></b></dt><dd> | 663 </dd><dt class="field"><b><i>errors ( <span style="color:#999999">opti
onal</span> List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b
></dt><dd> |
| 657 | 664 |
| 658 <p> | 665 <p> |
| 659 The errors contained in the file. | 666 The errors contained in the file. |
| 660 </p> | 667 </p> |
| 661 </dd></dl></dd><dt class="notification">analysis.flushResults</dt><dd>
<div class="box"><pre>notification: { | 668 </dd></dl></dd><dt class="notification">analysis.flushResults</dt><dd>
<div class="box"><pre>notification: { |
| 662 "event": "analysis.flushResults" | 669 "event": "analysis.flushResults" |
| 663 "params": { | 670 "params": { |
| 664 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 671 "<b>files</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_FilePath">FilePath</a>> |
| 665 } | 672 } |
| 666 }</pre></div> | 673 }</pre></div> |
| 667 <p> | 674 <p> |
| 668 Reports that any analysis results that were previously | 675 Reports that any analysis results that were previously |
| 669 associated with the given files should be considered to be | 676 associated with the given files should be considered to be |
| 670 invalid because those files are no longer being analyzed, | 677 invalid because those files are no longer being analyzed, |
| 671 either because the analysis root that contained it is no | 678 either because the analysis root that contained it is no |
| 672 longer being analyzed or because the file no longer exists. | 679 longer being analyzed or because the file no longer exists. |
| 673 </p> | 680 </p> |
| 674 <p> | 681 <p> |
| 675 If a file is included in this notification and at some later | 682 If a file is included in this notification and at some later |
| 676 time a notification with results for the file is received, | 683 time a notification with results for the file is received, |
| 677 clients should assume that the file is once again being | 684 clients should assume that the file is once again being |
| 678 analyzed and the information should be processed. | 685 analyzed and the information should be processed. |
| 679 </p> | 686 </p> |
| 680 <p> | 687 <p> |
| 681 It is not possible to subscribe to or unsubscribe from this | 688 It is not possible to subscribe to or unsubscribe from this |
| 682 notification. | 689 notification. |
| 683 </p> | 690 </p> |
| 684 | 691 |
| 685 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#t
ype_FilePath">FilePath</a>> )</i></b></dt><dd> | 692 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( <span style="color:
#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i>
</b></dt><dd> |
| 686 | 693 |
| 687 <p> | 694 <p> |
| 688 The files that are no longer being analyzed. | 695 The files that are no longer being analyzed. |
| 689 </p> | 696 </p> |
| 690 </dd></dl></dd><dt class="notification">analysis.folding</dt><dd><div
class="box"><pre>notification: { | 697 </dd></dl></dd><dt class="notification">analysis.folding</dt><dd><div
class="box"><pre>notification: { |
| 691 "event": "analysis.folding" | 698 "event": "analysis.folding" |
| 692 "params": { | 699 "params": { |
| 693 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 700 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 694 "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>>
; | 701 "<b>regions</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_FoldingRegion">FoldingRegion</a>> |
| 695 } | 702 } |
| 696 }</pre></div> | 703 }</pre></div> |
| 697 <p> | 704 <p> |
| 698 Reports the folding regions associated with a given | 705 Reports the folding regions associated with a given |
| 699 file. Folding regions can be nested, but will not be | 706 file. Folding regions can be nested, but will not be |
| 700 overlapping. Nesting occurs when a foldable element, such as | 707 overlapping. Nesting occurs when a foldable element, such as |
| 701 a method, is nested inside another foldable element such as | 708 a method, is nested inside another foldable element such as |
| 702 a class. | 709 a class. |
| 703 </p> | 710 </p> |
| 704 <p> | 711 <p> |
| 705 This notification is not subscribed to by default. Clients | 712 This notification is not subscribed to by default. Clients |
| 706 can subscribe by including the value <tt>"FOLDING"</tt> in | 713 can subscribe by including the value <tt>"FOLDING"</tt> in |
| 707 the list of services passed in an analysis.setSubscriptions | 714 the list of services passed in an analysis.setSubscriptions |
| 708 request. | 715 request. |
| 709 </p> | 716 </p> |
| 710 | 717 |
| 711 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 718 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 712 | 719 |
| 713 <p> | 720 <p> |
| 714 The file containing the folding regions. | 721 The file containing the folding regions. |
| 715 </p> | 722 </p> |
| 716 </dd><dt class="field"><b><i>regions ( List<<a href="#type_FoldingR
egion">FoldingRegion</a>> )</i></b></dt><dd> | 723 </dd><dt class="field"><b><i>regions ( <span style="color:#999999">opt
ional</span> List<<a href="#type_FoldingRegion">FoldingRegion</a>> )</i></
b></dt><dd> |
| 717 | 724 |
| 718 <p> | 725 <p> |
| 719 The folding regions contained in the file. | 726 The folding regions contained in the file. |
| 720 </p> | 727 </p> |
| 721 </dd></dl></dd><dt class="notification">analysis.highlights</dt><dd><d
iv class="box"><pre>notification: { | 728 </dd></dl></dd><dt class="notification">analysis.highlights</dt><dd><d
iv class="box"><pre>notification: { |
| 722 "event": "analysis.highlights" | 729 "event": "analysis.highlights" |
| 723 "params": { | 730 "params": { |
| 724 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 731 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 725 "<b>regions</b>": List<<a href="#type_HighlightRegion">HighlightRegion</a
>> | 732 "<b>regions</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_HighlightRegion">HighlightRegion</a>> |
| 726 } | 733 } |
| 727 }</pre></div> | 734 }</pre></div> |
| 728 <p> | 735 <p> |
| 729 Reports the highlight regions associated with a given file. | 736 Reports the highlight regions associated with a given file. |
| 730 </p> | 737 </p> |
| 731 <p> | 738 <p> |
| 732 This notification is not subscribed to by default. Clients | 739 This notification is not subscribed to by default. Clients |
| 733 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> | 740 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> |
| 734 in the list of services passed in an | 741 in the list of services passed in an |
| 735 analysis.setSubscriptions request. | 742 analysis.setSubscriptions request. |
| 736 </p> | 743 </p> |
| 737 | 744 |
| 738 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 745 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 739 | 746 |
| 740 <p> | 747 <p> |
| 741 The file containing the highlight regions. | 748 The file containing the highlight regions. |
| 742 </p> | 749 </p> |
| 743 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Highligh
tRegion">HighlightRegion</a>> )</i></b></dt><dd> | 750 </dd><dt class="field"><b><i>regions ( <span style="color:#999999">opt
ional</span> List<<a href="#type_HighlightRegion">HighlightRegion</a>> )</
i></b></dt><dd> |
| 744 | 751 |
| 745 <p> | 752 <p> |
| 746 The highlight regions contained in the file. Each | 753 The highlight regions contained in the file. Each |
| 747 highlight region represents a particular syntactic or | 754 highlight region represents a particular syntactic or |
| 748 semantic meaning associated with some range. Note that | 755 semantic meaning associated with some range. Note that |
| 749 the highlight regions that are returned can overlap | 756 the highlight regions that are returned can overlap |
| 750 other highlight regions if there is more than one | 757 other highlight regions if there is more than one |
| 751 meaning associated with a particular region. | 758 meaning associated with a particular region. |
| 752 </p> | 759 </p> |
| 753 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d
iv class="box"><pre>notification: { | 760 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d
iv class="box"><pre>notification: { |
| 754 "event": "analysis.navigation" | 761 "event": "analysis.navigation" |
| 755 "params": { | 762 "params": { |
| 756 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 763 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 757 "<b>regions</b>": List<<a href="#type_NavigationRegion">NavigationRegion<
/a>> | 764 "<b>regions</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_NavigationRegion">NavigationRegion</a>> |
| 758 } | 765 } |
| 759 }</pre></div> | 766 }</pre></div> |
| 760 <p> | 767 <p> |
| 761 Reports the navigation targets associated with a given file. | 768 Reports the navigation targets associated with a given file. |
| 762 </p> | 769 </p> |
| 763 <p> | 770 <p> |
| 764 This notification is not subscribed to by default. Clients | 771 This notification is not subscribed to by default. Clients |
| 765 can subscribe by including the value <tt>"NAVIGATION"</tt> | 772 can subscribe by including the value <tt>"NAVIGATION"</tt> |
| 766 in the list of services passed in an | 773 in the list of services passed in an |
| 767 analysis.setSubscriptions request. | 774 analysis.setSubscriptions request. |
| 768 </p> | 775 </p> |
| 769 | 776 |
| 770 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 777 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 771 | 778 |
| 772 <p> | 779 <p> |
| 773 The file containing the navigation regions. | 780 The file containing the navigation regions. |
| 774 </p> | 781 </p> |
| 775 </dd><dt class="field"><b><i>regions ( List<<a href="#type_Navigati
onRegion">NavigationRegion</a>> )</i></b></dt><dd> | 782 </dd><dt class="field"><b><i>regions ( <span style="color:#999999">opt
ional</span> List<<a href="#type_NavigationRegion">NavigationRegion</a>> )
</i></b></dt><dd> |
| 776 | 783 |
| 777 <p> | 784 <p> |
| 778 The navigation regions contained in the file. Each | 785 The navigation regions contained in the file. Each |
| 779 navigation region represents a list of targets | 786 navigation region represents a list of targets |
| 780 associated with some range. The lists will usually | 787 associated with some range. The lists will usually |
| 781 contain a single target, but can contain more in the | 788 contain a single target, but can contain more in the |
| 782 case of a part that is included in multiple libraries | 789 case of a part that is included in multiple libraries |
| 783 or in Dart code that is compiled against multiple | 790 or in Dart code that is compiled against multiple |
| 784 versions of a package. Note that the navigation | 791 versions of a package. Note that the navigation |
| 785 regions that are returned do not overlap other | 792 regions that are returned do not overlap other |
| 786 navigation regions. | 793 navigation regions. |
| 787 </p> | 794 </p> |
| 788 </dd></dl></dd><dt class="notification">analysis.occurrences</dt><dd><
div class="box"><pre>notification: { | 795 </dd></dl></dd><dt class="notification">analysis.occurrences</dt><dd><
div class="box"><pre>notification: { |
| 789 "event": "analysis.occurrences" | 796 "event": "analysis.occurrences" |
| 790 "params": { | 797 "params": { |
| 791 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 798 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 792 "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>>
; | 799 "<b>occurrences</b>": <span style="color:#999999">optional</span> List<<a
href="#type_Occurrences">Occurrences</a>> |
| 793 } | 800 } |
| 794 }</pre></div> | 801 }</pre></div> |
| 795 <p> | 802 <p> |
| 796 Reports the occurrences of references to elements within a | 803 Reports the occurrences of references to elements within a |
| 797 single file. | 804 single file. |
| 798 </p> | 805 </p> |
| 799 <p> | 806 <p> |
| 800 This notification is not subscribed to by default. Clients | 807 This notification is not subscribed to by default. Clients |
| 801 can subscribe by including the value <tt>"OCCURRENCES"</tt> | 808 can subscribe by including the value <tt>"OCCURRENCES"</tt> |
| 802 in the list of services passed in an | 809 in the list of services passed in an |
| 803 analysis.setSubscriptions request. | 810 analysis.setSubscriptions request. |
| 804 </p> | 811 </p> |
| 805 | 812 |
| 806 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 813 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 807 | 814 |
| 808 <p> | 815 <p> |
| 809 The file in which the references occur. | 816 The file in which the references occur. |
| 810 </p> | 817 </p> |
| 811 </dd><dt class="field"><b><i>occurrences ( List<<a href="#type_Occu
rrences">Occurrences</a>> )</i></b></dt><dd> | 818 </dd><dt class="field"><b><i>occurrences ( <span style="color:#999999"
>optional</span> List<<a href="#type_Occurrences">Occurrences</a>> )</i></
b></dt><dd> |
| 812 | 819 |
| 813 <p> | 820 <p> |
| 814 The occurrences of references to elements within the | 821 The occurrences of references to elements within the |
| 815 file. | 822 file. |
| 816 </p> | 823 </p> |
| 817 </dd></dl></dd><dt class="notification">analysis.outline</dt><dd><div
class="box"><pre>notification: { | 824 </dd></dl></dd><dt class="notification">analysis.outline</dt><dd><div
class="box"><pre>notification: { |
| 818 "event": "analysis.outline" | 825 "event": "analysis.outline" |
| 819 "params": { | 826 "params": { |
| 820 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 827 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 821 "<b>outline</b>": <a href="#type_Outline">Outline</a> | 828 "<b>outline</b>": <a href="#type_Outline">Outline</a> |
| (...skipping 16 matching lines...) Expand all Loading... |
| 838 </p> | 845 </p> |
| 839 </dd><dt class="field"><b><i>outline ( <a href="#type_Outline">Outline
</a> )</i></b></dt><dd> | 846 </dd><dt class="field"><b><i>outline ( <a href="#type_Outline">Outline
</a> )</i></b></dt><dd> |
| 840 | 847 |
| 841 <p> | 848 <p> |
| 842 The outline associated with the file. | 849 The outline associated with the file. |
| 843 </p> | 850 </p> |
| 844 </dd></dl></dd><dt class="notification">analysis.overrides</dt><dd><di
v class="box"><pre>notification: { | 851 </dd></dl></dd><dt class="notification">analysis.overrides</dt><dd><di
v class="box"><pre>notification: { |
| 845 "event": "analysis.overrides" | 852 "event": "analysis.overrides" |
| 846 "params": { | 853 "params": { |
| 847 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 854 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 848 "<b>overrides</b>": List<<a href="#type_Override">Override</a>> | 855 "<b>overrides</b>": <span style="color:#999999">optional</span> List<<a h
ref="#type_Override">Override</a>> |
| 849 } | 856 } |
| 850 }</pre></div> | 857 }</pre></div> |
| 851 <p> | 858 <p> |
| 852 Reports the overridding members in a file. | 859 Reports the overridding members in a file. |
| 853 </p> | 860 </p> |
| 854 <p> | 861 <p> |
| 855 This notification is not subscribed to by default. Clients | 862 This notification is not subscribed to by default. Clients |
| 856 can subscribe by including the value <tt>"OVERRIDES"</tt> in | 863 can subscribe by including the value <tt>"OVERRIDES"</tt> in |
| 857 the list of services passed in an analysis.setSubscriptions | 864 the list of services passed in an analysis.setSubscriptions |
| 858 request. | 865 request. |
| 859 </p> | 866 </p> |
| 860 | 867 |
| 861 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 868 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 862 | 869 |
| 863 <p> | 870 <p> |
| 864 The file with which the overrides are associated. | 871 The file with which the overrides are associated. |
| 865 </p> | 872 </p> |
| 866 </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Overri
de">Override</a>> )</i></b></dt><dd> | 873 </dd><dt class="field"><b><i>overrides ( <span style="color:#999999">o
ptional</span> List<<a href="#type_Override">Override</a>> )</i></b></dt><
dd> |
| 867 | 874 |
| 868 <p> | 875 <p> |
| 869 The overrides associated with the file. | 876 The overrides associated with the file. |
| 870 </p> | 877 </p> |
| 871 </dd></dl></dd></dl> | 878 </dd></dl></dd></dl> |
| 872 <h2 class="domain"><a name="domain_completion">Domain: completion</a></h2> | 879 <h2 class="domain"><a name="domain_completion">Domain: completion</a></h2> |
| 873 <p> | 880 <p> |
| 874 The code completion domain contains commands related to | 881 The code completion domain contains commands related to |
| 875 getting code completion suggestions. | 882 getting code completion suggestions. |
| 876 </p> | 883 </p> |
| (...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 913 <p> | 920 <p> |
| 914 The identifier used to associate results with this | 921 The identifier used to associate results with this |
| 915 completion request. | 922 completion request. |
| 916 </p> | 923 </p> |
| 917 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>completion.results</dt><dd><div class="box"><pre>notification: { | 924 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>completion.results</dt><dd><div class="box"><pre>notification: { |
| 918 "event": "completion.results" | 925 "event": "completion.results" |
| 919 "params": { | 926 "params": { |
| 920 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> | 927 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> |
| 921 "<b>replacementOffset</b>": int | 928 "<b>replacementOffset</b>": int |
| 922 "<b>replacementLength</b>": int | 929 "<b>replacementLength</b>": int |
| 923 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug
gestion</a>> | 930 "<b>results</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_CompletionSuggestion">CompletionSuggestion</a>> |
| 924 "<b>last</b>": bool | 931 "<b>last</b>": bool |
| 925 } | 932 } |
| 926 }</pre></div> | 933 }</pre></div> |
| 927 <p> | 934 <p> |
| 928 Reports the completion suggestions that should be presented | 935 Reports the completion suggestions that should be presented |
| 929 to the user. The set of suggestions included in the | 936 to the user. The set of suggestions included in the |
| 930 notification is always a complete list that supersedes any | 937 notification is always a complete list that supersedes any |
| 931 previously reported suggestions. | 938 previously reported suggestions. |
| 932 </p> | 939 </p> |
| 933 | 940 |
| (...skipping 13 matching lines...) Expand all Loading... |
| 947 the offset of the beginning of said identifier. | 954 the offset of the beginning of said identifier. |
| 948 </p> | 955 </p> |
| 949 </dd><dt class="field"><b><i>replacementLength ( int )</i></b></dt><dd
> | 956 </dd><dt class="field"><b><i>replacementLength ( int )</i></b></dt><dd
> |
| 950 | 957 |
| 951 <p> | 958 <p> |
| 952 The length of the text to be replaced if the remainder | 959 The length of the text to be replaced if the remainder |
| 953 of the identifier containing the cursor is to be | 960 of the identifier containing the cursor is to be |
| 954 replaced when the suggestion is applied (that is, the | 961 replaced when the suggestion is applied (that is, the |
| 955 number of characters in the existing identifier). | 962 number of characters in the existing identifier). |
| 956 </p> | 963 </p> |
| 957 </dd><dt class="field"><b><i>results ( List<<a href="#type_Completi
onSuggestion">CompletionSuggestion</a>> )</i></b></dt><dd> | 964 </dd><dt class="field"><b><i>results ( <span style="color:#999999">opt
ional</span> List<<a href="#type_CompletionSuggestion">CompletionSuggestion</
a>> )</i></b></dt><dd> |
| 958 | 965 |
| 959 <p> | 966 <p> |
| 960 The completion suggestions being reported. The | 967 The completion suggestions being reported. The |
| 961 notification contains all possible completions at the | 968 notification contains all possible completions at the |
| 962 requested cursor position, even those that do not match | 969 requested cursor position, even those that do not match |
| 963 the characters the user has already typed. This allows | 970 the characters the user has already typed. This allows |
| 964 the client to respond to further keystrokes from the | 971 the client to respond to further keystrokes from the |
| 965 user without having to make additional requests. | 972 user without having to make additional requests. |
| 966 </p> | 973 </p> |
| 967 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> | 974 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> |
| (...skipping 229 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1197 <p> | 1204 <p> |
| 1198 This field will be absent if the code at the given file | 1205 This field will be absent if the code at the given file |
| 1199 and offset does not represent a type, or if the file has | 1206 and offset does not represent a type, or if the file has |
| 1200 not been sufficiently analyzed to allow a type hierarchy | 1207 not been sufficiently analyzed to allow a type hierarchy |
| 1201 to be produced. | 1208 to be produced. |
| 1202 </p> | 1209 </p> |
| 1203 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>search.results</dt><dd><div class="box"><pre>notification: { | 1210 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>search.results</dt><dd><div class="box"><pre>notification: { |
| 1204 "event": "search.results" | 1211 "event": "search.results" |
| 1205 "params": { | 1212 "params": { |
| 1206 "<b>id</b>": <a href="#type_SearchId">SearchId</a> | 1213 "<b>id</b>": <a href="#type_SearchId">SearchId</a> |
| 1207 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>> | 1214 "<b>results</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_SearchResult">SearchResult</a>> |
| 1208 "<b>last</b>": bool | 1215 "<b>last</b>": bool |
| 1209 } | 1216 } |
| 1210 }</pre></div> | 1217 }</pre></div> |
| 1211 <p> | 1218 <p> |
| 1212 Reports some or all of the results of performing a requested | 1219 Reports some or all of the results of performing a requested |
| 1213 search. Unlike other notifications, this notification | 1220 search. Unlike other notifications, this notification |
| 1214 contains search results that should be added to any | 1221 contains search results that should be added to any |
| 1215 previously received search results associated with the same | 1222 previously received search results associated with the same |
| 1216 search id. | 1223 search id. |
| 1217 </p> | 1224 </p> |
| 1218 | 1225 |
| 1219 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchI
d">SearchId</a> )</i></b></dt><dd> | 1226 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_SearchI
d">SearchId</a> )</i></b></dt><dd> |
| 1220 | 1227 |
| 1221 <p> | 1228 <p> |
| 1222 The id associated with the search. | 1229 The id associated with the search. |
| 1223 </p> | 1230 </p> |
| 1224 </dd><dt class="field"><b><i>results ( List<<a href="#type_SearchRe
sult">SearchResult</a>> )</i></b></dt><dd> | 1231 </dd><dt class="field"><b><i>results ( <span style="color:#999999">opt
ional</span> List<<a href="#type_SearchResult">SearchResult</a>> )</i></b>
</dt><dd> |
| 1225 | 1232 |
| 1226 <p> | 1233 <p> |
| 1227 The search results being reported. | 1234 The search results being reported. |
| 1228 </p> | 1235 </p> |
| 1229 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> | 1236 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> |
| 1230 | 1237 |
| 1231 <p> | 1238 <p> |
| 1232 True if this is that last set of results that will be | 1239 True if this is that last set of results that will be |
| 1233 returned for the indicated search. | 1240 returned for the indicated search. |
| 1234 </p> | 1241 </p> |
| (...skipping 12 matching lines...) Expand all Loading... |
| 1247 "method": "edit.getAssists" | 1254 "method": "edit.getAssists" |
| 1248 "params": { | 1255 "params": { |
| 1249 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1256 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 1250 "<b>offset</b>": int | 1257 "<b>offset</b>": int |
| 1251 "<b>length</b>": int | 1258 "<b>length</b>": int |
| 1252 } | 1259 } |
| 1253 }</pre><br><pre>response: { | 1260 }</pre><br><pre>response: { |
| 1254 "id": String | 1261 "id": String |
| 1255 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 1262 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 1256 "result": { | 1263 "result": { |
| 1257 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>> | 1264 "<b>assists</b>": <span style="color:#999999">optional</span> List<<a hre
f="#type_SourceChange">SourceChange</a>> |
| 1258 } | 1265 } |
| 1259 }</pre></div> | 1266 }</pre></div> |
| 1260 <p> | 1267 <p> |
| 1261 Return the set of assists that are available at the given | 1268 Return the set of assists that are available at the given |
| 1262 location. An assist is distinguished from a refactoring | 1269 location. An assist is distinguished from a refactoring |
| 1263 primarily by the fact that it affects a single file and does | 1270 primarily by the fact that it affects a single file and does |
| 1264 not require user input in order to be performed. | 1271 not require user input in order to be performed. |
| 1265 </p> | 1272 </p> |
| 1266 | 1273 |
| 1267 | 1274 |
| 1268 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 1275 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 1269 | 1276 |
| 1270 <p> | 1277 <p> |
| 1271 The file containing the code for which assists are being | 1278 The file containing the code for which assists are being |
| 1272 requested. | 1279 requested. |
| 1273 </p> | 1280 </p> |
| 1274 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 1281 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
| 1275 | 1282 |
| 1276 <p> | 1283 <p> |
| 1277 The offset of the code for which assists are being | 1284 The offset of the code for which assists are being |
| 1278 requested. | 1285 requested. |
| 1279 </p> | 1286 </p> |
| 1280 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | 1287 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
| 1281 | 1288 |
| 1282 <p> | 1289 <p> |
| 1283 The length of the code for which assists are being | 1290 The length of the code for which assists are being |
| 1284 requested. | 1291 requested. |
| 1285 </p> | 1292 </p> |
| 1286 </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> | 1293 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>assists ( <span
style="color:#999999">optional</span> List<<a href="#type_SourceChange">Sourc
eChange</a>> )</i></b></dt><dd> |
| 1287 | 1294 |
| 1288 <p> | 1295 <p> |
| 1289 The assists that are available at the given location. | 1296 The assists that are available at the given location. |
| 1290 </p> | 1297 </p> |
| 1291 </dd></dl></dd><dt class="request">edit.getAvailableRefactorings</dt><
dd><div class="box"><pre>request: { | 1298 </dd></dl></dd><dt class="request">edit.getAvailableRefactorings</dt><
dd><div class="box"><pre>request: { |
| 1292 "id": String | 1299 "id": String |
| 1293 "method": "edit.getAvailableRefactorings" | 1300 "method": "edit.getAvailableRefactorings" |
| 1294 "params": { | 1301 "params": { |
| 1295 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1302 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 1296 "<b>offset</b>": int | 1303 "<b>offset</b>": int |
| 1297 "<b>length</b>": int | 1304 "<b>length</b>": int |
| 1298 } | 1305 } |
| 1299 }</pre><br><pre>response: { | 1306 }</pre><br><pre>response: { |
| 1300 "id": String | 1307 "id": String |
| 1301 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 1308 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 1302 "result": { | 1309 "result": { |
| 1303 "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>&
gt; | 1310 "<b>kinds</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_RefactoringKind">RefactoringKind</a>> |
| 1304 } | 1311 } |
| 1305 }</pre></div> | 1312 }</pre></div> |
| 1306 <p> | 1313 <p> |
| 1307 Get a list of the kinds of refactorings that are valid for | 1314 Get a list of the kinds of refactorings that are valid for |
| 1308 the given selection in the given file. | 1315 the given selection in the given file. |
| 1309 </p> | 1316 </p> |
| 1310 | 1317 |
| 1311 | 1318 |
| 1312 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 1319 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 1313 | 1320 |
| 1314 <p> | 1321 <p> |
| 1315 The file containing the code on which the refactoring | 1322 The file containing the code on which the refactoring |
| 1316 would be based. | 1323 would be based. |
| 1317 </p> | 1324 </p> |
| 1318 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 1325 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
| 1319 | 1326 |
| 1320 <p> | 1327 <p> |
| 1321 The offset of the code on which the refactoring would be | 1328 The offset of the code on which the refactoring would be |
| 1322 based. | 1329 based. |
| 1323 </p> | 1330 </p> |
| 1324 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | 1331 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
| 1325 | 1332 |
| 1326 <p> | 1333 <p> |
| 1327 The length of the code on which the refactoring would be | 1334 The length of the code on which the refactoring would be |
| 1328 based. | 1335 based. |
| 1329 </p> | 1336 </p> |
| 1330 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( List<
<a href="#type_RefactoringKind">RefactoringKind</a>> )</i></b></dt><dd> | 1337 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( <span st
yle="color:#999999">optional</span> List<<a href="#type_RefactoringKind">Refa
ctoringKind</a>> )</i></b></dt><dd> |
| 1331 | 1338 |
| 1332 <p> | 1339 <p> |
| 1333 The kinds of refactorings that are valid for the given | 1340 The kinds of refactorings that are valid for the given |
| 1334 selection. | 1341 selection. |
| 1335 </p> | 1342 </p> |
| 1336 </dd></dl></dd><dt class="request">edit.getFixes</dt><dd><div class="b
ox"><pre>request: { | 1343 </dd></dl></dd><dt class="request">edit.getFixes</dt><dd><div class="b
ox"><pre>request: { |
| 1337 "id": String | 1344 "id": String |
| 1338 "method": "edit.getFixes" | 1345 "method": "edit.getFixes" |
| 1339 "params": { | 1346 "params": { |
| 1340 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1347 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 1341 "<b>offset</b>": int | 1348 "<b>offset</b>": int |
| 1342 } | 1349 } |
| 1343 }</pre><br><pre>response: { | 1350 }</pre><br><pre>response: { |
| 1344 "id": String | 1351 "id": String |
| 1345 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 1352 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 1346 "result": { | 1353 "result": { |
| 1347 "<b>fixes</b>": List<<a href="#type_ErrorFixes">ErrorFixes</a>> | 1354 "<b>fixes</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_ErrorFixes">ErrorFixes</a>> |
| 1348 } | 1355 } |
| 1349 }</pre></div> | 1356 }</pre></div> |
| 1350 <p> | 1357 <p> |
| 1351 Return the set of fixes that are available for the errors at | 1358 Return the set of fixes that are available for the errors at |
| 1352 a given offset in a given file. | 1359 a given offset in a given file. |
| 1353 </p> | 1360 </p> |
| 1354 | 1361 |
| 1355 | 1362 |
| 1356 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> | 1363 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP
ath">FilePath</a> )</i></b></dt><dd> |
| 1357 | 1364 |
| 1358 <p> | 1365 <p> |
| 1359 The file containing the errors for which fixes are being | 1366 The file containing the errors for which fixes are being |
| 1360 requested. | 1367 requested. |
| 1361 </p> | 1368 </p> |
| 1362 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 1369 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
| 1363 | 1370 |
| 1364 <p> | 1371 <p> |
| 1365 The offset used to select the errors for which fixes | 1372 The offset used to select the errors for which fixes |
| 1366 will be returned. | 1373 will be returned. |
| 1367 </p> | 1374 </p> |
| 1368 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List<
<a href="#type_ErrorFixes">ErrorFixes</a>> )</i></b></dt><dd> | 1375 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( <span st
yle="color:#999999">optional</span> List<<a href="#type_ErrorFixes">ErrorFixe
s</a>> )</i></b></dt><dd> |
| 1369 | 1376 |
| 1370 <p> | 1377 <p> |
| 1371 The fixes that are available for each of the analysis | 1378 The fixes that are available for each of the analysis |
| 1372 errors. There is a one-to-one correspondence between the | 1379 errors. There is a one-to-one correspondence between the |
| 1373 analysis errors in the request and the lists of changes | 1380 analysis errors in the request and the lists of changes |
| 1374 in the response. In particular, it is always the case | 1381 in the response. In particular, it is always the case |
| 1375 that errors.length == fixes.length and that fixes[i] is | 1382 that errors.length == fixes.length and that fixes[i] is |
| 1376 the list of fixes for the error in errors[i]. The list | 1383 the list of fixes for the error in errors[i]. The list |
| 1377 of changes corresponding to an error can be empty if | 1384 of changes corresponding to an error can be empty if |
| 1378 there are no fixes available for that error. | 1385 there are no fixes available for that error. |
| 1379 </p> | 1386 </p> |
| 1380 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl
ass="box"><pre>request: { | 1387 </dd></dl></dd><dt class="request">edit.getRefactoring</dt><dd><div cl
ass="box"><pre>request: { |
| 1381 "id": String | 1388 "id": String |
| 1382 "method": "edit.getRefactoring" | 1389 "method": "edit.getRefactoring" |
| 1383 "params": { | 1390 "params": { |
| 1384 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> | 1391 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> |
| 1385 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1392 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
| 1386 "<b>offset</b>": int | 1393 "<b>offset</b>": int |
| 1387 "<b>length</b>": int | 1394 "<b>length</b>": int |
| 1388 "<b>validateOnly</b>": bool | 1395 "<b>validateOnly</b>": bool |
| 1389 "<b>options</b>": <span style="color:#999999">optional</span> object | 1396 "<b>options</b>": <span style="color:#999999">optional</span> object |
| 1390 } | 1397 } |
| 1391 }</pre><br><pre>response: { | 1398 }</pre><br><pre>response: { |
| 1392 "id": String | 1399 "id": String |
| 1393 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 1400 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 1394 "result": { | 1401 "result": { |
| 1395 "<b>status</b>": List<<a href="#type_RefactoringProblem">RefactoringProbl
em</a>> | 1402 "<b>status</b>": <span style="color:#999999">optional</span> List<<a href
="#type_RefactoringProblem">RefactoringProblem</a>> |
| 1396 "<b>feedback</b>": <span style="color:#999999">optional</span> object | 1403 "<b>feedback</b>": <span style="color:#999999">optional</span> object |
| 1397 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_
SourceChange">SourceChange</a> | 1404 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_
SourceChange">SourceChange</a> |
| 1398 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List<
;String> | 1405 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List<
;String> |
| 1399 } | 1406 } |
| 1400 }</pre></div> | 1407 }</pre></div> |
| 1401 <p> | 1408 <p> |
| 1402 Get the changes required to perform a refactoring. | 1409 Get the changes required to perform a refactoring. |
| 1403 </p> | 1410 </p> |
| 1404 | 1411 |
| 1405 | 1412 |
| (...skipping 28 matching lines...) Expand all Loading... |
| 1434 | 1441 |
| 1435 <p> | 1442 <p> |
| 1436 Data used to provide values provided by the user. The | 1443 Data used to provide values provided by the user. The |
| 1437 structure of the data is dependent on the kind of | 1444 structure of the data is dependent on the kind of |
| 1438 refactoring being performed. The data that is expected is | 1445 refactoring being performed. The data that is expected is |
| 1439 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as | 1446 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as |
| 1440 “Options”. This field can be omitted if the refactoring | 1447 “Options”. This field can be omitted if the refactoring |
| 1441 does not require any options or if the values of those | 1448 does not require any options or if the values of those |
| 1442 options are not known. | 1449 options are not known. |
| 1443 </p> | 1450 </p> |
| 1444 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>status ( List<
;<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd
> | 1451 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>status ( <span s
tyle="color:#999999">optional</span> List<<a href="#type_RefactoringProblem">
RefactoringProblem</a>> )</i></b></dt><dd> |
| 1445 | 1452 |
| 1446 <p> | 1453 <p> |
| 1447 The status of the refactoring. The array will be empty | 1454 The status of the refactoring. The array will be empty |
| 1448 if there are no known problems. | 1455 if there are no known problems. |
| 1449 </p> | 1456 </p> |
| 1450 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op
tional</span> object )</i></b></dt><dd> | 1457 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op
tional</span> object )</i></b></dt><dd> |
| 1451 | 1458 |
| 1452 <p> | 1459 <p> |
| 1453 Data used to provide feedback to the user. The structure | 1460 Data used to provide feedback to the user. The structure |
| 1454 of the data is dependent on the kind of refactoring | 1461 of the data is dependent on the kind of refactoring |
| (...skipping 139 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1594 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona
l</span> String )</i></b></dt><dd> | 1601 </dd><dt class="field"><b><i>uri ( <span style="color:#999999">optiona
l</span> String )</i></b></dt><dd> |
| 1595 | 1602 |
| 1596 <p> | 1603 <p> |
| 1597 The URI to which the file path was mapped. This field is | 1604 The URI to which the file path was mapped. This field is |
| 1598 omitted if the file field was not given in the request. | 1605 omitted if the file field was not given in the request. |
| 1599 </p> | 1606 </p> |
| 1600 </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div
class="box"><pre>request: { | 1607 </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div
class="box"><pre>request: { |
| 1601 "id": String | 1608 "id": String |
| 1602 "method": "debug.setSubscriptions" | 1609 "method": "debug.setSubscriptions" |
| 1603 "params": { | 1610 "params": { |
| 1604 "<b>subscriptions</b>": List<<a href="#type_DebugService">DebugService</a
>> | 1611 "<b>subscriptions</b>": <span style="color:#999999">optional</span> List<
<a href="#type_DebugService">DebugService</a>> |
| 1605 } | 1612 } |
| 1606 }</pre><br><pre>response: { | 1613 }</pre><br><pre>response: { |
| 1607 "id": String | 1614 "id": String |
| 1608 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> | 1615 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err
or</a> |
| 1609 }</pre></div> | 1616 }</pre></div> |
| 1610 <p> | 1617 <p> |
| 1611 Subscribe for services. All previous subscriptions are | 1618 Subscribe for services. All previous subscriptions are |
| 1612 replaced by the given set of services. | 1619 replaced by the given set of services. |
| 1613 </p> | 1620 </p> |
| 1614 <p> | 1621 <p> |
| 1615 It is an error if any of the elements in the list are not | 1622 It is an error if any of the elements in the list are not |
| 1616 valid services. If there is an error, then the current | 1623 valid services. If there is an error, then the current |
| 1617 subscriptions will remain unchanged. | 1624 subscriptions will remain unchanged. |
| 1618 </p> | 1625 </p> |
| 1619 | 1626 |
| 1620 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a
href="#type_DebugService">DebugService</a>> )</i></b></dt><dd> | 1627 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( <span style
="color:#999999">optional</span> List<<a href="#type_DebugService">DebugServi
ce</a>> )</i></b></dt><dd> |
| 1621 | 1628 |
| 1622 <p> | 1629 <p> |
| 1623 A list of the services being subscribed to. | 1630 A list of the services being subscribed to. |
| 1624 </p> | 1631 </p> |
| 1625 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>debug.launchData</dt><dd><div class="box"><pre>notification: { | 1632 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
>debug.launchData</dt><dd><div class="box"><pre>notification: { |
| 1626 "event": "debug.launchData" | 1633 "event": "debug.launchData" |
| 1627 "params": { | 1634 "params": { |
| 1628 "<b>executables</b>": List<<a href="#type_ExecutableFile">ExecutableFile<
/a>> | 1635 "<b>executables</b>": <span style="color:#999999">optional</span> List<<a
href="#type_ExecutableFile">ExecutableFile</a>> |
| 1629 "<b>dartToHtml</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<
a href="#type_FilePath">FilePath</a>>> | 1636 "<b>dartToHtml</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<
a href="#type_FilePath">FilePath</a>>> |
| 1630 "<b>htmlToDart</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<
a href="#type_FilePath">FilePath</a>>> | 1637 "<b>htmlToDart</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<
a href="#type_FilePath">FilePath</a>>> |
| 1631 } | 1638 } |
| 1632 }</pre></div> | 1639 }</pre></div> |
| 1633 <p> | 1640 <p> |
| 1634 Reports information needed to allow applications within the | 1641 Reports information needed to allow applications within the |
| 1635 given context to be launched. | 1642 given context to be launched. |
| 1636 </p> | 1643 </p> |
| 1637 <p> | 1644 <p> |
| 1638 This notification is not subscribed to by default. Clients | 1645 This notification is not subscribed to by default. Clients |
| 1639 can subscribe by including the value "LAUNCH_DATA" in the | 1646 can subscribe by including the value "LAUNCH_DATA" in the |
| 1640 list of services passed in a debug.setSubscriptions request. | 1647 list of services passed in a debug.setSubscriptions request. |
| 1641 </p> | 1648 </p> |
| 1642 | 1649 |
| 1643 <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( List<<a hr
ef="#type_ExecutableFile">ExecutableFile</a>> )</i></b></dt><dd> | 1650 <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( <span style="
color:#999999">optional</span> List<<a href="#type_ExecutableFile">Executable
File</a>> )</i></b></dt><dd> |
| 1644 | 1651 |
| 1645 <p> | 1652 <p> |
| 1646 A list of the files that are executable in the given | 1653 A list of the files that are executable in the given |
| 1647 context. This list replaces any previous list provided | 1654 context. This list replaces any previous list provided |
| 1648 for the given context. | 1655 for the given context. |
| 1649 </p> | 1656 </p> |
| 1650 </dd><dt class="field"><b><i>dartToHtml ( Map<<a href="#type_FilePa
th">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>> )</i></b
></dt><dd> | 1657 </dd><dt class="field"><b><i>dartToHtml ( Map<<a href="#type_FilePa
th">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>> )</i></b
></dt><dd> |
| 1651 | 1658 |
| 1652 <p> | 1659 <p> |
| 1653 A mapping from the paths of Dart files that are | 1660 A mapping from the paths of Dart files that are |
| (...skipping 183 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1837 The edits are applied in the order in which they occur in the list. | 1844 The edits are applied in the order in which they occur in the list. |
| 1838 This means that the offset of each edit must be correct under the | 1845 This means that the offset of each edit must be correct under the |
| 1839 assumption that all previous edits have been applied. | 1846 assumption that all previous edits have been applied. |
| 1840 </p> | 1847 </p> |
| 1841 <p> | 1848 <p> |
| 1842 It is an error to use this overlay on a file that does not yet have | 1849 It is an error to use this overlay on a file that does not yet have |
| 1843 a file content overlay or that has had its overlay removed via | 1850 a file content overlay or that has had its overlay removed via |
| 1844 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. | 1851 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. |
| 1845 </p> | 1852 </p> |
| 1846 | 1853 |
| 1847 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class
="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</
i></b></dt><dd> | 1854 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class
="field"><b><i>edits ( <span style="color:#999999">optional</span> List<<a hr
ef="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd> |
| 1848 | 1855 |
| 1849 <p> | 1856 <p> |
| 1850 The edits to be applied to the file. | 1857 The edits to be applied to the file. |
| 1851 </p> | 1858 </p> |
| 1852 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> | 1859 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> |
| 1853 | 1860 |
| 1854 <p> | 1861 <p> |
| 1855 An identifier used to associate completion results with a | 1862 An identifier used to associate completion results with a |
| 1856 completion request. | 1863 completion request. |
| 1857 </p> | 1864 </p> |
| (...skipping 221 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2079 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorFixes">Er
rorFixes: object</a></dt><dd> | 2086 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorFixes">Er
rorFixes: object</a></dt><dd> |
| 2080 <p> | 2087 <p> |
| 2081 A list of fixes associated with a specific error | 2088 A list of fixes associated with a specific error |
| 2082 </p> | 2089 </p> |
| 2083 | 2090 |
| 2084 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis
Error</a> )</i></b></dt><dd> | 2091 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis
Error</a> )</i></b></dt><dd> |
| 2085 | 2092 |
| 2086 <p> | 2093 <p> |
| 2087 The error with which the fixes are associated. | 2094 The error with which the fixes are associated. |
| 2088 </p> | 2095 </p> |
| 2089 </dd><dt class="field"><b><i>fixes ( List<<a href="#type_SourceChan
ge">SourceChange</a>> )</i></b></dt><dd> | 2096 </dd><dt class="field"><b><i>fixes ( <span style="color:#999999">optio
nal</span> List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></
dt><dd> |
| 2090 | 2097 |
| 2091 <p> | 2098 <p> |
| 2092 The fixes associated with the error. | 2099 The fixes associated with the error. |
| 2093 </p> | 2100 </p> |
| 2094 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorSeverity"
>ErrorSeverity: String</a></dt><dd> | 2101 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorSeverity"
>ErrorSeverity: String</a></dt><dd> |
| 2095 <p> | 2102 <p> |
| 2096 An enumeration of the possible severities of analysis | 2103 An enumeration of the possible severities of analysis |
| 2097 errors. | 2104 errors. |
| 2098 </p> | 2105 </p> |
| 2099 | 2106 |
| (...skipping 162 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2262 <p> | 2269 <p> |
| 2263 A collection of positions that should be linked (edited | 2270 A collection of positions that should be linked (edited |
| 2264 simultaneously) for the purposes of updating code after a | 2271 simultaneously) for the purposes of updating code after a |
| 2265 source change. For example, if a set of edits introduced a | 2272 source change. For example, if a set of edits introduced a |
| 2266 new variable name, the group would contain all of the | 2273 new variable name, the group would contain all of the |
| 2267 positions of the variable name so that if the client wanted | 2274 positions of the variable name so that if the client wanted |
| 2268 to let the user edit the variable name after the operation, | 2275 to let the user edit the variable name after the operation, |
| 2269 all occurrences of the name could be edited simultaneously. | 2276 all occurrences of the name could be edited simultaneously. |
| 2270 </p> | 2277 </p> |
| 2271 | 2278 |
| 2272 <dl><dt class="field"><b><i>positions ( List<<a href="#type_Position">P
osition</a>> )</i></b></dt><dd> | 2279 <dl><dt class="field"><b><i>positions ( <span style="color:#999999">option
al</span> List<<a href="#type_Position">Position</a>> )</i></b></dt><dd> |
| 2273 | 2280 |
| 2274 <p> | 2281 <p> |
| 2275 The positions of the regions that should be edited | 2282 The positions of the regions that should be edited |
| 2276 simultaneously. | 2283 simultaneously. |
| 2277 </p> | 2284 </p> |
| 2278 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | 2285 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
| 2279 | 2286 |
| 2280 <p> | 2287 <p> |
| 2281 The length of the regions that should be edited | 2288 The length of the regions that should be edited |
| 2282 simultaneously. | 2289 simultaneously. |
| 2283 </p> | 2290 </p> |
| 2284 </dd><dt class="field"><b><i>suggestions ( List<<a href="#type_Link
edEditSuggestion">LinkedEditSuggestion</a>> )</i></b></dt><dd> | 2291 </dd><dt class="field"><b><i>suggestions ( <span style="color:#999999"
>optional</span> List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggesti
on</a>> )</i></b></dt><dd> |
| 2285 | 2292 |
| 2286 <p> | 2293 <p> |
| 2287 Pre-computed suggestions for what every region might | 2294 Pre-computed suggestions for what every region might |
| 2288 want to be changed to. | 2295 want to be changed to. |
| 2289 </p> | 2296 </p> |
| 2290 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estion">LinkedEditSuggestion: object</a></dt><dd> | 2297 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estion">LinkedEditSuggestion: object</a></dt><dd> |
| 2291 <p> | 2298 <p> |
| 2292 A suggestion of a value that could be used to replace all of | 2299 A suggestion of a value that could be used to replace all of |
| 2293 the linked edit regions in a LinkedEditGroup. | 2300 the linked edit regions in a LinkedEditGroup. |
| 2294 </p> | 2301 </p> |
| (...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2351 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> | 2358 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> |
| 2352 | 2359 |
| 2353 <p> | 2360 <p> |
| 2354 The offset of the region from which the user can navigate. | 2361 The offset of the region from which the user can navigate. |
| 2355 </p> | 2362 </p> |
| 2356 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | 2363 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
| 2357 | 2364 |
| 2358 <p> | 2365 <p> |
| 2359 The length of the region from which the user can navigate. | 2366 The length of the region from which the user can navigate. |
| 2360 </p> | 2367 </p> |
| 2361 </dd><dt class="field"><b><i>targets ( List<<a href="#type_Element"
>Element</a>> )</i></b></dt><dd> | 2368 </dd><dt class="field"><b><i>targets ( <span style="color:#999999">opt
ional</span> List<<a href="#type_Element">Element</a>> )</i></b></dt><dd> |
| 2362 | 2369 |
| 2363 <p> | 2370 <p> |
| 2364 The elements to which the given region is bound. By | 2371 The elements to which the given region is bound. By |
| 2365 opening the declaration of the elements, clients can | 2372 opening the declaration of the elements, clients can |
| 2366 implement one form of navigation. | 2373 implement one form of navigation. |
| 2367 </p> | 2374 </p> |
| 2368 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O
ccurrences: object</a></dt><dd> | 2375 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O
ccurrences: object</a></dt><dd> |
| 2369 <p> | 2376 <p> |
| 2370 A description of the references to a single element within a | 2377 A description of the references to a single element within a |
| 2371 single file. | 2378 single file. |
| 2372 </p> | 2379 </p> |
| 2373 | 2380 |
| 2374 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a>
)</i></b></dt><dd> | 2381 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a>
)</i></b></dt><dd> |
| 2375 | 2382 |
| 2376 <p> | 2383 <p> |
| 2377 The element that was referenced. | 2384 The element that was referenced. |
| 2378 </p> | 2385 </p> |
| 2379 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><
dd> | 2386 </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">opt
ional</span> List<int> )</i></b></dt><dd> |
| 2380 | 2387 |
| 2381 <p> | 2388 <p> |
| 2382 The offsets of the name of the referenced element within | 2389 The offsets of the name of the referenced element within |
| 2383 the file. | 2390 the file. |
| 2384 </p> | 2391 </p> |
| 2385 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | 2392 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> |
| 2386 | 2393 |
| 2387 <p> | 2394 <p> |
| 2388 The length of the name of the referenced element. | 2395 The length of the name of the referenced element. |
| 2389 </p> | 2396 </p> |
| (...skipping 198 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2588 </p> | 2595 </p> |
| 2589 </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd> | 2596 </dd><dt class="field"><b><i>isPotential ( bool )</i></b></dt><dd> |
| 2590 | 2597 |
| 2591 <p> | 2598 <p> |
| 2592 True if the result is a potential match but cannot be | 2599 True if the result is a potential match but cannot be |
| 2593 confirmed to be a match. For example, if all references to | 2600 confirmed to be a match. For example, if all references to |
| 2594 a method m defined in some class were requested, and a | 2601 a method m defined in some class were requested, and a |
| 2595 reference to a method m from an unknown class were found, | 2602 reference to a method m from an unknown class were found, |
| 2596 it would be marked as being a potential match. | 2603 it would be marked as being a potential match. |
| 2597 </p> | 2604 </p> |
| 2598 </dd><dt class="field"><b><i>path ( List<<a href="#type_Element">El
ement</a>> )</i></b></dt><dd> | 2605 </dd><dt class="field"><b><i>path ( <span style="color:#999999">option
al</span> List<<a href="#type_Element">Element</a>> )</i></b></dt><dd> |
| 2599 | 2606 |
| 2600 <p> | 2607 <p> |
| 2601 The elements that contain the result, starting with the | 2608 The elements that contain the result, starting with the |
| 2602 most immediately enclosing ancestor and ending with the | 2609 most immediately enclosing ancestor and ending with the |
| 2603 library. | 2610 library. |
| 2604 </p> | 2611 </p> |
| 2605 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi
nd">SearchResultKind: String</a></dt><dd> | 2612 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi
nd">SearchResultKind: String</a></dt><dd> |
| 2606 <p> | 2613 <p> |
| 2607 An enumeration of the kinds of search results returned by the | 2614 An enumeration of the kinds of search results returned by the |
| 2608 search domain. | 2615 search domain. |
| (...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2652 <p> | 2659 <p> |
| 2653 A description of a set of edits that implement a single | 2660 A description of a set of edits that implement a single |
| 2654 conceptual change. | 2661 conceptual change. |
| 2655 </p> | 2662 </p> |
| 2656 | 2663 |
| 2657 <dl><dt class="field"><b><i>message ( String )</i></b></dt><dd> | 2664 <dl><dt class="field"><b><i>message ( String )</i></b></dt><dd> |
| 2658 | 2665 |
| 2659 <p> | 2666 <p> |
| 2660 A human-readable description of the change to be applied. | 2667 A human-readable description of the change to be applied. |
| 2661 </p> | 2668 </p> |
| 2662 </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceFile
Edit">SourceFileEdit</a>> )</i></b></dt><dd> | 2669 </dd><dt class="field"><b><i>edits ( <span style="color:#999999">optio
nal</span> List<<a href="#type_SourceFileEdit">SourceFileEdit</a>> )</i></
b></dt><dd> |
| 2663 | 2670 |
| 2664 <p> | 2671 <p> |
| 2665 A list of the edits used to effect the change, grouped by | 2672 A list of the edits used to effect the change, grouped by |
| 2666 file. | 2673 file. |
| 2667 </p> | 2674 </p> |
| 2668 </dd><dt class="field"><b><i>linkedEditGroups ( List<<a href="#type
_LinkedEditGroup">LinkedEditGroup</a>> )</i></b></dt><dd> | 2675 </dd><dt class="field"><b><i>linkedEditGroups ( <span style="color:#99
9999">optional</span> List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a
>> )</i></b></dt><dd> |
| 2669 | 2676 |
| 2670 <p> | 2677 <p> |
| 2671 A list of the linked editing groups used to customize | 2678 A list of the linked editing groups used to customize |
| 2672 the changes that were made. | 2679 the changes that were made. |
| 2673 </p> | 2680 </p> |
| 2674 </dd><dt class="field"><b><i>selection ( <span style="color:#999999">o
ptional</span> <a href="#type_Position">Position</a> )</i></b></dt><dd> | 2681 </dd><dt class="field"><b><i>selection ( <span style="color:#999999">o
ptional</span> <a href="#type_Position">Position</a> )</i></b></dt><dd> |
| 2675 | 2682 |
| 2676 <p> | 2683 <p> |
| 2677 The position that should be selected after the edits | 2684 The position that should be selected after the edits |
| 2678 have been applied. | 2685 have been applied. |
| (...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2716 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit
">SourceFileEdit: object</a></dt><dd> | 2723 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit
">SourceFileEdit: object</a></dt><dd> |
| 2717 <p> | 2724 <p> |
| 2718 A description of a set of changes to a single file. | 2725 A description of a set of changes to a single file. |
| 2719 </p> | 2726 </p> |
| 2720 | 2727 |
| 2721 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )
</i></b></dt><dd> | 2728 <dl><dt class="field"><b><i>file ( <a href="#type_FilePath">FilePath</a> )
</i></b></dt><dd> |
| 2722 | 2729 |
| 2723 <p> | 2730 <p> |
| 2724 The file containing the code to be modified. | 2731 The file containing the code to be modified. |
| 2725 </p> | 2732 </p> |
| 2726 </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit
">SourceEdit</a>> )</i></b></dt><dd> | 2733 </dd><dt class="field"><b><i>edits ( <span style="color:#999999">optio
nal</span> List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><
dd> |
| 2727 | 2734 |
| 2728 <p> | 2735 <p> |
| 2729 A list of the edits used to effect the change. | 2736 A list of the edits used to effect the change. |
| 2730 </p> | 2737 </p> |
| 2731 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI
tem">TypeHierarchyItem: object</a></dt><dd> | 2738 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI
tem">TypeHierarchyItem: object</a></dt><dd> |
| 2732 <p> | 2739 <p> |
| 2733 A representation of a class in a type hierarchy. | 2740 A representation of a class in a type hierarchy. |
| 2734 </p> | 2741 </p> |
| 2735 | 2742 |
| 2736 <dl><dt class="field"><b><i>classElement ( <a href="#type_Element">Element
</a> )</i></b></dt><dd> | 2743 <dl><dt class="field"><b><i>classElement ( <a href="#type_Element">Element
</a> )</i></b></dt><dd> |
| (...skipping 18 matching lines...) Expand all Loading... |
| 2755 omitted if the hierarchy was not requested for a member or | 2762 omitted if the hierarchy was not requested for a member or |
| 2756 if the class does not have a corresponding member. | 2763 if the class does not have a corresponding member. |
| 2757 </p> | 2764 </p> |
| 2758 </dd><dt class="field"><b><i>superclass ( <span style="color:#999999">
optional</span> int )</i></b></dt><dd> | 2765 </dd><dt class="field"><b><i>superclass ( <span style="color:#999999">
optional</span> int )</i></b></dt><dd> |
| 2759 | 2766 |
| 2760 <p> | 2767 <p> |
| 2761 The index of the item representing the superclass of | 2768 The index of the item representing the superclass of |
| 2762 this class. This field will be omitted if this item | 2769 this class. This field will be omitted if this item |
| 2763 represents the class Object. | 2770 represents the class Object. |
| 2764 </p> | 2771 </p> |
| 2765 </dd><dt class="field"><b><i>interfaces ( List<int> )</i></b></d
t><dd> | 2772 </dd><dt class="field"><b><i>interfaces ( <span style="color:#999999">
optional</span> List<int> )</i></b></dt><dd> |
| 2766 | 2773 |
| 2767 <p> | 2774 <p> |
| 2768 The indexes of the items representing the interfaces | 2775 The indexes of the items representing the interfaces |
| 2769 implemented by this class. The list will be empty if | 2776 implemented by this class. The list will be empty if |
| 2770 there are no implemented interfaces. | 2777 there are no implemented interfaces. |
| 2771 </p> | 2778 </p> |
| 2772 </dd><dt class="field"><b><i>mixins ( List<int> )</i></b></dt><d
d> | 2779 </dd><dt class="field"><b><i>mixins ( <span style="color:#999999">opti
onal</span> List<int> )</i></b></dt><dd> |
| 2773 | 2780 |
| 2774 <p> | 2781 <p> |
| 2775 The indexes of the items representing the mixins | 2782 The indexes of the items representing the mixins |
| 2776 referenced by this class. The list will be empty if | 2783 referenced by this class. The list will be empty if |
| 2777 there are no classes mixed in to this class. | 2784 there are no classes mixed in to this class. |
| 2778 </p> | 2785 </p> |
| 2779 </dd><dt class="field"><b><i>subclasses ( List<int> )</i></b></d
t><dd> | 2786 </dd><dt class="field"><b><i>subclasses ( <span style="color:#999999">
optional</span> List<int> )</i></b></dt><dd> |
| 2780 | 2787 |
| 2781 <p> | 2788 <p> |
| 2782 The indexes of the items representing the subtypes of | 2789 The indexes of the items representing the subtypes of |
| 2783 this class. The list will be empty if there are no | 2790 this class. The list will be empty if there are no |
| 2784 subtypes or if this item represents a supertype of the | 2791 subtypes or if this item represents a supertype of the |
| 2785 pivot type. | 2792 pivot type. |
| 2786 </p> | 2793 </p> |
| 2787 </dd></dl></dd></dl> | 2794 </dd></dl></dd></dl> |
| 2788 | 2795 |
| 2789 <h2><a name="refactorings">Refactorings</a></h2> | 2796 <h2><a name="refactorings">Refactorings</a></h2> |
| (...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2827 <p> | 2834 <p> |
| 2828 Create a local variable initialized by a specified | 2835 Create a local variable initialized by a specified |
| 2829 expression. | 2836 expression. |
| 2830 </p> | 2837 </p> |
| 2831 <p> | 2838 <p> |
| 2832 It is an error if the range contains anything other than a | 2839 It is an error if the range contains anything other than a |
| 2833 complete expression (no partial expressions are allowed). | 2840 complete expression (no partial expressions are allowed). |
| 2834 </p> | 2841 </p> |
| 2835 | 2842 |
| 2836 | 2843 |
| 2837 <h4>Feedback</h4><dl><dt class="field"><b><i>names ( List<String> )<
/i></b></dt><dd> | 2844 <h4>Feedback</h4><dl><dt class="field"><b><i>names ( <span style="color:#9
99999">optional</span> List<String> )</i></b></dt><dd> |
| 2838 | 2845 |
| 2839 <p> | 2846 <p> |
| 2840 The proposed names for the local variable. | 2847 The proposed names for the local variable. |
| 2841 </p> | 2848 </p> |
| 2842 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><
dd> | 2849 </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">opt
ional</span> List<int> )</i></b></dt><dd> |
| 2843 | 2850 |
| 2844 <p> | 2851 <p> |
| 2845 The offsets of the expressions that would be replaced by | 2852 The offsets of the expressions that would be replaced by |
| 2846 a reference to the variable. | 2853 a reference to the variable. |
| 2847 </p> | 2854 </p> |
| 2848 </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><
dd> | 2855 </dd><dt class="field"><b><i>lengths ( <span style="color:#999999">opt
ional</span> List<int> )</i></b></dt><dd> |
| 2849 | 2856 |
| 2850 <p> | 2857 <p> |
| 2851 The lengths of the expressions that would be replaced by | 2858 The lengths of the expressions that would be replaced by |
| 2852 a reference to the variable. The lengths correspond to | 2859 a reference to the variable. The lengths correspond to |
| 2853 the offsets. In other words, for a given expression, if | 2860 the offsets. In other words, for a given expression, if |
| 2854 the offset of that expression is offsets[i], then the | 2861 the offset of that expression is offsets[i], then the |
| 2855 length of that expression is lengths[i]. | 2862 length of that expression is lengths[i]. |
| 2856 </p> | 2863 </p> |
| 2857 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>name ( String )<
/i></b></dt><dd> | 2864 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>name ( String )<
/i></b></dt><dd> |
| 2858 | 2865 |
| (...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2891 | 2898 |
| 2892 <p> | 2899 <p> |
| 2893 The length of the expression or statements that will be | 2900 The length of the expression or statements that will be |
| 2894 extracted. | 2901 extracted. |
| 2895 </p> | 2902 </p> |
| 2896 </dd><dt class="field"><b><i>returnType ( String )</i></b></dt><dd> | 2903 </dd><dt class="field"><b><i>returnType ( String )</i></b></dt><dd> |
| 2897 | 2904 |
| 2898 <p> | 2905 <p> |
| 2899 The proposed return type for the method. | 2906 The proposed return type for the method. |
| 2900 </p> | 2907 </p> |
| 2901 </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt>
<dd> | 2908 </dd><dt class="field"><b><i>names ( <span style="color:#999999">optio
nal</span> List<String> )</i></b></dt><dd> |
| 2902 | 2909 |
| 2903 <p> | 2910 <p> |
| 2904 The proposed names for the method. | 2911 The proposed names for the method. |
| 2905 </p> | 2912 </p> |
| 2906 </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd> | 2913 </dd><dt class="field"><b><i>canCreateGetter ( bool )</i></b></dt><dd> |
| 2907 | 2914 |
| 2908 <p> | 2915 <p> |
| 2909 True if a getter could be created rather than a method. | 2916 True if a getter could be created rather than a method. |
| 2910 </p> | 2917 </p> |
| 2911 </dd><dt class="field"><b><i>parameters ( List<<a href="#type_Refac
toringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd> | 2918 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">
optional</span> List<<a href="#type_RefactoringMethodParameter">RefactoringMe
thodParameter</a>> )</i></b></dt><dd> |
| 2912 | 2919 |
| 2913 <p> | 2920 <p> |
| 2914 The proposed parameters for the method. | 2921 The proposed parameters for the method. |
| 2915 </p> | 2922 </p> |
| 2916 </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd> | 2923 </dd><dt class="field"><b><i>occurrences ( int )</i></b></dt><dd> |
| 2917 | 2924 |
| 2918 <p> | 2925 <p> |
| 2919 The number of times the expression or statements occurs. | 2926 The number of times the expression or statements occurs. |
| 2920 </p> | 2927 </p> |
| 2921 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><
dd> | 2928 </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">opt
ional</span> List<int> )</i></b></dt><dd> |
| 2922 | 2929 |
| 2923 <p> | 2930 <p> |
| 2924 The offsets of the expressions or statements that would | 2931 The offsets of the expressions or statements that would |
| 2925 be replaced by an invocation of the method. | 2932 be replaced by an invocation of the method. |
| 2926 </p> | 2933 </p> |
| 2927 </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><
dd> | 2934 </dd><dt class="field"><b><i>lengths ( <span style="color:#999999">opt
ional</span> List<int> )</i></b></dt><dd> |
| 2928 | 2935 |
| 2929 <p> | 2936 <p> |
| 2930 The lengths of the expressions or statements that would | 2937 The lengths of the expressions or statements that would |
| 2931 be replaced by an invocation of the method. The lengths | 2938 be replaced by an invocation of the method. The lengths |
| 2932 correspond to the offsets. In other words, for a given | 2939 correspond to the offsets. In other words, for a given |
| 2933 expression (or block of statements), if the offset of | 2940 expression (or block of statements), if the offset of |
| 2934 that expression is offsets[i], then the length of that | 2941 that expression is offsets[i], then the length of that |
| 2935 expression is lengths[i]. | 2942 expression is lengths[i]. |
| 2936 </p> | 2943 </p> |
| 2937 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>returnType ( Str
ing )</i></b></dt><dd> | 2944 </dd></dl><h4>Options</h4><dl><dt class="field"><b><i>returnType ( Str
ing )</i></b></dt><dd> |
| 2938 | 2945 |
| 2939 <p> | 2946 <p> |
| 2940 The return type that should be defined for the method. | 2947 The return type that should be defined for the method. |
| 2941 </p> | 2948 </p> |
| 2942 </dd><dt class="field"><b><i>createGetter ( bool )</i></b></dt><dd> | 2949 </dd><dt class="field"><b><i>createGetter ( bool )</i></b></dt><dd> |
| 2943 | 2950 |
| 2944 <p> | 2951 <p> |
| 2945 True if a getter should be created rather than a | 2952 True if a getter should be created rather than a |
| 2946 method. It is an error if this field is true and the | 2953 method. It is an error if this field is true and the |
| 2947 list of parameters is non-empty. | 2954 list of parameters is non-empty. |
| 2948 </p> | 2955 </p> |
| 2949 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> | 2956 </dd><dt class="field"><b><i>name ( String )</i></b></dt><dd> |
| 2950 | 2957 |
| 2951 <p> | 2958 <p> |
| 2952 The name that the method should be given. | 2959 The name that the method should be given. |
| 2953 </p> | 2960 </p> |
| 2954 </dd><dt class="field"><b><i>parameters ( List<<a href="#type_Refac
toringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd> | 2961 </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">
optional</span> List<<a href="#type_RefactoringMethodParameter">RefactoringMe
thodParameter</a>> )</i></b></dt><dd> |
| 2955 | 2962 |
| 2956 <p> | 2963 <p> |
| 2957 The parameters that should be defined for the method. | 2964 The parameters that should be defined for the method. |
| 2958 </p><p> | 2965 </p><p> |
| 2959 It is an error if a REQUIRED or NAMED parameter follows a | 2966 It is an error if a REQUIRED or NAMED parameter follows a |
| 2960 POSITIONAL parameter. | 2967 POSITIONAL parameter. |
| 2961 It is an error if a REQUIRED or POSITIONAL parameter follows a | 2968 It is an error if a REQUIRED or POSITIONAL parameter follows a |
| 2962 NAMED parameter. | 2969 NAMED parameter. |
| 2963 </p> | 2970 </p> |
| 2964 <ul> | 2971 <ul> |
| (...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3046 <p> | 3053 <p> |
| 3047 This section contains a list of all of the errors that are | 3054 This section contains a list of all of the errors that are |
| 3048 produced by the server and the data that is returned with each. | 3055 produced by the server and the data that is returned with each. |
| 3049 </p> | 3056 </p> |
| 3050 <p> | 3057 <p> |
| 3051 TBD | 3058 TBD |
| 3052 </p> | 3059 </p> |
| 3053 | 3060 |
| 3054 | 3061 |
| 3055 </body></html> | 3062 </body></html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 482573004:
Change analysis server protocol to omit empty lists when optional. (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart