Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(187)

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 530583004: Rename Error to RequestError in analysis server API. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestError.java ('k') | pkg/analysis_server/lib/src/constants.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 171 matching lines...) Expand 10 before | Expand all | Expand 10 after
182 182
183 183
184 184
185 185
186 186
187 <h3>Requests</h3><dl><dt class="request">server.getVersion</dt><dd><div clas s="box"><pre>request: { 187 <h3>Requests</h3><dl><dt class="request">server.getVersion</dt><dd><div clas s="box"><pre>request: {
188 "id": String 188 "id": String
189 "method": "server.getVersion" 189 "method": "server.getVersion"
190 }</pre><br><pre>response: { 190 }</pre><br><pre>response: {
191 "id": String 191 "id": String
192 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 192 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
193 "result": { 193 "result": {
194 "<b>version</b>": String 194 "<b>version</b>": String
195 } 195 }
196 }</pre></div> 196 }</pre></div>
197 <p>Return the version number of the analysis server.</p> 197 <p>Return the version number of the analysis server.</p>
198 198
199 <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt ><dd> 199 <h4>Returns</h4><dl><dt class="field"><b><i>version ( String )</i></b></dt ><dd>
200 200
201 <p>The version number of the analysis server.</p> 201 <p>The version number of the analysis server.</p>
202 </dd></dl></dd><dt class="request">server.shutdown</dt><dd><div class= "box"><pre>request: { 202 </dd></dl></dd><dt class="request">server.shutdown</dt><dd><div class= "box"><pre>request: {
203 "id": String 203 "id": String
204 "method": "server.shutdown" 204 "method": "server.shutdown"
205 }</pre><br><pre>response: { 205 }</pre><br><pre>response: {
206 "id": String 206 "id": String
207 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 207 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
208 }</pre></div> 208 }</pre></div>
209 <p> 209 <p>
210 Cleanly shutdown the analysis server. Requests that are 210 Cleanly shutdown the analysis server. Requests that are
211 received after this request will not be processed. Requests 211 received after this request will not be processed. Requests
212 that were received before this request, but for which a 212 that were received before this request, but for which a
213 response has not yet been sent, will not be responded to. No 213 response has not yet been sent, will not be responded to. No
214 further responses or notifications will be sent after the 214 further responses or notifications will be sent after the
215 response to this request has been sent. 215 response to this request has been sent.
216 </p> 216 </p>
217 </dd><dt class="request">server.setSubscriptions</dt><dd><div class="box"> <pre>request: { 217 </dd><dt class="request">server.setSubscriptions</dt><dd><div class="box"> <pre>request: {
218 "id": String 218 "id": String
219 "method": "server.setSubscriptions" 219 "method": "server.setSubscriptions"
220 "params": { 220 "params": {
221 "<b>subscriptions</b>": List&lt;<a href="#type_ServerService">ServerService< /a>&gt; 221 "<b>subscriptions</b>": List&lt;<a href="#type_ServerService">ServerService< /a>&gt;
222 } 222 }
223 }</pre><br><pre>response: { 223 }</pre><br><pre>response: {
224 "id": String 224 "id": String
225 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 225 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
226 }</pre></div> 226 }</pre></div>
227 <p> 227 <p>
228 Subscribe for services. All previous subscriptions are 228 Subscribe for services. All previous subscriptions are
229 replaced by the given set of services. 229 replaced by the given set of services.
230 </p> 230 </p>
231 <p> 231 <p>
232 It is an error if any of the elements in the list are not 232 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 233 valid services. If there is an error, then the current
234 subscriptions will remain unchanged. 234 subscriptions will remain unchanged.
235 </p> 235 </p>
(...skipping 102 matching lines...) Expand 10 before | Expand all | Expand 10 after
338 338
339 339
340 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: { 340 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: {
341 "id": String 341 "id": String
342 "method": "analysis.getErrors" 342 "method": "analysis.getErrors"
343 "params": { 343 "params": {
344 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 344 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
345 } 345 }
346 }</pre><br><pre>response: { 346 }</pre><br><pre>response: {
347 "id": String 347 "id": String
348 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 348 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
349 "result": { 349 "result": {
350 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt; 350 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt;
351 } 351 }
352 }</pre></div> 352 }</pre></div>
353 <p> 353 <p>
354 Return the errors associated with the given file. If the 354 Return the errors associated with the given file. If the
355 errors for the given file have not yet been computed, or the 355 errors for the given file have not yet been computed, or the
356 most recently computed errors for the given file are out of 356 most recently computed errors for the given file are out of
357 date, then the response for this request will be delayed 357 date, then the response for this request will be delayed
358 until they have been computed. If some or all of the errors 358 until they have been computed. If some or all of the errors
(...skipping 23 matching lines...) Expand all
382 </p> 382 </p>
383 </dd></dl></dd><dt class="request">analysis.getHover</dt><dd><div clas s="box"><pre>request: { 383 </dd></dl></dd><dt class="request">analysis.getHover</dt><dd><div clas s="box"><pre>request: {
384 "id": String 384 "id": String
385 "method": "analysis.getHover" 385 "method": "analysis.getHover"
386 "params": { 386 "params": {
387 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 387 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
388 "<b>offset</b>": int 388 "<b>offset</b>": int
389 } 389 }
390 }</pre><br><pre>response: { 390 }</pre><br><pre>response: {
391 "id": String 391 "id": String
392 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 392 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
393 "result": { 393 "result": {
394 "<b>hovers</b>": List&lt;<a href="#type_HoverInformation">HoverInformation</ a>&gt; 394 "<b>hovers</b>": List&lt;<a href="#type_HoverInformation">HoverInformation</ a>&gt;
395 } 395 }
396 }</pre></div> 396 }</pre></div>
397 <p> 397 <p>
398 Return the hover information associate with the given 398 Return the hover information associate with the given
399 location. If some or all of the hover information is not 399 location. If some or all of the hover information is not
400 available at the time this request is processed the 400 available at the time this request is processed the
401 information will be omitted from the response. 401 information will be omitted from the response.
402 </p> 402 </p>
(...skipping 19 matching lines...) Expand all
422 could be determined for the location. The list can 422 could be determined for the location. The list can
423 contain multiple items if the file is being analyzed 423 contain multiple items if the file is being analyzed
424 in multiple contexts in conflicting ways (such as a 424 in multiple contexts in conflicting ways (such as a
425 part that is included in multiple libraries). 425 part that is included in multiple libraries).
426 </p> 426 </p>
427 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: { 427 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: {
428 "id": String 428 "id": String
429 "method": "analysis.reanalyze" 429 "method": "analysis.reanalyze"
430 }</pre><br><pre>response: { 430 }</pre><br><pre>response: {
431 "id": String 431 "id": String
432 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 432 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
433 }</pre></div> 433 }</pre></div>
434 <p> 434 <p>
435 Force the re-analysis of everything contained in the 435 Force the re-analysis of everything contained in the
436 existing analysis roots. This will cause all previously 436 existing analysis roots. This will cause all previously
437 computed analysis results to be discarded and recomputed, 437 computed analysis results to be discarded and recomputed,
438 and will cause all subscribed notifications to be re-sent. 438 and will cause all subscribed notifications to be re-sent.
439 </p> 439 </p>
440 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box "><pre>request: { 440 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box "><pre>request: {
441 "id": String 441 "id": String
442 "method": "analysis.setAnalysisRoots" 442 "method": "analysis.setAnalysisRoots"
443 "params": { 443 "params": {
444 "<b>included</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 444 "<b>included</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
445 "<b>excluded</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 445 "<b>excluded</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
446 } 446 }
447 }</pre><br><pre>response: { 447 }</pre><br><pre>response: {
448 "id": String 448 "id": String
449 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 449 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
450 }</pre></div> 450 }</pre></div>
451 <p> 451 <p>
452 Sets the root paths used to determine which files to 452 Sets the root paths used to determine which files to
453 analyze. The set of files to be analyzed are all of the 453 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 454 files in one of the root paths that are not also in one of
455 the excluded paths. 455 the excluded paths.
456 </p> 456 </p>
457 <p> 457 <p>
458 Note that this request determines the set of requested 458 Note that this request determines the set of requested
459 analysis roots. The actual set of analysis roots at any 459 analysis roots. The actual set of analysis roots at any
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
491 included directories that should not be analyzed. 491 included directories that should not be analyzed.
492 </p> 492 </p>
493 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd>< div class="box"><pre>request: { 493 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd>< div class="box"><pre>request: {
494 "id": String 494 "id": String
495 "method": "analysis.setPriorityFiles" 495 "method": "analysis.setPriorityFiles"
496 "params": { 496 "params": {
497 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 497 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
498 } 498 }
499 }</pre><br><pre>response: { 499 }</pre><br><pre>response: {
500 "id": String 500 "id": String
501 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 501 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
502 }</pre></div> 502 }</pre></div>
503 <p> 503 <p>
504 Set the priority files to the files in the given list. A 504 Set the priority files to the files in the given list. A
505 priority file is a file that is given priority when 505 priority file is a file that is given priority when
506 scheduling which analysis work to do first. The list 506 scheduling which analysis work to do first. The list
507 typically contains those files that are visible to the user 507 typically contains those files that are visible to the user
508 and those for which analysis results will have the biggest 508 and those for which analysis results will have the biggest
509 impact on the user experience. The order of the files within 509 impact on the user experience. The order of the files within
510 the list is significant: the first file will be given higher 510 the list is significant: the first file will be given higher
511 priority than the second, the second higher priority than 511 priority than the second, the second higher priority than
(...skipping 20 matching lines...) Expand all
532 The files that are to be a priority for analysis. 532 The files that are to be a priority for analysis.
533 </p> 533 </p>
534 </dd></dl></dd><dt class="request">analysis.setSubscriptions</dt><dd>< div class="box"><pre>request: { 534 </dd></dl></dd><dt class="request">analysis.setSubscriptions</dt><dd>< div class="box"><pre>request: {
535 "id": String 535 "id": String
536 "method": "analysis.setSubscriptions" 536 "method": "analysis.setSubscriptions"
537 "params": { 537 "params": {
538 "<b>subscriptions</b>": Map&lt;<a href="#type_AnalysisService">AnalysisServi ce</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; 538 "<b>subscriptions</b>": Map&lt;<a href="#type_AnalysisService">AnalysisServi ce</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt;
539 } 539 }
540 }</pre><br><pre>response: { 540 }</pre><br><pre>response: {
541 "id": String 541 "id": String
542 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 542 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
543 }</pre></div> 543 }</pre></div>
544 <p> 544 <p>
545 Subscribe for services. All previous subscriptions are 545 Subscribe for services. All previous subscriptions are
546 replaced by the current set of subscriptions. If a given 546 replaced by the current set of subscriptions. If a given
547 service is not included as a key in the map then no files 547 service is not included as a key in the map then no files
548 will be subscribed to the service, exactly as if the service 548 will be subscribed to the service, exactly as if the service
549 had been included in the map with an explicit empty list of 549 had been included in the map with an explicit empty list of
550 files. 550 files.
551 </p> 551 </p>
552 <p> 552 <p>
(...skipping 29 matching lines...) Expand all
582 subscribed to the service. 582 subscribed to the service.
583 </p> 583 </p>
584 </dd></dl></dd><dt class="request">analysis.updateContent</dt><dd><div class="box"><pre>request: { 584 </dd></dl></dd><dt class="request">analysis.updateContent</dt><dd><div class="box"><pre>request: {
585 "id": String 585 "id": String
586 "method": "analysis.updateContent" 586 "method": "analysis.updateContent"
587 "params": { 587 "params": {
588 "<b>files</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, <a href="#type _AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOv erlay</a>&gt; 588 "<b>files</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, <a href="#type _AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a> | <a href="#type_RemoveContentOverlay">RemoveContentOv erlay</a>&gt;
589 } 589 }
590 }</pre><br><pre>response: { 590 }</pre><br><pre>response: {
591 "id": String 591 "id": String
592 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 592 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
593 }</pre></div> 593 }</pre></div>
594 <p> 594 <p>
595 Update the content of one or more files. Files that were 595 Update the content of one or more files. Files that were
596 previously updated but not included in this update remain 596 previously updated but not included in this update remain
597 unchanged. This effectively represents an overlay of the 597 unchanged. This effectively represents an overlay of the
598 filesystem. The files whose content is overridden are 598 filesystem. The files whose content is overridden are
599 therefore seen by server as being files with the given 599 therefore seen by server as being files with the given
600 content, even if the files do not exist on the filesystem or 600 content, even if the files do not exist on the filesystem or
601 if the file path represents the path to a directory on the 601 if the file path represents the path to a directory on the
602 filesystem. 602 filesystem.
603 </p> 603 </p>
604 604
605 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map&lt;<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</ a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#t ype_RemoveContentOverlay">RemoveContentOverlay</a>&gt; )</i></b></dt><dd> 605 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map&lt;<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</ a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#t ype_RemoveContentOverlay">RemoveContentOverlay</a>&gt; )</i></b></dt><dd>
606 606
607 <p> 607 <p>
608 A table mapping the files whose content has changed to a 608 A table mapping the files whose content has changed to a
609 description of the content change. 609 description of the content change.
610 </p> 610 </p>
611 </dd></dl></dd><dt class="request">analysis.updateOptions</dt><dd><div class="box"><pre>request: { 611 </dd></dl></dd><dt class="request">analysis.updateOptions</dt><dd><div class="box"><pre>request: {
612 "id": String 612 "id": String
613 "method": "analysis.updateOptions" 613 "method": "analysis.updateOptions"
614 "params": { 614 "params": {
615 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a> 615 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>
616 } 616 }
617 }</pre><br><pre>response: { 617 }</pre><br><pre>response: {
618 "id": String 618 "id": String
619 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 619 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
620 }</pre></div> 620 }</pre></div>
621 <p> 621 <p>
622 Update the options controlling analysis based on the given 622 Update the options controlling analysis based on the given
623 set of options. Any options that are not included in the 623 set of options. Any options that are not included in the
624 analysis options will not be changed. If there are options 624 analysis options will not be changed. If there are options
625 in the analysis options that are not valid, they will be 625 in the analysis options that are not valid, they will be
626 silently ignored. 626 silently ignored.
627 </p> 627 </p>
628 628
629 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An alysisOptions">AnalysisOptions</a> )</i></b></dt><dd> 629 <h4>Parameters</h4><dl><dt class="field"><b><i>options ( <a href="#type_An alysisOptions">AnalysisOptions</a> )</i></b></dt><dd>
(...skipping 248 matching lines...) Expand 10 before | Expand all | Expand 10 after
878 878
879 <h3>Requests</h3><dl><dt class="request">completion.getSuggestions</dt><dd>< div class="box"><pre>request: { 879 <h3>Requests</h3><dl><dt class="request">completion.getSuggestions</dt><dd>< div class="box"><pre>request: {
880 "id": String 880 "id": String
881 "method": "completion.getSuggestions" 881 "method": "completion.getSuggestions"
882 "params": { 882 "params": {
883 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 883 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
884 "<b>offset</b>": int 884 "<b>offset</b>": int
885 } 885 }
886 }</pre><br><pre>response: { 886 }</pre><br><pre>response: {
887 "<b>id</b>": String 887 "<b>id</b>": String
888 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 888 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
889 "result": { 889 "result": {
890 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> 890 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a>
891 } 891 }
892 }</pre></div> 892 }</pre></div>
893 <p> 893 <p>
894 Request that completion suggestions for the given offset in 894 Request that completion suggestions for the given offset in
895 the given file be returned. 895 the given file be returned.
896 </p> 896 </p>
897 897
898 898
(...skipping 86 matching lines...) Expand 10 before | Expand all | Expand 10 after
985 <h3>Requests</h3><dl><dt class="request">search.findElementReferences</dt><d d><div class="box"><pre>request: { 985 <h3>Requests</h3><dl><dt class="request">search.findElementReferences</dt><d d><div class="box"><pre>request: {
986 "id": String 986 "id": String
987 "method": "search.findElementReferences" 987 "method": "search.findElementReferences"
988 "params": { 988 "params": {
989 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 989 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
990 "<b>offset</b>": int 990 "<b>offset</b>": int
991 "<b>includePotential</b>": bool 991 "<b>includePotential</b>": bool
992 } 992 }
993 }</pre><br><pre>response: { 993 }</pre><br><pre>response: {
994 "<b>id</b>": String 994 "<b>id</b>": String
995 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 995 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
996 "result": { 996 "result": {
997 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 997 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
998 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type _Element">Element</a> 998 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type _Element">Element</a>
999 } 999 }
1000 }</pre></div> 1000 }</pre></div>
1001 <p> 1001 <p>
1002 Perform a search for references to the element defined or 1002 Perform a search for references to the element defined or
1003 referenced at the given offset in the given file. 1003 referenced at the given offset in the given file.
1004 </p> 1004 </p>
1005 <p> 1005 <p>
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
1045 field will be absent. 1045 field will be absent.
1046 </p> 1046 </p>
1047 </dd></dl></dd><dt class="request">search.findMemberDeclarations</dt>< dd><div class="box"><pre>request: { 1047 </dd></dl></dd><dt class="request">search.findMemberDeclarations</dt>< dd><div class="box"><pre>request: {
1048 "id": String 1048 "id": String
1049 "method": "search.findMemberDeclarations" 1049 "method": "search.findMemberDeclarations"
1050 "params": { 1050 "params": {
1051 "<b>name</b>": String 1051 "<b>name</b>": String
1052 } 1052 }
1053 }</pre><br><pre>response: { 1053 }</pre><br><pre>response: {
1054 "<b>id</b>": String 1054 "<b>id</b>": String
1055 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1055 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1056 "result": { 1056 "result": {
1057 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 1057 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
1058 } 1058 }
1059 }</pre></div> 1059 }</pre></div>
1060 <p> 1060 <p>
1061 Perform a search for declarations of members whose name is 1061 Perform a search for declarations of members whose name is
1062 equal to the given name. 1062 equal to the given name.
1063 </p> 1063 </p>
1064 <p> 1064 <p>
1065 An identifier is returned immediately, and individual 1065 An identifier is returned immediately, and individual
(...skipping 14 matching lines...) Expand all
1080 search request. 1080 search request.
1081 </p> 1081 </p>
1082 </dd></dl></dd><dt class="request">search.findMemberReferences</dt><dd ><div class="box"><pre>request: { 1082 </dd></dl></dd><dt class="request">search.findMemberReferences</dt><dd ><div class="box"><pre>request: {
1083 "id": String 1083 "id": String
1084 "method": "search.findMemberReferences" 1084 "method": "search.findMemberReferences"
1085 "params": { 1085 "params": {
1086 "<b>name</b>": String 1086 "<b>name</b>": String
1087 } 1087 }
1088 }</pre><br><pre>response: { 1088 }</pre><br><pre>response: {
1089 "<b>id</b>": String 1089 "<b>id</b>": String
1090 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1090 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1091 "result": { 1091 "result": {
1092 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 1092 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
1093 } 1093 }
1094 }</pre></div> 1094 }</pre></div>
1095 <p> 1095 <p>
1096 Perform a search for references to members whose name is 1096 Perform a search for references to members whose name is
1097 equal to the given name. This search does not check to see 1097 equal to the given name. This search does not check to see
1098 that there is a member defined with the given name, so it is 1098 that there is a member defined with the given name, so it is
1099 able to find references to undefined members as well. 1099 able to find references to undefined members as well.
1100 </p> 1100 </p>
(...skipping 16 matching lines...) Expand all
1117 search request. 1117 search request.
1118 </p> 1118 </p>
1119 </dd></dl></dd><dt class="request">search.findTopLevelDeclarations</dt ><dd><div class="box"><pre>request: { 1119 </dd></dl></dd><dt class="request">search.findTopLevelDeclarations</dt ><dd><div class="box"><pre>request: {
1120 "id": String 1120 "id": String
1121 "method": "search.findTopLevelDeclarations" 1121 "method": "search.findTopLevelDeclarations"
1122 "params": { 1122 "params": {
1123 "<b>pattern</b>": String 1123 "<b>pattern</b>": String
1124 } 1124 }
1125 }</pre><br><pre>response: { 1125 }</pre><br><pre>response: {
1126 "<b>id</b>": String 1126 "<b>id</b>": String
1127 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1127 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1128 "result": { 1128 "result": {
1129 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 1129 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
1130 } 1130 }
1131 }</pre></div> 1131 }</pre></div>
1132 <p> 1132 <p>
1133 Perform a search for declarations of top-level elements 1133 Perform a search for declarations of top-level elements
1134 (classes, typedefs, getters, setters, functions and fields) 1134 (classes, typedefs, getters, setters, functions and fields)
1135 whose name matches the given pattern. 1135 whose name matches the given pattern.
1136 </p> 1136 </p>
1137 <p> 1137 <p>
(...skipping 17 matching lines...) Expand all
1155 </p> 1155 </p>
1156 </dd></dl></dd><dt class="request">search.getTypeHierarchy</dt><dd><di v class="box"><pre>request: { 1156 </dd></dl></dd><dt class="request">search.getTypeHierarchy</dt><dd><di v class="box"><pre>request: {
1157 "id": String 1157 "id": String
1158 "method": "search.getTypeHierarchy" 1158 "method": "search.getTypeHierarchy"
1159 "params": { 1159 "params": {
1160 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1160 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1161 "<b>offset</b>": int 1161 "<b>offset</b>": int
1162 } 1162 }
1163 }</pre><br><pre>response: { 1163 }</pre><br><pre>response: {
1164 "id": String 1164 "id": String
1165 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1165 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1166 "result": { 1166 "result": {
1167 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List&lt ;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>&gt; 1167 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List&lt ;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>&gt;
1168 } 1168 }
1169 }</pre></div> 1169 }</pre></div>
1170 <p> 1170 <p>
1171 Return the type hierarchy of the class declared or 1171 Return the type hierarchy of the class declared or
1172 referenced at the given location. 1172 referenced at the given location.
1173 </p> 1173 </p>
1174 1174
1175 1175
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
1245 <h3>Requests</h3><dl><dt class="request">edit.getAssists</dt><dd><div class= "box"><pre>request: { 1245 <h3>Requests</h3><dl><dt class="request">edit.getAssists</dt><dd><div class= "box"><pre>request: {
1246 "id": String 1246 "id": String
1247 "method": "edit.getAssists" 1247 "method": "edit.getAssists"
1248 "params": { 1248 "params": {
1249 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1249 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1250 "<b>offset</b>": int 1250 "<b>offset</b>": int
1251 "<b>length</b>": int 1251 "<b>length</b>": int
1252 } 1252 }
1253 }</pre><br><pre>response: { 1253 }</pre><br><pre>response: {
1254 "id": String 1254 "id": String
1255 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1255 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1256 "result": { 1256 "result": {
1257 "<b>assists</b>": List&lt;<a href="#type_SourceChange">SourceChange</a>&gt; 1257 "<b>assists</b>": List&lt;<a href="#type_SourceChange">SourceChange</a>&gt;
1258 } 1258 }
1259 }</pre></div> 1259 }</pre></div>
1260 <p> 1260 <p>
1261 Return the set of assists that are available at the given 1261 Return the set of assists that are available at the given
1262 location. An assist is distinguished from a refactoring 1262 location. An assist is distinguished from a refactoring
1263 primarily by the fact that it affects a single file and does 1263 primarily by the fact that it affects a single file and does
1264 not require user input in order to be performed. 1264 not require user input in order to be performed.
1265 </p> 1265 </p>
(...skipping 25 matching lines...) Expand all
1291 </dd></dl></dd><dt class="request">edit.getAvailableRefactorings</dt>< dd><div class="box"><pre>request: { 1291 </dd></dl></dd><dt class="request">edit.getAvailableRefactorings</dt>< dd><div class="box"><pre>request: {
1292 "id": String 1292 "id": String
1293 "method": "edit.getAvailableRefactorings" 1293 "method": "edit.getAvailableRefactorings"
1294 "params": { 1294 "params": {
1295 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1295 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1296 "<b>offset</b>": int 1296 "<b>offset</b>": int
1297 "<b>length</b>": int 1297 "<b>length</b>": int
1298 } 1298 }
1299 }</pre><br><pre>response: { 1299 }</pre><br><pre>response: {
1300 "id": String 1300 "id": String
1301 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1301 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1302 "result": { 1302 "result": {
1303 "<b>kinds</b>": List&lt;<a href="#type_RefactoringKind">RefactoringKind</a>& gt; 1303 "<b>kinds</b>": List&lt;<a href="#type_RefactoringKind">RefactoringKind</a>& gt;
1304 } 1304 }
1305 }</pre></div> 1305 }</pre></div>
1306 <p> 1306 <p>
1307 Get a list of the kinds of refactorings that are valid for 1307 Get a list of the kinds of refactorings that are valid for
1308 the given selection in the given file. 1308 the given selection in the given file.
1309 </p> 1309 </p>
1310 1310
1311 1311
(...skipping 23 matching lines...) Expand all
1335 </p> 1335 </p>
1336 </dd></dl></dd><dt class="request">edit.getFixes</dt><dd><div class="b ox"><pre>request: { 1336 </dd></dl></dd><dt class="request">edit.getFixes</dt><dd><div class="b ox"><pre>request: {
1337 "id": String 1337 "id": String
1338 "method": "edit.getFixes" 1338 "method": "edit.getFixes"
1339 "params": { 1339 "params": {
1340 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1340 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1341 "<b>offset</b>": int 1341 "<b>offset</b>": int
1342 } 1342 }
1343 }</pre><br><pre>response: { 1343 }</pre><br><pre>response: {
1344 "id": String 1344 "id": String
1345 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1345 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1346 "result": { 1346 "result": {
1347 "<b>fixes</b>": List&lt;<a href="#type_ErrorFixes">ErrorFixes</a>&gt; 1347 "<b>fixes</b>": List&lt;<a href="#type_ErrorFixes">ErrorFixes</a>&gt;
1348 } 1348 }
1349 }</pre></div> 1349 }</pre></div>
1350 <p> 1350 <p>
1351 Return the set of fixes that are available for the errors at 1351 Return the set of fixes that are available for the errors at
1352 a given offset in a given file. 1352 a given offset in a given file.
1353 </p> 1353 </p>
1354 1354
1355 1355
(...skipping 27 matching lines...) Expand all
1383 "params": { 1383 "params": {
1384 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> 1384 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>
1385 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1385 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1386 "<b>offset</b>": int 1386 "<b>offset</b>": int
1387 "<b>length</b>": int 1387 "<b>length</b>": int
1388 "<b>validateOnly</b>": bool 1388 "<b>validateOnly</b>": bool
1389 "<b>options</b>": <span style="color:#999999">optional</span> object 1389 "<b>options</b>": <span style="color:#999999">optional</span> object
1390 } 1390 }
1391 }</pre><br><pre>response: { 1391 }</pre><br><pre>response: {
1392 "id": String 1392 "id": String
1393 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1393 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1394 "result": { 1394 "result": {
1395 "<b>problems</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringPro blem</a>&gt; 1395 "<b>problems</b>": List&lt;<a href="#type_RefactoringProblem">RefactoringPro blem</a>&gt;
1396 "<b>feedback</b>": <span style="color:#999999">optional</span> object 1396 "<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> 1397 "<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&lt ;String&gt; 1398 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String&gt;
1399 } 1399 }
1400 }</pre></div> 1400 }</pre></div>
1401 <p> 1401 <p>
1402 Get the changes required to perform a refactoring. 1402 Get the changes required to perform a refactoring.
1403 </p> 1403 </p>
(...skipping 85 matching lines...) Expand 10 before | Expand all | Expand 10 after
1489 1489
1490 1490
1491 <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div cl ass="box"><pre>request: { 1491 <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div cl ass="box"><pre>request: {
1492 "id": String 1492 "id": String
1493 "method": "debug.createContext" 1493 "method": "debug.createContext"
1494 "params": { 1494 "params": {
1495 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a> 1495 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a>
1496 } 1496 }
1497 }</pre><br><pre>response: { 1497 }</pre><br><pre>response: {
1498 "<b>id</b>": String 1498 "<b>id</b>": String
1499 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1499 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1500 "result": { 1500 "result": {
1501 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1501 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>
1502 } 1502 }
1503 }</pre></div> 1503 }</pre></div>
1504 <p> 1504 <p>
1505 Create a debugging context for the executable file with the 1505 Create a debugging context for the executable file with the
1506 given path. The context that is created will persist until 1506 given path. The context that is created will persist until
1507 debug.deleteContext is used to delete it. Clients, 1507 debug.deleteContext is used to delete it. Clients,
1508 therefore, are responsible for managing the lifetime of 1508 therefore, are responsible for managing the lifetime of
1509 debugging contexts. 1509 debugging contexts.
(...skipping 12 matching lines...) Expand all
1522 that was created. 1522 that was created.
1523 </p> 1523 </p>
1524 </dd></dl></dd><dt class="request">debug.deleteContext</dt><dd><div cl ass="box"><pre>request: { 1524 </dd></dl></dd><dt class="request">debug.deleteContext</dt><dd><div cl ass="box"><pre>request: {
1525 "<b>id</b>": String 1525 "<b>id</b>": String
1526 "method": "debug.deleteContext" 1526 "method": "debug.deleteContext"
1527 "params": { 1527 "params": {
1528 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1528 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>
1529 } 1529 }
1530 }</pre><br><pre>response: { 1530 }</pre><br><pre>response: {
1531 "id": String 1531 "id": String
1532 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1532 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1533 }</pre></div> 1533 }</pre></div>
1534 <p> 1534 <p>
1535 Delete the debugging context with the given identifier. The 1535 Delete the debugging context with the given identifier. The
1536 context id is no longer valid after this command. The server 1536 context id is no longer valid after this command. The server
1537 is allowed to re-use ids when they are no longer valid. 1537 is allowed to re-use ids when they are no longer valid.
1538 </p> 1538 </p>
1539 1539
1540 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugCo ntextId">DebugContextId</a> )</i></b></dt><dd> 1540 <h4>Parameters</h4><dl><dt class="field"><b><i>id ( <a href="#type_DebugCo ntextId">DebugContextId</a> )</i></b></dt><dd>
1541 1541
1542 <p> 1542 <p>
1543 The identifier of the debugging context that is to be 1543 The identifier of the debugging context that is to be
1544 deleted. 1544 deleted.
1545 </p> 1545 </p>
1546 </dd></dl></dd><dt class="request">debug.mapUri</dt><dd><div class="bo x"><pre>request: { 1546 </dd></dl></dd><dt class="request">debug.mapUri</dt><dd><div class="bo x"><pre>request: {
1547 "<b>id</b>": String 1547 "<b>id</b>": String
1548 "method": "debug.mapUri" 1548 "method": "debug.mapUri"
1549 "params": { 1549 "params": {
1550 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a> 1550 "<b>id</b>": <a href="#type_DebugContextId">DebugContextId</a>
1551 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a> 1551 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>
1552 "<b>uri</b>": <span style="color:#999999">optional</span> String 1552 "<b>uri</b>": <span style="color:#999999">optional</span> String
1553 } 1553 }
1554 }</pre><br><pre>response: { 1554 }</pre><br><pre>response: {
1555 "id": String 1555 "id": String
1556 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1556 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1557 "result": { 1557 "result": {
1558 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a> 1558 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi lePath">FilePath</a>
1559 "<b>uri</b>": <span style="color:#999999">optional</span> String 1559 "<b>uri</b>": <span style="color:#999999">optional</span> String
1560 } 1560 }
1561 }</pre></div> 1561 }</pre></div>
1562 <p> 1562 <p>
1563 Map a URI from the debugging context to the file that it 1563 Map a URI from the debugging context to the file that it
1564 corresponds to, or map a file to the URI that it corresponds 1564 corresponds to, or map a file to the URI that it corresponds
1565 to in the debugging context. 1565 to in the debugging context.
1566 </p> 1566 </p>
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
1598 omitted if the file field was not given in the request. 1598 omitted if the file field was not given in the request.
1599 </p> 1599 </p>
1600 </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div class="box"><pre>request: { 1600 </dd></dl></dd><dt class="request">debug.setSubscriptions</dt><dd><div class="box"><pre>request: {
1601 "id": String 1601 "id": String
1602 "method": "debug.setSubscriptions" 1602 "method": "debug.setSubscriptions"
1603 "params": { 1603 "params": {
1604 "<b>subscriptions</b>": List&lt;<a href="#type_DebugService">DebugService</a >&gt; 1604 "<b>subscriptions</b>": List&lt;<a href="#type_DebugService">DebugService</a >&gt;
1605 } 1605 }
1606 }</pre><br><pre>response: { 1606 }</pre><br><pre>response: {
1607 "id": String 1607 "id": String
1608 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1608 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
1609 }</pre></div> 1609 }</pre></div>
1610 <p> 1610 <p>
1611 Subscribe for services. All previous subscriptions are 1611 Subscribe for services. All previous subscriptions are
1612 replaced by the given set of services. 1612 replaced by the given set of services.
1613 </p> 1613 </p>
1614 <p> 1614 <p>
1615 It is an error if any of the elements in the list are not 1615 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 1616 valid services. If there is an error, then the current
1617 subscriptions will remain unchanged. 1617 subscriptions will remain unchanged.
1618 </p> 1618 </p>
(...skipping 428 matching lines...) Expand 10 before | Expand all | Expand 10 after
2047 The return type of the element. If the element is not a 2047 The return type of the element. If the element is not a
2048 method or function this field will not be defined. If the 2048 method or function this field will not be defined. If the
2049 element does not have a declared return type, this field 2049 element does not have a declared return type, this field
2050 will contain an empty string. 2050 will contain an empty string.
2051 </p> 2051 </p>
2052 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd> 2052 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E lementKind: String</a></dt><dd>
2053 <p> 2053 <p>
2054 An enumeration of the kinds of elements. 2054 An enumeration of the kinds of elements.
2055 </p> 2055 </p>
2056 2056
2057 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class= "value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE _ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class= "value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAME TER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><d t class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt cla ss="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class= "typeDefinition"><a name="type_Error">Error: object</a></dt><dd> 2057 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class= "value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE _ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LIBRARY</dt><dt class= "value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">PARAME TER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><d t class="value">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dt cla ss="value">UNIT_TEST_TEST</dt><dt class="value">UNKNOWN</dt></dl></dd><dt class= "typeDefinition"><a name="type_ErrorFixes">ErrorFixes: object</a></dt><dd>
2058 <p>
2059 An indication of a problem with the execution of the server,
2060 typically in response to a request.
2061 </p>
2062
2063 <dl><dt class="field"><b><i>code ( <a href="#type_RequestErrorCode">Reques tErrorCode</a> )</i></b></dt><dd>
2064
2065 <p>
2066 A code that uniquely identifies the error that occurred.
2067 </p>
2068 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
2069
2070 <p>
2071 A short description of the error.
2072 </p>
2073 </dd><dt class="field"><b><i>data ( <span style="color:#999999">option al</span> object )</i></b></dt><dd>
2074
2075 <p>
2076 Additional data related to the error. This field is
2077 omitted if there is no additional data available.
2078 </p>
2079 </dd></dl></dd><dt class="typeDefinition"><a name="type_ErrorFixes">Er rorFixes: object</a></dt><dd>
2080 <p> 2058 <p>
2081 A list of fixes associated with a specific error 2059 A list of fixes associated with a specific error
2082 </p> 2060 </p>
2083 2061
2084 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis Error</a> )</i></b></dt><dd> 2062 <dl><dt class="field"><b><i>error ( <a href="#type_AnalysisError">Analysis Error</a> )</i></b></dt><dd>
2085 2063
2086 <p> 2064 <p>
2087 The error with which the fixes are associated. 2065 The error with which the fixes are associated.
2088 </p> 2066 </p>
2089 </dd><dt class="field"><b><i>fixes ( List&lt;<a href="#type_SourceChan ge">SourceChange</a>&gt; )</i></b></dt><dd> 2067 </dd><dt class="field"><b><i>fixes ( List&lt;<a href="#type_SourceChan ge">SourceChange</a>&gt; )</i></b></dt><dd>
(...skipping 467 matching lines...) Expand 10 before | Expand all | Expand 10 after
2557 <p> 2535 <p>
2558 A directive to remove an existing file content overlay. 2536 A directive to remove an existing file content overlay.
2559 After processing this directive, the file contents will once 2537 After processing this directive, the file contents will once
2560 again be read from the file system. 2538 again be read from the file system.
2561 </p> 2539 </p>
2562 <p> 2540 <p>
2563 If this directive is used on a file that doesn't currently 2541 If this directive is used on a file that doesn't currently
2564 have a content overlay, it has no effect. 2542 have a content overlay, it has no effect.
2565 </p> 2543 </p>
2566 2544
2567 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_RequestErrorCode">RequestErrorCode: St ring</a></dt><dd> 2545 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_RequestError">RequestError: object</a> </dt><dd>
2546 <p>
2547 An indication of a problem with the execution of the server,
2548 typically in response to a request.
2549 </p>
2550
2551 <dl><dt class="field"><b><i>code ( <a href="#type_RequestErrorCode">Reques tErrorCode</a> )</i></b></dt><dd>
2552
2553 <p>
2554 A code that uniquely identifies the error that occurred.
2555 </p>
2556 </dd><dt class="field"><b><i>message ( String )</i></b></dt><dd>
2557
2558 <p>
2559 A short description of the error.
2560 </p>
2561 </dd><dt class="field"><b><i>data ( <span style="color:#999999">option al</span> object )</i></b></dt><dd>
2562
2563 <p>
2564 Additional data related to the error. This field is
2565 omitted if there is no additional data available.
2566 </p>
2567 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>
2568 <p> 2568 <p>
2569 An enumeration of the types of errors that can occur in the 2569 An enumeration of the types of errors that can occur in the
2570 execution of the server. 2570 execution of the server.
2571 </p> 2571 </p>
2572 2572
2573 <dl><dt class="value">GET_ERRORS_ERROR</dt><dd> 2573 <dl><dt class="value">GET_ERRORS_ERROR</dt><dd>
2574 2574
2575 <p> 2575 <p>
2576 An error occurred during the processing of an 2576 An error occurred during the processing of an
2577 "analysis.getErrors" request. 2577 "analysis.getErrors" request.
(...skipping 514 matching lines...) Expand 10 before | Expand all | Expand 10 after
3092 <p> 3092 <p>
3093 This section contains a list of all of the errors that are 3093 This section contains a list of all of the errors that are
3094 produced by the server and the data that is returned with each. 3094 produced by the server and the data that is returned with each.
3095 </p> 3095 </p>
3096 <p> 3096 <p>
3097 TBD 3097 TBD
3098 </p> 3098 </p>
3099 3099
3100 3100
3101 </body></html> 3101 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestError.java ('k') | pkg/analysis_server/lib/src/constants.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698