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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2911783002: Re-gen analysis server specs. (Closed)
Patch Set: Created 3 years, 7 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
« no previous file with comments | « pkg/analysis_server/tool/spec/to_html.dart ('k') | pkg/analyzer_plugin/test/integration/support/integration_test_methods.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 <!DOCTYPE html><html><head> 1 <!DOCTYPE html><html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server Plugin API Specification</title> 3 <title>Analysis Server Plugin API Specification</title>
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {
5 font-family: 'Roboto', sans-serif; 5 font-family: 'Roboto', sans-serif;
6 max-width: 800px; 6 max-width: 800px;
7 margin: 0 auto; 7 margin: 0 auto;
8 padding: 0 16px; 8 padding: 0 16px;
9 font-size: 16px; 9 font-size: 16px;
10 line-height: 1.5; 10 line-height: 1.5;
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
88 a:focus, a:hover { 88 a:focus, a:hover {
89 text-decoration: underline; 89 text-decoration: underline;
90 } 90 }
91 91
92 .deprecated { 92 .deprecated {
93 text-decoration: line-through; 93 text-decoration: line-through;
94 } 94 }
95 95
96 /* Styles for index */ 96 /* Styles for index */
97 97
98 .subindex {
99 }
100
101 .subindex ul { 98 .subindex ul {
102 padding-left: 0; 99 padding-left: 0;
103 margin-left: 0; 100 margin-left: 0;
104 101
105 -webkit-margin-before: 0; 102 -webkit-margin-before: 0;
106 -webkit-margin-start: 0; 103 -webkit-margin-start: 0;
107 -webkit-padding-start: 0; 104 -webkit-padding-start: 0;
108 105
109 list-style-type: none; 106 list-style-type: none;
110 } 107 }
(...skipping 22 matching lines...) Expand all
133 TODO: Provide notifications by which plugins can report instrumentation 130 TODO: Provide notifications by which plugins can report instrumentation
134 and/or DartSilo data. 131 and/or DartSilo data.
135 </p> 132 </p>
136 <p> 133 <p>
137 TODO: Add a notification to the server protocol to inform the client of 134 TODO: Add a notification to the server protocol to inform the client of
138 problems related to the execution of plugins. 135 problems related to the execution of plugins.
139 </p> 136 </p>
140 137
141 138
142 139
143 <h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">p lugin.versionCheck</a> (<a href="#request_plugin.versionCheck">#</a>)</dt><dd><d iv class="box"><pre>request: { 140 <h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">p lugin.versionCheck</a></dt><dd><div class="box"><pre>request: {
144 "id": String 141 "id": String
145 "method": "plugin.versionCheck" 142 "method": "plugin.versionCheck"
146 "params": { 143 "params": {
147 "<b>byteStorePath</b>": String 144 "<b>byteStorePath</b>": String
148 "<b>sdkPath</b>": String 145 "<b>sdkPath</b>": String
149 "<b>version</b>": String 146 "<b>version</b>": String
150 } 147 }
151 }</pre><br><pre>response: { 148 }</pre><br><pre>response: {
152 "id": String 149 "id": String
153 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 150 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
154 "result": { 151 "result": {
155 "<b>isCompatible</b>": bool 152 "<b>isCompatible</b>": bool
156 "<b>name</b>": String 153 "<b>name</b>": String
157 "<b>version</b>": String 154 "<b>version</b>": String
158 "<b>contactInfo</b>": <span style="color:#999999">optional</span> String 155 "<b>contactInfo</b>": <span style="color:#999999">optional</span> String
159 "<b>interestingFiles</b>": List&lt;String&gt; 156 "<b>interestingFiles</b>": List&lt;String&gt;
160 } 157 }
161 }</pre></div> 158 }</pre></div>
162 <p> 159 <p>
163 Used to request that the plugin perform a version check to confirm that it 160 Used to request that the plugin perform a version check to confirm that it
164 works with the version of the analysis server that is executing it. 161 works with the version of the analysis server that is executing it.
165 </p> 162 </p>
166 163
167 164
168 <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath (String)</b></dt><d d> 165 <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath: String</b></dt><dd >
169 166
170 <p> 167 <p>
171 The path to the directory containing the on-disk byte store that is to 168 The path to the directory containing the on-disk byte store that is to
172 be used by any analysis drivers that are created. 169 be used by any analysis drivers that are created.
173 </p> 170 </p>
174 </dd><dt class="field"><b>sdkPath (String)</b></dt><dd> 171 </dd><dt class="field"><b>sdkPath: String</b></dt><dd>
175 172
176 <p> 173 <p>
177 The path to the directory containing the SDK that is to be used by any 174 The path to the directory containing the SDK that is to be used by any
178 analysis drivers that are created. 175 analysis drivers that are created.
179 </p> 176 </p>
180 </dd><dt class="field"><b>version (String)</b></dt><dd> 177 </dd><dt class="field"><b>version: String</b></dt><dd>
181 178
182 <p> 179 <p>
183 The version number of the plugin spec supported by the analysis server 180 The version number of the plugin spec supported by the analysis server
184 that is executing the plugin. 181 that is executing the plugin.
185 </p> 182 </p>
186 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>isCompatible (bool)</b ></dt><dd> 183 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>isCompatible: bool</b> </dt><dd>
187 184
188 <p> 185 <p>
189 A flag indicating whether the plugin supports the same version of the 186 A flag indicating whether the plugin supports the same version of the
190 plugin spec as the analysis server. If the value is <tt>false</tt>, 187 plugin spec as the analysis server. If the value is <tt>false</tt>,
191 then the plugin is expected to shutdown after returning the response. 188 then the plugin is expected to shutdown after returning the response.
192 </p> 189 </p>
193 </dd><dt class="field"><b>name (String)</b></dt><dd> 190 </dd><dt class="field"><b>name: String</b></dt><dd>
194 191
195 <p> 192 <p>
196 The name of the plugin. This value is only used when the server needs 193 The name of the plugin. This value is only used when the server needs
197 to identify the plugin, either to the user or for debugging purposes. 194 to identify the plugin, either to the user or for debugging purposes.
198 </p> 195 </p>
199 </dd><dt class="field"><b>version (String)</b></dt><dd> 196 </dd><dt class="field"><b>version: String</b></dt><dd>
200 197
201 <p> 198 <p>
202 The version of the plugin. This value is only used when the server 199 The version of the plugin. This value is only used when the server
203 needs to identify the plugin, either to the user or for debugging 200 needs to identify the plugin, either to the user or for debugging
204 purposes. 201 purposes.
205 </p> 202 </p>
206 </dd><dt class="field"><b>contactInfo (<span style="color:#999999">optiona l</span> String)</b></dt><dd> 203 </dd><dt class="field"><b>contactInfo: String<span style="color:#999999"> (optional)</span></b></dt><dd>
207 204
208 <p> 205 <p>
209 Information that the user can use to use to contact the maintainers of 206 Information that the user can use to use to contact the maintainers of
210 the plugin when there is a problem. 207 the plugin when there is a problem.
211 </p> 208 </p>
212 </dd><dt class="field"><b>interestingFiles (List&lt;String&gt;)</b></dt><d d> 209 </dd><dt class="field"><b>interestingFiles: List&lt;String&gt;</b></dt><dd >
213 210
214 <p> 211 <p>
215 The glob patterns of the files for which the plugin will provide 212 The glob patterns of the files for which the plugin will provide
216 information. This value is ignored if the <tt>isCompatible</tt> 213 information. This value is ignored if the <tt>isCompatible</tt>
217 field is <tt>false</tt>. Otherwise, it will be used to identify 214 field is <tt>false</tt>. Otherwise, it will be used to identify
218 the files for which the plugin should be notified of changes. 215 the files for which the plugin should be notified of changes.
219 </p> 216 </p>
220 </dd></dl></dd><dt class="request"><a name="request_plugin.shutdown">plugi n.shutdown</a> (<a href="#request_plugin.shutdown">#</a>)</dt><dd><div class="bo x"><pre>request: { 217 </dd></dl></dd><dt class="request"><a name="request_plugin.shutdown">plugi n.shutdown</a></dt><dd><div class="box"><pre>request: {
221 "id": String 218 "id": String
222 "method": "plugin.shutdown" 219 "method": "plugin.shutdown"
223 }</pre><br><pre>response: { 220 }</pre><br><pre>response: {
224 "id": String 221 "id": String
225 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 222 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
226 }</pre></div> 223 }</pre></div>
227 <p> 224 <p>
228 Used to request that the plugin exit. The server will not send any other 225 Used to request that the plugin exit. The server will not send any other
229 requests after this request. The plugin should not send any responses or 226 requests after this request. The plugin should not send any responses or
230 notifications after sending the response to this request. 227 notifications after sending the response to this request.
231 </p> 228 </p>
232 </dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notifica tion_plugin.error">plugin.error</a> (<a href="#notification_plugin.error">#</a>) </dt><dd><div class="box"><pre>notification: { 229 </dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notifica tion_plugin.error">plugin.error</a></dt><dd><div class="box"><pre>notification: {
233 "event": "plugin.error" 230 "event": "plugin.error"
234 "params": { 231 "params": {
235 "<b>isFatal</b>": bool 232 "<b>isFatal</b>": bool
236 "<b>message</b>": String 233 "<b>message</b>": String
237 "<b>stackTrace</b>": String 234 "<b>stackTrace</b>": String
238 } 235 }
239 }</pre></div> 236 }</pre></div>
240 <p> 237 <p>
241 Used to report that an unexpected error has occurred while executing the 238 Used to report that an unexpected error has occurred while executing the
242 plugin. This notification is not used for problems with specific requests 239 plugin. This notification is not used for problems with specific requests
243 (which should be returned as part of the response) but is used for 240 (which should be returned as part of the response) but is used for
244 exceptions that occur while performing other tasks, such as analysis or 241 exceptions that occur while performing other tasks, such as analysis or
245 preparing notifications. 242 preparing notifications.
246 </p> 243 </p>
247 244
248 <h4>parameters:</h4><dl><dt class="field"><b>isFatal (bool)</b></dt><dd> 245 <h4>parameters:</h4><dl><dt class="field"><b>isFatal: bool</b></dt><dd>
249 246
250 <p> 247 <p>
251 A flag indicating whether the error is a fatal error, meaning that the 248 A flag indicating whether the error is a fatal error, meaning that the
252 plugin will shutdown automatically after sending this notification. If 249 plugin will shutdown automatically after sending this notification. If
253 <tt>true</tt>, the server will not expect any other responses or 250 <tt>true</tt>, the server will not expect any other responses or
254 notifications from the plugin. 251 notifications from the plugin.
255 </p> 252 </p>
256 </dd><dt class="field"><b>message (String)</b></dt><dd> 253 </dd><dt class="field"><b>message: String</b></dt><dd>
257 254
258 <p> 255 <p>
259 The error message indicating what kind of error was encountered. 256 The error message indicating what kind of error was encountered.
260 </p> 257 </p>
261 </dd><dt class="field"><b>stackTrace (String)</b></dt><dd> 258 </dd><dt class="field"><b>stackTrace: String</b></dt><dd>
262 259
263 <p> 260 <p>
264 The stack trace associated with the generation of the error, used for 261 The stack trace associated with the generation of the error, used for
265 debugging the plugin. 262 debugging the plugin.
266 </p> 263 </p>
267 </dd></dl></dd></dl> 264 </dd></dl></dd></dl>
268 <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2> 265 <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2>
269 <p> 266 <p>
270 The analysis domain contains API’s related to the analysis of files. 267 The analysis domain contains API’s related to the analysis of files.
271 </p> 268 </p>
272 269
273 270
274 271
275 272
276 273
277 274
278 275
279 276
280 277
281 278
282 279
283 280
284 281
285 282
286 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation ">analysis.getNavigation</a> (<a href="#request_analysis.getNavigation">#</a>)</ dt><dd><div class="box"><pre>request: { 283 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation ">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {
287 "id": String 284 "id": String
288 "method": "analysis.getNavigation" 285 "method": "analysis.getNavigation"
289 "params": { 286 "params": {
290 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 287 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
291 "<b>offset</b>": int 288 "<b>offset</b>": int
292 "<b>length</b>": int 289 "<b>length</b>": int
293 } 290 }
294 }</pre><br><pre>response: { 291 }</pre><br><pre>response: {
295 "id": String 292 "id": String
296 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 293 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
(...skipping 16 matching lines...) Expand all
313 <p> 310 <p>
314 If a navigation region overlaps (but extends either before or after) 311 If a navigation region overlaps (but extends either before or after)
315 the given region of the file it will be included in the result. This 312 the given region of the file it will be included in the result. This
316 means that it is theoretically possible to get the same navigation 313 means that it is theoretically possible to get the same navigation
317 region in response to multiple requests. Clients can avoid this by 314 region in response to multiple requests. Clients can avoid this by
318 always choosing a region that starts at the beginning of a line and 315 always choosing a region that starts at the beginning of a line and
319 ends at the end of a (possibly different) line in the file. 316 ends at the end of a (possibly different) line in the file.
320 </p> 317 </p>
321 318
322 319
323 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 320 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
324 321
325 <p> 322 <p>
326 The file in which navigation information is being requested. 323 The file in which navigation information is being requested.
327 </p> 324 </p>
328 </dd><dt class="field"><b>offset (int)</b></dt><dd> 325 </dd><dt class="field"><b>offset: int</b></dt><dd>
329 326
330 <p> 327 <p>
331 The offset of the region for which navigation information is being 328 The offset of the region for which navigation information is being
332 requested. 329 requested.
333 </p> 330 </p>
334 </dd><dt class="field"><b>length (int)</b></dt><dd> 331 </dd><dt class="field"><b>length: int</b></dt><dd>
335 332
336 <p> 333 <p>
337 The length of the region for which navigation information is being 334 The length of the region for which navigation information is being
338 requested. 335 requested.
339 </p> 336 </p>
340 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files (List&lt;<a href ="#type_FilePath">FilePath</a>&gt;)</b></dt><dd> 337 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files: List&lt;<a href ="#type_FilePath">FilePath</a>&gt;</b></dt><dd>
341 338
342 <p> 339 <p>
343 A list of the paths of files that are referenced by the navigation 340 A list of the paths of files that are referenced by the navigation
344 targets. 341 targets.
345 </p> 342 </p>
346 </dd><dt class="field"><b>targets (List&lt;<a href="#type_NavigationTarget ">NavigationTarget</a>&gt;)</b></dt><dd> 343 </dd><dt class="field"><b>targets: List&lt;<a href="#type_NavigationTarget ">NavigationTarget</a>&gt;</b></dt><dd>
347 344
348 <p> 345 <p>
349 A list of the navigation targets that are referenced by the 346 A list of the navigation targets that are referenced by the
350 navigation regions. 347 navigation regions.
351 </p> 348 </p>
352 </dd><dt class="field"><b>regions (List&lt;<a href="#type_NavigationRegion ">NavigationRegion</a>&gt;)</b></dt><dd> 349 </dd><dt class="field"><b>regions: List&lt;<a href="#type_NavigationRegion ">NavigationRegion</a>&gt;</b></dt><dd>
353 350
354 <p> 351 <p>
355 A list of the navigation regions within the requested region of 352 A list of the navigation regions within the requested region of
356 the file. 353 the file.
357 </p> 354 </p>
358 </dd></dl></dd><dt class="request"><a name="request_analysis.handleWatchEv ents">analysis.handleWatchEvents</a> (<a href="#request_analysis.handleWatchEven ts">#</a>)</dt><dd><div class="box"><pre>request: { 355 </dd></dl></dd><dt class="request"><a name="request_analysis.handleWatchEv ents">analysis.handleWatchEvents</a></dt><dd><div class="box"><pre>request: {
359 "id": String 356 "id": String
360 "method": "analysis.handleWatchEvents" 357 "method": "analysis.handleWatchEvents"
361 "params": { 358 "params": {
362 "<b>events</b>": List&lt;<a href="#type_WatchEvent">WatchEvent</a>&gt; 359 "<b>events</b>": List&lt;<a href="#type_WatchEvent">WatchEvent</a>&gt;
363 } 360 }
364 }</pre><br><pre>response: { 361 }</pre><br><pre>response: {
365 "id": String 362 "id": String
366 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 363 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
367 }</pre></div> 364 }</pre></div>
368 <p> 365 <p>
369 Used to inform the plugin of changes to files in the file system. Only 366 Used to inform the plugin of changes to files in the file system. Only
370 events associated with files that match the <tt>interestingFiles</tt> glob 367 events associated with files that match the <tt>interestingFiles</tt> glob
371 patterns will be forwarded to the plugin. 368 patterns will be forwarded to the plugin.
372 </p> 369 </p>
373 370
374 <h4>parameters:</h4><dl><dt class="field"><b>events (List&lt;<a href="#type_Wa tchEvent">WatchEvent</a>&gt;)</b></dt><dd> 371 <h4>parameters:</h4><dl><dt class="field"><b>events: List&lt;<a href="#type_Wa tchEvent">WatchEvent</a>&gt;</b></dt><dd>
375 372
376 <p> 373 <p>
377 The watch events that the plugin should handle. 374 The watch events that the plugin should handle.
378 </p> 375 </p>
379 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">an alysis.reanalyze</a> (<a href="#request_analysis.reanalyze">#</a>)</dt><dd><div class="box"><pre>request: { 376 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">an alysis.reanalyze</a></dt><dd><div class="box"><pre>request: {
380 "id": String 377 "id": String
381 "method": "analysis.reanalyze" 378 "method": "analysis.reanalyze"
382 "params": { 379 "params": {
383 "<b>roots</b>": <span style="color:#999999">optional</span> List&lt;<a href= "#type_FilePath">FilePath</a>&gt; 380 "<b>roots</b>": <span style="color:#999999">optional</span> List&lt;<a href= "#type_FilePath">FilePath</a>&gt;
384 } 381 }
385 }</pre><br><pre>response: { 382 }</pre><br><pre>response: {
386 "id": String 383 "id": String
387 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 384 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
388 }</pre></div> 385 }</pre></div>
389 <p> 386 <p>
390 Used to force the re-analysis of everything contained in the specified 387 Used to force the re-analysis of everything contained in the specified
391 context roots. This should cause all previously computed analysis results 388 context roots. This should cause all previously computed analysis results
392 to be discarded and recomputed, and should cause all subscribed 389 to be discarded and recomputed, and should cause all subscribed
393 notifications to be re-sent. 390 notifications to be re-sent.
394 </p> 391 </p>
395 392
396 <h4>parameters:</h4><dl><dt class="field"><b>roots (<span style="color:#999999 ">optional</span> List&lt;<a href="#type_FilePath">FilePath</a>&gt;)</b></dt><dd > 393 <h4>parameters:</h4><dl><dt class="field"><b>roots: List&lt;<a href="#type_Fil ePath">FilePath</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><d d>
397 394
398 <p> 395 <p>
399 A list of the context roots that are to be re-analyzed. 396 A list of the context roots that are to be re-analyzed.
400 </p> 397 </p>
401 <p> 398 <p>
402 If no context roots are provided, then all current context roots 399 If no context roots are provided, then all current context roots
403 should be re-analyzed. 400 should be re-analyzed.
404 </p> 401 </p>
405 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextBui lderOptions">analysis.setContextBuilderOptions</a> (<a href="#request_analysis.s etContextBuilderOptions">#</a>)</dt><dd><div class="box"><pre>request: { 402 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextBui lderOptions">analysis.setContextBuilderOptions</a></dt><dd><div class="box"><pre >request: {
406 "id": String 403 "id": String
407 "method": "analysis.setContextBuilderOptions" 404 "method": "analysis.setContextBuilderOptions"
408 "params": { 405 "params": {
409 "<b>options</b>": <a href="#type_ContextBuilderOptions">ContextBuilderOption s</a> 406 "<b>options</b>": <a href="#type_ContextBuilderOptions">ContextBuilderOption s</a>
410 } 407 }
411 }</pre><br><pre>response: { 408 }</pre><br><pre>response: {
412 "id": String 409 "id": String
413 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 410 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
414 }</pre></div> 411 }</pre></div>
415 <p> 412 <p>
416 Used to set the options used to build analysis contexts. This request will 413 Used to set the options used to build analysis contexts. This request will
417 be sent exactly once before any context roots have been specified. 414 be sent exactly once before any context roots have been specified.
418 </p> 415 </p>
419 416
420 <h4>parameters:</h4><dl><dt class="field"><b>options (<a href="#type_ContextBu ilderOptions">ContextBuilderOptions</a>)</b></dt><dd> 417 <h4>parameters:</h4><dl><dt class="field"><b>options: <a href="#type_ContextBu ilderOptions">ContextBuilderOptions</a></b></dt><dd>
421 418
422 <p> 419 <p>
423 The options used to build the analysis contexts. 420 The options used to build the analysis contexts.
424 </p> 421 </p>
425 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoo ts">analysis.setContextRoots</a> (<a href="#request_analysis.setContextRoots">#< /a>)</dt><dd><div class="box"><pre>request: { 422 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoo ts">analysis.setContextRoots</a></dt><dd><div class="box"><pre>request: {
426 "id": String 423 "id": String
427 "method": "analysis.setContextRoots" 424 "method": "analysis.setContextRoots"
428 "params": { 425 "params": {
429 "<b>roots</b>": List&lt;<a href="#type_ContextRoot">ContextRoot</a>&gt; 426 "<b>roots</b>": List&lt;<a href="#type_ContextRoot">ContextRoot</a>&gt;
430 } 427 }
431 }</pre><br><pre>response: { 428 }</pre><br><pre>response: {
432 "id": String 429 "id": String
433 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 430 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
434 }</pre></div> 431 }</pre></div>
435 <p> 432 <p>
436 Set the list of context roots that should be analyzed. 433 Set the list of context roots that should be analyzed.
437 </p> 434 </p>
438 435
439 <h4>parameters:</h4><dl><dt class="field"><b>roots (List&lt;<a href="#type_Con textRoot">ContextRoot</a>&gt;)</b></dt><dd> 436 <h4>parameters:</h4><dl><dt class="field"><b>roots: List&lt;<a href="#type_Con textRoot">ContextRoot</a>&gt;</b></dt><dd>
440 437
441 <p> 438 <p>
442 A list of the context roots that should be analyzed. 439 A list of the context roots that should be analyzed.
443 </p> 440 </p>
444 </dd></dl></dd><dt class="request"><a name="request_analysis.setPriorityFi les">analysis.setPriorityFiles</a> (<a href="#request_analysis.setPriorityFiles" >#</a>)</dt><dd><div class="box"><pre>request: { 441 </dd></dl></dd><dt class="request"><a name="request_analysis.setPriorityFi les">analysis.setPriorityFiles</a></dt><dd><div class="box"><pre>request: {
445 "id": String 442 "id": String
446 "method": "analysis.setPriorityFiles" 443 "method": "analysis.setPriorityFiles"
447 "params": { 444 "params": {
448 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 445 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
449 } 446 }
450 }</pre><br><pre>response: { 447 }</pre><br><pre>response: {
451 "id": String 448 "id": String
452 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 449 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
453 }</pre></div> 450 }</pre></div>
454 <p> 451 <p>
455 Used to set the priority files to the files in the given list. A priority 452 Used to set the priority files to the files in the given list. A priority
456 file is a file that should be given priority when scheduling which 453 file is a file that should be given priority when scheduling which
457 analysis work to do first. The list typically contains those files that 454 analysis work to do first. The list typically contains those files that
458 are visible to the user and those for which analysis results will have the 455 are visible to the user and those for which analysis results will have the
459 biggest impact on the user experience. The order of the files within the 456 biggest impact on the user experience. The order of the files within the
460 list is significant: the first file will be given higher priority than 457 list is significant: the first file will be given higher priority than
461 the second, the second higher priority than the third, and so on. 458 the second, the second higher priority than the third, and so on.
462 </p> 459 </p>
463 460
464 <h4>parameters:</h4><dl><dt class="field"><b>files (List&lt;<a href="#type_Fil ePath">FilePath</a>&gt;)</b></dt><dd> 461 <h4>parameters:</h4><dl><dt class="field"><b>files: List&lt;<a href="#type_Fil ePath">FilePath</a>&gt;</b></dt><dd>
465 462
466 <p> 463 <p>
467 The files that are to be a priority for analysis. 464 The files that are to be a priority for analysis.
468 </p> 465 </p>
469 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscripti ons">analysis.setSubscriptions</a> (<a href="#request_analysis.setSubscriptions" >#</a>)</dt><dd><div class="box"><pre>request: { 466 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscripti ons">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: {
470 "id": String 467 "id": String
471 "method": "analysis.setSubscriptions" 468 "method": "analysis.setSubscriptions"
472 "params": { 469 "params": {
473 "<b>subscriptions</b>": Map&lt;<a href="#type_AnalysisService">AnalysisServi ce</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt; 470 "<b>subscriptions</b>": Map&lt;<a href="#type_AnalysisService">AnalysisServi ce</a>, List&lt;<a href="#type_FilePath">FilePath</a>&gt;&gt;
474 } 471 }
475 }</pre><br><pre>response: { 472 }</pre><br><pre>response: {
476 "id": String 473 "id": String
477 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 474 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
478 }</pre></div> 475 }</pre></div>
479 <p> 476 <p>
480 Used to subscribe for services that are specific to individual files. All 477 Used to subscribe for services that are specific to individual files. All
481 previous subscriptions should be replaced by the current set of 478 previous subscriptions should be replaced by the current set of
482 subscriptions. If a given service is not included as a key in the map then 479 subscriptions. If a given service is not included as a key in the map then
483 no files should be subscribed to the service, exactly as if the service 480 no files should be subscribed to the service, exactly as if the service
484 had been included in the map with an explicit empty list of files. 481 had been included in the map with an explicit empty list of files.
485 </p> 482 </p>
486 483
487 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (Map&lt;<a href="#t ype_AnalysisService">AnalysisService</a>, List&lt;<a href="#type_FilePath">FileP ath</a>&gt;&gt;)</b></dt><dd> 484 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: Map&lt;<a href="#t ype_AnalysisService">AnalysisService</a>, List&lt;<a href="#type_FilePath">FileP ath</a>&gt;&gt;</b></dt><dd>
488 485
489 <p> 486 <p>
490 A table mapping services to a list of the files being subscribed to 487 A table mapping services to a list of the files being subscribed to
491 the service. 488 the service.
492 </p> 489 </p>
493 </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent ">analysis.updateContent</a> (<a href="#request_analysis.updateContent">#</a>)</ dt><dd><div class="box"><pre>request: { 490 </dd></dl></dd><dt class="request"><a name="request_analysis.updateContent ">analysis.updateContent</a></dt><dd><div class="box"><pre>request: {
494 "id": String 491 "id": String
495 "method": "analysis.updateContent" 492 "method": "analysis.updateContent"
496 "params": { 493 "params": {
497 "<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; 494 "<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;
498 } 495 }
499 }</pre><br><pre>response: { 496 }</pre><br><pre>response: {
500 "id": String 497 "id": String
501 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 498 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
502 }</pre></div> 499 }</pre></div>
503 <p> 500 <p>
504 Used to update the content of one or more files. Files that were 501 Used to update the content of one or more files. Files that were
505 previously updated but not included in this update remain unchanged. This 502 previously updated but not included in this update remain unchanged. This
506 effectively represents an overlay of the filesystem. The files whose 503 effectively represents an overlay of the filesystem. The files whose
507 content is overridden are therefore seen by the plugin as being files with 504 content is overridden are therefore seen by the plugin as being files with
508 the given content, even if the files do not exist on the filesystem or if 505 the given content, even if the files do not exist on the filesystem or if
509 the file path represents the path to a directory on the filesystem. 506 the file path represents the path to a directory on the filesystem.
510 </p> 507 </p>
511 508
512 <h4>parameters:</h4><dl><dt class="field"><b>files (Map&lt;<a href="#type_File Path">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_Rem oveContentOverlay">RemoveContentOverlay</a>&gt;)</b></dt><dd> 509 <h4>parameters:</h4><dl><dt class="field"><b>files: Map&lt;<a href="#type_File Path">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a> | <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type_Rem oveContentOverlay">RemoveContentOverlay</a>&gt;</b></dt><dd>
513 510
514 <p> 511 <p>
515 A table mapping the files whose content has changed to a description 512 A table mapping the files whose content has changed to a description
516 of the content change. 513 of the content change.
517 </p> 514 </p>
518 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a> (<a href="#notification_ analysis.errors">#</a>)</dt><dd><div class="box"><pre>notification: { 515 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"><a name="notification_analysis.errors">analysis.errors</a></dt><dd><div class="box" ><pre>notification: {
519 "event": "analysis.errors" 516 "event": "analysis.errors"
520 "params": { 517 "params": {
521 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 518 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
522 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt; 519 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt;
523 } 520 }
524 }</pre></div> 521 }</pre></div>
525 <p> 522 <p>
526 Used to report the errors associated with a given file. The set of errors 523 Used to report the errors associated with a given file. The set of errors
527 included in the notification is always a complete list that supersedes any 524 included in the notification is always a complete list that supersedes any
528 previously reported errors. 525 previously reported errors.
529 </p> 526 </p>
530 527
531 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 528 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
532 529
533 <p> 530 <p>
534 The file containing the errors. 531 The file containing the errors.
535 </p> 532 </p>
536 </dd><dt class="field"><b>errors (List&lt;<a href="#type_AnalysisError">An alysisError</a>&gt;)</b></dt><dd> 533 </dd><dt class="field"><b>errors: List&lt;<a href="#type_AnalysisError">An alysisError</a>&gt;</b></dt><dd>
537 534
538 <p> 535 <p>
539 The errors contained in the file. 536 The errors contained in the file.
540 </p> 537 </p>
541 </dd></dl></dd><dt class="notification"><a name="notification_analysis.fol ding">analysis.folding</a> (<a href="#notification_analysis.folding">#</a>)</dt> <dd><div class="box"><pre>notification: { 538 </dd></dl></dd><dt class="notification"><a name="notification_analysis.fol ding">analysis.folding</a></dt><dd><div class="box"><pre>notification: {
542 "event": "analysis.folding" 539 "event": "analysis.folding"
543 "params": { 540 "params": {
544 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 541 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
545 "<b>regions</b>": List&lt;<a href="#type_FoldingRegion">FoldingRegion</a>&gt ; 542 "<b>regions</b>": List&lt;<a href="#type_FoldingRegion">FoldingRegion</a>&gt ;
546 } 543 }
547 }</pre></div> 544 }</pre></div>
548 <p> 545 <p>
549 Used to report the folding regions associated with a given file. Folding 546 Used to report the folding regions associated with a given file. Folding
550 regions can be nested, but cannot be overlapping. Nesting occurs when a 547 regions can be nested, but cannot be overlapping. Nesting occurs when a
551 foldable element, such as a method, is nested inside another foldable 548 foldable element, such as a method, is nested inside another foldable
552 element such as a class. 549 element such as a class.
553 </p> 550 </p>
554 <p> 551 <p>
555 Folding regions that overlap a folding region computed by the server, or 552 Folding regions that overlap a folding region computed by the server, or
556 by one of the other plugins that are currently running, might be dropped 553 by one of the other plugins that are currently running, might be dropped
557 by the server in order to present a consistent view to the client. 554 by the server in order to present a consistent view to the client.
558 </p> 555 </p>
559 <p> 556 <p>
560 This notification should only be sent if the server has subscribed to it 557 This notification should only be sent if the server has subscribed to it
561 by including the value <tt>"FOLDING"</tt> in the list of services 558 by including the value <tt>"FOLDING"</tt> in the list of services
562 passed in an analysis.setSubscriptions request. 559 passed in an analysis.setSubscriptions request.
563 </p> 560 </p>
564 561
565 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 562 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
566 563
567 <p> 564 <p>
568 The file containing the folding regions. 565 The file containing the folding regions.
569 </p> 566 </p>
570 </dd><dt class="field"><b>regions (List&lt;<a href="#type_FoldingRegion">F oldingRegion</a>&gt;)</b></dt><dd> 567 </dd><dt class="field"><b>regions: List&lt;<a href="#type_FoldingRegion">F oldingRegion</a>&gt;</b></dt><dd>
571 568
572 <p> 569 <p>
573 The folding regions contained in the file. 570 The folding regions contained in the file.
574 </p> 571 </p>
575 </dd></dl></dd><dt class="notification"><a name="notification_analysis.hig hlights">analysis.highlights</a> (<a href="#notification_analysis.highlights">#< /a>)</dt><dd><div class="box"><pre>notification: { 572 </dd></dl></dd><dt class="notification"><a name="notification_analysis.hig hlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification: {
576 "event": "analysis.highlights" 573 "event": "analysis.highlights"
577 "params": { 574 "params": {
578 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 575 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
579 "<b>regions</b>": List&lt;<a href="#type_HighlightRegion">HighlightRegion</a >&gt; 576 "<b>regions</b>": List&lt;<a href="#type_HighlightRegion">HighlightRegion</a >&gt;
580 } 577 }
581 }</pre></div> 578 }</pre></div>
582 <p> 579 <p>
583 Used to report the highlight regions associated with a given file. Each 580 Used to report the highlight regions associated with a given file. Each
584 highlight region represents a particular syntactic or semantic meaning 581 highlight region represents a particular syntactic or semantic meaning
585 associated with some range. Note that the highlight regions that are 582 associated with some range. Note that the highlight regions that are
586 returned can overlap other highlight regions if there is more than one 583 returned can overlap other highlight regions if there is more than one
587 meaning associated with a particular region. 584 meaning associated with a particular region.
588 </p> 585 </p>
589 <p> 586 <p>
590 This notification should only be sent if the server has subscribed to it 587 This notification should only be sent if the server has subscribed to it
591 by including the value <tt>"HIGHLIGHTS"</tt> in the list of services 588 by including the value <tt>"HIGHLIGHTS"</tt> in the list of services
592 passed in an analysis.setSubscriptions request. 589 passed in an analysis.setSubscriptions request.
593 </p> 590 </p>
594 591
595 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 592 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
596 593
597 <p> 594 <p>
598 The file containing the highlight regions. 595 The file containing the highlight regions.
599 </p> 596 </p>
600 </dd><dt class="field"><b>regions (List&lt;<a href="#type_HighlightRegion" >HighlightRegion</a>&gt;)</b></dt><dd> 597 </dd><dt class="field"><b>regions: List&lt;<a href="#type_HighlightRegion" >HighlightRegion</a>&gt;</b></dt><dd>
601 598
602 <p> 599 <p>
603 The highlight regions contained in the file. 600 The highlight regions contained in the file.
604 </p> 601 </p>
605 </dd></dl></dd><dt class="notification"><a name="notification_analysis.nav igation">analysis.navigation</a> (<a href="#notification_analysis.navigation">#< /a>)</dt><dd><div class="box"><pre>notification: { 602 </dd></dl></dd><dt class="notification"><a name="notification_analysis.nav igation">analysis.navigation</a></dt><dd><div class="box"><pre>notification: {
606 "event": "analysis.navigation" 603 "event": "analysis.navigation"
607 "params": { 604 "params": {
608 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 605 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
609 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt; 606 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt;
610 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt; 607 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt;
611 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 608 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
612 } 609 }
613 }</pre></div> 610 }</pre></div>
614 <p> 611 <p>
615 Used to report the navigation regions associated with a given file. Each 612 Used to report the navigation regions associated with a given file. Each
616 navigation region represents a list of targets associated with some range. 613 navigation region represents a list of targets associated with some range.
617 The lists will usually contain a single target, but can contain more in 614 The lists will usually contain a single target, but can contain more in
618 the case of a part that is included in multiple libraries or in Dart code 615 the case of a part that is included in multiple libraries or in Dart code
619 that is compiled against multiple versions of a package. Note that the 616 that is compiled against multiple versions of a package. Note that the
620 navigation regions that are returned should not overlap other navigation 617 navigation regions that are returned should not overlap other navigation
621 regions. 618 regions.
622 </p> 619 </p>
623 <p> 620 <p>
624 Navigation regions that overlap a navigation region computed by the 621 Navigation regions that overlap a navigation region computed by the
625 server, or by one of the other plugins that are currently running, might 622 server, or by one of the other plugins that are currently running, might
626 be dropped or modified by the server in order to present a consistent view 623 be dropped or modified by the server in order to present a consistent view
627 to the client. 624 to the client.
628 </p> 625 </p>
629 <p> 626 <p>
630 This notification should only be sent if the server has subscribed to it 627 This notification should only be sent if the server has subscribed to it
631 by including the value <tt>"NAVIGATION"</tt> in the list of services 628 by including the value <tt>"NAVIGATION"</tt> in the list of services
632 passed in an analysis.setSubscriptions request. 629 passed in an analysis.setSubscriptions request.
633 </p> 630 </p>
634 631
635 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 632 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
636 633
637 <p> 634 <p>
638 The file containing the navigation regions. 635 The file containing the navigation regions.
639 </p> 636 </p>
640 </dd><dt class="field"><b>regions (List&lt;<a href="#type_NavigationRegion ">NavigationRegion</a>&gt;)</b></dt><dd> 637 </dd><dt class="field"><b>regions: List&lt;<a href="#type_NavigationRegion ">NavigationRegion</a>&gt;</b></dt><dd>
641 638
642 <p> 639 <p>
643 The navigation regions contained in the file. 640 The navigation regions contained in the file.
644 </p> 641 </p>
645 </dd><dt class="field"><b>targets (List&lt;<a href="#type_NavigationTarget ">NavigationTarget</a>&gt;)</b></dt><dd> 642 </dd><dt class="field"><b>targets: List&lt;<a href="#type_NavigationTarget ">NavigationTarget</a>&gt;</b></dt><dd>
646 643
647 <p> 644 <p>
648 The navigation targets referenced in the file. They are referenced by 645 The navigation targets referenced in the file. They are referenced by
649 <a href="#type_NavigationRegion">NavigationRegion</a>s by their index 646 <a href="#type_NavigationRegion">NavigationRegion</a>s by their index
650 in this array. 647 in this array.
651 </p> 648 </p>
652 </dd><dt class="field"><b>files (List&lt;<a href="#type_FilePath">FilePath </a>&gt;)</b></dt><dd> 649 </dd><dt class="field"><b>files: List&lt;<a href="#type_FilePath">FilePath </a>&gt;</b></dt><dd>
653 650
654 <p> 651 <p>
655 The files containing navigation targets referenced in the file. They 652 The files containing navigation targets referenced in the file. They
656 are referenced by 653 are referenced by
657 <a href="#type_NavigationTarget">NavigationTarget</a>s by their index 654 <a href="#type_NavigationTarget">NavigationTarget</a>s by their index
658 in this array. 655 in this array.
659 </p> 656 </p>
660 </dd></dl></dd><dt class="notification"><a name="notification_analysis.occ urrences">analysis.occurrences</a> (<a href="#notification_analysis.occurrences" >#</a>)</dt><dd><div class="box"><pre>notification: { 657 </dd></dl></dd><dt class="notification"><a name="notification_analysis.occ urrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notification: {
661 "event": "analysis.occurrences" 658 "event": "analysis.occurrences"
662 "params": { 659 "params": {
663 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 660 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
664 "<b>occurrences</b>": List&lt;<a href="#type_Occurrences">Occurrences</a>&gt ; 661 "<b>occurrences</b>": List&lt;<a href="#type_Occurrences">Occurrences</a>&gt ;
665 } 662 }
666 }</pre></div> 663 }</pre></div>
667 <p> 664 <p>
668 Used to report the occurrences of references to elements within a single 665 Used to report the occurrences of references to elements within a single
669 file. None of the occurrence regions should overlap. 666 file. None of the occurrence regions should overlap.
670 </p> 667 </p>
671 <p> 668 <p>
672 Occurrence regions that overlap an occurrence region computed by the 669 Occurrence regions that overlap an occurrence region computed by the
673 server, or by one of the other plugins that are currently running, might 670 server, or by one of the other plugins that are currently running, might
674 be dropped or modified by the server in order to present a consistent view 671 be dropped or modified by the server in order to present a consistent view
675 to the client. 672 to the client.
676 </p> 673 </p>
677 <p> 674 <p>
678 This notification should only be sent if the server has subscribed to it 675 This notification should only be sent if the server has subscribed to it
679 by including the value <tt>"OCCURRENCES"</tt> in the list of services 676 by including the value <tt>"OCCURRENCES"</tt> in the list of services
680 passed in an analysis.setSubscriptions request. 677 passed in an analysis.setSubscriptions request.
681 </p> 678 </p>
682 679
683 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 680 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
684 681
685 <p> 682 <p>
686 The file in which the references occur. 683 The file in which the references occur.
687 </p> 684 </p>
688 </dd><dt class="field"><b>occurrences (List&lt;<a href="#type_Occurrences" >Occurrences</a>&gt;)</b></dt><dd> 685 </dd><dt class="field"><b>occurrences: List&lt;<a href="#type_Occurrences" >Occurrences</a>&gt;</b></dt><dd>
689 686
690 <p> 687 <p>
691 The occurrences of references to elements within the file. 688 The occurrences of references to elements within the file.
692 </p> 689 </p>
693 </dd></dl></dd><dt class="notification"><a name="notification_analysis.out line">analysis.outline</a> (<a href="#notification_analysis.outline">#</a>)</dt> <dd><div class="box"><pre>notification: { 690 </dd></dl></dd><dt class="notification"><a name="notification_analysis.out line">analysis.outline</a></dt><dd><div class="box"><pre>notification: {
694 "event": "analysis.outline" 691 "event": "analysis.outline"
695 "params": { 692 "params": {
696 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 693 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
697 "<b>outline</b>": List&lt;<a href="#type_Outline">Outline</a>&gt; 694 "<b>outline</b>": List&lt;<a href="#type_Outline">Outline</a>&gt;
698 } 695 }
699 }</pre></div> 696 }</pre></div>
700 <p> 697 <p>
701 Used to report the outline fragments associated with a single file. 698 Used to report the outline fragments associated with a single file.
702 </p> 699 </p>
703 <p> 700 <p>
704 The outline fragments will be merged with any outline produced by the 701 The outline fragments will be merged with any outline produced by the
705 server and with any fragments produced by other plugins. If the server 702 server and with any fragments produced by other plugins. If the server
706 cannot create a coherent outline, some fragments might be dropped. 703 cannot create a coherent outline, some fragments might be dropped.
707 </p> 704 </p>
708 <p> 705 <p>
709 This notification should only be sent if the server has subscribed to it 706 This notification should only be sent if the server has subscribed to it
710 by including the value <tt>"OUTLINE"</tt> in the list of services 707 by including the value <tt>"OUTLINE"</tt> in the list of services
711 passed in an analysis.setSubscriptions request. 708 passed in an analysis.setSubscriptions request.
712 </p> 709 </p>
713 710
714 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 711 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
715 712
716 <p> 713 <p>
717 The file with which the outline is associated. 714 The file with which the outline is associated.
718 </p> 715 </p>
719 </dd><dt class="field"><b>outline (List&lt;<a href="#type_Outline">Outline </a>&gt;)</b></dt><dd> 716 </dd><dt class="field"><b>outline: List&lt;<a href="#type_Outline">Outline </a>&gt;</b></dt><dd>
720 717
721 <p> 718 <p>
722 The outline fragments associated with the file. 719 The outline fragments associated with the file.
723 </p> 720 </p>
724 </dd></dl></dd></dl> 721 </dd></dl></dd></dl>
725 <h2 class="domain"><a name="domain_completion">completion domain</a></h2> 722 <h2 class="domain"><a name="domain_completion">completion domain</a></h2>
726 <p> 723 <p>
727 The code completion domain contains API's related to getting code completion 724 The code completion domain contains API's related to getting code completion
728 suggestions. 725 suggestions.
729 </p> 726 </p>
730 727
731 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggesti ons">completion.getSuggestions</a> (<a href="#request_completion.getSuggestions" >#</a>)</dt><dd><div class="box"><pre>request: { 728 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSuggesti ons">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: {
732 "id": String 729 "id": String
733 "method": "completion.getSuggestions" 730 "method": "completion.getSuggestions"
734 "params": { 731 "params": {
735 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 732 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
736 "<b>offset</b>": int 733 "<b>offset</b>": int
737 } 734 }
738 }</pre><br><pre>response: { 735 }</pre><br><pre>response: {
739 "id": String 736 "id": String
740 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 737 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
741 "result": { 738 "result": {
742 "<b>replacementOffset</b>": int 739 "<b>replacementOffset</b>": int
743 "<b>replacementLength</b>": int 740 "<b>replacementLength</b>": int
744 "<b>results</b>": List&lt;<a href="#type_CompletionSuggestion">CompletionSug gestion</a>&gt; 741 "<b>results</b>": List&lt;<a href="#type_CompletionSuggestion">CompletionSug gestion</a>&gt;
745 } 742 }
746 }</pre></div> 743 }</pre></div>
747 <p> 744 <p>
748 Used to request that completion suggestions for the given offset in the 745 Used to request that completion suggestions for the given offset in the
749 given file be returned. 746 given file be returned.
750 </p> 747 </p>
751 748
752 749
753 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 750 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
754 751
755 <p> 752 <p>
756 The file containing the point at which suggestions are to be made. 753 The file containing the point at which suggestions are to be made.
757 </p> 754 </p>
758 </dd><dt class="field"><b>offset (int)</b></dt><dd> 755 </dd><dt class="field"><b>offset: int</b></dt><dd>
759 756
760 <p> 757 <p>
761 The offset within the file at which suggestions are to be made. 758 The offset within the file at which suggestions are to be made.
762 </p> 759 </p>
763 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>replacementOffset (int )</b></dt><dd> 760 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>replacementOffset: int </b></dt><dd>
764 761
765 <p> 762 <p>
766 The offset of the start of the text to be replaced. This will be 763 The offset of the start of the text to be replaced. This will be
767 different than the offset used to request the completion suggestions 764 different than the offset used to request the completion suggestions
768 if there was a portion of an identifier before the original offset. In 765 if there was a portion of an identifier before the original offset. In
769 particular, the replacementOffset will be the offset of the beginning 766 particular, the replacementOffset will be the offset of the beginning
770 of said identifier. 767 of said identifier.
771 </p> 768 </p>
772 </dd><dt class="field"><b>replacementLength (int)</b></dt><dd> 769 </dd><dt class="field"><b>replacementLength: int</b></dt><dd>
773 770
774 <p> 771 <p>
775 The length of the text to be replaced if the remainder of the 772 The length of the text to be replaced if the remainder of the
776 identifier containing the cursor is to be replaced when the suggestion 773 identifier containing the cursor is to be replaced when the suggestion
777 is applied (that is, the number of characters in the existing 774 is applied (that is, the number of characters in the existing
778 identifier). 775 identifier).
779 </p> 776 </p>
780 </dd><dt class="field"><b>results (List&lt;<a href="#type_CompletionSugges tion">CompletionSuggestion</a>&gt;)</b></dt><dd> 777 </dd><dt class="field"><b>results: List&lt;<a href="#type_CompletionSugges tion">CompletionSuggestion</a>&gt;</b></dt><dd>
781 778
782 <p> 779 <p>
783 The completion suggestions being reported. The notification contains 780 The completion suggestions being reported. The notification contains
784 all possible completions at the requested cursor position, even those 781 all possible completions at the requested cursor position, even those
785 that do not match the characters the user has already typed. This 782 that do not match the characters the user has already typed. This
786 allows the client to respond to further keystrokes from the user 783 allows the client to respond to further keystrokes from the user
787 without having to make additional requests. 784 without having to make additional requests.
788 </p> 785 </p>
789 </dd></dl></dd></dl> 786 </dd></dl></dd></dl>
790 <h2 class="domain"><a name="domain_edit">edit domain</a></h2> 787 <h2 class="domain"><a name="domain_edit">edit domain</a></h2>
791 <p> 788 <p>
792 The edit domain contains API's related to edits that can be applied to the 789 The edit domain contains API's related to edits that can be applied to the
793 code. 790 code.
794 </p> 791 </p>
795 792
796 793
797 794
798 795
799 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.getAssists">edit. getAssists</a> (<a href="#request_edit.getAssists">#</a>)</dt><dd><div class="bo x"><pre>request: { 796 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.getAssists">edit. getAssists</a></dt><dd><div class="box"><pre>request: {
800 "id": String 797 "id": String
801 "method": "edit.getAssists" 798 "method": "edit.getAssists"
802 "params": { 799 "params": {
803 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 800 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
804 "<b>offset</b>": int 801 "<b>offset</b>": int
805 "<b>length</b>": int 802 "<b>length</b>": int
806 } 803 }
807 }</pre><br><pre>response: { 804 }</pre><br><pre>response: {
808 "id": String 805 "id": String
809 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 806 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
810 "result": { 807 "result": {
811 "<b>assists</b>": List&lt;<a href="#type_PrioritizedSourceChange">Prioritize dSourceChange</a>&gt; 808 "<b>assists</b>": List&lt;<a href="#type_PrioritizedSourceChange">Prioritize dSourceChange</a>&gt;
812 } 809 }
813 }</pre></div> 810 }</pre></div>
814 <p> 811 <p>
815 Used to request the set of assists that are available at the given 812 Used to request the set of assists that are available at the given
816 location. An assist is distinguished from a refactoring primarily by the 813 location. An assist is distinguished from a refactoring primarily by the
817 fact that it affects a single file and does not require user input in 814 fact that it affects a single file and does not require user input in
818 order to be performed. 815 order to be performed.
819 </p> 816 </p>
820 817
821 818
822 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 819 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
823 820
824 <p> 821 <p>
825 The file containing the code for which assists are being requested. 822 The file containing the code for which assists are being requested.
826 </p> 823 </p>
827 </dd><dt class="field"><b>offset (int)</b></dt><dd> 824 </dd><dt class="field"><b>offset: int</b></dt><dd>
828 825
829 <p> 826 <p>
830 The offset of the code for which assists are being requested. 827 The offset of the code for which assists are being requested.
831 </p> 828 </p>
832 </dd><dt class="field"><b>length (int)</b></dt><dd> 829 </dd><dt class="field"><b>length: int</b></dt><dd>
833 830
834 <p> 831 <p>
835 The length of the code for which assists are being requested. 832 The length of the code for which assists are being requested.
836 </p> 833 </p>
837 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists (List&lt;<a hr ef="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>&gt;)</b></dt><dd> 834 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists: List&lt;<a hr ef="#type_PrioritizedSourceChange">PrioritizedSourceChange</a>&gt;</b></dt><dd>
838 835
839 <p> 836 <p>
840 The assists that are available at the given location. 837 The assists that are available at the given location.
841 </p> 838 </p>
842 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefac torings">edit.getAvailableRefactorings</a> (<a href="#request_edit.getAvailableR efactorings">#</a>)</dt><dd><div class="box"><pre>request: { 839 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableRefac torings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>request : {
843 "id": String 840 "id": String
844 "method": "edit.getAvailableRefactorings" 841 "method": "edit.getAvailableRefactorings"
845 "params": { 842 "params": {
846 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 843 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
847 "<b>offset</b>": int 844 "<b>offset</b>": int
848 "<b>length</b>": int 845 "<b>length</b>": int
849 } 846 }
850 }</pre><br><pre>response: { 847 }</pre><br><pre>response: {
851 "id": String 848 "id": String
852 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 849 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
853 "result": { 850 "result": {
854 "<b>kinds</b>": List&lt;<a href="#type_RefactoringKind">RefactoringKind</a>& gt; 851 "<b>kinds</b>": List&lt;<a href="#type_RefactoringKind">RefactoringKind</a>& gt;
855 } 852 }
856 }</pre></div> 853 }</pre></div>
857 <p> 854 <p>
858 Used to request a list of the kinds of refactorings that are valid for the 855 Used to request a list of the kinds of refactorings that are valid for the
859 given selection in the given file. 856 given selection in the given file.
860 </p> 857 </p>
861 858
862 859
863 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 860 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
864 861
865 <p> 862 <p>
866 The file containing the code on which the refactoring would be based. 863 The file containing the code on which the refactoring would be based.
867 </p> 864 </p>
868 </dd><dt class="field"><b>offset (int)</b></dt><dd> 865 </dd><dt class="field"><b>offset: int</b></dt><dd>
869 866
870 <p> 867 <p>
871 The offset of the code on which the refactoring would be based. 868 The offset of the code on which the refactoring would be based.
872 </p> 869 </p>
873 </dd><dt class="field"><b>length (int)</b></dt><dd> 870 </dd><dt class="field"><b>length: int</b></dt><dd>
874 871
875 <p> 872 <p>
876 The length of the code on which the refactoring would be based. 873 The length of the code on which the refactoring would be based.
877 </p> 874 </p>
878 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds (List&lt;<a href ="#type_RefactoringKind">RefactoringKind</a>&gt;)</b></dt><dd> 875 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds: List&lt;<a href ="#type_RefactoringKind">RefactoringKind</a>&gt;</b></dt><dd>
879 876
880 <p> 877 <p>
881 The kinds of refactorings that are valid for the given selection. 878 The kinds of refactorings that are valid for the given selection.
882 </p> 879 </p>
883 <p> 880 <p>
884 The list of refactoring kinds is currently limited to those defined by 881 The list of refactoring kinds is currently limited to those defined by
885 the server API, preventing plugins from adding their own refactorings. 882 the server API, preventing plugins from adding their own refactorings.
886 However, plugins can support pre-defined refactorings, such as a 883 However, plugins can support pre-defined refactorings, such as a
887 rename refactoring, at locations not supported by server. 884 rename refactoring, at locations not supported by server.
888 </p> 885 </p>
889 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.ge tFixes</a> (<a href="#request_edit.getFixes">#</a>)</dt><dd><div class="box"><pr e>request: { 886 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edit.ge tFixes</a></dt><dd><div class="box"><pre>request: {
890 "id": String 887 "id": String
891 "method": "edit.getFixes" 888 "method": "edit.getFixes"
892 "params": { 889 "params": {
893 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 890 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
894 "<b>offset</b>": int 891 "<b>offset</b>": int
895 } 892 }
896 }</pre><br><pre>response: { 893 }</pre><br><pre>response: {
897 "id": String 894 "id": String
898 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 895 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
899 "result": { 896 "result": {
900 "<b>fixes</b>": List&lt;<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>&gt; 897 "<b>fixes</b>": List&lt;<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe s</a>&gt;
901 } 898 }
902 }</pre></div> 899 }</pre></div>
903 <p> 900 <p>
904 Used to request the set of fixes that are available for the errors at a 901 Used to request the set of fixes that are available for the errors at a
905 given offset in a given file. 902 given offset in a given file.
906 </p> 903 </p>
907 904
908 905
909 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath">Fi lePath</a>)</b></dt><dd> 906 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">Fi lePath</a></b></dt><dd>
910 907
911 <p> 908 <p>
912 The file containing the errors for which fixes are being requested. 909 The file containing the errors for which fixes are being requested.
913 </p> 910 </p>
914 </dd><dt class="field"><b>offset (int)</b></dt><dd> 911 </dd><dt class="field"><b>offset: int</b></dt><dd>
915 912
916 <p> 913 <p>
917 The offset used to select the errors for which fixes will be returned. 914 The offset used to select the errors for which fixes will be returned.
918 </p> 915 </p>
919 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes (List&lt;<a href ="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>&gt;)</b></dt><dd> 916 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes: List&lt;<a href ="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>&gt;</b></dt><dd>
920 917
921 <p> 918 <p>
922 The fixes that are available for the errors at the given offset. 919 The fixes that are available for the errors at the given offset.
923 </p> 920 </p>
924 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactoring">e dit.getRefactoring</a> (<a href="#request_edit.getRefactoring">#</a>)</dt><dd><d iv class="box"><pre>request: { 921 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactoring">e dit.getRefactoring</a></dt><dd><div class="box"><pre>request: {
925 "id": String 922 "id": String
926 "method": "edit.getRefactoring" 923 "method": "edit.getRefactoring"
927 "params": { 924 "params": {
928 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> 925 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a>
929 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 926 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
930 "<b>offset</b>": int 927 "<b>offset</b>": int
931 "<b>length</b>": int 928 "<b>length</b>": int
932 "<b>validateOnly</b>": bool 929 "<b>validateOnly</b>": bool
933 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a> 930 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>
934 } 931 }
935 }</pre><br><pre>response: { 932 }</pre><br><pre>response: {
936 "id": String 933 "id": String
937 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 934 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
938 "result": { 935 "result": {
939 "<b>initialProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refacto ringProblem</a>&gt; 936 "<b>initialProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refacto ringProblem</a>&gt;
940 "<b>optionsProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refacto ringProblem</a>&gt; 937 "<b>optionsProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refacto ringProblem</a>&gt;
941 "<b>finalProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refactori ngProblem</a>&gt; 938 "<b>finalProblems</b>": List&lt;<a href="#type_RefactoringProblem">Refactori ngProblem</a>&gt;
942 "<b>feedback</b>": <span style="color:#999999">optional</span> <a href="#typ e_RefactoringFeedback">RefactoringFeedback</a> 939 "<b>feedback</b>": <span style="color:#999999">optional</span> <a href="#typ e_RefactoringFeedback">RefactoringFeedback</a>
943 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a> 940 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a>
944 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String&gt; 941 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String&gt;
945 } 942 }
946 }</pre></div> 943 }</pre></div>
947 <p> 944 <p>
948 Used to request the changes required to perform a refactoring. 945 Used to request the changes required to perform a refactoring.
949 </p> 946 </p>
950 947
951 948
952 <h4>parameters:</h4><dl><dt class="field"><b>kind (<a href="#type_RefactoringK ind">RefactoringKind</a>)</b></dt><dd> 949 <h4>parameters:</h4><dl><dt class="field"><b>kind: <a href="#type_RefactoringK ind">RefactoringKind</a></b></dt><dd>
953 950
954 <p> 951 <p>
955 The kind of refactoring to be performed. 952 The kind of refactoring to be performed.
956 </p> 953 </p>
957 </dd><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b> </dt><dd> 954 </dd><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b>< /dt><dd>
958 955
959 <p> 956 <p>
960 The file containing the code involved in the refactoring. 957 The file containing the code involved in the refactoring.
961 </p> 958 </p>
962 </dd><dt class="field"><b>offset (int)</b></dt><dd> 959 </dd><dt class="field"><b>offset: int</b></dt><dd>
963 960
964 <p> 961 <p>
965 The offset of the region involved in the refactoring. 962 The offset of the region involved in the refactoring.
966 </p> 963 </p>
967 </dd><dt class="field"><b>length (int)</b></dt><dd> 964 </dd><dt class="field"><b>length: int</b></dt><dd>
968 965
969 <p> 966 <p>
970 The length of the region involved in the refactoring. 967 The length of the region involved in the refactoring.
971 </p> 968 </p>
972 </dd><dt class="field"><b>validateOnly (bool)</b></dt><dd> 969 </dd><dt class="field"><b>validateOnly: bool</b></dt><dd>
973 970
974 <p> 971 <p>
975 True if the client is only requesting that the values of the options 972 True if the client is only requesting that the values of the options
976 be validated and no change be generated. 973 be validated and no change be generated.
977 </p> 974 </p>
978 </dd><dt class="field"><b>options (<span style="color:#999999">optional</s pan> <a href="#type_RefactoringOptions">RefactoringOptions</a>)</b></dt><dd> 975 </dd><dt class="field"><b>options: <a href="#type_RefactoringOptions">Refa ctoringOptions</a><span style="color:#999999"> (optional)</span></b></dt><dd>
979 976
980 <p> 977 <p>
981 Data used to provide values provided by the user. The structure of the 978 Data used to provide values provided by the user. The structure of the
982 data is dependent on the kind of refactoring being performed. The data 979 data is dependent on the kind of refactoring being performed. The data
983 that is expected is documented in the section titled 980 that is expected is documented in the section titled
984 <a href="#refactorings">Refactorings</a>, labeled as "Options". This 981 <a href="#refactorings">Refactorings</a>, labeled as "Options". This
985 field can be omitted if the refactoring does not require any options 982 field can be omitted if the refactoring does not require any options
986 or if the values of those options are not known. 983 or if the values of those options are not known.
987 </p> 984 </p>
988 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems (List& lt;<a href="#type_RefactoringProblem">RefactoringProblem</a>&gt;)</b></dt><dd> 985 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems: List& lt;<a href="#type_RefactoringProblem">RefactoringProblem</a>&gt;</b></dt><dd>
989 986
990 <p> 987 <p>
991 The initial status of the refactoring, that is, problems related to 988 The initial status of the refactoring, that is, problems related to
992 the context in which the refactoring is requested. The list should be 989 the context in which the refactoring is requested. The list should be
993 empty if there are no known problems. 990 empty if there are no known problems.
994 </p> 991 </p>
995 </dd><dt class="field"><b>optionsProblems (List&lt;<a href="#type_Refactor ingProblem">RefactoringProblem</a>&gt;)</b></dt><dd> 992 </dd><dt class="field"><b>optionsProblems: List&lt;<a href="#type_Refactor ingProblem">RefactoringProblem</a>&gt;</b></dt><dd>
996 993
997 <p> 994 <p>
998 The options validation status, that is, problems in the given options, 995 The options validation status, that is, problems in the given options,
999 such as light-weight validation of a new name, flags compatibility, 996 such as light-weight validation of a new name, flags compatibility,
1000 etc. The list should be empty if there are no known problems. 997 etc. The list should be empty if there are no known problems.
1001 </p> 998 </p>
1002 </dd><dt class="field"><b>finalProblems (List&lt;<a href="#type_Refactorin gProblem">RefactoringProblem</a>&gt;)</b></dt><dd> 999 </dd><dt class="field"><b>finalProblems: List&lt;<a href="#type_Refactorin gProblem">RefactoringProblem</a>&gt;</b></dt><dd>
1003 1000
1004 <p> 1001 <p>
1005 The final status of the refactoring, that is, problems identified in 1002 The final status of the refactoring, that is, problems identified in
1006 the result of a full, potentially expensive validation and / or change 1003 the result of a full, potentially expensive validation and / or change
1007 creation. The list should be empty if there are no known problems. 1004 creation. The list should be empty if there are no known problems.
1008 </p> 1005 </p>
1009 </dd><dt class="field"><b>feedback (<span style="color:#999999">optional</ span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</b></dt><dd> 1006 </dd><dt class="field"><b>feedback: <a href="#type_RefactoringFeedback">Re factoringFeedback</a><span style="color:#999999"> (optional)</span></b></dt><dd>
1010 1007
1011 <p> 1008 <p>
1012 Data used to provide feedback to the user. The structure of the data 1009 Data used to provide feedback to the user. The structure of the data
1013 is dependent on the kind of refactoring being created. The data that 1010 is dependent on the kind of refactoring being created. The data that
1014 is returned is documented in the section titled 1011 is returned is documented in the section titled
1015 <a href="#refactorings">Refactorings</a>, labeled as "Feedback". 1012 <a href="#refactorings">Refactorings</a>, labeled as "Feedback".
1016 </p> 1013 </p>
1017 </dd><dt class="field"><b>change (<span style="color:#999999">optional</sp an> <a href="#type_SourceChange">SourceChange</a>)</b></dt><dd> 1014 </dd><dt class="field"><b>change: <a href="#type_SourceChange">SourceChang e</a><span style="color:#999999"> (optional)</span></b></dt><dd>
1018 1015
1019 <p> 1016 <p>
1020 The changes that are to be applied to affect the refactoring. This 1017 The changes that are to be applied to affect the refactoring. This
1021 field can be omitted if there are problems that prevent a set of 1018 field can be omitted if there are problems that prevent a set of
1022 changes from being computed, such as having no options specified for a 1019 changes from being computed, such as having no options specified for a
1023 refactoring that requires them, or if only validation was requested. 1020 refactoring that requires them, or if only validation was requested.
1024 </p> 1021 </p>
1025 </dd><dt class="field"><b>potentialEdits (<span style="color:#999999">opti onal</span> List&lt;String&gt;)</b></dt><dd> 1022 </dd><dt class="field"><b>potentialEdits: List&lt;String&gt;<span style="c olor:#999999"> (optional)</span></b></dt><dd>
1026 1023
1027 <p> 1024 <p>
1028 The ids of source edits that are not known to be valid. An edit is not 1025 The ids of source edits that are not known to be valid. An edit is not
1029 known to be valid if there was insufficient type information for the 1026 known to be valid if there was insufficient type information for the
1030 plugin to be able to determine whether or not the code needs to be 1027 plugin to be able to determine whether or not the code needs to be
1031 modified, such as when a member is being renamed and there is a 1028 modified, such as when a member is being renamed and there is a
1032 reference to a member from an unknown type. This field can be omitted 1029 reference to a member from an unknown type. This field can be omitted
1033 if the change field is omitted or if there are no potential edits for 1030 if the change field is omitted or if there are no potential edits for
1034 the refactoring. 1031 the refactoring.
1035 </p> 1032 </p>
(...skipping 22 matching lines...) Expand all
1058 content will be used for analysis in place of the file contents in the 1055 content will be used for analysis in place of the file contents in the
1059 filesystem. 1056 filesystem.
1060 </p> 1057 </p>
1061 <p> 1058 <p>
1062 If this directive is used on a file that already has a file content 1059 If this directive is used on a file that already has a file content
1063 overlay, the old overlay is discarded and replaced with the new one. 1060 overlay, the old overlay is discarded and replaced with the new one.
1064 </p> 1061 </p>
1065 1062
1066 <dl><dt class="field"><b>type = "add"</b></dt><dd> 1063 <dl><dt class="field"><b>type = "add"</b></dt><dd>
1067 1064
1068 </dd><dt class="field"><b>content (String)</b></dt><dd> 1065 </dd><dt class="field"><b>content: String</b></dt><dd>
1069 1066
1070 <p> 1067 <p>
1071 The new content of the file. 1068 The new content of the file.
1072 </p> 1069 </p>
1073 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">Ana lysisError: object</a></dt><dd> 1070 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">Ana lysisError: object</a></dt><dd>
1074 <p> 1071 <p>
1075 An indication of an error, warning, or hint that was produced by the 1072 An indication of an error, warning, or hint that was produced by the
1076 analysis. 1073 analysis.
1077 </p> 1074 </p>
1078 1075
1079 <dl><dt class="field"><b>severity (<a href="#type_AnalysisErrorSeverity">Analy sisErrorSeverity</a>)</b></dt><dd> 1076 <dl><dt class="field"><b>severity: <a href="#type_AnalysisErrorSeverity">Analy sisErrorSeverity</a></b></dt><dd>
1080 1077
1081 <p> 1078 <p>
1082 The severity of the error. 1079 The severity of the error.
1083 </p> 1080 </p>
1084 </dd><dt class="field"><b>type (<a href="#type_AnalysisErrorType">Analysis ErrorType</a>)</b></dt><dd> 1081 </dd><dt class="field"><b>type: <a href="#type_AnalysisErrorType">Analysis ErrorType</a></b></dt><dd>
1085 1082
1086 <p> 1083 <p>
1087 The type of the error. 1084 The type of the error.
1088 </p> 1085 </p>
1089 </dd><dt class="field"><b>location (<a href="#type_Location">Location</a>) </b></dt><dd> 1086 </dd><dt class="field"><b>location: <a href="#type_Location">Location</a>< /b></dt><dd>
1090 1087
1091 <p> 1088 <p>
1092 The location associated with the error. 1089 The location associated with the error.
1093 </p> 1090 </p>
1094 </dd><dt class="field"><b>message (String)</b></dt><dd> 1091 </dd><dt class="field"><b>message: String</b></dt><dd>
1095 1092
1096 <p> 1093 <p>
1097 The message to be displayed for this error. The message should 1094 The message to be displayed for this error. The message should
1098 indicate what is wrong with the code and why it is wrong. 1095 indicate what is wrong with the code and why it is wrong.
1099 </p> 1096 </p>
1100 </dd><dt class="field"><b>correction (<span style="color:#999999">optional </span> String)</b></dt><dd> 1097 </dd><dt class="field"><b>correction: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1101 1098
1102 <p> 1099 <p>
1103 The correction message to be displayed for this error. The correction 1100 The correction message to be displayed for this error. The correction
1104 message should indicate how the user can fix the error. The field is 1101 message should indicate how the user can fix the error. The field is
1105 omitted if there is no correction message associated with the error 1102 omitted if there is no correction message associated with the error
1106 code. 1103 code.
1107 </p> 1104 </p>
1108 </dd><dt class="field"><b>code (String)</b></dt><dd> 1105 </dd><dt class="field"><b>code: String</b></dt><dd>
1109 1106
1110 <p> 1107 <p>
1111 The name, as a string, of the error code associated with this error. 1108 The name, as a string, of the error code associated with this error.
1112 </p> 1109 </p>
1113 </dd><dt class="field"><b>hasFix (<span style="color:#999999">optional</sp an> bool)</b></dt><dd> 1110 </dd><dt class="field"><b>hasFix: bool<span style="color:#999999"> (option al)</span></b></dt><dd>
1114 1111
1115 <p> 1112 <p>
1116 A hint to indicate to interested clients that this error has an 1113 A hint to indicate to interested clients that this error has an
1117 associated fix (or fixes). The absence of this field implies there 1114 associated fix (or fixes). The absence of this field implies there
1118 are not known to be fixes. Note that since the operation to calculate 1115 are not known to be fixes. Note that since the operation to calculate
1119 whether fixes apply needs to be performant it is possible that 1116 whether fixes apply needs to be performant it is possible that
1120 complicated tests will be skipped and a false negative returned. For 1117 complicated tests will be skipped and a false negative returned. For
1121 this reason, this attribute should be treated as a "hint". Despite the 1118 this reason, this attribute should be treated as a "hint". Despite the
1122 possibility of false negatives, no false positives should be returned. 1119 possibility of false negatives, no false positives should be returned.
1123 If a client sees this flag set they can proceed with the confidence 1120 If a client sees this flag set they can proceed with the confidence
1124 that there are in fact associated fixes. 1121 that there are in fact associated fixes.
1125 </p> 1122 </p>
1126 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorFixes ">AnalysisErrorFixes: object</a></dt><dd> 1123 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorFixes ">AnalysisErrorFixes: object</a></dt><dd>
1127 <p> 1124 <p>
1128 A list of fixes associated with a specific error 1125 A list of fixes associated with a specific error
1129 </p> 1126 </p>
1130 1127
1131 <dl><dt class="field"><b>error (<a href="#type_AnalysisError">AnalysisError</a >)</b></dt><dd> 1128 <dl><dt class="field"><b>error: <a href="#type_AnalysisError">AnalysisError</a ></b></dt><dd>
1132 1129
1133 <p> 1130 <p>
1134 The error with which the fixes are associated. 1131 The error with which the fixes are associated.
1135 </p> 1132 </p>
1136 </dd><dt class="field"><b>fixes (List&lt;<a href="#type_PrioritizedSourceC hange">PrioritizedSourceChange</a>&gt;)</b></dt><dd> 1133 </dd><dt class="field"><b>fixes: List&lt;<a href="#type_PrioritizedSourceC hange">PrioritizedSourceChange</a>&gt;</b></dt><dd>
1137 1134
1138 <p> 1135 <p>
1139 The fixes associated with the error. 1136 The fixes associated with the error.
1140 </p> 1137 </p>
1141 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorSever ity">AnalysisErrorSeverity: String</a></dt><dd> 1138 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorSever ity">AnalysisErrorSeverity: String</a></dt><dd>
1142 <p> 1139 <p>
1143 An enumeration of the possible severities of analysis errors. 1140 An enumeration of the possible severities of analysis errors.
1144 </p> 1141 </p>
1145 1142
1146 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value" >ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorType" >AnalysisErrorType: String</a></dt><dd> 1143 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value" >ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorType" >AnalysisErrorType: String</a></dt><dd>
(...skipping 23 matching lines...) Expand all
1170 content overlay or that has had its overlay removed via 1167 content overlay or that has had its overlay removed via
1171 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. 1168 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.
1172 </p> 1169 </p>
1173 <p> 1170 <p>
1174 If any of the edits cannot be applied due to its offset or length being 1171 If any of the edits cannot be applied due to its offset or length being
1175 out of range, an <tt>INVALID_OVERLAY_CHANGE</tt> error will be reported. 1172 out of range, an <tt>INVALID_OVERLAY_CHANGE</tt> error will be reported.
1176 </p> 1173 </p>
1177 1174
1178 <dl><dt class="field"><b>type = "change"</b></dt><dd> 1175 <dl><dt class="field"><b>type = "change"</b></dt><dd>
1179 1176
1180 </dd><dt class="field"><b>edits (List&lt;<a href="#type_SourceEdit">Source Edit</a>&gt;)</b></dt><dd> 1177 </dd><dt class="field"><b>edits: List&lt;<a href="#type_SourceEdit">Source Edit</a>&gt;</b></dt><dd>
1181 1178
1182 <p> 1179 <p>
1183 The edits to be applied to the file. 1180 The edits to be applied to the file.
1184 </p> 1181 </p>
1185 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggesti on">CompletionSuggestion: object</a></dt><dd> 1182 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggesti on">CompletionSuggestion: object</a></dt><dd>
1186 <p> 1183 <p>
1187 A suggestion for how to complete partially entered text. Many of the 1184 A suggestion for how to complete partially entered text. Many of the
1188 fields are optional, depending on the kind of element being suggested. 1185 fields are optional, depending on the kind of element being suggested.
1189 </p> 1186 </p>
1190 1187
1191 <dl><dt class="field"><b>kind (<a href="#type_CompletionSuggestionKind">Comple tionSuggestionKind</a>)</b></dt><dd> 1188 <dl><dt class="field"><b>kind: <a href="#type_CompletionSuggestionKind">Comple tionSuggestionKind</a></b></dt><dd>
1192 1189
1193 <p> 1190 <p>
1194 The kind of element being suggested. 1191 The kind of element being suggested.
1195 </p> 1192 </p>
1196 </dd><dt class="field"><b>relevance (int)</b></dt><dd> 1193 </dd><dt class="field"><b>relevance: int</b></dt><dd>
1197 1194
1198 <p> 1195 <p>
1199 The relevance of this completion suggestion where a higher number 1196 The relevance of this completion suggestion where a higher number
1200 indicates a higher relevance. 1197 indicates a higher relevance.
1201 </p> 1198 </p>
1202 </dd><dt class="field"><b>completion (String)</b></dt><dd> 1199 </dd><dt class="field"><b>completion: String</b></dt><dd>
1203 1200
1204 <p> 1201 <p>
1205 The identifier to be inserted if the suggestion is selected. If the 1202 The identifier to be inserted if the suggestion is selected. If the
1206 suggestion is for a method or function, the client might want to 1203 suggestion is for a method or function, the client might want to
1207 additionally insert a template for the parameters. The information 1204 additionally insert a template for the parameters. The information
1208 required in order to do so is contained in other fields. 1205 required in order to do so is contained in other fields.
1209 </p> 1206 </p>
1210 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> 1207 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd>
1211 1208
1212 <p> 1209 <p>
1213 The offset, relative to the beginning of the completion, of where the 1210 The offset, relative to the beginning of the completion, of where the
1214 selection should be placed after insertion. 1211 selection should be placed after insertion.
1215 </p> 1212 </p>
1216 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> 1213 </dd><dt class="field"><b>selectionLength: int</b></dt><dd>
1217 1214
1218 <p> 1215 <p>
1219 The number of characters that should be selected after insertion. 1216 The number of characters that should be selected after insertion.
1220 </p> 1217 </p>
1221 </dd><dt class="field"><b>isDeprecated (bool)</b></dt><dd> 1218 </dd><dt class="field"><b>isDeprecated: bool</b></dt><dd>
1222 1219
1223 <p> 1220 <p>
1224 True if the suggested element is deprecated. 1221 True if the suggested element is deprecated.
1225 </p> 1222 </p>
1226 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd> 1223 </dd><dt class="field"><b>isPotential: bool</b></dt><dd>
1227 1224
1228 <p> 1225 <p>
1229 True if the element is not known to be valid for the target. This 1226 True if the element is not known to be valid for the target. This
1230 happens if the type of the target is dynamic. 1227 happens if the type of the target is dynamic.
1231 </p> 1228 </p>
1232 </dd><dt class="field"><b>docSummary (<span style="color:#999999">optional </span> String)</b></dt><dd> 1229 </dd><dt class="field"><b>docSummary: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1233 1230
1234 <p> 1231 <p>
1235 An abbreviated version of the Dartdoc associated with the element 1232 An abbreviated version of the Dartdoc associated with the element
1236 being suggested, This field is omitted if there is no Dartdoc 1233 being suggested, This field is omitted if there is no Dartdoc
1237 associated with the element. 1234 associated with the element.
1238 </p> 1235 </p>
1239 </dd><dt class="field"><b>docComplete (<span style="color:#999999">optiona l</span> String)</b></dt><dd> 1236 </dd><dt class="field"><b>docComplete: String<span style="color:#999999"> (optional)</span></b></dt><dd>
1240 1237
1241 <p> 1238 <p>
1242 The Dartdoc associated with the element being suggested. This field is 1239 The Dartdoc associated with the element being suggested. This field is
1243 omitted if there is no Dartdoc associated with the element. 1240 omitted if there is no Dartdoc associated with the element.
1244 </p> 1241 </p>
1245 </dd><dt class="field"><b>declaringType (<span style="color:#999999">optio nal</span> String)</b></dt><dd> 1242 </dd><dt class="field"><b>declaringType: String<span style="color:#999999" > (optional)</span></b></dt><dd>
1246 1243
1247 <p> 1244 <p>
1248 The class that declares the element being suggested. This field is 1245 The class that declares the element being suggested. This field is
1249 omitted if the suggested element is not a member of a class. 1246 omitted if the suggested element is not a member of a class.
1250 </p> 1247 </p>
1251 </dd><dt class="field"><b>defaultArgumentListString (<span style="color:#9 99999">optional</span> String)</b></dt><dd> 1248 </dd><dt class="field"><b>defaultArgumentListString: String<span style="co lor:#999999"> (optional)</span></b></dt><dd>
1252 1249
1253 <p> 1250 <p>
1254 A default String for use in generating argument list source contents 1251 A default String for use in generating argument list source contents
1255 on the client side. 1252 on the client side.
1256 </p> 1253 </p>
1257 </dd><dt class="field"><b>defaultArgumentListTextRanges (<span style="colo r:#999999">optional</span> List&lt;int&gt;)</b></dt><dd> 1254 </dd><dt class="field"><b>defaultArgumentListTextRanges: List&lt;int&gt;<s pan style="color:#999999"> (optional)</span></b></dt><dd>
1258 1255
1259 <p> 1256 <p>
1260 Pairs of offsets and lengths describing 'defaultArgumentListString' 1257 Pairs of offsets and lengths describing 'defaultArgumentListString'
1261 text ranges suitable for use by clients to set up linked edits of 1258 text ranges suitable for use by clients to set up linked edits of
1262 default argument source contents. For example, given an argument list 1259 default argument source contents. For example, given an argument list
1263 string 'x, y', the corresponding text range [0, 1, 3, 1], indicates 1260 string 'x, y', the corresponding text range [0, 1, 3, 1], indicates
1264 two text ranges of length 1, starting at offsets 0 and 3. Clients can 1261 two text ranges of length 1, starting at offsets 0 and 3. Clients can
1265 use these ranges to treat the 'x' and 'y' values specially for linked 1262 use these ranges to treat the 'x' and 'y' values specially for linked
1266 edits. 1263 edits.
1267 </p> 1264 </p>
1268 </dd><dt class="field"><b>element (<span style="color:#999999">optional</s pan> <a href="#type_Element">Element</a>)</b></dt><dd> 1265 </dd><dt class="field"><b>element: <a href="#type_Element">Element</a><spa n style="color:#999999"> (optional)</span></b></dt><dd>
1269 1266
1270 <p> 1267 <p>
1271 Information about the element reference being suggested. 1268 Information about the element reference being suggested.
1272 </p> 1269 </p>
1273 </dd><dt class="field"><b>returnType (<span style="color:#999999">optional </span> String)</b></dt><dd> 1270 </dd><dt class="field"><b>returnType: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1274 1271
1275 <p> 1272 <p>
1276 The return type of the getter, function or method or the type of the 1273 The return type of the getter, function or method or the type of the
1277 field being suggested. This field is omitted if the suggested element 1274 field being suggested. This field is omitted if the suggested element
1278 is not a getter, function or method. 1275 is not a getter, function or method.
1279 </p> 1276 </p>
1280 </dd><dt class="field"><b>parameterNames (<span style="color:#999999">opti onal</span> List&lt;String&gt;)</b></dt><dd> 1277 </dd><dt class="field"><b>parameterNames: List&lt;String&gt;<span style="c olor:#999999"> (optional)</span></b></dt><dd>
1281 1278
1282 <p> 1279 <p>
1283 The names of the parameters of the function or method being suggested. 1280 The names of the parameters of the function or method being suggested.
1284 This field is omitted if the suggested element is not a setter, 1281 This field is omitted if the suggested element is not a setter,
1285 function or method. 1282 function or method.
1286 </p> 1283 </p>
1287 </dd><dt class="field"><b>parameterTypes (<span style="color:#999999">opti onal</span> List&lt;String&gt;)</b></dt><dd> 1284 </dd><dt class="field"><b>parameterTypes: List&lt;String&gt;<span style="c olor:#999999"> (optional)</span></b></dt><dd>
1288 1285
1289 <p> 1286 <p>
1290 The types of the parameters of the function or method being suggested. 1287 The types of the parameters of the function or method being suggested.
1291 This field is omitted if the parameterNames field is omitted. 1288 This field is omitted if the parameterNames field is omitted.
1292 </p> 1289 </p>
1293 </dd><dt class="field"><b>requiredParameterCount (<span style="color:#9999 99">optional</span> int)</b></dt><dd> 1290 </dd><dt class="field"><b>requiredParameterCount: int<span style="color:#9 99999"> (optional)</span></b></dt><dd>
1294 1291
1295 <p> 1292 <p>
1296 The number of required parameters for the function or method being 1293 The number of required parameters for the function or method being
1297 suggested. This field is omitted if the parameterNames field is 1294 suggested. This field is omitted if the parameterNames field is
1298 omitted. 1295 omitted.
1299 </p> 1296 </p>
1300 </dd><dt class="field"><b>hasNamedParameters (<span style="color:#999999"> optional</span> bool)</b></dt><dd> 1297 </dd><dt class="field"><b>hasNamedParameters: bool<span style="color:#9999 99"> (optional)</span></b></dt><dd>
1301 1298
1302 <p> 1299 <p>
1303 True if the function or method being suggested has at least one named 1300 True if the function or method being suggested has at least one named
1304 parameter. This field is omitted if the parameterNames field is 1301 parameter. This field is omitted if the parameterNames field is
1305 omitted. 1302 omitted.
1306 </p> 1303 </p>
1307 </dd><dt class="field"><b>parameterName (<span style="color:#999999">optio nal</span> String)</b></dt><dd> 1304 </dd><dt class="field"><b>parameterName: String<span style="color:#999999" > (optional)</span></b></dt><dd>
1308 1305
1309 <p> 1306 <p>
1310 The name of the optional parameter being suggested. This field is 1307 The name of the optional parameter being suggested. This field is
1311 omitted if the suggestion is not the addition of an optional argument 1308 omitted if the suggestion is not the addition of an optional argument
1312 within an argument list. 1309 within an argument list.
1313 </p> 1310 </p>
1314 </dd><dt class="field"><b>parameterType (<span style="color:#999999">optio nal</span> String)</b></dt><dd> 1311 </dd><dt class="field"><b>parameterType: String<span style="color:#999999" > (optional)</span></b></dt><dd>
1315 1312
1316 <p> 1313 <p>
1317 The type of the options parameter being suggested. This field is 1314 The type of the options parameter being suggested. This field is
1318 omitted if the parameterName field is omitted. 1315 omitted if the parameterName field is omitted.
1319 </p> 1316 </p>
1320 </dd><dt class="field"><b>importUri (<span style="color:#999999">optional< /span> String)</b></dt><dd> 1317 </dd><dt class="field"><b>importUri: String<span style="color:#999999"> (o ptional)</span></b></dt><dd>
1321 1318
1322 <p> 1319 <p>
1323 The import to be added if the suggestion is out of scope and needs 1320 The import to be added if the suggestion is out of scope and needs
1324 an import to be added to be in scope. 1321 an import to be added to be in scope.
1325 </p> 1322 </p>
1326 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggesti onKind">CompletionSuggestionKind: String</a></dt><dd> 1323 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSuggesti onKind">CompletionSuggestionKind: String</a></dt><dd>
1327 <p> 1324 <p>
1328 An enumeration of the kinds of elements that can be included in a 1325 An enumeration of the kinds of elements that can be included in a
1329 completion suggestion. 1326 completion suggestion.
1330 </p> 1327 </p>
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
1365 <p> 1362 <p>
1366 A named argument for the current call site is being suggested. For 1363 A named argument for the current call site is being suggested. For
1367 suggestions of this kind, the completion is the named argument 1364 suggestions of this kind, the completion is the named argument
1368 identifier including a trailing ':' and a space. 1365 identifier including a trailing ':' and a space.
1369 </p> 1366 </p>
1370 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</ dt></dl></dd><dt class="typeDefinition"><a name="type_ContextBuilderOptions">Con textBuilderOptions: object</a></dt><dd> 1367 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</ dt></dl></dd><dt class="typeDefinition"><a name="type_ContextBuilderOptions">Con textBuilderOptions: object</a></dt><dd>
1371 <p> 1368 <p>
1372 The options used to build an analysis context. 1369 The options used to build an analysis context.
1373 </p> 1370 </p>
1374 1371
1375 <dl><dt class="field"><b>dartSdkSummaryPath (<span style="color:#999999">optio nal</span> String)</b></dt><dd> 1372 <dl><dt class="field"><b>dartSdkSummaryPath: String<span style="color:#999999" > (optional)</span></b></dt><dd>
1376 1373
1377 <p> 1374 <p>
1378 The file path of the file containing the summary of the SDK that 1375 The file path of the file containing the summary of the SDK that
1379 should be used to "analyze" the SDK. The field will be omitted if the 1376 should be used to "analyze" the SDK. The field will be omitted if the
1380 summary should be found in the SDK. 1377 summary should be found in the SDK.
1381 </p> 1378 </p>
1382 </dd><dt class="field"><b>defaultAnalysisOptionsFilePath (<span style="col or:#999999">optional</span> List&lt;String&gt;)</b></dt><dd> 1379 </dd><dt class="field"><b>defaultAnalysisOptionsFilePath: List&lt;String&g t;<span style="color:#999999"> (optional)</span></b></dt><dd>
1383 1380
1384 <p> 1381 <p>
1385 The file path of the analysis options file that should be used in 1382 The file path of the analysis options file that should be used in
1386 place of any file in the root directory or a parent of the root 1383 place of any file in the root directory or a parent of the root
1387 directory. The field will be omitted if the normal lookup mechanism 1384 directory. The field will be omitted if the normal lookup mechanism
1388 should be used. 1385 should be used.
1389 </p> 1386 </p>
1390 </dd><dt class="field"><b>declaredVariables (<span style="color:#999999">o ptional</span> Map&lt;String, String&gt;)</b></dt><dd> 1387 </dd><dt class="field"><b>declaredVariables: Map&lt;String, String&gt;<spa n style="color:#999999"> (optional)</span></b></dt><dd>
1391 1388
1392 <p> 1389 <p>
1393 A table mapping variable names to values for the declared variables. 1390 A table mapping variable names to values for the declared variables.
1394 The field will be omitted if no additional variables need to be 1391 The field will be omitted if no additional variables need to be
1395 declared. 1392 declared.
1396 </p> 1393 </p>
1397 </dd><dt class="field"><b>defaultPackageFilePath (<span style="color:#9999 99">optional</span> List&lt;String&gt;)</b></dt><dd> 1394 </dd><dt class="field"><b>defaultPackageFilePath: List&lt;String&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
1398 1395
1399 <p> 1396 <p>
1400 The file path of the .packages file that should be used in place of 1397 The file path of the .packages file that should be used in place of
1401 any file found using the normal (Package Specification DEP) lookup 1398 any file found using the normal (Package Specification DEP) lookup
1402 mechanism. The field will be omitted if the normal lookup mechanism 1399 mechanism. The field will be omitted if the normal lookup mechanism
1403 should be used. 1400 should be used.
1404 </p> 1401 </p>
1405 </dd><dt class="field"><b>defaultPackagesDirectoryPath (<span style="color :#999999">optional</span> List&lt;String&gt;)</b></dt><dd> 1402 </dd><dt class="field"><b>defaultPackagesDirectoryPath: List&lt;String&gt; <span style="color:#999999"> (optional)</span></b></dt><dd>
1406 1403
1407 <p> 1404 <p>
1408 The file path of the packages directory that should be used in place 1405 The file path of the packages directory that should be used in place
1409 of any file found using the normal (Package Specification DEP) lookup 1406 of any file found using the normal (Package Specification DEP) lookup
1410 mechanism. The field will be omitted if the normal lookup mechanism 1407 mechanism. The field will be omitted if the normal lookup mechanism
1411 should be used. 1408 should be used.
1412 </p> 1409 </p>
1413 </dd></dl></dd><dt class="typeDefinition"><a name="type_ContextRoot">Conte xtRoot: object</a></dt><dd> 1410 </dd></dl></dd><dt class="typeDefinition"><a name="type_ContextRoot">Conte xtRoot: object</a></dt><dd>
1414 <p> 1411 <p>
1415 A description of an analysis context. 1412 A description of an analysis context.
1416 </p> 1413 </p>
1417 1414
1418 <dl><dt class="field"><b>root (String)</b></dt><dd> 1415 <dl><dt class="field"><b>root: String</b></dt><dd>
1419 1416
1420 <p> 1417 <p>
1421 The absolute path of the root directory containing the files to be 1418 The absolute path of the root directory containing the files to be
1422 analyzed. 1419 analyzed.
1423 </p> 1420 </p>
1424 </dd><dt class="field"><b>exclude (List&lt;String&gt;)</b></dt><dd> 1421 </dd><dt class="field"><b>exclude: List&lt;String&gt;</b></dt><dd>
1425 1422
1426 <p> 1423 <p>
1427 A list of the absolute paths of files and directories within the root 1424 A list of the absolute paths of files and directories within the root
1428 directory that should not be analyzed. 1425 directory that should not be analyzed.
1429 </p> 1426 </p>
1430 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd> 1427 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Element: object</a></dt><dd>
1431 <p> 1428 <p>
1432 Information about an element (something that can be declared in code). 1429 Information about an element (something that can be declared in code).
1433 </p> 1430 </p>
1434 1431
1435 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>)</b ></dt><dd> 1432 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a></b> </dt><dd>
1436 1433
1437 <p> 1434 <p>
1438 The kind of the element. 1435 The kind of the element.
1439 </p> 1436 </p>
1440 </dd><dt class="field"><b>name (String)</b></dt><dd> 1437 </dd><dt class="field"><b>name: String</b></dt><dd>
1441 1438
1442 <p> 1439 <p>
1443 The name of the element. This is typically used as the label in the 1440 The name of the element. This is typically used as the label in the
1444 outline. 1441 outline.
1445 </p> 1442 </p>
1446 </dd><dt class="field"><b>location (<span style="color:#999999">optional</ span> <a href="#type_Location">Location</a>)</b></dt><dd> 1443 </dd><dt class="field"><b>location: <a href="#type_Location">Location</a>< span style="color:#999999"> (optional)</span></b></dt><dd>
1447 1444
1448 <p> 1445 <p>
1449 The location of the name in the declaration of the element. 1446 The location of the name in the declaration of the element.
1450 </p> 1447 </p>
1451 </dd><dt class="field"><b>flags (int)</b></dt><dd> 1448 </dd><dt class="field"><b>flags: int</b></dt><dd>
1452 1449
1453 <p> 1450 <p>
1454 A bit-map containing the following flags: 1451 A bit-map containing the following flags:
1455 </p> 1452 </p>
1456 <ul> 1453 <ul>
1457 <li> 1454 <li>
1458 0x01 - set if the element is explicitly or implicitly abstract 1455 0x01 - set if the element is explicitly or implicitly abstract
1459 </li> 1456 </li>
1460 <li> 1457 <li>
1461 0x02 - set if the element was declared to be ‘const’ 1458 0x02 - set if the element was declared to be ‘const’
1462 </li> 1459 </li>
1463 <li> 1460 <li>
1464 0x04 - set if the element was declared to be ‘final’ 1461 0x04 - set if the element was declared to be ‘final’
1465 </li> 1462 </li>
1466 <li> 1463 <li>
1467 0x08 - set if the element is a static member of a class or is a 1464 0x08 - set if the element is a static member of a class or is a
1468 top-level function or field 1465 top-level function or field
1469 </li> 1466 </li>
1470 <li> 1467 <li>
1471 0x10 - set if the element is private 1468 0x10 - set if the element is private
1472 </li> 1469 </li>
1473 <li> 1470 <li>
1474 0x20 - set if the element is deprecated 1471 0x20 - set if the element is deprecated
1475 </li> 1472 </li>
1476 </ul> 1473 </ul>
1477 </dd><dt class="field"><b>parameters (<span style="color:#999999">optional </span> String)</b></dt><dd> 1474 </dd><dt class="field"><b>parameters: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1478 1475
1479 <p> 1476 <p>
1480 The parameter list for the element. If the element is not a method or 1477 The parameter list for the element. If the element is not a method or
1481 function this field will not be defined. If the element doesn't have 1478 function this field will not be defined. If the element doesn't have
1482 parameters (e.g. getter), this field will not be defined. If the 1479 parameters (e.g. getter), this field will not be defined. If the
1483 element has zero parameters, this field will have a value of "()". 1480 element has zero parameters, this field will have a value of "()".
1484 </p> 1481 </p>
1485 </dd><dt class="field"><b>returnType (<span style="color:#999999">optional </span> String)</b></dt><dd> 1482 </dd><dt class="field"><b>returnType: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1486 1483
1487 <p> 1484 <p>
1488 The return type of the element. If the element is not a method or 1485 The return type of the element. If the element is not a method or
1489 function this field will not be defined. If the element does not have 1486 function this field will not be defined. If the element does not have
1490 a declared return type, this field will contain an empty string. 1487 a declared return type, this field will contain an empty string.
1491 </p> 1488 </p>
1492 </dd><dt class="field"><b>typeParameters (<span style="color:#999999">opti onal</span> String)</b></dt><dd> 1489 </dd><dt class="field"><b>typeParameters: String<span style="color:#999999 "> (optional)</span></b></dt><dd>
1493 1490
1494 <p> 1491 <p>
1495 The type parameter list for the element. If the element doesn't have 1492 The type parameter list for the element. If the element doesn't have
1496 type parameters, this field will not be defined. 1493 type parameters, this field will not be defined.
1497 </p> 1494 </p>
1498 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">Eleme ntKind: String</a></dt><dd> 1495 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">Eleme ntKind: String</a></dt><dd>
1499 <p> 1496 <p>
1500 An enumeration of the kinds of elements. 1497 An enumeration of the kinds of elements.
1501 </p> 1498 </p>
1502 1499
1503 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt cla ss="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="val ue">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTIO N_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt cl ass="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">M ETHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class ="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">T YPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dd> 1500 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt cla ss="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class="val ue">ENUM</dt><dt class="value">ENUM_CONSTANT</dt><dt class="value">FIELD</dt><dt class="value">FILE</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTIO N_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><dt cl ass="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">M ETHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt class ="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">T YPE_PARAMETER</dt><dt class="value deprecated">UNIT_TEST_GROUP</dt><dd>
1504 1501
1505 <p><b>Deprecated:</b> support for tests was removed.</p> 1502 <p><b>Deprecated:</b> support for tests was removed.</p>
1506 </dd><dt class="value">UNIT_TEST_TEST</dt><dd> 1503 </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd>
1507 1504
1508 <p><b>Deprecated:</b> support for tests was removed.</p> 1505 <p><b>Deprecated:</b> support for tests was removed.</p>
1509 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd> 1506 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition"><a name="type_FilePath">FilePath: String</a></dt><dd>
1510 1507
1511 <p> 1508 <p>
1512 The absolute, normalized path of a file. 1509 The absolute, normalized path of a file.
1513 </p> 1510 </p>
1514 <p> 1511 <p>
1515 If the format of a file path in a request is not valid, e.g. the path is 1512 If the format of a file path in a request is not valid, e.g. the path is
1516 not absolute or is not normalized, then an error of type 1513 not absolute or is not normalized, then an error of type
1517 <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated. 1514 <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated.
1518 </p> 1515 </p>
1519 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: String </a></dt><dd> 1516 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: String </a></dt><dd>
1520 <p> 1517 <p>
1521 An enumeration of the kinds of folding regions. 1518 An enumeration of the kinds of folding regions.
1522 </p> 1519 </p>
1523 1520
1524 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt class ="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt class="v alue">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name="ty pe_FoldingRegion">FoldingRegion: object</a></dt><dd> 1521 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt class ="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt class="v alue">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name="ty pe_FoldingRegion">FoldingRegion: object</a></dt><dd>
1525 <p> 1522 <p>
1526 A description of a region that can be folded. 1523 A description of a region that can be folded.
1527 </p> 1524 </p>
1528 1525
1529 <dl><dt class="field"><b>kind (<a href="#type_FoldingKind">FoldingKind</a>)</b ></dt><dd> 1526 <dl><dt class="field"><b>kind: <a href="#type_FoldingKind">FoldingKind</a></b> </dt><dd>
1530 1527
1531 <p> 1528 <p>
1532 The kind of the region. 1529 The kind of the region.
1533 </p> 1530 </p>
1534 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1531 </dd><dt class="field"><b>offset: int</b></dt><dd>
1535 1532
1536 <p> 1533 <p>
1537 The offset of the region to be folded. 1534 The offset of the region to be folded.
1538 </p> 1535 </p>
1539 </dd><dt class="field"><b>length (int)</b></dt><dd> 1536 </dd><dt class="field"><b>length: int</b></dt><dd>
1540 1537
1541 <p> 1538 <p>
1542 The length of the region to be folded. 1539 The length of the region to be folded.
1543 </p> 1540 </p>
1544 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegion">H ighlightRegion: object</a></dt><dd> 1541 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegion">H ighlightRegion: object</a></dt><dd>
1545 <p> 1542 <p>
1546 A description of a region that could have special highlighting associated 1543 A description of a region that could have special highlighting associated
1547 with it. 1544 with it.
1548 </p> 1545 </p>
1549 1546
1550 <dl><dt class="field"><b>type (<a href="#type_HighlightRegionType">HighlightRe gionType</a>)</b></dt><dd> 1547 <dl><dt class="field"><b>type: <a href="#type_HighlightRegionType">HighlightRe gionType</a></b></dt><dd>
1551 1548
1552 <p> 1549 <p>
1553 The type of highlight associated with the region. 1550 The type of highlight associated with the region.
1554 </p> 1551 </p>
1555 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1552 </dd><dt class="field"><b>offset: int</b></dt><dd>
1556 1553
1557 <p> 1554 <p>
1558 The offset of the region to be highlighted. 1555 The offset of the region to be highlighted.
1559 </p> 1556 </p>
1560 </dd><dt class="field"><b>length (int)</b></dt><dd> 1557 </dd><dt class="field"><b>length: int</b></dt><dd>
1561 1558
1562 <p> 1559 <p>
1563 The length of the region to be highlighted. 1560 The length of the region to be highlighted.
1564 </p> 1561 </p>
1565 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegionTyp e">HighlightRegionType: String</a></dt><dd> 1562 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegionTyp e">HighlightRegionType: String</a></dt><dd>
1566 <p> 1563 <p>
1567 An enumeration of the kinds of highlighting that can be applied to files. 1564 An enumeration of the kinds of highlighting that can be applied to files.
1568 </p> 1565 </p>
1569 1566
1570 <dl><dt class="value">ANNOTATION</dt><dt class="value">BUILT_IN</dt><dt class= "value">CLASS</dt><dt class="value">COMMENT_BLOCK</dt><dt class="value">COMMENT_ DOCUMENTATION</dt><dt class="value">COMMENT_END_OF_LINE</dt><dt class="value">CO NSTRUCTOR</dt><dt class="value">DIRECTIVE</dt><dt class="value">DYNAMIC_TYPE</dt ><dd> 1567 <dl><dt class="value">ANNOTATION</dt><dt class="value">BUILT_IN</dt><dt class= "value">CLASS</dt><dt class="value">COMMENT_BLOCK</dt><dt class="value">COMMENT_ DOCUMENTATION</dt><dt class="value">COMMENT_END_OF_LINE</dt><dt class="value">CO NSTRUCTOR</dt><dt class="value">DIRECTIVE</dt><dt class="value">DYNAMIC_TYPE</dt ><dd>
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after
1717 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">L inkedEditGroup: object</a></dt><dd> 1714 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">L inkedEditGroup: object</a></dt><dd>
1718 <p> 1715 <p>
1719 A collection of positions that should be linked (edited simultaneously) 1716 A collection of positions that should be linked (edited simultaneously)
1720 for the purposes of updating code after a source change. For example, if a 1717 for the purposes of updating code after a source change. For example, if a
1721 set of edits introduced a new variable name, the group would contain all 1718 set of edits introduced a new variable name, the group would contain all
1722 of the positions of the variable name so that if the client wanted to let 1719 of the positions of the variable name so that if the client wanted to let
1723 the user edit the variable name after the operation, all occurrences of 1720 the user edit the variable name after the operation, all occurrences of
1724 the name could be edited simultaneously. 1721 the name could be edited simultaneously.
1725 </p> 1722 </p>
1726 1723
1727 <dl><dt class="field"><b>positions (List&lt;<a href="#type_Position">Position< /a>&gt;)</b></dt><dd> 1724 <dl><dt class="field"><b>positions: List&lt;<a href="#type_Position">Position< /a>&gt;</b></dt><dd>
1728 1725
1729 <p> 1726 <p>
1730 The positions of the regions that should be edited simultaneously. 1727 The positions of the regions that should be edited simultaneously.
1731 </p> 1728 </p>
1732 </dd><dt class="field"><b>length (int)</b></dt><dd> 1729 </dd><dt class="field"><b>length: int</b></dt><dd>
1733 1730
1734 <p> 1731 <p>
1735 The length of the regions that should be edited simultaneously. 1732 The length of the regions that should be edited simultaneously.
1736 </p> 1733 </p>
1737 </dd><dt class="field"><b>suggestions (List&lt;<a href="#type_LinkedEditSu ggestion">LinkedEditSuggestion</a>&gt;)</b></dt><dd> 1734 </dd><dt class="field"><b>suggestions: List&lt;<a href="#type_LinkedEditSu ggestion">LinkedEditSuggestion</a>&gt;</b></dt><dd>
1738 1735
1739 <p> 1736 <p>
1740 Pre-computed suggestions for what every region might want to be 1737 Pre-computed suggestions for what every region might want to be
1741 changed to. 1738 changed to.
1742 </p> 1739 </p>
1743 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggesti on">LinkedEditSuggestion: object</a></dt><dd> 1740 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggesti on">LinkedEditSuggestion: object</a></dt><dd>
1744 <p> 1741 <p>
1745 A suggestion of a value that could be used to replace all of the linked 1742 A suggestion of a value that could be used to replace all of the linked
1746 edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>. 1743 edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>.
1747 </p> 1744 </p>
1748 1745
1749 <dl><dt class="field"><b>value (String)</b></dt><dd> 1746 <dl><dt class="field"><b>value: String</b></dt><dd>
1750 1747
1751 <p> 1748 <p>
1752 The value that could be used to replace all of the linked edit 1749 The value that could be used to replace all of the linked edit
1753 regions. 1750 regions.
1754 </p> 1751 </p>
1755 </dd><dt class="field"><b>kind (<a href="#type_LinkedEditSuggestionKind">L inkedEditSuggestionKind</a>)</b></dt><dd> 1752 </dd><dt class="field"><b>kind: <a href="#type_LinkedEditSuggestionKind">L inkedEditSuggestionKind</a></b></dt><dd>
1756 1753
1757 <p> 1754 <p>
1758 The kind of value being proposed. 1755 The kind of value being proposed.
1759 </p> 1756 </p>
1760 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggesti onKind">LinkedEditSuggestionKind: String</a></dt><dd> 1757 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSuggesti onKind">LinkedEditSuggestionKind: String</a></dt><dd>
1761 <p> 1758 <p>
1762 An enumeration of the kind of values that can be suggested for a linked 1759 An enumeration of the kind of values that can be suggested for a linked
1763 edit. 1760 edit.
1764 </p> 1761 </p>
1765 1762
1766 <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="va lue">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefinition "><a name="type_Location">Location: object</a></dt><dd> 1763 <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class="va lue">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefinition "><a name="type_Location">Location: object</a></dt><dd>
1767 <p> 1764 <p>
1768 A location (character range) within a file. 1765 A location (character range) within a file.
1769 </p> 1766 </p>
1770 1767
1771 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt> <dd> 1768 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt>< dd>
1772 1769
1773 <p> 1770 <p>
1774 The file containing the range. 1771 The file containing the range.
1775 </p> 1772 </p>
1776 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1773 </dd><dt class="field"><b>offset: int</b></dt><dd>
1777 1774
1778 <p> 1775 <p>
1779 The offset of the range. 1776 The offset of the range.
1780 </p> 1777 </p>
1781 </dd><dt class="field"><b>length (int)</b></dt><dd> 1778 </dd><dt class="field"><b>length: int</b></dt><dd>
1782 1779
1783 <p> 1780 <p>
1784 The length of the range. 1781 The length of the range.
1785 </p> 1782 </p>
1786 </dd><dt class="field"><b>startLine (int)</b></dt><dd> 1783 </dd><dt class="field"><b>startLine: int</b></dt><dd>
1787 1784
1788 <p> 1785 <p>
1789 The one-based index of the line containing the first character of the 1786 The one-based index of the line containing the first character of the
1790 range. 1787 range.
1791 </p> 1788 </p>
1792 </dd><dt class="field"><b>startColumn (int)</b></dt><dd> 1789 </dd><dt class="field"><b>startColumn: int</b></dt><dd>
1793 1790
1794 <p> 1791 <p>
1795 The one-based index of the column containing the first character of 1792 The one-based index of the column containing the first character of
1796 the range. 1793 the range.
1797 </p> 1794 </p>
1798 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegion"> NavigationRegion: object</a></dt><dd> 1795 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegion"> NavigationRegion: object</a></dt><dd>
1799 <p> 1796 <p>
1800 A description of a region from which the user can navigate to the 1797 A description of a region from which the user can navigate to the
1801 declaration of an element. 1798 declaration of an element.
1802 </p> 1799 </p>
1803 1800
1804 <dl><dt class="field"><b>offset (int)</b></dt><dd> 1801 <dl><dt class="field"><b>offset: int</b></dt><dd>
1805 1802
1806 <p> 1803 <p>
1807 The offset of the region from which the user can navigate. 1804 The offset of the region from which the user can navigate.
1808 </p> 1805 </p>
1809 </dd><dt class="field"><b>length (int)</b></dt><dd> 1806 </dd><dt class="field"><b>length: int</b></dt><dd>
1810 1807
1811 <p> 1808 <p>
1812 The length of the region from which the user can navigate. 1809 The length of the region from which the user can navigate.
1813 </p> 1810 </p>
1814 </dd><dt class="field"><b>targets (List&lt;int&gt;)</b></dt><dd> 1811 </dd><dt class="field"><b>targets: List&lt;int&gt;</b></dt><dd>
1815 1812
1816 <p> 1813 <p>
1817 The indexes of the targets (in the enclosing navigation response) to 1814 The indexes of the targets (in the enclosing navigation response) to
1818 which the given region is bound. By opening the target, clients can 1815 which the given region is bound. By opening the target, clients can
1819 implement one form of navigation. This list cannot be empty. 1816 implement one form of navigation. This list cannot be empty.
1820 </p> 1817 </p>
1821 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarget"> NavigationTarget: object</a></dt><dd> 1818 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarget"> NavigationTarget: object</a></dt><dd>
1822 <p> 1819 <p>
1823 A description of a target to which the user can navigate. 1820 A description of a target to which the user can navigate.
1824 </p> 1821 </p>
1825 1822
1826 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>)</b ></dt><dd> 1823 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a></b> </dt><dd>
1827 1824
1828 <p> 1825 <p>
1829 The kind of the element. 1826 The kind of the element.
1830 </p> 1827 </p>
1831 </dd><dt class="field"><b>fileIndex (int)</b></dt><dd> 1828 </dd><dt class="field"><b>fileIndex: int</b></dt><dd>
1832 1829
1833 <p> 1830 <p>
1834 The index of the file (in the enclosing navigation response) to 1831 The index of the file (in the enclosing navigation response) to
1835 navigate to. 1832 navigate to.
1836 </p> 1833 </p>
1837 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1834 </dd><dt class="field"><b>offset: int</b></dt><dd>
1838 1835
1839 <p> 1836 <p>
1840 The offset of the region to which the user can navigate. 1837 The offset of the region to which the user can navigate.
1841 </p> 1838 </p>
1842 </dd><dt class="field"><b>length (int)</b></dt><dd> 1839 </dd><dt class="field"><b>length: int</b></dt><dd>
1843 1840
1844 <p> 1841 <p>
1845 The length of the region to which the user can navigate. 1842 The length of the region to which the user can navigate.
1846 </p> 1843 </p>
1847 </dd><dt class="field"><b>startLine (int)</b></dt><dd> 1844 </dd><dt class="field"><b>startLine: int</b></dt><dd>
1848 1845
1849 <p> 1846 <p>
1850 The one-based index of the line containing the first character of the 1847 The one-based index of the line containing the first character of the
1851 region. 1848 region.
1852 </p> 1849 </p>
1853 </dd><dt class="field"><b>startColumn (int)</b></dt><dd> 1850 </dd><dt class="field"><b>startColumn: int</b></dt><dd>
1854 1851
1855 <p> 1852 <p>
1856 The one-based index of the column containing the first character of 1853 The one-based index of the column containing the first character of
1857 the region. 1854 the region.
1858 </p> 1855 </p>
1859 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">Occur rences: object</a></dt><dd> 1856 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">Occur rences: object</a></dt><dd>
1860 <p> 1857 <p>
1861 A description of the references to a single element within a single file. 1858 A description of the references to a single element within a single file.
1862 </p> 1859 </p>
1863 1860
1864 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b></dt ><dd> 1861 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b></dt> <dd>
1865 1862
1866 <p> 1863 <p>
1867 The element that was referenced. 1864 The element that was referenced.
1868 </p> 1865 </p>
1869 </dd><dt class="field"><b>offsets (List&lt;int&gt;)</b></dt><dd> 1866 </dd><dt class="field"><b>offsets: List&lt;int&gt;</b></dt><dd>
1870 1867
1871 <p> 1868 <p>
1872 The offsets of the name of the referenced element within the file. 1869 The offsets of the name of the referenced element within the file.
1873 </p> 1870 </p>
1874 </dd><dt class="field"><b>length (int)</b></dt><dd> 1871 </dd><dt class="field"><b>length: int</b></dt><dd>
1875 1872
1876 <p> 1873 <p>
1877 The length of the name of the referenced element. 1874 The length of the name of the referenced element.
1878 </p> 1875 </p>
1879 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outline: object</a></dt><dd> 1876 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outline: object</a></dt><dd>
1880 <p> 1877 <p>
1881 An node in the outline structure of a file. 1878 An node in the outline structure of a file.
1882 </p> 1879 </p>
1883 1880
1884 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b></dt ><dd> 1881 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b></dt> <dd>
1885 1882
1886 <p> 1883 <p>
1887 A description of the element represented by this node. 1884 A description of the element represented by this node.
1888 </p> 1885 </p>
1889 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1886 </dd><dt class="field"><b>offset: int</b></dt><dd>
1890 1887
1891 <p> 1888 <p>
1892 The offset of the first character of the element. This is different 1889 The offset of the first character of the element. This is different
1893 than the offset in the Element, which is the offset of the name of the 1890 than the offset in the Element, which is the offset of the name of the
1894 element. It can be used, for example, to map locations in the file 1891 element. It can be used, for example, to map locations in the file
1895 back to an outline. 1892 back to an outline.
1896 </p> 1893 </p>
1897 </dd><dt class="field"><b>length (int)</b></dt><dd> 1894 </dd><dt class="field"><b>length: int</b></dt><dd>
1898 1895
1899 <p> 1896 <p>
1900 The length of the element. 1897 The length of the element.
1901 </p> 1898 </p>
1902 </dd><dt class="field"><b>children (<span style="color:#999999">optional</ span> List&lt;<a href="#type_Outline">Outline</a>&gt;)</b></dt><dd> 1899 </dd><dt class="field"><b>children: List&lt;<a href="#type_Outline">Outlin e</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
1903 1900
1904 <p> 1901 <p>
1905 The children of the node. The field will be omitted if the node has no 1902 The children of the node. The field will be omitted if the node has no
1906 children. 1903 children.
1907 </p> 1904 </p>
1908 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Position : object</a></dt><dd> 1905 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Position : object</a></dt><dd>
1909 <p> 1906 <p>
1910 A position within a file. 1907 A position within a file.
1911 </p> 1908 </p>
1912 1909
1913 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt> <dd> 1910 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt>< dd>
1914 1911
1915 <p> 1912 <p>
1916 The file containing the position. 1913 The file containing the position.
1917 </p> 1914 </p>
1918 </dd><dt class="field"><b>offset (int)</b></dt><dd> 1915 </dd><dt class="field"><b>offset: int</b></dt><dd>
1919 1916
1920 <p> 1917 <p>
1921 The offset of the position. 1918 The offset of the position.
1922 </p> 1919 </p>
1923 </dd></dl></dd><dt class="typeDefinition"><a name="type_PrioritizedSourceC hange">PrioritizedSourceChange: object</a></dt><dd> 1920 </dd></dl></dd><dt class="typeDefinition"><a name="type_PrioritizedSourceC hange">PrioritizedSourceChange: object</a></dt><dd>
1924 <p> 1921 <p>
1925 A source change that has a priority associated with it. 1922 A source change that has a priority associated with it.
1926 </p> 1923 </p>
1927 1924
1928 <dl><dt class="field"><b>priority (int)</b></dt><dd> 1925 <dl><dt class="field"><b>priority: int</b></dt><dd>
1929 1926
1930 <p> 1927 <p>
1931 The priority of the change. The value is expected to be non-negative, 1928 The priority of the change. The value is expected to be non-negative,
1932 and zero (0) is the lowest priority. 1929 and zero (0) is the lowest priority.
1933 </p> 1930 </p>
1934 </dd><dt class="field"><b>change (<a href="#type_SourceChange">SourceChang e</a>)</b></dt><dd> 1931 </dd><dt class="field"><b>change: <a href="#type_SourceChange">SourceChang e</a></b></dt><dd>
1935 1932
1936 <p> 1933 <p>
1937 The change with which the relevance is associated. 1934 The change with which the relevance is associated.
1938 </p> 1935 </p>
1939 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFeedbac k">RefactoringFeedback: object</a></dt><dd> 1936 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFeedbac k">RefactoringFeedback: object</a></dt><dd>
1940 <p> 1937 <p>
1941 An abstract superclass of all refactoring feedbacks. 1938 An abstract superclass of all refactoring feedbacks.
1942 </p> 1939 </p>
1943 1940
1944 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKind">Refact oringKind: String</a></dt><dd> 1941 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKind">Refact oringKind: String</a></dt><dd>
1945 <p> 1942 <p>
1946 An enumeration of the kinds of refactorings that can be created. 1943 An enumeration of the kinds of refactorings that can be created.
1947 </p> 1944 </p>
1948 1945
1949 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVERT_M ETHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="valu e">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class="val ue">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENAME</ dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><a na me="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a></dt> <dd> 1946 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVERT_M ETHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="valu e">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class="val ue">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENAME</ dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><a na me="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a></dt> <dd>
1950 1947
1951 <p> 1948 <p>
1952 A description of a parameter in a method refactoring. 1949 A description of a parameter in a method refactoring.
1953 </p> 1950 </p>
1954 1951
1955 <dl><dt class="field"><b>id (<span style="color:#999999">optional</span> Strin g)</b></dt><dd> 1952 <dl><dt class="field"><b>id: String<span style="color:#999999"> (optional)</sp an></b></dt><dd>
1956 1953
1957 <p> 1954 <p>
1958 The unique identifier of the parameter. Clients may omit this field 1955 The unique identifier of the parameter. Clients may omit this field
1959 for the parameters they want to add. 1956 for the parameters they want to add.
1960 </p> 1957 </p>
1961 </dd><dt class="field"><b>kind (<a href="#type_RefactoringMethodParameterK ind">RefactoringMethodParameterKind</a>)</b></dt><dd> 1958 </dd><dt class="field"><b>kind: <a href="#type_RefactoringMethodParameterK ind">RefactoringMethodParameterKind</a></b></dt><dd>
1962 1959
1963 <p> 1960 <p>
1964 The kind of the parameter. 1961 The kind of the parameter.
1965 </p> 1962 </p>
1966 </dd><dt class="field"><b>type (String)</b></dt><dd> 1963 </dd><dt class="field"><b>type: String</b></dt><dd>
1967 1964
1968 <p> 1965 <p>
1969 The type that should be given to the parameter, or the return type of 1966 The type that should be given to the parameter, or the return type of
1970 the parameter's function type. 1967 the parameter's function type.
1971 </p> 1968 </p>
1972 </dd><dt class="field"><b>name (String)</b></dt><dd> 1969 </dd><dt class="field"><b>name: String</b></dt><dd>
1973 1970
1974 <p> 1971 <p>
1975 The name that should be given to the parameter. 1972 The name that should be given to the parameter.
1976 </p> 1973 </p>
1977 </dd><dt class="field"><b>parameters (<span style="color:#999999">optional </span> String)</b></dt><dd> 1974 </dd><dt class="field"><b>parameters: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
1978 1975
1979 <p> 1976 <p>
1980 The parameter list of the parameter's function type. If the parameter 1977 The parameter list of the parameter's function type. If the parameter
1981 is not of a function type, this field will not be defined. If the 1978 is not of a function type, this field will not be defined. If the
1982 function type has zero parameters, this field will have a value of 1979 function type has zero parameters, this field will have a value of
1983 '()'. 1980 '()'.
1984 </p> 1981 </p>
1985 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodP arameterKind">RefactoringMethodParameterKind: String</a></dt><dd> 1982 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodP arameterKind">RefactoringMethodParameterKind: String</a></dt><dd>
1986 <p> 1983 <p>
1987 An enumeration of the kinds of parameters. 1984 An enumeration of the kinds of parameters.
1988 </p> 1985 </p>
1989 1986
1990 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt class= "value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refactoring Options">RefactoringOptions: object</a></dt><dd> 1987 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt class= "value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refactoring Options">RefactoringOptions: object</a></dt><dd>
1991 <p> 1988 <p>
1992 An abstract superclass of all refactoring options. 1989 An abstract superclass of all refactoring options.
1993 </p> 1990 </p>
1994 1991
1995 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem">Ref actoringProblem: object</a></dt><dd> 1992 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem">Ref actoringProblem: object</a></dt><dd>
1996 <p> 1993 <p>
1997 A description of a problem related to a refactoring. 1994 A description of a problem related to a refactoring.
1998 </p> 1995 </p>
1999 1996
2000 <dl><dt class="field"><b>severity (<a href="#type_RefactoringProblemSeverity"> RefactoringProblemSeverity</a>)</b></dt><dd> 1997 <dl><dt class="field"><b>severity: <a href="#type_RefactoringProblemSeverity"> RefactoringProblemSeverity</a></b></dt><dd>
2001 1998
2002 <p> 1999 <p>
2003 The severity of the problem being represented. 2000 The severity of the problem being represented.
2004 </p> 2001 </p>
2005 </dd><dt class="field"><b>message (String)</b></dt><dd> 2002 </dd><dt class="field"><b>message: String</b></dt><dd>
2006 2003
2007 <p> 2004 <p>
2008 A human-readable description of the problem being represented. 2005 A human-readable description of the problem being represented.
2009 </p> 2006 </p>
2010 </dd><dt class="field"><b>location (<span style="color:#999999">optional</ span> <a href="#type_Location">Location</a>)</b></dt><dd> 2007 </dd><dt class="field"><b>location: <a href="#type_Location">Location</a>< span style="color:#999999"> (optional)</span></b></dt><dd>
2011 2008
2012 <p> 2009 <p>
2013 The location of the problem being represented. This field is omitted 2010 The location of the problem being represented. This field is omitted
2014 unless there is a specific location associated with the problem (such 2011 unless there is a specific location associated with the problem (such
2015 as a location where an element being renamed will be shadowed). 2012 as a location where an element being renamed will be shadowed).
2016 </p> 2013 </p>
2017 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem Severity">RefactoringProblemSeverity: String</a></dt><dd> 2014 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringProblem Severity">RefactoringProblemSeverity: String</a></dt><dd>
2018 <p> 2015 <p>
2019 An enumeration of the severities of problems that can be returned by the 2016 An enumeration of the severities of problems that can be returned by the
2020 refactoring requests. 2017 refactoring requests.
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
2065 </p> 2062 </p>
2066 2063
2067 <dl><dt class="field"><b>type = "remove"</b></dt><dd> 2064 <dl><dt class="field"><b>type = "remove"</b></dt><dd>
2068 2065
2069 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">Requ estError: object</a></dt><dd> 2066 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestError">Requ estError: object</a></dt><dd>
2070 <p> 2067 <p>
2071 An indication of a problem with the execution of the server, 2068 An indication of a problem with the execution of the server,
2072 typically in response to a request. 2069 typically in response to a request.
2073 </p> 2070 </p>
2074 2071
2075 <dl><dt class="field"><b>code (<a href="#type_RequestErrorCode">RequestErrorCo de</a>)</b></dt><dd> 2072 <dl><dt class="field"><b>code: <a href="#type_RequestErrorCode">RequestErrorCo de</a></b></dt><dd>
2076 2073
2077 <p> 2074 <p>
2078 A code that uniquely identifies the error that occurred. 2075 A code that uniquely identifies the error that occurred.
2079 </p> 2076 </p>
2080 </dd><dt class="field"><b>message (String)</b></dt><dd> 2077 </dd><dt class="field"><b>message: String</b></dt><dd>
2081 2078
2082 <p> 2079 <p>
2083 A short description of the error. 2080 A short description of the error.
2084 </p> 2081 </p>
2085 </dd><dt class="field"><b>stackTrace (<span style="color:#999999">optional </span> String)</b></dt><dd> 2082 </dd><dt class="field"><b>stackTrace: String<span style="color:#999999"> ( optional)</span></b></dt><dd>
2086 2083
2087 <p> 2084 <p>
2088 The stack trace associated with processing the request, used for 2085 The stack trace associated with processing the request, used for
2089 debugging the plugin. 2086 debugging the plugin.
2090 </p> 2087 </p>
2091 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCode"> RequestErrorCode: String</a></dt><dd> 2088 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCode"> RequestErrorCode: String</a></dt><dd>
2092 <p> 2089 <p>
2093 An enumeration of the types of errors that can occur in the execution of 2090 An enumeration of the types of errors that can occur in the execution of
2094 the plugin. 2091 the plugin.
2095 </p> 2092 </p>
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
2128 2125
2129 <p> 2126 <p>
2130 A request was received that the plugin does not recognize, or cannot 2127 A request was received that the plugin does not recognize, or cannot
2131 handle in its current configuration. 2128 handle in its current configuration.
2132 </p> 2129 </p>
2133 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceChange">Sour ceChange: object</a></dt><dd> 2130 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceChange">Sour ceChange: object</a></dt><dd>
2134 <p> 2131 <p>
2135 A description of a set of edits that implement a single conceptual change. 2132 A description of a set of edits that implement a single conceptual change.
2136 </p> 2133 </p>
2137 2134
2138 <dl><dt class="field"><b>message (String)</b></dt><dd> 2135 <dl><dt class="field"><b>message: String</b></dt><dd>
2139 2136
2140 <p> 2137 <p>
2141 A human-readable description of the change to be applied. 2138 A human-readable description of the change to be applied.
2142 </p> 2139 </p>
2143 </dd><dt class="field"><b>edits (List&lt;<a href="#type_SourceFileEdit">So urceFileEdit</a>&gt;)</b></dt><dd> 2140 </dd><dt class="field"><b>edits: List&lt;<a href="#type_SourceFileEdit">So urceFileEdit</a>&gt;</b></dt><dd>
2144 2141
2145 <p> 2142 <p>
2146 A list of the edits used to effect the change, grouped by file. 2143 A list of the edits used to effect the change, grouped by file.
2147 </p> 2144 </p>
2148 </dd><dt class="field"><b>linkedEditGroups (List&lt;<a href="#type_LinkedE ditGroup">LinkedEditGroup</a>&gt;)</b></dt><dd> 2145 </dd><dt class="field"><b>linkedEditGroups: List&lt;<a href="#type_LinkedE ditGroup">LinkedEditGroup</a>&gt;</b></dt><dd>
2149 2146
2150 <p> 2147 <p>
2151 A list of the linked editing groups used to customize the changes that 2148 A list of the linked editing groups used to customize the changes that
2152 were made. 2149 were made.
2153 </p> 2150 </p>
2154 </dd><dt class="field"><b>selection (<span style="color:#999999">optional< /span> <a href="#type_Position">Position</a>)</b></dt><dd> 2151 </dd><dt class="field"><b>selection: <a href="#type_Position">Position</a> <span style="color:#999999"> (optional)</span></b></dt><dd>
2155 2152
2156 <p> 2153 <p>
2157 The position that should be selected after the edits have been 2154 The position that should be selected after the edits have been
2158 applied. 2155 applied.
2159 </p> 2156 </p>
2160 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">Source Edit: object</a></dt><dd> 2157 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">Source Edit: object</a></dt><dd>
2161 <p> 2158 <p>
2162 A description of a single change to a single file. 2159 A description of a single change to a single file.
2163 </p> 2160 </p>
2164 2161
2165 <dl><dt class="field"><b>offset (int)</b></dt><dd> 2162 <dl><dt class="field"><b>offset: int</b></dt><dd>
2166 2163
2167 <p> 2164 <p>
2168 The offset of the region to be modified. 2165 The offset of the region to be modified.
2169 </p> 2166 </p>
2170 </dd><dt class="field"><b>length (int)</b></dt><dd> 2167 </dd><dt class="field"><b>length: int</b></dt><dd>
2171 2168
2172 <p> 2169 <p>
2173 The length of the region to be modified. 2170 The length of the region to be modified.
2174 </p> 2171 </p>
2175 </dd><dt class="field"><b>replacement (String)</b></dt><dd> 2172 </dd><dt class="field"><b>replacement: String</b></dt><dd>
2176 2173
2177 <p> 2174 <p>
2178 The code that is to replace the specified region in the original code. 2175 The code that is to replace the specified region in the original code.
2179 </p> 2176 </p>
2180 </dd><dt class="field"><b>id (<span style="color:#999999">optional</span> String)</b></dt><dd> 2177 </dd><dt class="field"><b>id: String<span style="color:#999999"> (optional )</span></b></dt><dd>
2181 2178
2182 <p> 2179 <p>
2183 An identifier that uniquely identifies this source edit from other 2180 An identifier that uniquely identifies this source edit from other
2184 edits in the same response. This field is omitted unless a containing 2181 edits in the same response. This field is omitted unless a containing
2185 structure needs to be able to identify the edit for some reason. 2182 structure needs to be able to identify the edit for some reason.
2186 </p> 2183 </p>
2187 <p> 2184 <p>
2188 For example, some refactoring operations can produce edits that might 2185 For example, some refactoring operations can produce edits that might
2189 not be appropriate (referred to as potential edits). Such edits will 2186 not be appropriate (referred to as potential edits). Such edits will
2190 have an id so that they can be referenced. Edits in the same response 2187 have an id so that they can be referenced. Edits in the same response
2191 that do not need to be referenced will not have an id. 2188 that do not need to be referenced will not have an id.
2192 </p> 2189 </p>
2193 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So urceFileEdit: object</a></dt><dd> 2190 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit">So urceFileEdit: object</a></dt><dd>
2194 <p> 2191 <p>
2195 A description of a set of changes to a single file. 2192 A description of a set of changes to a single file.
2196 </p> 2193 </p>
2197 2194
2198 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b></dt> <dd> 2195 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></dt>< dd>
2199 2196
2200 <p> 2197 <p>
2201 The file containing the code to be modified. 2198 The file containing the code to be modified.
2202 </p> 2199 </p>
2203 </dd><dt class="field"><b>fileStamp (long)</b></dt><dd> 2200 </dd><dt class="field"><b>fileStamp: long</b></dt><dd>
2204 2201
2205 <p> 2202 <p>
2206 The modification stamp of the file at the moment when the change was 2203 The modification stamp of the file at the moment when the change was
2207 created, in milliseconds since the "Unix epoch". Will be -1 if the 2204 created, in milliseconds since the "Unix epoch". Will be -1 if the
2208 file did not exist and should be created. The client may use this 2205 file did not exist and should be created. The client may use this
2209 field to make sure that the file was not changed since then, so it is 2206 field to make sure that the file was not changed since then, so it is
2210 safe to apply the change. 2207 safe to apply the change.
2211 </p> 2208 </p>
2212 </dd><dt class="field"><b>edits (List&lt;<a href="#type_SourceEdit">Source Edit</a>&gt;)</b></dt><dd> 2209 </dd><dt class="field"><b>edits: List&lt;<a href="#type_SourceEdit">Source Edit</a>&gt;</b></dt><dd>
2213 2210
2214 <p> 2211 <p>
2215 A list of the edits used to effect the change. 2212 A list of the edits used to effect the change.
2216 </p> 2213 </p>
2217 </dd></dl></dd><dt class="typeDefinition"><a name="type_WatchEvent">WatchE vent: object</a></dt><dd> 2214 </dd></dl></dd><dt class="typeDefinition"><a name="type_WatchEvent">WatchE vent: object</a></dt><dd>
2218 <p> 2215 <p>
2219 A watch event sent by the server when the file system has been modified. 2216 A watch event sent by the server when the file system has been modified.
2220 </p> 2217 </p>
2221 2218
2222 <dl><dt class="field"><b>type (<a href="#type_WatchEventType">WatchEventType</ a>)</b></dt><dd> 2219 <dl><dt class="field"><b>type: <a href="#type_WatchEventType">WatchEventType</ a></b></dt><dd>
2223 2220
2224 <p> 2221 <p>
2225 The type of change represented by this event. 2222 The type of change represented by this event.
2226 </p> 2223 </p>
2227 </dd><dt class="field"><b>path (String)</b></dt><dd> 2224 </dd><dt class="field"><b>path: String</b></dt><dd>
2228 2225
2229 <p> 2226 <p>
2230 The absolute path of the file or directory that changed. 2227 The absolute path of the file or directory that changed.
2231 </p> 2228 </p>
2232 </dd></dl></dd><dt class="typeDefinition"><a name="type_WatchEventType">Wa tchEventType: String</a></dt><dd> 2229 </dd></dl></dd><dt class="typeDefinition"><a name="type_WatchEventType">Wa tchEventType: String</a></dt><dd>
2233 <p> 2230 <p>
2234 An indication of the type of change associated with a watch event. 2231 An indication of the type of change associated with a watch event.
2235 </p> 2232 </p>
2236 2233
2237 <dl><dt class="value">ADD</dt><dd> 2234 <dl><dt class="value">ADD</dt><dd>
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
2292 <p> 2289 <p>
2293 Create a local variable initialized by the expression that covers the 2290 Create a local variable initialized by the expression that covers the
2294 specified selection. 2291 specified selection.
2295 </p> 2292 </p>
2296 <p> 2293 <p>
2297 It is an error if the selection range is not covered by a complete 2294 It is an error if the selection range is not covered by a complete
2298 expression. 2295 expression.
2299 </p> 2296 </p>
2300 2297
2301 2298
2302 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets (<span st yle="color:#999999">optional</span> List&lt;int&gt;)</b></dt><dd> 2299 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets: List&lt; int&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
2303 2300
2304 <p> 2301 <p>
2305 The offsets of the expressions that cover the specified selection, 2302 The offsets of the expressions that cover the specified selection,
2306 from the down most to the up most. 2303 from the down most to the up most.
2307 </p> 2304 </p>
2308 </dd><dt class="field"><b>coveringExpressionLengths (<span style="color:#9 99999">optional</span> List&lt;int&gt;)</b></dt><dd> 2305 </dd><dt class="field"><b>coveringExpressionLengths: List&lt;int&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
2309 2306
2310 <p> 2307 <p>
2311 The lengths of the expressions that cover the specified selection, 2308 The lengths of the expressions that cover the specified selection,
2312 from the down most to the up most. 2309 from the down most to the up most.
2313 </p> 2310 </p>
2314 </dd><dt class="field"><b>names (List&lt;String&gt;)</b></dt><dd> 2311 </dd><dt class="field"><b>names: List&lt;String&gt;</b></dt><dd>
2315 2312
2316 <p> 2313 <p>
2317 The proposed names for the local variable. 2314 The proposed names for the local variable.
2318 </p> 2315 </p>
2319 </dd><dt class="field"><b>offsets (List&lt;int&gt;)</b></dt><dd> 2316 </dd><dt class="field"><b>offsets: List&lt;int&gt;</b></dt><dd>
2320 2317
2321 <p> 2318 <p>
2322 The offsets of the expressions that would be replaced by a reference 2319 The offsets of the expressions that would be replaced by a reference
2323 to the variable. 2320 to the variable.
2324 </p> 2321 </p>
2325 </dd><dt class="field"><b>lengths (List&lt;int&gt;)</b></dt><dd> 2322 </dd><dt class="field"><b>lengths: List&lt;int&gt;</b></dt><dd>
2326 2323
2327 <p> 2324 <p>
2328 The lengths of the expressions that would be replaced by a reference 2325 The lengths of the expressions that would be replaced by a reference
2329 to the variable. The lengths correspond to the offsets. In other 2326 to the variable. The lengths correspond to the offsets. In other
2330 words, for a given expression, if the offset of that expression is 2327 words, for a given expression, if the offset of that expression is
2331 offsets[i], then the length of that expression is lengths[i]. 2328 offsets[i], then the length of that expression is lengths[i].
2332 </p> 2329 </p>
2333 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name (String)</b></dt> <dd> 2330 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name: String</b></dt>< dd>
2334 2331
2335 <p> 2332 <p>
2336 The name that the local variable should be given. 2333 The name that the local variable should be given.
2337 </p> 2334 </p>
2338 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> 2335 </dd><dt class="field"><b>extractAll: bool</b></dt><dd>
2339 2336
2340 <p> 2337 <p>
2341 True if all occurrences of the expression within the scope in which 2338 True if all occurrences of the expression within the scope in which
2342 the variable will be defined should be replaced by a reference to the 2339 the variable will be defined should be replaced by a reference to the
2343 local variable. The expression used to initiate the refactoring will 2340 local variable. The expression used to initiate the refactoring will
2344 always be replaced. 2341 always be replaced.
2345 </p> 2342 </p>
2346 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd> 2343 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd>
2347 <p> 2344 <p>
2348 Create a method whose body is the specified expression or list of 2345 Create a method whose body is the specified expression or list of
2349 statements, possibly augmented with a return statement. 2346 statements, possibly augmented with a return statement.
2350 </p> 2347 </p>
2351 <p> 2348 <p>
2352 It is an error if the range contains anything other than a complete 2349 It is an error if the range contains anything other than a complete
2353 expression (no partial expressions are allowed) or a complete sequence of 2350 expression (no partial expressions are allowed) or a complete sequence of
2354 statements. 2351 statements.
2355 </p> 2352 </p>
2356 2353
2357 2354
2358 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> 2355 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd>
2359 2356
2360 <p> 2357 <p>
2361 The offset to the beginning of the expression or statements that will 2358 The offset to the beginning of the expression or statements that will
2362 be extracted. 2359 be extracted.
2363 </p> 2360 </p>
2364 </dd><dt class="field"><b>length (int)</b></dt><dd> 2361 </dd><dt class="field"><b>length: int</b></dt><dd>
2365 2362
2366 <p> 2363 <p>
2367 The length of the expression or statements that will be extracted. 2364 The length of the expression or statements that will be extracted.
2368 </p> 2365 </p>
2369 </dd><dt class="field"><b>returnType (String)</b></dt><dd> 2366 </dd><dt class="field"><b>returnType: String</b></dt><dd>
2370 2367
2371 <p> 2368 <p>
2372 The proposed return type for the method. If the returned element does 2369 The proposed return type for the method. If the returned element does
2373 not have a declared return type, this field will contain an empty 2370 not have a declared return type, this field will contain an empty
2374 string. 2371 string.
2375 </p> 2372 </p>
2376 </dd><dt class="field"><b>names (List&lt;String&gt;)</b></dt><dd> 2373 </dd><dt class="field"><b>names: List&lt;String&gt;</b></dt><dd>
2377 2374
2378 <p> 2375 <p>
2379 The proposed names for the method. 2376 The proposed names for the method.
2380 </p> 2377 </p>
2381 </dd><dt class="field"><b>canCreateGetter (bool)</b></dt><dd> 2378 </dd><dt class="field"><b>canCreateGetter: bool</b></dt><dd>
2382 2379
2383 <p> 2380 <p>
2384 True if a getter could be created rather than a method. 2381 True if a getter could be created rather than a method.
2385 </p> 2382 </p>
2386 </dd><dt class="field"><b>parameters (List&lt;<a href="#type_RefactoringMe thodParameter">RefactoringMethodParameter</a>&gt;)</b></dt><dd> 2383 </dd><dt class="field"><b>parameters: List&lt;<a href="#type_RefactoringMe thodParameter">RefactoringMethodParameter</a>&gt;</b></dt><dd>
2387 2384
2388 <p> 2385 <p>
2389 The proposed parameters for the method. 2386 The proposed parameters for the method.
2390 </p> 2387 </p>
2391 </dd><dt class="field"><b>offsets (List&lt;int&gt;)</b></dt><dd> 2388 </dd><dt class="field"><b>offsets: List&lt;int&gt;</b></dt><dd>
2392 2389
2393 <p> 2390 <p>
2394 The offsets of the expressions or statements that would be replaced by 2391 The offsets of the expressions or statements that would be replaced by
2395 an invocation of the method. 2392 an invocation of the method.
2396 </p> 2393 </p>
2397 </dd><dt class="field"><b>lengths (List&lt;int&gt;)</b></dt><dd> 2394 </dd><dt class="field"><b>lengths: List&lt;int&gt;</b></dt><dd>
2398 2395
2399 <p> 2396 <p>
2400 The lengths of the expressions or statements that would be replaced by 2397 The lengths of the expressions or statements that would be replaced by
2401 an invocation of the method. The lengths correspond to the offsets. In 2398 an invocation of the method. The lengths correspond to the offsets. In
2402 other words, for a given expression (or block of statements), if the 2399 other words, for a given expression (or block of statements), if the
2403 offset of that expression is offsets[i], then the length of that 2400 offset of that expression is offsets[i], then the length of that
2404 expression is lengths[i]. 2401 expression is lengths[i].
2405 </p> 2402 </p>
2406 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType (String)</b ></dt><dd> 2403 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType: String</b> </dt><dd>
2407 2404
2408 <p> 2405 <p>
2409 The return type that should be defined for the method. 2406 The return type that should be defined for the method.
2410 </p> 2407 </p>
2411 </dd><dt class="field"><b>createGetter (bool)</b></dt><dd> 2408 </dd><dt class="field"><b>createGetter: bool</b></dt><dd>
2412 2409
2413 <p> 2410 <p>
2414 True if a getter should be created rather than a method. It is an 2411 True if a getter should be created rather than a method. It is an
2415 error if this field is true and the list of parameters is non-empty. 2412 error if this field is true and the list of parameters is non-empty.
2416 </p> 2413 </p>
2417 </dd><dt class="field"><b>name (String)</b></dt><dd> 2414 </dd><dt class="field"><b>name: String</b></dt><dd>
2418 2415
2419 <p> 2416 <p>
2420 The name that the method should be given. 2417 The name that the method should be given.
2421 </p> 2418 </p>
2422 </dd><dt class="field"><b>parameters (List&lt;<a href="#type_RefactoringMe thodParameter">RefactoringMethodParameter</a>&gt;)</b></dt><dd> 2419 </dd><dt class="field"><b>parameters: List&lt;<a href="#type_RefactoringMe thodParameter">RefactoringMethodParameter</a>&gt;</b></dt><dd>
2423 2420
2424 <p> 2421 <p>
2425 The parameters that should be defined for the method. 2422 The parameters that should be defined for the method.
2426 </p> 2423 </p>
2427 <p> 2424 <p>
2428 It is an error if a REQUIRED or NAMED parameter follows a POSITIONAL 2425 It is an error if a REQUIRED or NAMED parameter follows a POSITIONAL
2429 parameter. It is an error if a REQUIRED or POSITIONAL parameter 2426 parameter. It is an error if a REQUIRED or POSITIONAL parameter
2430 follows a NAMED parameter. 2427 follows a NAMED parameter.
2431 </p> 2428 </p>
2432 <ul> 2429 <ul>
2433 <li> 2430 <li>
2434 To change the order and/or update proposed parameters, add 2431 To change the order and/or update proposed parameters, add
2435 parameters with the same identifiers as proposed. 2432 parameters with the same identifiers as proposed.
2436 </li> 2433 </li>
2437 <li> 2434 <li>
2438 To add new parameters, omit their identifier. 2435 To add new parameters, omit their identifier.
2439 </li> 2436 </li>
2440 <li> 2437 <li>
2441 To remove some parameters, omit them in this list. 2438 To remove some parameters, omit them in this list.
2442 </li> 2439 </li>
2443 </ul> 2440 </ul>
2444 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> 2441 </dd><dt class="field"><b>extractAll: bool</b></dt><dd>
2445 2442
2446 <p> 2443 <p>
2447 True if all occurrences of the expression or statements should be 2444 True if all occurrences of the expression or statements should be
2448 replaced by an invocation of the method. The expression or statements 2445 replaced by an invocation of the method. The expression or statements
2449 used to initiate the refactoring will always be replaced. 2446 used to initiate the refactoring will always be replaced.
2450 </p> 2447 </p>
2451 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd> 2448 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd>
2452 <p> 2449 <p>
2453 Inline the initializer expression of a local variable in place of any 2450 Inline the initializer expression of a local variable in place of any
2454 references to that variable. 2451 references to that variable.
2455 </p> 2452 </p>
2456 <p> 2453 <p>
2457 It is an error if the range contains anything other than all or part of 2454 It is an error if the range contains anything other than all or part of
2458 the name of a single local variable. 2455 the name of a single local variable.
2459 </p> 2456 </p>
2460 2457
2461 <h4>Feedback:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> 2458 <h4>Feedback:</h4><dl><dt class="field"><b>name: String</b></dt><dd>
2462 2459
2463 <p> 2460 <p>
2464 The name of the variable being inlined. 2461 The name of the variable being inlined.
2465 </p> 2462 </p>
2466 </dd><dt class="field"><b>occurrences (int)</b></dt><dd> 2463 </dd><dt class="field"><b>occurrences: int</b></dt><dd>
2467 2464
2468 <p> 2465 <p>
2469 The number of times the variable occurs. 2466 The number of times the variable occurs.
2470 </p> 2467 </p>
2471 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INLINE_ METHOD</dt><dd> 2468 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INLINE_ METHOD</dt><dd>
2472 <p> 2469 <p>
2473 Inline a method in place of one or all references to that method. 2470 Inline a method in place of one or all references to that method.
2474 </p> 2471 </p>
2475 <p> 2472 <p>
2476 It is an error if the range contains anything other than all or part of 2473 It is an error if the range contains anything other than all or part of
2477 the name of a single method. 2474 the name of a single method.
2478 </p> 2475 </p>
2479 2476
2480 2477
2481 <h4>Feedback:</h4><dl><dt class="field"><b>className (<span style="color:#9999 99">optional</span> String)</b></dt><dd> 2478 <h4>Feedback:</h4><dl><dt class="field"><b>className: String<span style="color :#999999"> (optional)</span></b></dt><dd>
2482 2479
2483 <p> 2480 <p>
2484 The name of the class enclosing the method being inlined. If not a 2481 The name of the class enclosing the method being inlined. If not a
2485 class member is being inlined, this field will be absent. 2482 class member is being inlined, this field will be absent.
2486 </p> 2483 </p>
2487 </dd><dt class="field"><b>methodName (String)</b></dt><dd> 2484 </dd><dt class="field"><b>methodName: String</b></dt><dd>
2488 2485
2489 <p> 2486 <p>
2490 The name of the method (or function) being inlined. 2487 The name of the method (or function) being inlined.
2491 </p> 2488 </p>
2492 </dd><dt class="field"><b>isDeclaration (bool)</b></dt><dd> 2489 </dd><dt class="field"><b>isDeclaration: bool</b></dt><dd>
2493 2490
2494 <p> 2491 <p>
2495 True if the declaration of the method is selected and all references 2492 True if the declaration of the method is selected and all references
2496 should be inlined. 2493 should be inlined.
2497 </p> 2494 </p>
2498 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource (bool)</b ></dt><dd> 2495 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource: bool</b> </dt><dd>
2499 2496
2500 <p> 2497 <p>
2501 True if the method being inlined should be removed. It is an error if 2498 True if the method being inlined should be removed. It is an error if
2502 this field is true and inlineAll is false. 2499 this field is true and inlineAll is false.
2503 </p> 2500 </p>
2504 </dd><dt class="field"><b>inlineAll (bool)</b></dt><dd> 2501 </dd><dt class="field"><b>inlineAll: bool</b></dt><dd>
2505 2502
2506 <p> 2503 <p>
2507 True if all invocations of the method should be inlined, or false if 2504 True if all invocations of the method should be inlined, or false if
2508 only the invocation site used to create this refactoring should be 2505 only the invocation site used to create this refactoring should be
2509 inlined. 2506 inlined.
2510 </p> 2507 </p>
2511 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd> 2508 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd>
2512 <p> 2509 <p>
2513 Move the given file and update all of the references to that file and from 2510 Move the given file and update all of the references to that file and from
2514 it. The move operation is supported in general case - for renaming a file 2511 it. The move operation is supported in general case - for renaming a file
2515 in the same folder, moving it to a different folder or both. 2512 in the same folder, moving it to a different folder or both.
2516 </p> 2513 </p>
2517 <p> 2514 <p>
2518 The refactoring must be activated before an actual file moving operation 2515 The refactoring must be activated before an actual file moving operation
2519 is performed. 2516 is performed.
2520 </p> 2517 </p>
2521 <p> 2518 <p>
2522 The "offset" and "length" fields from the request are ignored, but the 2519 The "offset" and "length" fields from the request are ignored, but the
2523 file specified in the request specifies the file to be moved. 2520 file specified in the request specifies the file to be moved.
2524 </p> 2521 </p>
2525 2522
2526 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>newFile (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> 2523 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>newFile : <a href="#type_FilePath">FilePath</a></b></dt><dd>
2527 2524
2528 <p> 2525 <p>
2529 The new file path to which the given file is being moved. 2526 The new file path to which the given file is being moved.
2530 </p> 2527 </p>
2531 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd> 2528 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd>
2532 <p> 2529 <p>
2533 Rename a given element and all of the references to that element. 2530 Rename a given element and all of the references to that element.
2534 </p> 2531 </p>
2535 <p> 2532 <p>
2536 It is an error if the range contains anything other than all or part of 2533 It is an error if the range contains anything other than all or part of
2537 the name of a single function (including methods, getters and setters), 2534 the name of a single function (including methods, getters and setters),
2538 variable (including fields, parameters and local variables), class or 2535 variable (including fields, parameters and local variables), class or
2539 function type. 2536 function type.
2540 </p> 2537 </p>
2541 2538
2542 2539
2543 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> 2540 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd>
2544 2541
2545 <p> 2542 <p>
2546 The offset to the beginning of the name selected to be renamed. 2543 The offset to the beginning of the name selected to be renamed.
2547 </p> 2544 </p>
2548 </dd><dt class="field"><b>length (int)</b></dt><dd> 2545 </dd><dt class="field"><b>length: int</b></dt><dd>
2549 2546
2550 <p> 2547 <p>
2551 The length of the name selected to be renamed. 2548 The length of the name selected to be renamed.
2552 </p> 2549 </p>
2553 </dd><dt class="field"><b>elementKindName (String)</b></dt><dd> 2550 </dd><dt class="field"><b>elementKindName: String</b></dt><dd>
2554 2551
2555 <p> 2552 <p>
2556 The human-readable description of the kind of element being renamed 2553 The human-readable description of the kind of element being renamed
2557 (such as “class” or “function type alias”). 2554 (such as “class” or “function type alias”).
2558 </p> 2555 </p>
2559 </dd><dt class="field"><b>oldName (String)</b></dt><dd> 2556 </dd><dt class="field"><b>oldName: String</b></dt><dd>
2560 2557
2561 <p> 2558 <p>
2562 The old name of the element before the refactoring. 2559 The old name of the element before the refactoring.
2563 </p> 2560 </p>
2564 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName (String)</b></ dt><dd> 2561 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b></d t><dd>
2565 2562
2566 <p> 2563 <p>
2567 The name that the element should have after the refactoring. 2564 The name that the element should have after the refactoring.
2568 </p> 2565 </p>
2569 </dd></dl></dd></dl> 2566 </dd></dl></dd></dl>
2570 <h2 class="domain"><a name="index">Index</a></h2> 2567 <h2 class="domain"><a name="index">Index</a></h2>
2571 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setContextBuilderOptions">setContextBu ilderOptions</a></li><li><a href="#request_analysis.setContextRoots">setContextR oots</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</ a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li ><li><a href="#request_analysis.updateContent">updateContent</a></li></ul><h5>No tifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.er rors">errors</a></li><li><a href="#notification_analysis.folding">folding</a></l i><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href ="#notification_analysis.navigation">navigation</a></li><li><a href="#notificati on_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis .outline">outline</a></li></ul></div></div><h4>completion (<a href="#domain_comp letion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ est_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>edit (<a hr ef="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h ref="#request_edit.getAssists">getAssists</a></li><li><a href="#request_edit.get AvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_ed it.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefa ctoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="su bindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li> <a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisE rrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity"> AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErro rType</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#ty pe_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_Complet ionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextBu ilderOptions">ContextBuilderOptions</a></li><li><a href="#type_ContextRoot">Cont extRoot</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_E lementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePath</a></li><l i><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegi on">FoldingRegion</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a ></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedE ditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggest ionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location< /a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a hre f="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrenc es">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href= "#type_Position">Position</a></li><li><a href="#type_PrioritizedSourceChange">Pr ioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback">Refactorin gFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><l i><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li> <li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKin d</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li> <a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type _RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#ty pe_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_Request Error">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCod e</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#ty pe_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileE dit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type _WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#r efactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONV ERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring _CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refact oring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refac toring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_L OCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_ME THOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></ li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> 2568 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setContextBuilderOptions">setContextBu ilderOptions</a></li><li><a href="#request_analysis.setContextRoots">setContextR oots</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</ a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li ><li><a href="#request_analysis.updateContent">updateContent</a></li></ul><h5>No tifications</h5><div class="subindex"><ul><li><a href="#notification_analysis.er rors">errors</a></li><li><a href="#notification_analysis.folding">folding</a></l i><li><a href="#notification_analysis.highlights">highlights</a></li><li><a href ="#notification_analysis.navigation">navigation</a></li><li><a href="#notificati on_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis .outline">outline</a></li></ul></div></div><h4>completion (<a href="#domain_comp letion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ est_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>edit (<a hr ef="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h ref="#request_edit.getAssists">getAssists</a></li><li><a href="#request_edit.get AvailableRefactorings">getAvailableRefactorings</a></li><li><a href="#request_ed it.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefa ctoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="su bindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li> <a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisE rrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity"> AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErro rType</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#ty pe_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_Complet ionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextBu ilderOptions">ContextBuilderOptions</a></li><li><a href="#type_ContextRoot">Cont extRoot</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_E lementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePath</a></li><l i><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegi on">FoldingRegion</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a ></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedE ditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggest ionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location< /a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a hre f="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrenc es">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href= "#type_Position">Position</a></li><li><a href="#type_PrioritizedSourceChange">Pr ioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback">Refactorin gFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><l i><a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li> <li><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKin d</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li> <a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type _RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#ty pe_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_Request Error">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCod e</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#ty pe_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileE dit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type _WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#r efactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONV ERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring _CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refact oring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refac toring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_L OCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_ME THOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></ li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div>
2572 2569
2573 2570
2574 </body></html> 2571 </body></html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/tool/spec/to_html.dart ('k') | pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698