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 | 9 <h1 style="color:#999999">Version |
10 <version>1.18.2</version> | 10 <version>1.18.2</version> |
(...skipping 457 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
468 <field name="elements"> | 468 <field name="elements"> |
469 <list> | 469 <list> |
470 <ref>ImportedElements</ref> | 470 <ref>ImportedElements</ref> |
471 </list> | 471 </list> |
472 <p> | 472 <p> |
473 The information about the elements that are referenced in the | 473 The information about the elements that are referenced in the |
474 specified region of the specified file that come from imported | 474 specified region of the specified file that come from imported |
475 libraries. | 475 libraries. |
476 </p> | 476 </p> |
477 </field> | 477 </field> |
478 <field name="complete"> | |
479 <ref>bool</ref> | |
480 <p> | |
481 True if all of the elements that are referenced in the specified | |
482 region are included in the list of elements. The list of elements will | |
483 be incomplete if there is an error in the specified region that | |
484 prevents an identifier from being resolved to a single element. | |
485 </p> | |
486 </field> | |
487 </result> | 478 </result> |
488 </request> | 479 </request> |
489 <request method="getLibraryDependencies"> | 480 <request method="getLibraryDependencies"> |
490 <p> | 481 <p> |
491 Return library dependency information for use in client-side indexing | 482 Return library dependency information for use in client-side indexing |
492 and package URI resolution. | 483 and package URI resolution. |
493 </p> | 484 </p> |
494 <p> | 485 <p> |
495 Clients that are only using the libraries field should consider using the | 486 Clients that are only using the libraries field should consider using the |
496 analyzedFiles notification instead. | 487 analyzedFiles notification instead. |
(...skipping 1579 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2076 </p> | 2067 </p> |
2077 </field> | 2068 </field> |
2078 </result> | 2069 </result> |
2079 </request> | 2070 </request> |
2080 <request method="importElements" experimental="true"> | 2071 <request method="importElements" experimental="true"> |
2081 <p> | 2072 <p> |
2082 Return a list of edits that would need to be applied in order to ensure | 2073 Return a list of edits that would need to be applied in order to ensure |
2083 that all of the elements in the specified list of imported elements are | 2074 that all of the elements in the specified list of imported elements are |
2084 accessible within the library. | 2075 accessible within the library. |
2085 </p> | 2076 </p> |
| 2077 <p> |
| 2078 If a request is made for a file that does not exist, or that is not |
| 2079 currently subject to analysis (e.g. because it is not associated with any |
| 2080 analysis root specified via analysis.setAnalysisRoots), an error of type |
| 2081 <tt>IMPORT_ELEMENTS_INVALID_FILE</tt> will be generated. |
| 2082 </p> |
2086 <params> | 2083 <params> |
2087 <field name="file"> | 2084 <field name="file"> |
2088 <ref>FilePath</ref> | 2085 <ref>FilePath</ref> |
2089 <p> | 2086 <p> |
2090 The file in which the specified elements are to be made accessible. | 2087 The file in which the specified elements are to be made accessible. |
2091 </p> | 2088 </p> |
2092 </field> | 2089 </field> |
2093 <field name="elements"> | 2090 <field name="elements"> |
2094 <list> | 2091 <list> |
2095 <ref>ImportedElements</ref> | 2092 <ref>ImportedElements</ref> |
2096 </list> | 2093 </list> |
2097 <p> | 2094 <p> |
2098 The elements to be made accessible in the specified file. | 2095 The elements to be made accessible in the specified file. |
2099 </p> | 2096 </p> |
2100 </field> | 2097 </field> |
2101 </params> | 2098 </params> |
2102 <result> | 2099 <result> |
2103 <field name="edits"> | 2100 <field name="edits"> |
2104 <list> | 2101 <list> |
2105 <ref>SourceEdit</ref> | 2102 <ref>SourceEdit</ref> |
2106 </list> | 2103 </list> |
2107 <p> | 2104 <p> |
2108 The edit(s) to be applied in order to make the specified elements | 2105 The edit(s) to be applied in order to make the specified elements |
2109 accessible. | 2106 accessible. |
2110 </p> | 2107 </p> |
2111 </field> | 2108 </field> |
2112 <field name="complete"> | |
2113 <ref>bool</ref> | |
2114 <p> | |
2115 True if all of the elements that are to be made accessible would be | |
2116 accessible if the edits were applied. The edits will not be complete, | |
2117 for example, if one of the libraries cannot be referenced in the | |
2118 target library or if one of the element names is already imported from | |
2119 a different library. | |
2120 </p> | |
2121 </field> | |
2122 </result> | 2109 </result> |
2123 </request> | 2110 </request> |
2124 <request method="sortMembers"> | 2111 <request method="sortMembers"> |
2125 <p> | 2112 <p> |
2126 Sort all of the directives, unit and class members | 2113 Sort all of the directives, unit and class members |
2127 of the given Dart file. | 2114 of the given Dart file. |
2128 </p> | 2115 </p> |
2129 <p> | 2116 <p> |
2130 If a request is made for a file that does not exist, does not belong | 2117 If a request is made for a file that does not exist, does not belong |
2131 to an analysis root or is not a Dart file, | 2118 to an analysis root or is not a Dart file, |
(...skipping 1010 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3142 </value> | 3129 </value> |
3143 <value> | 3130 <value> |
3144 <code>GET_REACHABLE_SOURCES_INVALID_FILE</code> | 3131 <code>GET_REACHABLE_SOURCES_INVALID_FILE</code> |
3145 <p> | 3132 <p> |
3146 An "analysis.getReachableSources" request specified a FilePath | 3133 An "analysis.getReachableSources" request specified a FilePath |
3147 which does not match a file currently subject to | 3134 which does not match a file currently subject to |
3148 analysis. | 3135 analysis. |
3149 </p> | 3136 </p> |
3150 </value> | 3137 </value> |
3151 <value> | 3138 <value> |
| 3139 <code>IMPORT_ELEMENTS_INVALID_FILE</code> |
| 3140 <p> |
| 3141 An "edit.importElements" request specified a FilePath that does not |
| 3142 match a file currently subject to analysis. |
| 3143 </p> |
| 3144 </value> |
| 3145 <value> |
3152 <code>INVALID_ANALYSIS_ROOT</code> | 3146 <code>INVALID_ANALYSIS_ROOT</code> |
3153 <p> | 3147 <p> |
3154 A path passed as an argument to a request (such as | 3148 A path passed as an argument to a request (such as |
3155 analysis.reanalyze) is required to be an analysis root, but isn't. | 3149 analysis.reanalyze) is required to be an analysis root, but isn't. |
3156 </p> | 3150 </p> |
3157 </value> | 3151 </value> |
3158 <value> | 3152 <value> |
3159 <code>INVALID_EXECUTION_CONTEXT</code> | 3153 <code>INVALID_EXECUTION_CONTEXT</code> |
3160 <p> | 3154 <p> |
3161 The context root used to create an execution context does not | 3155 The context root used to create an execution context does not |
(...skipping 691 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3853 This section contains a list of all of the errors that are | 3847 This section contains a list of all of the errors that are |
3854 produced by the server and the data that is returned with each. | 3848 produced by the server and the data that is returned with each. |
3855 </p> | 3849 </p> |
3856 <p> | 3850 <p> |
3857 TODO: TBD | 3851 TODO: TBD |
3858 </p> | 3852 </p> |
3859 <h2 class="domain"><a name="index">Index</a></h2> | 3853 <h2 class="domain"><a name="index">Index</a></h2> |
3860 <index></index> | 3854 <index></index> |
3861 </body> | 3855 </body> |
3862 </html> | 3856 </html> |
OLD | NEW |