OLD | NEW |
1 <html> | 1 <html> |
2 <head> | 2 <head> |
3 <meta charset="UTF-8"/> | 3 <meta charset="UTF-8"/> |
4 <title>Analysis Server API Specification</title> | 4 <title>Analysis Server API Specification</title> |
5 </head> | 5 </head> |
6 <body> | 6 <body> |
7 <h1>Analysis Server API Specification</h1> | 7 <h1>Analysis Server API Specification</h1> |
8 <h1 style="color:#999999">Version <version>1.9.0</version></h1> | 8 <h1 style="color:#999999">Version <version>1.9.0</version></h1> |
9 <p> | 9 <p> |
10 This document contains a specification of the API provided by the | 10 This document contains a specification of the API provided by the |
(...skipping 1679 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1690 <result> | 1690 <result> |
1691 <field name="edit"> | 1691 <field name="edit"> |
1692 <ref>SourceFileEdit</ref> | 1692 <ref>SourceFileEdit</ref> |
1693 <p> | 1693 <p> |
1694 The file edit that is to be applied to the given file to effect | 1694 The file edit that is to be applied to the given file to effect |
1695 the sorting. | 1695 the sorting. |
1696 </p> | 1696 </p> |
1697 </field> | 1697 </field> |
1698 </result> | 1698 </result> |
1699 </request> | 1699 </request> |
| 1700 <request method="organizeDirectives"> |
| 1701 <p> |
| 1702 Organizes all of the directives - removes unused imports and sorts |
| 1703 directives of the given Dart file according to the |
| 1704 <a href="https://www.dartlang.org/articles/style-guide/">Dart Style Gu
ide</a>. |
| 1705 </p> |
| 1706 <p> |
| 1707 If a request is made for a file that does not exist, does not belong |
| 1708 to an analysis root or is not a Dart file, |
| 1709 <tt>FILE_NOT_ANALYZED</tt> will be generated. |
| 1710 </p> |
| 1711 <p> |
| 1712 If directives of the Dart file cannot be organized, for example |
| 1713 because it has scan or parse errors, or by other reasons, |
| 1714 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message |
| 1715 will provide datails about the reason. |
| 1716 </p> |
| 1717 <params> |
| 1718 <field name="file"> |
| 1719 <ref>FilePath</ref> |
| 1720 <p> |
| 1721 The Dart file to organize directives in. |
| 1722 </p> |
| 1723 </field> |
| 1724 </params> |
| 1725 <result> |
| 1726 <field name="edit"> |
| 1727 <ref>SourceFileEdit</ref> |
| 1728 <p> |
| 1729 The file edit that is to be applied to the given file to effect |
| 1730 the organizing. |
| 1731 </p> |
| 1732 </field> |
| 1733 </result> |
| 1734 </request> |
1700 </domain> | 1735 </domain> |
1701 <domain name="execution"> | 1736 <domain name="execution"> |
1702 <p> | 1737 <p> |
1703 The execution domain contains commands related to providing an execution | 1738 The execution domain contains commands related to providing an execution |
1704 or debugging experience. | 1739 or debugging experience. |
1705 </p> | 1740 </p> |
1706 <request method="createContext"> | 1741 <request method="createContext"> |
1707 <p> | 1742 <p> |
1708 Create an execution context for the executable file with the given | 1743 Create an execution context for the executable file with the given |
1709 path. The context that is created will persist until | 1744 path. The context that is created will persist until |
(...skipping 1667 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3377 <enum> | 3412 <enum> |
3378 <value> | 3413 <value> |
3379 <code>CONTENT_MODIFIED</code> | 3414 <code>CONTENT_MODIFIED</code> |
3380 <p> | 3415 <p> |
3381 An "analysis.getErrors" or "analysis.getNavigation" request could | 3416 An "analysis.getErrors" or "analysis.getNavigation" request could |
3382 not be satisfied because the content of the file changed before | 3417 not be satisfied because the content of the file changed before |
3383 the requested results could be computed. | 3418 the requested results could be computed. |
3384 </p> | 3419 </p> |
3385 </value> | 3420 </value> |
3386 <value> | 3421 <value> |
| 3422 <code>FILE_NOT_ANALYZED</code> |
| 3423 <p> |
| 3424 A request specified a FilePath which does not match a file in |
| 3425 an analysis root, or the requested operation is not available |
| 3426 for the file. |
| 3427 </p> |
| 3428 </value> |
| 3429 <value> |
3387 <code>FORMAT_INVALID_FILE</code> | 3430 <code>FORMAT_INVALID_FILE</code> |
3388 <p> | 3431 <p> |
3389 An "edit.format" request specified a FilePath | 3432 An "edit.format" request specified a FilePath |
3390 which does not match a Dart file in an analysis root. | 3433 which does not match a Dart file in an analysis root. |
3391 </p> | 3434 </p> |
3392 </value> | 3435 </value> |
3393 <value> | 3436 <value> |
3394 <code>FORMAT_WITH_ERRORS</code> | 3437 <code>FORMAT_WITH_ERRORS</code> |
3395 <p> | 3438 <p> |
3396 An "edit.format" request specified a file that contains syntax | 3439 An "edit.format" request specified a file that contains syntax |
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3449 </p> | 3492 </p> |
3450 </value> | 3493 </value> |
3451 <value> | 3494 <value> |
3452 <code>NO_INDEX_GENERATED</code> | 3495 <code>NO_INDEX_GENERATED</code> |
3453 <p> | 3496 <p> |
3454 The "--no-index" flag was passed when the analysis server created, | 3497 The "--no-index" flag was passed when the analysis server created, |
3455 but this API call requires an index to have been generated. | 3498 but this API call requires an index to have been generated. |
3456 </p> | 3499 </p> |
3457 </value> | 3500 </value> |
3458 <value> | 3501 <value> |
| 3502 <code>ORGANIZE_DIRECTIVES_ERROR</code> |
| 3503 <p> |
| 3504 An "edit.organizeDirectives" request specified a Dart file that |
| 3505 cannot be analyzed. The reason is described in the message. |
| 3506 </p> |
| 3507 </value> |
| 3508 <value> |
3459 <code>REFACTORING_REQUEST_CANCELLED</code> | 3509 <code>REFACTORING_REQUEST_CANCELLED</code> |
3460 <p> | 3510 <p> |
3461 Another refactoring request was received during processing of | 3511 Another refactoring request was received during processing of |
3462 this one. | 3512 this one. |
3463 </p> | 3513 </p> |
3464 </value> | 3514 </value> |
3465 <value> | 3515 <value> |
3466 <code>SERVER_ALREADY_STARTED</code> | 3516 <code>SERVER_ALREADY_STARTED</code> |
3467 <p> | 3517 <p> |
3468 The analysis server has already been started (and hence | 3518 The analysis server has already been started (and hence |
(...skipping 702 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4171 <h2>Errors</h2> | 4221 <h2>Errors</h2> |
4172 <p> | 4222 <p> |
4173 This section contains a list of all of the errors that are | 4223 This section contains a list of all of the errors that are |
4174 produced by the server and the data that is returned with each. | 4224 produced by the server and the data that is returned with each. |
4175 </p> | 4225 </p> |
4176 <p> | 4226 <p> |
4177 TBD | 4227 TBD |
4178 </p> | 4228 </p> |
4179 </body> | 4229 </body> |
4180 </html> | 4230 </html> |
OLD | NEW |