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 Plugin API Specification</title> | 5 <title>Analysis Server Plugin API Specification</title> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <h1>Analysis Server Plugin API Specification</h1> | 8 <h1>Analysis Server Plugin API Specification</h1> |
9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
10 <version>1.0.0-alpha.0</version> | 10 <version>1.0.0-alpha.0</version> |
(...skipping 131 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
142 debugging the plugin. | 142 debugging the plugin. |
143 </p> | 143 </p> |
144 </field> | 144 </field> |
145 </params> | 145 </params> |
146 </notification> | 146 </notification> |
147 </domain> | 147 </domain> |
148 <domain name="analysis"> | 148 <domain name="analysis"> |
149 <p> | 149 <p> |
150 The analysis domain contains API’s related to the analysis of files. | 150 The analysis domain contains API’s related to the analysis of files. |
151 </p> | 151 </p> |
| 152 <request method="getNavigation"> |
| 153 <p> |
| 154 Return the navigation information associated with the given region of |
| 155 the given file. If the navigation information for the given file has |
| 156 not yet been computed, or the most recently computed navigation |
| 157 information for the given file is out of date, then the response for |
| 158 this request will be delayed until it has been computed. If the |
| 159 content of the file changes after this request was received but before |
| 160 a response could be sent, then an error of type |
| 161 <tt>CONTENT_MODIFIED</tt> will be generated. |
| 162 </p> |
| 163 <p> |
| 164 If a navigation region overlaps (but extends either before or after) |
| 165 the given region of the file it will be included in the result. This |
| 166 means that it is theoretically possible to get the same navigation |
| 167 region in response to multiple requests. Clients can avoid this by |
| 168 always choosing a region that starts at the beginning of a line and |
| 169 ends at the end of a (possibly different) line in the file. |
| 170 </p> |
| 171 <params> |
| 172 <field name="file"> |
| 173 <ref>FilePath</ref> |
| 174 <p> |
| 175 The file in which navigation information is being requested. |
| 176 </p> |
| 177 </field> |
| 178 <field name="offset"> |
| 179 <ref>int</ref> |
| 180 <p> |
| 181 The offset of the region for which navigation information is being |
| 182 requested. |
| 183 </p> |
| 184 </field> |
| 185 <field name="length"> |
| 186 <ref>int</ref> |
| 187 <p> |
| 188 The length of the region for which navigation information is being |
| 189 requested. |
| 190 </p> |
| 191 </field> |
| 192 </params> |
| 193 <result> |
| 194 <field name="files"> |
| 195 <list> |
| 196 <ref>FilePath</ref> |
| 197 </list> |
| 198 <p> |
| 199 A list of the paths of files that are referenced by the navigation |
| 200 targets. |
| 201 </p> |
| 202 </field> |
| 203 <field name="targets"> |
| 204 <list> |
| 205 <ref>NavigationTarget</ref> |
| 206 </list> |
| 207 <p> |
| 208 A list of the navigation targets that are referenced by the |
| 209 navigation regions. |
| 210 </p> |
| 211 </field> |
| 212 <field name="regions"> |
| 213 <list> |
| 214 <ref>NavigationRegion</ref> |
| 215 </list> |
| 216 <p> |
| 217 A list of the navigation regions within the requested region of |
| 218 the file. |
| 219 </p> |
| 220 </field> |
| 221 </result> |
| 222 </request> |
152 <request method="handleWatchEvents"> | 223 <request method="handleWatchEvents"> |
153 <p> | 224 <p> |
154 Used to inform the plugin of changes to files in the file system. Only | 225 Used to inform the plugin of changes to files in the file system. Only |
155 events associated with files that match the <tt>interestingFiles</tt> glob | 226 events associated with files that match the <tt>interestingFiles</tt> glob |
156 patterns will be forwarded to the plugin. | 227 patterns will be forwarded to the plugin. |
157 </p> | 228 </p> |
158 <params> | 229 <params> |
159 <field name="events"> | 230 <field name="events"> |
160 <list> | 231 <list> |
161 <ref>WatchEvent</ref> | 232 <ref>WatchEvent</ref> |
(...skipping 1410 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1572 The name that the element should have after the refactoring. | 1643 The name that the element should have after the refactoring. |
1573 </p> | 1644 </p> |
1574 </field> | 1645 </field> |
1575 </options> | 1646 </options> |
1576 </refactoring> | 1647 </refactoring> |
1577 </refactorings> | 1648 </refactorings> |
1578 <h2 class="domain"><a name="index">Index</a></h2> | 1649 <h2 class="domain"><a name="index">Index</a></h2> |
1579 <index></index> | 1650 <index></index> |
1580 </body> | 1651 </body> |
1581 </html> | 1652 </html> |
OLD | NEW |