| OLD | NEW |
| 1 <!doctype html> | 1 <!doctype html> |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version <version>1.18.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.18.1</version></h1> |
| 10 <p> | 10 <p> |
| 11 This document contains a specification of the API provided by the | 11 This document contains a specification of the API provided by the |
| 12 analysis server. The API in this document is currently under | 12 analysis server. The API in this document is currently under |
| 13 development. Changes to the API will be accompanied by an update to the | 13 development. Changes to the API will be accompanied by an update to the |
| 14 protocol version number according to the principles of semantic | 14 protocol version number according to the principles of semantic |
| 15 versioning (<a href="http://semver.org/">semver.org</a>). | 15 versioning (<a href="http://semver.org/">semver.org</a>). |
| 16 </p> | 16 </p> |
| 17 <h2>Overview</h2> | 17 <h2>Overview</h2> |
| 18 <p> | 18 <p> |
| 19 The analysis server API is a bi-directional client-server | 19 The analysis server API is a bi-directional client-server |
| (...skipping 1774 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1794 not known to be valid if there was insufficient type information | 1794 not known to be valid if there was insufficient type information |
| 1795 for the server to be able to determine whether or not the code | 1795 for the server to be able to determine whether or not the code |
| 1796 needs to be modified, such as when a member is being renamed and | 1796 needs to be modified, such as when a member is being renamed and |
| 1797 there is a reference to a member from an unknown type. This field | 1797 there is a reference to a member from an unknown type. This field |
| 1798 will be omitted if the change field is omitted or if there are no | 1798 will be omitted if the change field is omitted or if there are no |
| 1799 potential edits for the refactoring. | 1799 potential edits for the refactoring. |
| 1800 </p> | 1800 </p> |
| 1801 </field> | 1801 </field> |
| 1802 </result> | 1802 </result> |
| 1803 </request> | 1803 </request> |
| 1804 <request method="getStatementCompletion" experimental="true"> |
| 1805 <p> |
| 1806 Get the changes required to convert the partial statement at the given |
| 1807 location into a syntactically valid statement. If the current statemen
t |
| 1808 is already valid the change will insert a newline plus appropriate |
| 1809 indentation at the end of the line containing the offset. |
| 1810 If a change that makes the statement valid cannot be determined (perha
ps |
| 1811 because it has not yet been implemented) the statement will be conside
red |
| 1812 already valid and the appropriate change returned. |
| 1813 </p> |
| 1814 <params> |
| 1815 <field name="file"> |
| 1816 <ref>FilePath</ref> |
| 1817 <p> |
| 1818 The file containing the statement to be completed. |
| 1819 </p> |
| 1820 </field> |
| 1821 <field name="offset"> |
| 1822 <ref>int</ref> |
| 1823 <p> |
| 1824 The offset used to identify the statement to be completed. |
| 1825 </p> |
| 1826 </field> |
| 1827 </params> |
| 1828 <result> |
| 1829 <field name="change"> |
| 1830 <ref>SourceChange</ref> |
| 1831 <p> |
| 1832 The change to be applied in order to complete the statement. |
| 1833 </p> |
| 1834 </field> |
| 1835 <field name="whitespaceOnly"> |
| 1836 <ref>bool</ref> |
| 1837 <p> |
| 1838 Will be true if the change contains nothing but whitespace |
| 1839 characters, or is empty. |
| 1840 </p> |
| 1841 </field> |
| 1842 </result> |
| 1843 </request> |
| 1804 <request method="sortMembers"> | 1844 <request method="sortMembers"> |
| 1805 <p> | 1845 <p> |
| 1806 Sort all of the directives, unit and class members | 1846 Sort all of the directives, unit and class members |
| 1807 of the given Dart file. | 1847 of the given Dart file. |
| 1808 </p> | 1848 </p> |
| 1809 <p> | 1849 <p> |
| 1810 If a request is made for a file that does not exist, does not belong | 1850 If a request is made for a file that does not exist, does not belong |
| 1811 to an analysis root or is not a Dart file, | 1851 to an analysis root or is not a Dart file, |
| 1812 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated. | 1852 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated. |
| 1813 </p> | 1853 </p> |
| (...skipping 2793 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 4607 This section contains a list of all of the errors that are | 4647 This section contains a list of all of the errors that are |
| 4608 produced by the server and the data that is returned with each. | 4648 produced by the server and the data that is returned with each. |
| 4609 </p> | 4649 </p> |
| 4610 <p> | 4650 <p> |
| 4611 TODO: TBD | 4651 TODO: TBD |
| 4612 </p> | 4652 </p> |
| 4613 <h2 class="domain"><a name="index">Index</a></h2> | 4653 <h2 class="domain"><a name="index">Index</a></h2> |
| 4614 <index></index> | 4654 <index></index> |
| 4615 </body> | 4655 </body> |
| 4616 </html> | 4656 </html> |
| OLD | NEW |