OLD | NEW |
1 <!DOCTYPE html><html><head> | 1 <!DOCTYPE html><html><head> |
2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
3 <title>Analysis Server API Specification</title> | 3 <title>Analysis Server API Specification</title> |
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co
de+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { | 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co
de+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; |
11 color: #111; | 11 color: #111; |
12 background-color: #fdfdfd; | 12 background-color: #fdfdfd; |
13 font-weight: 300; | 13 font-weight: 300; |
14 -webkit-font-smoothing: auto; | 14 -webkit-font-smoothing: auto; |
15 } | 15 } |
16 | 16 |
17 h1 { | |
18 text-align: center; | |
19 } | |
20 | |
21 h2, h3, h4, h5 { | 17 h2, h3, h4, h5 { |
22 margin-bottom: 0; | 18 margin-bottom: 0; |
23 } | 19 } |
24 | 20 |
25 h2.domain { | 21 h2.domain { |
26 border-bottom: 1px solid rgb(200, 200, 200); | 22 border-bottom: 1px solid rgb(200, 200, 200); |
27 margin-bottom: 0.5em; | 23 margin-bottom: 0.5em; |
28 } | 24 } |
29 | 25 |
30 h4 { | 26 h4 { |
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
86 } | 82 } |
87 | 83 |
88 a { | 84 a { |
89 text-decoration: none; | 85 text-decoration: none; |
90 } | 86 } |
91 | 87 |
92 a:focus, a:hover { | 88 a:focus, a:hover { |
93 text-decoration: underline; | 89 text-decoration: underline; |
94 } | 90 } |
95 | 91 |
| 92 .deprecated { |
| 93 text-decoration: line-through; |
| 94 } |
| 95 |
96 /* Styles for index */ | 96 /* Styles for index */ |
97 | 97 |
98 .subindex ul { | 98 .subindex ul { |
99 padding-left: 0; | 99 padding-left: 0; |
100 margin-left: 0; | 100 margin-left: 0; |
101 | 101 |
102 -webkit-margin-before: 0; | 102 -webkit-margin-before: 0; |
103 -webkit-margin-start: 0; | 103 -webkit-margin-start: 0; |
104 -webkit-padding-start: 0; | 104 -webkit-padding-start: 0; |
105 | 105 |
(...skipping 107 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
213 described with each notification. | 213 described with each notification. |
214 </p> | 214 </p> |
215 <p> | 215 <p> |
216 In order to be backward compatible, clients should ignore fields that were | 216 In order to be backward compatible, clients should ignore fields that were |
217 not specified in the version of the API on which they were based. Clients | 217 not specified in the version of the API on which they were based. Clients |
218 should also use the server.getVersion request to test that the version of | 218 should also use the server.getVersion request to test that the version of |
219 the server supports an API before using it. | 219 the server supports an API before using it. |
220 </p> | 220 </p> |
221 <h3>Eventual Consistency</h3> | 221 <h3>Eventual Consistency</h3> |
222 <p> | 222 <p> |
223 TODO: TBD | 223 The analysis server satisfies requests under the principle of |
| 224 <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual cons
istency</a>. |
| 225 That is, in some cases it may return responses with the currently availabl
e |
| 226 results while it's catching up with unprocessed changes. |
224 </p> | 227 </p> |
225 <h3>Domains</h3> | 228 <h3>Domains</h3> |
226 <p> | 229 <p> |
227 For convenience, the API is divided into domains. Each domain is | 230 For convenience, the API is divided into domains. Each domain is specified |
228 specified in a separate section below: | 231 in a separate section below. The specifications of the API’s refer to data |
229 </p> | 232 structures beyond the standard JSON primitives. These data structures are |
230 <ul> | |
231 <li><a href="#domain_server">Server</a></li> | |
232 <li><a href="#domain_analysis">Analysis</a></li> | |
233 <li><a href="#domain_completion">Completion</a></li> | |
234 <li><a href="#domain_search">Search</a></li> | |
235 <li><a href="#domain_edit">Edit</a></li> | |
236 <li><a href="#domain_execution">Execution</a></li> | |
237 <li><a href="#domain_diagnostic">Diagnostic</a></li> | |
238 </ul> | |
239 <p> | |
240 The specifications of the API’s refer to data structures beyond | |
241 the standard JSON primitives. These data structures are | |
242 documented in the section titled <a href="#types">Types</a>. | 233 documented in the section titled <a href="#types">Types</a>. |
243 </p> | 234 </p> |
244 <p> | 235 |
245 To get an overview of the API, you can consult the <a href="#index">index<
/a>. | 236 <p><a href="#domain_server">Server</a></p><ul><li><a href="#request_server.getVe
rsion">server.getVersion</a></li> |
246 </p> | 237 <li><a href="#request_server.shutdown">server.shutdown</a></li> |
| 238 <li><a href="#request_server.setSubscriptions">server.setSubscriptions</a></li> |
| 239 </ul> |
| 240 |
| 241 <p><a href="#domain_analysis">Analysis</a></p><ul><li><a href="#request_analysis
.getErrors">analysis.getErrors</a></li> |
| 242 <li><a href="#request_analysis.getHover">analysis.getHover</a></li> |
| 243 <li><a href="#request_analysis.getReachableSources">analysis.getReachableSources
</a></li> |
| 244 <li><a href="#request_analysis.getLibraryDependencies">analysis.getLibraryDepend
encies</a></li> |
| 245 <li><a href="#request_analysis.getNavigation">analysis.getNavigation</a></li> |
| 246 <li><a href="#request_analysis.reanalyze">analysis.reanalyze</a></li> |
| 247 <li><a href="#request_analysis.setAnalysisRoots">analysis.setAnalysisRoots</a></
li> |
| 248 <li><a href="#request_analysis.setGeneralSubscriptions">analysis.setGeneralSubsc
riptions</a></li> |
| 249 <li><a href="#request_analysis.setPriorityFiles">analysis.setPriorityFiles</a></
li> |
| 250 <li><a href="#request_analysis.setSubscriptions">analysis.setSubscriptions</a></
li> |
| 251 <li><a href="#request_analysis.updateContent">analysis.updateContent</a></li> |
| 252 <li><a class="deprecated" href="#request_analysis.updateOptions">analysis.update
Options</a></li> |
| 253 </ul> |
| 254 |
| 255 <p><a href="#domain_completion">Completion</a></p><ul><li><a href="#request_comp
letion.getSuggestions">completion.getSuggestions</a></li> |
| 256 </ul> |
| 257 |
| 258 <p><a href="#domain_search">Search</a></p><ul><li><a href="#request_search.findE
lementReferences">search.findElementReferences</a></li> |
| 259 <li><a href="#request_search.findMemberDeclarations">search.findMemberDeclaratio
ns</a></li> |
| 260 <li><a href="#request_search.findMemberReferences">search.findMemberReferences</
a></li> |
| 261 <li><a href="#request_search.findTopLevelDeclarations">search.findTopLevelDeclar
ations</a></li> |
| 262 <li><a href="#request_search.getTypeHierarchy">search.getTypeHierarchy</a></li> |
| 263 </ul> |
| 264 |
| 265 <p><a href="#domain_edit">Edit</a></p><ul><li><a href="#request_edit.format">edi
t.format</a></li> |
| 266 <li><a href="#request_edit.getAssists">edit.getAssists</a></li> |
| 267 <li><a href="#request_edit.getAvailableRefactorings">edit.getAvailableRefactorin
gs</a></li> |
| 268 <li><a href="#request_edit.getFixes">edit.getFixes</a></li> |
| 269 <li><a href="#request_edit.getRefactoring">edit.getRefactoring</a></li> |
| 270 <li><a href="#request_edit.getStatementCompletion">edit.getStatementCompletion</
a></li> |
| 271 <li><a href="#request_edit.sortMembers">edit.sortMembers</a></li> |
| 272 <li><a href="#request_edit.organizeDirectives">edit.organizeDirectives</a></li> |
| 273 </ul> |
| 274 |
| 275 <p><a href="#domain_execution">Execution</a></p><ul><li><a href="#request_execut
ion.createContext">execution.createContext</a></li> |
| 276 <li><a href="#request_execution.deleteContext">execution.deleteContext</a></li> |
| 277 <li><a href="#request_execution.mapUri">execution.mapUri</a></li> |
| 278 <li><a class="deprecated" href="#request_execution.setSubscriptions">execution.s
etSubscriptions</a></li> |
| 279 </ul> |
| 280 |
| 281 <p><a href="#domain_diagnostic">Diagnostic</a></p><ul><li><a href="#request_diag
nostic.getDiagnostics">diagnostic.getDiagnostics</a></li> |
| 282 <li><a href="#request_diagnostic.getServerPort">diagnostic.getServerPort</a></li
> |
| 283 </ul> |
| 284 |
247 <h3>Command-line Arguments</h3> | 285 <h3>Command-line Arguments</h3> |
248 <p> | 286 <p> |
249 The command-line arguments that can be passed to the server. | 287 The command-line arguments that can be passed to the server. |
250 </p> | 288 </p> |
251 <h4>Options</h4> | 289 <h4>Options</h4> |
252 <blockquote> | 290 <blockquote> |
253 <dl> | 291 <dl> |
254 <dt>--client-id</dt> | 292 <dt>--client-id</dt> |
255 <dd> | 293 <dd> |
256 <p> | 294 <p> |
(...skipping 15 matching lines...) Expand all Loading... |
272 the server. Used when generating error reports. | 310 the server. Used when generating error reports. |
273 </p> | 311 </p> |
274 <p> | 312 <p> |
275 Clients are strongly encouraged to provide this information in | 313 Clients are strongly encouraged to provide this information in |
276 order to improve the quality of information that can be provided | 314 order to improve the quality of information that can be provided |
277 to them. | 315 to them. |
278 </p> | 316 </p> |
279 </dd> | 317 </dd> |
280 </dl> | 318 </dl> |
281 <dl> | 319 <dl> |
282 <dt>--no-error-notification</dt> | 320 <dt class="deprecated">--no-error-notification</dt> |
283 <dd> | 321 <dd> |
284 <p><b>Deprecated</b></p> | 322 <p><b>Deprecated:</b> clients should no longer pass this option in</p> |
285 Disable notifications about errors (see analysis.error). If this | 323 Disable notifications about errors (see analysis.error). If this |
286 flag is not specified then notifications will be sent for all | 324 flag is not specified then notifications will be sent for all |
287 errors produced for all files in the actual analysis roots. | 325 errors produced for all files in the actual analysis roots. |
288 </dd> | 326 </dd> |
289 </dl> | 327 </dl> |
290 <dl> | 328 <dl> |
291 <dt>--no-index</dt> | 329 <dt>--no-index</dt> |
292 <dd> | 330 <dd> |
293 Disable the server from generating an index. If this flag is passed and an | 331 Disable the server from generating an index. If this flag is passed and an |
294 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, | 332 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, |
295 will be thrown. The set of API calls that require an index include: | 333 will be thrown. The set of API calls that require an index include: |
296 refactoring calls, code completions and searching. | 334 refactoring calls, code completions and searching. |
297 | 335 |
298 </dd> | 336 </dd> |
299 </dl> | 337 </dl> |
300 <dl> | 338 <dl> |
301 <dt>--file-read-mode</dt> | 339 <dt class="deprecated">--file-read-mode</dt> |
302 <dd> | 340 <dd> |
303 <p><b>Deprecated</b></p> | 341 <p><b>Deprecated:</b> clients should no longer pass this option in</p> |
304 An enumeration of the ways files can be read from disk. Some clients | 342 An enumeration of the ways files can be read from disk. Some clients |
305 normalize end of line characters which would make the file offset and | 343 normalize end of line characters which would make the file offset and |
306 range information incorrect. The default option is <tt>as-is</tt>, but | 344 range information incorrect. The default option is <tt>as-is</tt>, but |
307 can also be set to <tt>normalize-eol-always</tt>. The default option | 345 can also be set to <tt>normalize-eol-always</tt>. The default option |
308 (<tt>as-is</tt>) reads files as they are on disk. The | 346 (<tt>as-is</tt>) reads files as they are on disk. The |
309 <tt>normalize-eol-always</tt> option does the following: | 347 <tt>normalize-eol-always</tt> option does the following: |
310 <ul> | 348 <ul> |
311 <li>'\r\n' is converted to '\n';</li> | 349 <li>'\r\n' is converted to '\n';</li> |
312 <li>'\r' by itself is converted to '\n';</li> | 350 <li>'\r' by itself is converted to '\n';</li> |
313 <li>this happens regardless of the OS editor is running on.</li> | 351 <li>this happens regardless of the OS editor is running on.</li> |
314 </ul> | 352 </ul> |
315 </dd> | 353 </dd> |
316 </dl> | 354 </dl> |
317 </blockquote> | 355 </blockquote> |
| 356 <h1>Domains</h1> |
318 <h2 class="domain"><a name="domain_server">server domain</a></h2> | 357 <h2 class="domain"><a name="domain_server">server domain</a></h2> |
319 <p> | 358 <p> |
320 The server domain contains API’s related to the execution of | 359 The server domain contains API’s related to the execution of |
321 the server. | 360 the server. |
322 </p> | 361 </p> |
323 | 362 |
324 | 363 |
325 | 364 |
326 | 365 |
327 | 366 |
328 | 367 |
329 <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion"
>server.getVersion</a> (<a href="#request_server.getVersion">#</a>)</dt><dd><div
class="box"><pre>request: { | 368 <h3>Requests</h3><dl><dt class="request"><a name="request_server.getVersion"
>server.getVersion</a></dt><dd><div class="box"><pre>request: { |
330 "id": String | 369 "id": String |
331 "method": "server.getVersion" | 370 "method": "server.getVersion" |
332 }</pre><br><pre>response: { | 371 }</pre><br><pre>response: { |
333 "id": String | 372 "id": String |
334 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 373 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
335 "result": { | 374 "result": { |
336 "<b>version</b>": String | 375 "<b>version</b>": String |
337 } | 376 } |
338 }</pre></div> | 377 }</pre></div> |
339 <p>Return the version number of the analysis server.</p> | 378 <p>Return the version number of the analysis server.</p> |
340 | 379 |
341 <h4>returns:</h4><dl><dt class="field"><b>version (String)</b></dt><dd> | 380 <h4>returns:</h4><dl><dt class="field"><b>version: String</b></dt><dd> |
342 | 381 |
343 <p>The version number of the analysis server.</p> | 382 <p>The version number of the analysis server.</p> |
344 </dd></dl></dd><dt class="request"><a name="request_server.shutdown">s
erver.shutdown</a> (<a href="#request_server.shutdown">#</a>)</dt><dd><div class
="box"><pre>request: { | 383 </dd></dl></dd><dt class="request"><a name="request_server.shutdown">s
erver.shutdown</a></dt><dd><div class="box"><pre>request: { |
345 "id": String | 384 "id": String |
346 "method": "server.shutdown" | 385 "method": "server.shutdown" |
347 }</pre><br><pre>response: { | 386 }</pre><br><pre>response: { |
348 "id": String | 387 "id": String |
349 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 388 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
350 }</pre></div> | 389 }</pre></div> |
351 <p> | 390 <p> |
352 Cleanly shutdown the analysis server. Requests that are | 391 Cleanly shutdown the analysis server. Requests that are |
353 received after this request will not be processed. Requests | 392 received after this request will not be processed. Requests |
354 that were received before this request, but for which a | 393 that were received before this request, but for which a |
355 response has not yet been sent, will not be responded to. No | 394 response has not yet been sent, will not be responded to. No |
356 further responses or notifications will be sent after the | 395 further responses or notifications will be sent after the |
357 response to this request has been sent. | 396 response to this request has been sent. |
358 </p> | 397 </p> |
359 </dd><dt class="request"><a name="request_server.setSubscriptions">server.
setSubscriptions</a> (<a href="#request_server.setSubscriptions">#</a>)</dt><dd>
<div class="box"><pre>request: { | 398 </dd><dt class="request"><a name="request_server.setSubscriptions">server.
setSubscriptions</a></dt><dd><div class="box"><pre>request: { |
360 "id": String | 399 "id": String |
361 "method": "server.setSubscriptions" | 400 "method": "server.setSubscriptions" |
362 "params": { | 401 "params": { |
363 "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService<
/a>> | 402 "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService<
/a>> |
364 } | 403 } |
365 }</pre><br><pre>response: { | 404 }</pre><br><pre>response: { |
366 "id": String | 405 "id": String |
367 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 406 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
368 }</pre></div> | 407 }</pre></div> |
369 <p> | 408 <p> |
370 Subscribe for services. All previous subscriptions are | 409 Subscribe for services. All previous subscriptions are |
371 replaced by the given set of services. | 410 replaced by the given set of services. |
372 </p> | 411 </p> |
373 <p> | 412 <p> |
374 It is an error if any of the elements in the list are not | 413 It is an error if any of the elements in the list are not |
375 valid services. If there is an error, then the current | 414 valid services. If there is an error, then the current |
376 subscriptions will remain unchanged. | 415 subscriptions will remain unchanged. |
377 </p> | 416 </p> |
378 | 417 |
379 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre
f="#type_ServerService">ServerService</a>>)</b></dt><dd> | 418 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre
f="#type_ServerService">ServerService</a>></b></dt><dd> |
380 | 419 |
381 <p>A list of the services being subscribed to.</p> | 420 <p>A list of the services being subscribed to.</p> |
382 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_server.connected">server.connected</a> (<a href="#notific
ation_server.connected">#</a>)</dt><dd><div class="box"><pre>notification: { | 421 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_server.connected">server.connected</a></dt><dd><div class
="box"><pre>notification: { |
383 "event": "server.connected" | 422 "event": "server.connected" |
384 "params": { | 423 "params": { |
385 "<b>version</b>": String | 424 "<b>version</b>": String |
386 "<b>pid</b>": int | 425 "<b>pid</b>": int |
387 "<b>sessionId</b>": <span style="color:#999999">optional</span> String | 426 "<b>sessionId</b>": <span style="color:#999999">optional</span> String |
388 } | 427 } |
389 }</pre></div> | 428 }</pre></div> |
390 <p> | 429 <p> |
391 Reports that the server is running. This notification is | 430 Reports that the server is running. This notification is |
392 issued once after the server has started running but before | 431 issued once after the server has started running but before |
393 any requests are processed to let the client know that it | 432 any requests are processed to let the client know that it |
394 started correctly. | 433 started correctly. |
395 </p> | 434 </p> |
396 <p> | 435 <p> |
397 It is not possible to subscribe to or unsubscribe from this | 436 It is not possible to subscribe to or unsubscribe from this |
398 notification. | 437 notification. |
399 </p> | 438 </p> |
400 | 439 |
401 <h4>parameters:</h4><dl><dt class="field"><b>version (String)</b></dt><dd> | 440 <h4>parameters:</h4><dl><dt class="field"><b>version: String</b></dt><dd> |
402 | 441 |
403 <p>The version number of the analysis server.</p> | 442 <p>The version number of the analysis server.</p> |
404 </dd><dt class="field"><b>pid (int)</b></dt><dd> | 443 </dd><dt class="field"><b>pid: int</b></dt><dd> |
405 | 444 |
406 <p>The process id of the analysis server process.</p> | 445 <p>The process id of the analysis server process.</p> |
407 </dd><dt class="field"><b>sessionId (<span style="color:#999999">option
al</span> String)</b></dt><dd> | 446 </dd><dt class="field"><b>sessionId: String<span style="color:#999999">
(optional)</span></b></dt><dd> |
408 | 447 |
409 <p>The session id for this session.</p> | 448 <p>The session id for this session.</p> |
410 </dd></dl></dd><dt class="notification"><a name="notification_server.er
ror">server.error</a> (<a href="#notification_server.error">#</a>)</dt><dd><div
class="box"><pre>notification: { | 449 </dd></dl></dd><dt class="notification"><a name="notification_server.er
ror">server.error</a></dt><dd><div class="box"><pre>notification: { |
411 "event": "server.error" | 450 "event": "server.error" |
412 "params": { | 451 "params": { |
413 "<b>isFatal</b>": bool | 452 "<b>isFatal</b>": bool |
414 "<b>message</b>": String | 453 "<b>message</b>": String |
415 "<b>stackTrace</b>": String | 454 "<b>stackTrace</b>": String |
416 } | 455 } |
417 }</pre></div> | 456 }</pre></div> |
418 <p> | 457 <p> |
419 Reports that an unexpected error has occurred while | 458 Reports that an unexpected error has occurred while |
420 executing the server. This notification is not used for | 459 executing the server. This notification is not used for |
421 problems with specific requests (which are returned as part | 460 problems with specific requests (which are returned as part |
422 of the response) but is used for exceptions that occur while | 461 of the response) but is used for exceptions that occur while |
423 performing other tasks, such as analysis or preparing | 462 performing other tasks, such as analysis or preparing |
424 notifications. | 463 notifications. |
425 </p> | 464 </p> |
426 <p> | 465 <p> |
427 It is not possible to subscribe to or unsubscribe from this | 466 It is not possible to subscribe to or unsubscribe from this |
428 notification. | 467 notification. |
429 </p> | 468 </p> |
430 | 469 |
431 <h4>parameters:</h4><dl><dt class="field"><b>isFatal (bool)</b></dt><dd> | 470 <h4>parameters:</h4><dl><dt class="field"><b>isFatal: bool</b></dt><dd> |
432 | 471 |
433 <p> | 472 <p> |
434 True if the error is a fatal error, meaning that the | 473 True if the error is a fatal error, meaning that the |
435 server will shutdown automatically after sending this | 474 server will shutdown automatically after sending this |
436 notification. | 475 notification. |
437 </p> | 476 </p> |
438 </dd><dt class="field"><b>message (String)</b></dt><dd> | 477 </dd><dt class="field"><b>message: String</b></dt><dd> |
439 | 478 |
440 <p> | 479 <p> |
441 The error message indicating what kind of error was | 480 The error message indicating what kind of error was |
442 encountered. | 481 encountered. |
443 </p> | 482 </p> |
444 </dd><dt class="field"><b>stackTrace (String)</b></dt><dd> | 483 </dd><dt class="field"><b>stackTrace: String</b></dt><dd> |
445 | 484 |
446 <p> | 485 <p> |
447 The stack trace associated with the generation of the | 486 The stack trace associated with the generation of the |
448 error, used for debugging the server. | 487 error, used for debugging the server. |
449 </p> | 488 </p> |
450 </dd></dl></dd><dt class="notification"><a name="notification_server.s
tatus">server.status</a> (<a href="#notification_server.status">#</a>)</dt><dd><
div class="box"><pre>notification: { | 489 </dd></dl></dd><dt class="notification"><a name="notification_server.s
tatus">server.status</a></dt><dd><div class="box"><pre>notification: { |
451 "event": "server.status" | 490 "event": "server.status" |
452 "params": { | 491 "params": { |
453 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ
e_AnalysisStatus">AnalysisStatus</a> | 492 "<b>analysis</b>": <span style="color:#999999">optional</span> <a href="#typ
e_AnalysisStatus">AnalysisStatus</a> |
454 "<b>pub</b>": <span style="color:#999999">optional</span> <a href="#type_Pub
Status">PubStatus</a> | 493 "<b>pub</b>": <span style="color:#999999">optional</span> <a href="#type_Pub
Status">PubStatus</a> |
455 } | 494 } |
456 }</pre></div> | 495 }</pre></div> |
457 <p> | 496 <p> |
458 Reports the current status of the server. Parameters are | 497 Reports the current status of the server. Parameters are |
459 omitted if there has been no change in the status | 498 omitted if there has been no change in the status |
460 represented by that parameter. | 499 represented by that parameter. |
461 </p> | 500 </p> |
462 <p> | 501 <p> |
463 This notification is not subscribed to by default. Clients | 502 This notification is not subscribed to by default. Clients |
464 can subscribe by including the value <tt>"STATUS"</tt> in | 503 can subscribe by including the value <tt>"STATUS"</tt> in |
465 the list of services passed in a server.setSubscriptions | 504 the list of services passed in a server.setSubscriptions |
466 request. | 505 request. |
467 </p> | 506 </p> |
468 | 507 |
469 <h4>parameters:</h4><dl><dt class="field"><b>analysis (<span style="color:
#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a>)</b><
/dt><dd> | 508 <h4>parameters:</h4><dl><dt class="field"><b>analysis: <a href="#type_Anal
ysisStatus">AnalysisStatus</a><span style="color:#999999"> (optional)</span></b>
</dt><dd> |
470 | 509 |
471 <p> | 510 <p> |
472 The current status of analysis, including whether | 511 The current status of analysis, including whether |
473 analysis is being performed and if so what is being | 512 analysis is being performed and if so what is being |
474 analyzed. | 513 analyzed. |
475 </p> | 514 </p> |
476 </dd><dt class="field"><b>pub (<span style="color:#999999">optional</s
pan> <a href="#type_PubStatus">PubStatus</a>)</b></dt><dd> | 515 </dd><dt class="field"><b>pub: <a href="#type_PubStatus">PubStatus</a>
<span style="color:#999999"> (optional)</span></b></dt><dd> |
477 | 516 |
478 <p> | 517 <p> |
479 The current status of pub execution, indicating whether we are | 518 The current status of pub execution, indicating whether we are |
480 currently running pub. | 519 currently running pub. |
481 </p> | 520 </p> |
482 </dd></dl></dd></dl> | 521 </dd></dl></dd></dl> |
483 <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2> | 522 <h2 class="domain"><a name="domain_analysis">analysis domain</a></h2> |
484 <p> | 523 <p> |
485 The analysis domain contains API’s related to the analysis of | 524 The analysis domain contains API’s related to the analysis of |
486 files. | 525 files. |
(...skipping 14 matching lines...) Expand all Loading... |
501 | 540 |
502 | 541 |
503 | 542 |
504 | 543 |
505 | 544 |
506 | 545 |
507 | 546 |
508 | 547 |
509 | 548 |
510 | 549 |
511 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getErrors
">analysis.getErrors</a> (<a href="#request_analysis.getErrors">#</a>)</dt><dd><
div class="box"><pre>request: { | 550 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getErrors
">analysis.getErrors</a></dt><dd><div class="box"><pre>request: { |
512 "id": String | 551 "id": String |
513 "method": "analysis.getErrors" | 552 "method": "analysis.getErrors" |
514 "params": { | 553 "params": { |
515 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 554 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
516 } | 555 } |
517 }</pre><br><pre>response: { | 556 }</pre><br><pre>response: { |
518 "id": String | 557 "id": String |
519 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 558 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
520 "result": { | 559 "result": { |
521 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> | 560 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> |
(...skipping 21 matching lines...) Expand all Loading... |
543 </p> | 582 </p> |
544 <p> | 583 <p> |
545 If a request is made for a file which does not exist, or | 584 If a request is made for a file which does not exist, or |
546 which is not currently subject to analysis (e.g. because it | 585 which is not currently subject to analysis (e.g. because it |
547 is not associated with any analysis root specified to | 586 is not associated with any analysis root specified to |
548 analysis.setAnalysisRoots), an error of type | 587 analysis.setAnalysisRoots), an error of type |
549 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated. | 588 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated. |
550 </p> | 589 </p> |
551 | 590 |
552 | 591 |
553 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 592 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
554 | 593 |
555 <p> | 594 <p> |
556 The file for which errors are being requested. | 595 The file for which errors are being requested. |
557 </p> | 596 </p> |
558 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors (List<<a
href="#type_AnalysisError">AnalysisError</a>>)</b></dt><dd> | 597 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>errors: List<<a
href="#type_AnalysisError">AnalysisError</a>></b></dt><dd> |
559 | 598 |
560 <p> | 599 <p> |
561 The errors associated with the file. | 600 The errors associated with the file. |
562 </p> | 601 </p> |
563 </dd></dl></dd><dt class="request"><a name="request_analysis.getHover"
>analysis.getHover</a> (<a href="#request_analysis.getHover">#</a>)</dt><dd><div
class="box"><pre>request: { | 602 </dd></dl></dd><dt class="request"><a name="request_analysis.getHover"
>analysis.getHover</a></dt><dd><div class="box"><pre>request: { |
564 "id": String | 603 "id": String |
565 "method": "analysis.getHover" | 604 "method": "analysis.getHover" |
566 "params": { | 605 "params": { |
567 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 606 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
568 "<b>offset</b>": int | 607 "<b>offset</b>": int |
569 } | 608 } |
570 }</pre><br><pre>response: { | 609 }</pre><br><pre>response: { |
571 "id": String | 610 "id": String |
572 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 611 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
573 "result": { | 612 "result": { |
574 "<b>hovers</b>": List<<a href="#type_HoverInformation">HoverInformation</
a>> | 613 "<b>hovers</b>": List<<a href="#type_HoverInformation">HoverInformation</
a>> |
575 } | 614 } |
576 }</pre></div> | 615 }</pre></div> |
577 <p> | 616 <p> |
578 Return the hover information associate with the given | 617 Return the hover information associate with the given |
579 location. If some or all of the hover information is not | 618 location. If some or all of the hover information is not |
580 available at the time this request is processed the | 619 available at the time this request is processed the |
581 information will be omitted from the response. | 620 information will be omitted from the response. |
582 </p> | 621 </p> |
583 | 622 |
584 | 623 |
585 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 624 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
586 | 625 |
587 <p> | 626 <p> |
588 The file in which hover information is being requested. | 627 The file in which hover information is being requested. |
589 </p> | 628 </p> |
590 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 629 </dd><dt class="field"><b>offset: int</b></dt><dd> |
591 | 630 |
592 <p> | 631 <p> |
593 The offset for which hover information is being requested. | 632 The offset for which hover information is being requested. |
594 </p> | 633 </p> |
595 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers (List<<a
href="#type_HoverInformation">HoverInformation</a>>)</b></dt><dd> | 634 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hovers: List<<a
href="#type_HoverInformation">HoverInformation</a>></b></dt><dd> |
596 | 635 |
597 <p> | 636 <p> |
598 The hover information associated with the | 637 The hover information associated with the |
599 location. The list will be empty if no information | 638 location. The list will be empty if no information |
600 could be determined for the location. The list can | 639 could be determined for the location. The list can |
601 contain multiple items if the file is being analyzed | 640 contain multiple items if the file is being analyzed |
602 in multiple contexts in conflicting ways (such as a | 641 in multiple contexts in conflicting ways (such as a |
603 part that is included in multiple libraries). | 642 part that is included in multiple libraries). |
604 </p> | 643 </p> |
605 </dd></dl></dd><dt class="request"><a name="request_analysis.getReacha
bleSources">analysis.getReachableSources</a> (<a href="#request_analysis.getReac
hableSources">#</a>)</dt><dd><div class="box"><pre>request: { | 644 </dd></dl></dd><dt class="request"><a name="request_analysis.getReacha
bleSources">analysis.getReachableSources</a></dt><dd><div class="box"><pre>reque
st: { |
606 "id": String | 645 "id": String |
607 "method": "analysis.getReachableSources" | 646 "method": "analysis.getReachableSources" |
608 "params": { | 647 "params": { |
609 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 648 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
610 } | 649 } |
611 }</pre><br><pre>response: { | 650 }</pre><br><pre>response: { |
612 "id": String | 651 "id": String |
613 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 652 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
614 "result": { | 653 "result": { |
615 "<b>sources</b>": Map<String, List<String>> | 654 "<b>sources</b>": Map<String, List<String>> |
616 } | 655 } |
617 }</pre></div> | 656 }</pre></div> |
618 <p> | 657 <p> |
619 Return the transitive closure of reachable sources for a given file. | 658 Return the transitive closure of reachable sources for a given file. |
620 </p> | 659 </p> |
621 <p> | 660 <p> |
622 If a request is made for a file which does not exist, or | 661 If a request is made for a file which does not exist, or |
623 which is not currently subject to analysis (e.g. because it | 662 which is not currently subject to analysis (e.g. because it |
624 is not associated with any analysis root specified to | 663 is not associated with any analysis root specified to |
625 analysis.setAnalysisRoots), an error of type | 664 analysis.setAnalysisRoots), an error of type |
626 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated. | 665 <tt>GET_REACHABLE_SOURCES_INVALID_FILE</tt> will be generated. |
627 </p> | 666 </p> |
628 | 667 |
629 | 668 |
630 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 669 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
631 | 670 |
632 <p> | 671 <p> |
633 The file for which reachable source information is being requested
. | 672 The file for which reachable source information is being requested
. |
634 </p> | 673 </p> |
635 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources (Map<St
ring, List<String>>)</b></dt><dd> | 674 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>sources: Map<St
ring, List<String>></b></dt><dd> |
636 | 675 |
637 <p> | 676 <p> |
638 A mapping from source URIs to directly reachable source URIs. For
example, | 677 A mapping from source URIs to directly reachable source URIs. For
example, |
639 a file "foo.dart" that imports "bar.dart" would have the correspon
ding mapping | 678 a file "foo.dart" that imports "bar.dart" would have the correspon
ding mapping |
640 { "file:///foo.dart" : ["file:///bar.dart"] }. If "bar.dart" has
further imports | 679 { "file:///foo.dart" : ["file:///bar.dart"] }. If "bar.dart" has
further imports |
641 (or exports) there will be a mapping from the URI "file:///bar.dar
t" to them. | 680 (or exports) there will be a mapping from the URI "file:///bar.dar
t" to them. |
642 To check if a specific URI is reachable from a given file, clients
can check | 681 To check if a specific URI is reachable from a given file, clients
can check |
643 for its presence in the resulting key set. | 682 for its presence in the resulting key set. |
644 </p> | 683 </p> |
645 </dd></dl></dd><dt class="request"><a name="request_analysis.getLibrar
yDependencies">analysis.getLibraryDependencies</a> (<a href="#request_analysis.g
etLibraryDependencies">#</a>)</dt><dd><div class="box"><pre>request: { | 684 </dd></dl></dd><dt class="request"><a name="request_analysis.getLibrar
yDependencies">analysis.getLibraryDependencies</a></dt><dd><div class="box"><pre
>request: { |
646 "id": String | 685 "id": String |
647 "method": "analysis.getLibraryDependencies" | 686 "method": "analysis.getLibraryDependencies" |
648 }</pre><br><pre>response: { | 687 }</pre><br><pre>response: { |
649 "id": String | 688 "id": String |
650 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 689 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
651 "result": { | 690 "result": { |
652 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>> | 691 "<b>libraries</b>": List<<a href="#type_FilePath">FilePath</a>> |
653 "<b>packageMap</b>": Map<String, Map<String, List<<a href="#type_Fi
lePath">FilePath</a>>>> | 692 "<b>packageMap</b>": Map<String, Map<String, List<<a href="#type_Fi
lePath">FilePath</a>>>> |
654 } | 693 } |
655 }</pre></div> | 694 }</pre></div> |
656 <p> | 695 <p> |
657 Return library dependency information for use in client-side indexing | 696 Return library dependency information for use in client-side indexing |
658 and package URI resolution. | 697 and package URI resolution. |
659 </p> | 698 </p> |
660 <p> | 699 <p> |
661 Clients that are only using the libraries field should consider using th
e | 700 Clients that are only using the libraries field should consider using th
e |
662 analyzedFiles notification instead. | 701 analyzedFiles notification instead. |
663 </p> | 702 </p> |
664 | 703 |
665 <h4>returns:</h4><dl><dt class="field"><b>libraries (List<<a href="#typ
e_FilePath">FilePath</a>>)</b></dt><dd> | 704 <h4>returns:</h4><dl><dt class="field"><b>libraries: List<<a href="#typ
e_FilePath">FilePath</a>></b></dt><dd> |
666 | 705 |
667 <p> | 706 <p> |
668 A list of the paths of library elements referenced by | 707 A list of the paths of library elements referenced by |
669 files in existing analysis roots. | 708 files in existing analysis roots. |
670 </p> | 709 </p> |
671 </dd><dt class="field"><b>packageMap (Map<String, Map<String,
List<<a href="#type_FilePath">FilePath</a>>>>)</b></dt><dd> | 710 </dd><dt class="field"><b>packageMap: Map<String, Map<String,
List<<a href="#type_FilePath">FilePath</a>>>></b></dt><dd> |
672 | 711 |
673 <p> | 712 <p> |
674 A mapping from context source roots to package maps which map | 713 A mapping from context source roots to package maps which map |
675 package names to source directories for use in client-side | 714 package names to source directories for use in client-side |
676 package URI resolution. | 715 package URI resolution. |
677 </p> | 716 </p> |
678 </dd></dl></dd><dt class="request"><a name="request_analysis.getNavi
gation">analysis.getNavigation</a> (<a href="#request_analysis.getNavigation">#<
/a>)</dt><dd><div class="box"><pre>request: { | 717 </dd></dl></dd><dt class="request"><a name="request_analysis.getNavi
gation">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: { |
679 "id": String | 718 "id": String |
680 "method": "analysis.getNavigation" | 719 "method": "analysis.getNavigation" |
681 "params": { | 720 "params": { |
682 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 721 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
683 "<b>offset</b>": int | 722 "<b>offset</b>": int |
684 "<b>length</b>": int | 723 "<b>length</b>": int |
685 } | 724 } |
686 }</pre><br><pre>response: { | 725 }</pre><br><pre>response: { |
687 "id": String | 726 "id": String |
688 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 727 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
(...skipping 23 matching lines...) Expand all Loading... |
712 </p> | 751 </p> |
713 <p> | 752 <p> |
714 If a request is made for a file which does not exist, or | 753 If a request is made for a file which does not exist, or |
715 which is not currently subject to analysis (e.g. because it | 754 which is not currently subject to analysis (e.g. because it |
716 is not associated with any analysis root specified to | 755 is not associated with any analysis root specified to |
717 analysis.setAnalysisRoots), an error of type | 756 analysis.setAnalysisRoots), an error of type |
718 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated. | 757 <tt>GET_NAVIGATION_INVALID_FILE</tt> will be generated. |
719 </p> | 758 </p> |
720 | 759 |
721 | 760 |
722 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 761 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
723 | 762 |
724 <p> | 763 <p> |
725 The file in which navigation information is being requested. | 764 The file in which navigation information is being requested. |
726 </p> | 765 </p> |
727 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 766 </dd><dt class="field"><b>offset: int</b></dt><dd> |
728 | 767 |
729 <p> | 768 <p> |
730 The offset of the region for which navigation information is being | 769 The offset of the region for which navigation information is being |
731 requested. | 770 requested. |
732 </p> | 771 </p> |
733 </dd><dt class="field"><b>length (int)</b></dt><dd> | 772 </dd><dt class="field"><b>length: int</b></dt><dd> |
734 | 773 |
735 <p> | 774 <p> |
736 The length of the region for which navigation information is being | 775 The length of the region for which navigation information is being |
737 requested. | 776 requested. |
738 </p> | 777 </p> |
739 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files (List<<a
href="#type_FilePath">FilePath</a>>)</b></dt><dd> | 778 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>files: List<<a
href="#type_FilePath">FilePath</a>></b></dt><dd> |
740 | 779 |
741 <p> | 780 <p> |
742 A list of the paths of files that are referenced by the navigation | 781 A list of the paths of files that are referenced by the navigation |
743 targets. | 782 targets. |
744 </p> | 783 </p> |
745 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa
rget">NavigationTarget</a>>)</b></dt><dd> | 784 </dd><dt class="field"><b>targets: List<<a href="#type_NavigationTa
rget">NavigationTarget</a>></b></dt><dd> |
746 | 785 |
747 <p> | 786 <p> |
748 A list of the navigation targets that are referenced by the | 787 A list of the navigation targets that are referenced by the |
749 navigation regions. | 788 navigation regions. |
750 </p> | 789 </p> |
751 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe
gion">NavigationRegion</a>>)</b></dt><dd> | 790 </dd><dt class="field"><b>regions: List<<a href="#type_NavigationRe
gion">NavigationRegion</a>></b></dt><dd> |
752 | 791 |
753 <p> | 792 <p> |
754 A list of the navigation regions within the requested region of | 793 A list of the navigation regions within the requested region of |
755 the file. | 794 the file. |
756 </p> | 795 </p> |
757 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze
">analysis.reanalyze</a> (<a href="#request_analysis.reanalyze">#</a>)</dt><dd><
div class="box"><pre>request: { | 796 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze
">analysis.reanalyze</a></dt><dd><div class="box"><pre>request: { |
758 "id": String | 797 "id": String |
759 "method": "analysis.reanalyze" | 798 "method": "analysis.reanalyze" |
760 "params": { | 799 "params": { |
761 "<b>roots</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_FilePath">FilePath</a>> | 800 "<b>roots</b>": <span style="color:#999999">optional</span> List<<a href=
"#type_FilePath">FilePath</a>> |
762 } | 801 } |
763 }</pre><br><pre>response: { | 802 }</pre><br><pre>response: { |
764 "id": String | 803 "id": String |
765 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 804 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
766 }</pre></div> | 805 }</pre></div> |
767 <p> | 806 <p> |
768 Force the re-analysis of everything contained in the specified | 807 Force the re-analysis of everything contained in the specified |
769 analysis roots. This will cause all previously computed analysis | 808 analysis roots. This will cause all previously computed analysis |
770 results to be discarded and recomputed, and will cause all subscribed | 809 results to be discarded and recomputed, and will cause all subscribed |
771 notifications to be re-sent. | 810 notifications to be re-sent. |
772 </p> | 811 </p> |
773 <p> | 812 <p> |
774 If no analysis roots are provided, then all current analysis roots | 813 If no analysis roots are provided, then all current analysis roots |
775 will be re-analyzed. If an empty list of analysis roots is provided, | 814 will be re-analyzed. If an empty list of analysis roots is provided, |
776 then nothing will be re-analyzed. If the list contains one or more | 815 then nothing will be re-analyzed. If the list contains one or more |
777 paths that are not currently analysis roots, then an error of type | 816 paths that are not currently analysis roots, then an error of type |
778 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated. | 817 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated. |
779 </p> | 818 </p> |
780 | 819 |
781 <h4>parameters:</h4><dl><dt class="field"><b>roots (<span style="color:#99
9999">optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt
><dd> | 820 <h4>parameters:</h4><dl><dt class="field"><b>roots: List<<a href="#type
_FilePath">FilePath</a>><span style="color:#999999"> (optional)</span></b></d
t><dd> |
782 | 821 |
783 <p> | 822 <p> |
784 A list of the analysis roots that are to be re-analyzed. | 823 A list of the analysis roots that are to be re-analyzed. |
785 </p> | 824 </p> |
786 </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalys
isRoots">analysis.setAnalysisRoots</a> (<a href="#request_analysis.setAnalysisRo
ots">#</a>)</dt><dd><div class="box"><pre>request: { | 825 </dd></dl></dd><dt class="request"><a name="request_analysis.setAnalys
isRoots">analysis.setAnalysisRoots</a></dt><dd><div class="box"><pre>request: { |
787 "id": String | 826 "id": String |
788 "method": "analysis.setAnalysisRoots" | 827 "method": "analysis.setAnalysisRoots" |
789 "params": { | 828 "params": { |
790 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> | 829 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> |
791 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> | 830 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> |
792 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a
href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> | 831 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a
href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> |
793 } | 832 } |
794 }</pre><br><pre>response: { | 833 }</pre><br><pre>response: { |
795 "id": String | 834 "id": String |
796 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 835 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
(...skipping 24 matching lines...) Expand all Loading... |
821 </p> | 860 </p> |
822 <p> | 861 <p> |
823 If an included path represents a file, then server will look | 862 If an included path represents a file, then server will look |
824 in the directory containing the file for a pubspec.yaml | 863 in the directory containing the file for a pubspec.yaml |
825 file. If none is found, then the parents of the directory | 864 file. If none is found, then the parents of the directory |
826 will be searched until such a file is found or the root of | 865 will be searched until such a file is found or the root of |
827 the file system is reached. If such a file is found, it will | 866 the file system is reached. If such a file is found, it will |
828 be used to resolve package: URI’s within the file. | 867 be used to resolve package: URI’s within the file. |
829 </p> | 868 </p> |
830 | 869 |
831 <h4>parameters:</h4><dl><dt class="field"><b>included (List<<a href="#t
ype_FilePath">FilePath</a>>)</b></dt><dd> | 870 <h4>parameters:</h4><dl><dt class="field"><b>included: List<<a href="#t
ype_FilePath">FilePath</a>></b></dt><dd> |
832 | 871 |
833 <p> | 872 <p> |
834 A list of the files and directories that should be | 873 A list of the files and directories that should be |
835 analyzed. | 874 analyzed. |
836 </p> | 875 </p> |
837 </dd><dt class="field"><b>excluded (List<<a href="#type_FilePath">F
ilePath</a>>)</b></dt><dd> | 876 </dd><dt class="field"><b>excluded: List<<a href="#type_FilePath">F
ilePath</a>></b></dt><dd> |
838 | 877 |
839 <p> | 878 <p> |
840 A list of the files and directories within the | 879 A list of the files and directories within the |
841 included directories that should not be analyzed. | 880 included directories that should not be analyzed. |
842 </p> | 881 </p> |
843 </dd><dt class="field"><b>packageRoots (<span style="color:#999999">op
tional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_FileP
ath">FilePath</a>>)</b></dt><dd> | 882 </dd><dt class="field"><b>packageRoots: Map<<a href="#type_FilePath
">FilePath</a>, <a href="#type_FilePath">FilePath</a>><span style="color:#999
999"> (optional)</span></b></dt><dd> |
844 | 883 |
845 <p> | 884 <p> |
846 A mapping from source directories to package roots | 885 A mapping from source directories to package roots |
847 that should override the normal package: URI resolution | 886 that should override the normal package: URI resolution |
848 mechanism. | 887 mechanism. |
849 </p> | 888 </p> |
850 <p> | 889 <p> |
851 If a package root is a directory, then | 890 If a package root is a directory, then |
852 the analyzer will behave as though the associated | 891 the analyzer will behave as though the associated |
853 source directory in the map contains a special | 892 source directory in the map contains a special |
(...skipping 10 matching lines...) Expand all Loading... |
864 as a "--packages" parameter to the Dart VM when | 903 as a "--packages" parameter to the Dart VM when |
865 executing any Dart file inside the source directory. | 904 executing any Dart file inside the source directory. |
866 </p> | 905 </p> |
867 <p> | 906 <p> |
868 Files in any directories that are not overridden by this | 907 Files in any directories that are not overridden by this |
869 mapping have their package: URI's resolved using the | 908 mapping have their package: URI's resolved using the |
870 normal pubspec.yaml mechanism. If this field is absent, | 909 normal pubspec.yaml mechanism. If this field is absent, |
871 or the empty map is specified, that indicates that the | 910 or the empty map is specified, that indicates that the |
872 normal pubspec.yaml mechanism should always be used. | 911 normal pubspec.yaml mechanism should always be used. |
873 </p> | 912 </p> |
874 </dd></dl></dd><dt class="request"><a name="request_analysis.setGenera
lSubscriptions">analysis.setGeneralSubscriptions</a> (<a href="#request_analysis
.setGeneralSubscriptions">#</a>)</dt><dd><div class="box"><pre>request: { | 913 </dd></dl></dd><dt class="request"><a name="request_analysis.setGenera
lSubscriptions">analysis.setGeneralSubscriptions</a></dt><dd><div class="box"><p
re>request: { |
875 "id": String | 914 "id": String |
876 "method": "analysis.setGeneralSubscriptions" | 915 "method": "analysis.setGeneralSubscriptions" |
877 "params": { | 916 "params": { |
878 "<b>subscriptions</b>": List<<a href="#type_GeneralAnalysisService">Gener
alAnalysisService</a>> | 917 "<b>subscriptions</b>": List<<a href="#type_GeneralAnalysisService">Gener
alAnalysisService</a>> |
879 } | 918 } |
880 }</pre><br><pre>response: { | 919 }</pre><br><pre>response: { |
881 "id": String | 920 "id": String |
882 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 921 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
883 }</pre></div> | 922 }</pre></div> |
884 <p> | 923 <p> |
885 Subscribe for general services (that is, services that are not | 924 Subscribe for general services (that is, services that are not |
886 specific to individual files). All previous subscriptions are replaced | 925 specific to individual files). All previous subscriptions are replaced |
887 by the given set of services. | 926 by the given set of services. |
888 </p> | 927 </p> |
889 <p> | 928 <p> |
890 It is an error if any of the elements in the list are not valid | 929 It is an error if any of the elements in the list are not valid |
891 services. If there is an error, then the current subscriptions will | 930 services. If there is an error, then the current subscriptions will |
892 remain unchanged. | 931 remain unchanged. |
893 </p> | 932 </p> |
894 | 933 |
895 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre
f="#type_GeneralAnalysisService">GeneralAnalysisService</a>>)</b></dt><dd> | 934 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre
f="#type_GeneralAnalysisService">GeneralAnalysisService</a>></b></dt><dd> |
896 | 935 |
897 <p>A list of the services being subscribed to.</p> | 936 <p>A list of the services being subscribed to.</p> |
898 </dd></dl></dd><dt class="request"><a name="request_analysis.setPriori
tyFiles">analysis.setPriorityFiles</a> (<a href="#request_analysis.setPriorityFi
les">#</a>)</dt><dd><div class="box"><pre>request: { | 937 </dd></dl></dd><dt class="request"><a name="request_analysis.setPriori
tyFiles">analysis.setPriorityFiles</a></dt><dd><div class="box"><pre>request: { |
899 "id": String | 938 "id": String |
900 "method": "analysis.setPriorityFiles" | 939 "method": "analysis.setPriorityFiles" |
901 "params": { | 940 "params": { |
902 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 941 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> |
903 } | 942 } |
904 }</pre><br><pre>response: { | 943 }</pre><br><pre>response: { |
905 "id": String | 944 "id": String |
906 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 945 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
907 }</pre></div> | 946 }</pre></div> |
908 <p> | 947 <p> |
(...skipping 15 matching lines...) Expand all Loading... |
924 analysis.setSubscriptions for a description of files that | 963 analysis.setSubscriptions for a description of files that |
925 are subject to analysis.) | 964 are subject to analysis.) |
926 </p> | 965 </p> |
927 <p> | 966 <p> |
928 If a requested priority file is a directory it is ignored, | 967 If a requested priority file is a directory it is ignored, |
929 but remains in the set of requested priority files so that | 968 but remains in the set of requested priority files so that |
930 if it later becomes a file it can be included in the set of | 969 if it later becomes a file it can be included in the set of |
931 actual priority files. | 970 actual priority files. |
932 </p> | 971 </p> |
933 | 972 |
934 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type
_FilePath">FilePath</a>>)</b></dt><dd> | 973 <h4>parameters:</h4><dl><dt class="field"><b>files: List<<a href="#type
_FilePath">FilePath</a>></b></dt><dd> |
935 | 974 |
936 <p> | 975 <p> |
937 The files that are to be a priority for analysis. | 976 The files that are to be a priority for analysis. |
938 </p> | 977 </p> |
939 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscr
iptions">analysis.setSubscriptions</a> (<a href="#request_analysis.setSubscripti
ons">#</a>)</dt><dd><div class="box"><pre>request: { | 978 </dd></dl></dd><dt class="request"><a name="request_analysis.setSubscr
iptions">analysis.setSubscriptions</a></dt><dd><div class="box"><pre>request: { |
940 "id": String | 979 "id": String |
941 "method": "analysis.setSubscriptions" | 980 "method": "analysis.setSubscriptions" |
942 "params": { | 981 "params": { |
943 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi
ce</a>, List<<a href="#type_FilePath">FilePath</a>>> | 982 "<b>subscriptions</b>": Map<<a href="#type_AnalysisService">AnalysisServi
ce</a>, List<<a href="#type_FilePath">FilePath</a>>> |
944 } | 983 } |
945 }</pre><br><pre>response: { | 984 }</pre><br><pre>response: { |
946 "id": String | 985 "id": String |
947 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 986 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
948 }</pre></div> | 987 }</pre></div> |
949 <p> | 988 <p> |
(...skipping 23 matching lines...) Expand all Loading... |
973 but remains in the set of requested subscriptions so that if | 1012 but remains in the set of requested subscriptions so that if |
974 it later becomes a file it can be included in the set of | 1013 it later becomes a file it can be included in the set of |
975 actual subscriptions. | 1014 actual subscriptions. |
976 </p> | 1015 </p> |
977 <p> | 1016 <p> |
978 It is an error if any of the keys in the map are not valid | 1017 It is an error if any of the keys in the map are not valid |
979 services. If there is an error, then the existing | 1018 services. If there is an error, then the existing |
980 subscriptions will remain unchanged. | 1019 subscriptions will remain unchanged. |
981 </p> | 1020 </p> |
982 | 1021 |
983 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (Map<<a href
="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">F
ilePath</a>>>)</b></dt><dd> | 1022 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: Map<<a href
="#type_AnalysisService">AnalysisService</a>, List<<a href="#type_FilePath">F
ilePath</a>>></b></dt><dd> |
984 | 1023 |
985 <p> | 1024 <p> |
986 A table mapping services to a list of the files being | 1025 A table mapping services to a list of the files being |
987 subscribed to the service. | 1026 subscribed to the service. |
988 </p> | 1027 </p> |
989 </dd></dl></dd><dt class="request"><a name="request_analysis.updateCon
tent">analysis.updateContent</a> (<a href="#request_analysis.updateContent">#</a
>)</dt><dd><div class="box"><pre>request: { | 1028 </dd></dl></dd><dt class="request"><a name="request_analysis.updateCon
tent">analysis.updateContent</a></dt><dd><div class="box"><pre>request: { |
990 "id": String | 1029 "id": String |
991 "method": "analysis.updateContent" | 1030 "method": "analysis.updateContent" |
992 "params": { | 1031 "params": { |
993 "<b>files</b>": Map<<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>> | 1032 "<b>files</b>": Map<<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>> |
994 } | 1033 } |
995 }</pre><br><pre>response: { | 1034 }</pre><br><pre>response: { |
996 "id": String | 1035 "id": String |
997 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1036 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
998 "result": { | 1037 "result": { |
999 } | 1038 } |
1000 }</pre></div> | 1039 }</pre></div> |
1001 <p> | 1040 <p> |
1002 Update the content of one or more files. Files that were | 1041 Update the content of one or more files. Files that were |
1003 previously updated but not included in this update remain | 1042 previously updated but not included in this update remain |
1004 unchanged. This effectively represents an overlay of the | 1043 unchanged. This effectively represents an overlay of the |
1005 filesystem. The files whose content is overridden are | 1044 filesystem. The files whose content is overridden are |
1006 therefore seen by server as being files with the given | 1045 therefore seen by server as being files with the given |
1007 content, even if the files do not exist on the filesystem or | 1046 content, even if the files do not exist on the filesystem or |
1008 if the file path represents the path to a directory on the | 1047 if the file path represents the path to a directory on the |
1009 filesystem. | 1048 filesystem. |
1010 </p> | 1049 </p> |
1011 | 1050 |
1012 | 1051 |
1013 <h4>parameters:</h4><dl><dt class="field"><b>files (Map<<a href="#type_
FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a>
| <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type
_RemoveContentOverlay">RemoveContentOverlay</a>>)</b></dt><dd> | 1052 <h4>parameters:</h4><dl><dt class="field"><b>files: Map<<a href="#type_
FilePath">FilePath</a>, <a href="#type_AddContentOverlay">AddContentOverlay</a>
| <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> | <a href="#type
_RemoveContentOverlay">RemoveContentOverlay</a>></b></dt><dd> |
1014 | 1053 |
1015 <p> | 1054 <p> |
1016 A table mapping the files whose content has changed to a | 1055 A table mapping the files whose content has changed to a |
1017 description of the content change. | 1056 description of the content change. |
1018 </p> | 1057 </p> |
1019 </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request"><a name="
request_analysis.updateOptions">analysis.updateOptions</a> (<a href="#request_an
alysis.updateOptions">#</a>)</dt><dd><div class="box"><pre>request: { | 1058 </dd></dl><h4>returns:</h4><dl></dl></dd><dt class="request deprecated
"><a name="request_analysis.updateOptions">analysis.updateOptions</a></dt><dd><d
iv class="box"><pre>request: { |
1020 "id": String | 1059 "id": String |
1021 "method": "analysis.updateOptions" | 1060 "method": "analysis.updateOptions" |
1022 "params": { | 1061 "params": { |
1023 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a> | 1062 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a> |
1024 } | 1063 } |
1025 }</pre><br><pre>response: { | 1064 }</pre><br><pre>response: { |
1026 "id": String | 1065 "id": String |
1027 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1066 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1028 }</pre></div> | 1067 }</pre></div> |
1029 <p><b><i>Deprecated</i></b>: all of the options can be set by users in | 1068 <p><b>Deprecated:</b> all of the options can be set by users in |
1030 an analysis options file.</p> | 1069 an analysis options file.</p> |
1031 <p> | 1070 <p> |
1032 Update the options controlling analysis based on the given | 1071 Update the options controlling analysis based on the given |
1033 set of options. Any options that are not included in the | 1072 set of options. Any options that are not included in the |
1034 analysis options will not be changed. If there are options | 1073 analysis options will not be changed. If there are options |
1035 in the analysis options that are not valid, they will be | 1074 in the analysis options that are not valid, they will be |
1036 silently ignored. | 1075 silently ignored. |
1037 </p> | 1076 </p> |
1038 | 1077 |
1039 <h4>parameters:</h4><dl><dt class="field"><b>options (<a href="#type_Analy
sisOptions">AnalysisOptions</a>)</b></dt><dd> | 1078 <h4>parameters:</h4><dl><dt class="field"><b>options: <a href="#type_Analy
sisOptions">AnalysisOptions</a></b></dt><dd> |
1040 | 1079 |
1041 <p> | 1080 <p> |
1042 The options that are to be used to control analysis. | 1081 The options that are to be used to control analysis. |
1043 </p> | 1082 </p> |
1044 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a> (<a hr
ef="#notification_analysis.analyzedFiles">#</a>)</dt><dd><div class="box"><pre>n
otification: { | 1083 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_analysis.analyzedFiles">analysis.analyzedFiles</a></dt><d
d><div class="box"><pre>notification: { |
1045 "event": "analysis.analyzedFiles" | 1084 "event": "analysis.analyzedFiles" |
1046 "params": { | 1085 "params": { |
1047 "<b>directories</b>": List<<a href="#type_FilePath">FilePath</a>> | 1086 "<b>directories</b>": List<<a href="#type_FilePath">FilePath</a>> |
1048 } | 1087 } |
1049 }</pre></div> | 1088 }</pre></div> |
1050 <p> | 1089 <p> |
1051 Reports the paths of the files that are being analyzed. | 1090 Reports the paths of the files that are being analyzed. |
1052 </p> | 1091 </p> |
1053 <p> | 1092 <p> |
1054 This notification is not subscribed to by default. Clients can | 1093 This notification is not subscribed to by default. Clients can |
1055 subscribe by including the value <tt>"ANALYZED_FILES"</tt> in the list | 1094 subscribe by including the value <tt>"ANALYZED_FILES"</tt> in the list |
1056 of services passed in an analysis.setGeneralSubscriptions request. | 1095 of services passed in an analysis.setGeneralSubscriptions request. |
1057 </p> | 1096 </p> |
1058 | 1097 |
1059 <h4>parameters:</h4><dl><dt class="field"><b>directories (List<<a href=
"#type_FilePath">FilePath</a>>)</b></dt><dd> | 1098 <h4>parameters:</h4><dl><dt class="field"><b>directories: List<<a href=
"#type_FilePath">FilePath</a>></b></dt><dd> |
1060 | 1099 |
1061 <p> | 1100 <p> |
1062 A list of the paths of the files that are being analyzed. | 1101 A list of the paths of the files that are being analyzed. |
1063 </p> | 1102 </p> |
1064 </dd></dl></dd><dt class="notification"><a name="notification_analys
is.errors">analysis.errors</a> (<a href="#notification_analysis.errors">#</a>)</
dt><dd><div class="box"><pre>notification: { | 1103 </dd></dl></dd><dt class="notification"><a name="notification_analys
is.errors">analysis.errors</a></dt><dd><div class="box"><pre>notification: { |
1065 "event": "analysis.errors" | 1104 "event": "analysis.errors" |
1066 "params": { | 1105 "params": { |
1067 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1106 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1068 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> | 1107 "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>> |
1069 } | 1108 } |
1070 }</pre></div> | 1109 }</pre></div> |
1071 <p> | 1110 <p> |
1072 Reports the errors associated with a given file. The set of | 1111 Reports the errors associated with a given file. The set of |
1073 errors included in the notification is always a complete | 1112 errors included in the notification is always a complete |
1074 list that supersedes any previously reported errors. | 1113 list that supersedes any previously reported errors. |
1075 </p> | 1114 </p> |
1076 | 1115 |
1077 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1116 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1078 | 1117 |
1079 <p> | 1118 <p> |
1080 The file containing the errors. | 1119 The file containing the errors. |
1081 </p> | 1120 </p> |
1082 </dd><dt class="field"><b>errors (List<<a href="#type_AnalysisError
">AnalysisError</a>>)</b></dt><dd> | 1121 </dd><dt class="field"><b>errors: List<<a href="#type_AnalysisError
">AnalysisError</a>></b></dt><dd> |
1083 | 1122 |
1084 <p> | 1123 <p> |
1085 The errors contained in the file. | 1124 The errors contained in the file. |
1086 </p> | 1125 </p> |
1087 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.flushResults">analysis.flushResults</a> (<a href="#notification_analysis.flushR
esults">#</a>)</dt><dd><div class="box"><pre>notification: { | 1126 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.flushResults">analysis.flushResults</a></dt><dd><div class="box"><pre>notificat
ion: { |
1088 "event": "analysis.flushResults" | 1127 "event": "analysis.flushResults" |
1089 "params": { | 1128 "params": { |
1090 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 1129 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> |
1091 } | 1130 } |
1092 }</pre></div> | 1131 }</pre></div> |
1093 <p> | 1132 <p> |
1094 Reports that any analysis results that were previously | 1133 Reports that any analysis results that were previously |
1095 associated with the given files should be considered to be | 1134 associated with the given files should be considered to be |
1096 invalid because those files are no longer being analyzed, | 1135 invalid because those files are no longer being analyzed, |
1097 either because the analysis root that contained it is no | 1136 either because the analysis root that contained it is no |
1098 longer being analyzed or because the file no longer exists. | 1137 longer being analyzed or because the file no longer exists. |
1099 </p> | 1138 </p> |
1100 <p> | 1139 <p> |
1101 If a file is included in this notification and at some later | 1140 If a file is included in this notification and at some later |
1102 time a notification with results for the file is received, | 1141 time a notification with results for the file is received, |
1103 clients should assume that the file is once again being | 1142 clients should assume that the file is once again being |
1104 analyzed and the information should be processed. | 1143 analyzed and the information should be processed. |
1105 </p> | 1144 </p> |
1106 <p> | 1145 <p> |
1107 It is not possible to subscribe to or unsubscribe from this | 1146 It is not possible to subscribe to or unsubscribe from this |
1108 notification. | 1147 notification. |
1109 </p> | 1148 </p> |
1110 | 1149 |
1111 <h4>parameters:</h4><dl><dt class="field"><b>files (List<<a href="#type
_FilePath">FilePath</a>>)</b></dt><dd> | 1150 <h4>parameters:</h4><dl><dt class="field"><b>files: List<<a href="#type
_FilePath">FilePath</a>></b></dt><dd> |
1112 | 1151 |
1113 <p> | 1152 <p> |
1114 The files that are no longer being analyzed. | 1153 The files that are no longer being analyzed. |
1115 </p> | 1154 </p> |
1116 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.folding">analysis.folding</a> (<a href="#notification_analysis.folding">#</a>)<
/dt><dd><div class="box"><pre>notification: { | 1155 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.folding">analysis.folding</a></dt><dd><div class="box"><pre>notification: { |
1117 "event": "analysis.folding" | 1156 "event": "analysis.folding" |
1118 "params": { | 1157 "params": { |
1119 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1158 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1120 "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>>
; | 1159 "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>>
; |
1121 } | 1160 } |
1122 }</pre></div> | 1161 }</pre></div> |
1123 <p> | 1162 <p> |
1124 Reports the folding regions associated with a given | 1163 Reports the folding regions associated with a given |
1125 file. Folding regions can be nested, but will not be | 1164 file. Folding regions can be nested, but will not be |
1126 overlapping. Nesting occurs when a foldable element, such as | 1165 overlapping. Nesting occurs when a foldable element, such as |
1127 a method, is nested inside another foldable element such as | 1166 a method, is nested inside another foldable element such as |
1128 a class. | 1167 a class. |
1129 </p> | 1168 </p> |
1130 <p> | 1169 <p> |
1131 This notification is not subscribed to by default. Clients | 1170 This notification is not subscribed to by default. Clients |
1132 can subscribe by including the value <tt>"FOLDING"</tt> in | 1171 can subscribe by including the value <tt>"FOLDING"</tt> in |
1133 the list of services passed in an analysis.setSubscriptions | 1172 the list of services passed in an analysis.setSubscriptions |
1134 request. | 1173 request. |
1135 </p> | 1174 </p> |
1136 | 1175 |
1137 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1176 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1138 | 1177 |
1139 <p> | 1178 <p> |
1140 The file containing the folding regions. | 1179 The file containing the folding regions. |
1141 </p> | 1180 </p> |
1142 </dd><dt class="field"><b>regions (List<<a href="#type_FoldingRegio
n">FoldingRegion</a>>)</b></dt><dd> | 1181 </dd><dt class="field"><b>regions: List<<a href="#type_FoldingRegio
n">FoldingRegion</a>></b></dt><dd> |
1143 | 1182 |
1144 <p> | 1183 <p> |
1145 The folding regions contained in the file. | 1184 The folding regions contained in the file. |
1146 </p> | 1185 </p> |
1147 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.highlights">analysis.highlights</a> (<a href="#notification_analysis.highlights
">#</a>)</dt><dd><div class="box"><pre>notification: { | 1186 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.highlights">analysis.highlights</a></dt><dd><div class="box"><pre>notification:
{ |
1148 "event": "analysis.highlights" | 1187 "event": "analysis.highlights" |
1149 "params": { | 1188 "params": { |
1150 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1189 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1151 "<b>regions</b>": List<<a href="#type_HighlightRegion">HighlightRegion</a
>> | 1190 "<b>regions</b>": List<<a href="#type_HighlightRegion">HighlightRegion</a
>> |
1152 } | 1191 } |
1153 }</pre></div> | 1192 }</pre></div> |
1154 <p> | 1193 <p> |
1155 Reports the highlight regions associated with a given file. | 1194 Reports the highlight regions associated with a given file. |
1156 </p> | 1195 </p> |
1157 <p> | 1196 <p> |
1158 This notification is not subscribed to by default. Clients | 1197 This notification is not subscribed to by default. Clients |
1159 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> | 1198 can subscribe by including the value <tt>"HIGHLIGHTS"</tt> |
1160 in the list of services passed in an | 1199 in the list of services passed in an |
1161 analysis.setSubscriptions request. | 1200 analysis.setSubscriptions request. |
1162 </p> | 1201 </p> |
1163 | 1202 |
1164 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1203 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1165 | 1204 |
1166 <p> | 1205 <p> |
1167 The file containing the highlight regions. | 1206 The file containing the highlight regions. |
1168 </p> | 1207 </p> |
1169 </dd><dt class="field"><b>regions (List<<a href="#type_HighlightReg
ion">HighlightRegion</a>>)</b></dt><dd> | 1208 </dd><dt class="field"><b>regions: List<<a href="#type_HighlightReg
ion">HighlightRegion</a>></b></dt><dd> |
1170 | 1209 |
1171 <p> | 1210 <p> |
1172 The highlight regions contained in the file. Each | 1211 The highlight regions contained in the file. Each |
1173 highlight region represents a particular syntactic or | 1212 highlight region represents a particular syntactic or |
1174 semantic meaning associated with some range. Note that | 1213 semantic meaning associated with some range. Note that |
1175 the highlight regions that are returned can overlap | 1214 the highlight regions that are returned can overlap |
1176 other highlight regions if there is more than one | 1215 other highlight regions if there is more than one |
1177 meaning associated with a particular region. | 1216 meaning associated with a particular region. |
1178 </p> | 1217 </p> |
1179 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.implemented">analysis.implemented</a> (<a href="#notification_analysis.implemen
ted">#</a>)</dt><dd><div class="box"><pre>notification: { | 1218 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.implemented">analysis.implemented</a></dt><dd><div class="box"><pre>notificatio
n: { |
1180 "event": "analysis.implemented" | 1219 "event": "analysis.implemented" |
1181 "params": { | 1220 "params": { |
1182 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1221 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1183 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass<
/a>> | 1222 "<b>classes</b>": List<<a href="#type_ImplementedClass">ImplementedClass<
/a>> |
1184 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe
r</a>> | 1223 "<b>members</b>": List<<a href="#type_ImplementedMember">ImplementedMembe
r</a>> |
1185 } | 1224 } |
1186 }</pre></div> | 1225 }</pre></div> |
1187 <p> | 1226 <p> |
1188 Reports the classes that are implemented or extended and | 1227 Reports the classes that are implemented or extended and |
1189 class members that are implemented or overridden in a file. | 1228 class members that are implemented or overridden in a file. |
1190 </p> | 1229 </p> |
1191 <p> | 1230 <p> |
1192 This notification is not subscribed to by default. Clients | 1231 This notification is not subscribed to by default. Clients |
1193 can subscribe by including the value <tt>"IMPLEMENTED"</tt> in | 1232 can subscribe by including the value <tt>"IMPLEMENTED"</tt> in |
1194 the list of services passed in an analysis.setSubscriptions | 1233 the list of services passed in an analysis.setSubscriptions |
1195 request. | 1234 request. |
1196 </p> | 1235 </p> |
1197 | 1236 |
1198 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1237 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1199 | 1238 |
1200 <p> | 1239 <p> |
1201 The file with which the implementations are associated. | 1240 The file with which the implementations are associated. |
1202 </p> | 1241 </p> |
1203 </dd><dt class="field"><b>classes (List<<a href="#type_ImplementedC
lass">ImplementedClass</a>>)</b></dt><dd> | 1242 </dd><dt class="field"><b>classes: List<<a href="#type_ImplementedC
lass">ImplementedClass</a>></b></dt><dd> |
1204 | 1243 |
1205 <p> | 1244 <p> |
1206 The classes defined in the file that are implemented or extended. | 1245 The classes defined in the file that are implemented or extended. |
1207 </p> | 1246 </p> |
1208 </dd><dt class="field"><b>members (List<<a href="#type_ImplementedM
ember">ImplementedMember</a>>)</b></dt><dd> | 1247 </dd><dt class="field"><b>members: List<<a href="#type_ImplementedM
ember">ImplementedMember</a>></b></dt><dd> |
1209 | 1248 |
1210 <p> | 1249 <p> |
1211 The member defined in the file that are implemented or overridden. | 1250 The member defined in the file that are implemented or overridden. |
1212 </p> | 1251 </p> |
1213 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.invalidate">analysis.invalidate</a> (<a href="#notification_analysis.invalidate
">#</a>)</dt><dd><div class="box"><pre>notification: { | 1252 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.invalidate">analysis.invalidate</a></dt><dd><div class="box"><pre>notification:
{ |
1214 "event": "analysis.invalidate" | 1253 "event": "analysis.invalidate" |
1215 "params": { | 1254 "params": { |
1216 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1255 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1217 "<b>offset</b>": int | 1256 "<b>offset</b>": int |
1218 "<b>length</b>": int | 1257 "<b>length</b>": int |
1219 "<b>delta</b>": int | 1258 "<b>delta</b>": int |
1220 } | 1259 } |
1221 }</pre></div> | 1260 }</pre></div> |
1222 <p> | 1261 <p> |
1223 Reports that the navigation information associated with a region of a | 1262 Reports that the navigation information associated with a region of a |
1224 single file has become invalid and should be re-requested. | 1263 single file has become invalid and should be re-requested. |
1225 </p> | 1264 </p> |
1226 <p> | 1265 <p> |
1227 This notification is not subscribed to by default. Clients can | 1266 This notification is not subscribed to by default. Clients can |
1228 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of | 1267 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of |
1229 services passed in an analysis.setSubscriptions request. | 1268 services passed in an analysis.setSubscriptions request. |
1230 </p> | 1269 </p> |
1231 | 1270 |
1232 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1271 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1233 | 1272 |
1234 <p> | 1273 <p> |
1235 The file whose information has been invalidated. | 1274 The file whose information has been invalidated. |
1236 </p> | 1275 </p> |
1237 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1276 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1238 | 1277 |
1239 <p> | 1278 <p> |
1240 The offset of the invalidated region. | 1279 The offset of the invalidated region. |
1241 </p> | 1280 </p> |
1242 </dd><dt class="field"><b>length (int)</b></dt><dd> | 1281 </dd><dt class="field"><b>length: int</b></dt><dd> |
1243 | 1282 |
1244 <p> | 1283 <p> |
1245 The length of the invalidated region. | 1284 The length of the invalidated region. |
1246 </p> | 1285 </p> |
1247 </dd><dt class="field"><b>delta (int)</b></dt><dd> | 1286 </dd><dt class="field"><b>delta: int</b></dt><dd> |
1248 | 1287 |
1249 <p> | 1288 <p> |
1250 The delta to be applied to the offsets in information that follows | 1289 The delta to be applied to the offsets in information that follows |
1251 the invalidated region in order to update it so that it doesn't | 1290 the invalidated region in order to update it so that it doesn't |
1252 need to be re-requested. | 1291 need to be re-requested. |
1253 </p> | 1292 </p> |
1254 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.navigation">analysis.navigation</a> (<a href="#notification_analysis.navigation
">#</a>)</dt><dd><div class="box"><pre>notification: { | 1293 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.navigation">analysis.navigation</a></dt><dd><div class="box"><pre>notification:
{ |
1255 "event": "analysis.navigation" | 1294 "event": "analysis.navigation" |
1256 "params": { | 1295 "params": { |
1257 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1296 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1258 "<b>regions</b>": List<<a href="#type_NavigationRegion">NavigationRegion<
/a>> | 1297 "<b>regions</b>": List<<a href="#type_NavigationRegion">NavigationRegion<
/a>> |
1259 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget<
/a>> | 1298 "<b>targets</b>": List<<a href="#type_NavigationTarget">NavigationTarget<
/a>> |
1260 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 1299 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> |
1261 } | 1300 } |
1262 }</pre></div> | 1301 }</pre></div> |
1263 <p> | 1302 <p> |
1264 Reports the navigation targets associated with a given file. | 1303 Reports the navigation targets associated with a given file. |
1265 </p> | 1304 </p> |
1266 <p> | 1305 <p> |
1267 This notification is not subscribed to by default. Clients | 1306 This notification is not subscribed to by default. Clients |
1268 can subscribe by including the value <tt>"NAVIGATION"</tt> | 1307 can subscribe by including the value <tt>"NAVIGATION"</tt> |
1269 in the list of services passed in an | 1308 in the list of services passed in an |
1270 analysis.setSubscriptions request. | 1309 analysis.setSubscriptions request. |
1271 </p> | 1310 </p> |
1272 | 1311 |
1273 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1312 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1274 | 1313 |
1275 <p> | 1314 <p> |
1276 The file containing the navigation regions. | 1315 The file containing the navigation regions. |
1277 </p> | 1316 </p> |
1278 </dd><dt class="field"><b>regions (List<<a href="#type_NavigationRe
gion">NavigationRegion</a>>)</b></dt><dd> | 1317 </dd><dt class="field"><b>regions: List<<a href="#type_NavigationRe
gion">NavigationRegion</a>></b></dt><dd> |
1279 | 1318 |
1280 <p> | 1319 <p> |
1281 The navigation regions contained in the file. | 1320 The navigation regions contained in the file. |
1282 The regions are sorted by their offsets. | 1321 The regions are sorted by their offsets. |
1283 Each navigation region represents a list of targets | 1322 Each navigation region represents a list of targets |
1284 associated with some range. The lists will usually | 1323 associated with some range. The lists will usually |
1285 contain a single target, but can contain more in the | 1324 contain a single target, but can contain more in the |
1286 case of a part that is included in multiple libraries | 1325 case of a part that is included in multiple libraries |
1287 or in Dart code that is compiled against multiple | 1326 or in Dart code that is compiled against multiple |
1288 versions of a package. Note that the navigation | 1327 versions of a package. Note that the navigation |
1289 regions that are returned do not overlap other | 1328 regions that are returned do not overlap other |
1290 navigation regions. | 1329 navigation regions. |
1291 </p> | 1330 </p> |
1292 </dd><dt class="field"><b>targets (List<<a href="#type_NavigationTa
rget">NavigationTarget</a>>)</b></dt><dd> | 1331 </dd><dt class="field"><b>targets: List<<a href="#type_NavigationTa
rget">NavigationTarget</a>></b></dt><dd> |
1293 | 1332 |
1294 <p> | 1333 <p> |
1295 The navigation targets referenced in the file. | 1334 The navigation targets referenced in the file. |
1296 They are referenced by <tt>NavigationRegion</tt>s by their | 1335 They are referenced by <tt>NavigationRegion</tt>s by their |
1297 index in this array. | 1336 index in this array. |
1298 </p> | 1337 </p> |
1299 </dd><dt class="field"><b>files (List<<a href="#type_FilePath">File
Path</a>>)</b></dt><dd> | 1338 </dd><dt class="field"><b>files: List<<a href="#type_FilePath">File
Path</a>></b></dt><dd> |
1300 | 1339 |
1301 <p> | 1340 <p> |
1302 The files containing navigation targets referenced in the file. | 1341 The files containing navigation targets referenced in the file. |
1303 They are referenced by <tt>NavigationTarget</tt>s by their | 1342 They are referenced by <tt>NavigationTarget</tt>s by their |
1304 index in this array. | 1343 index in this array. |
1305 </p> | 1344 </p> |
1306 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.occurrences">analysis.occurrences</a> (<a href="#notification_analysis.occurren
ces">#</a>)</dt><dd><div class="box"><pre>notification: { | 1345 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.occurrences">analysis.occurrences</a></dt><dd><div class="box"><pre>notificatio
n: { |
1307 "event": "analysis.occurrences" | 1346 "event": "analysis.occurrences" |
1308 "params": { | 1347 "params": { |
1309 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1348 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1310 "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>>
; | 1349 "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>>
; |
1311 } | 1350 } |
1312 }</pre></div> | 1351 }</pre></div> |
1313 <p> | 1352 <p> |
1314 Reports the occurrences of references to elements within a | 1353 Reports the occurrences of references to elements within a |
1315 single file. | 1354 single file. |
1316 </p> | 1355 </p> |
1317 <p> | 1356 <p> |
1318 This notification is not subscribed to by default. Clients | 1357 This notification is not subscribed to by default. Clients |
1319 can subscribe by including the value <tt>"OCCURRENCES"</tt> | 1358 can subscribe by including the value <tt>"OCCURRENCES"</tt> |
1320 in the list of services passed in an | 1359 in the list of services passed in an |
1321 analysis.setSubscriptions request. | 1360 analysis.setSubscriptions request. |
1322 </p> | 1361 </p> |
1323 | 1362 |
1324 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1363 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1325 | 1364 |
1326 <p> | 1365 <p> |
1327 The file in which the references occur. | 1366 The file in which the references occur. |
1328 </p> | 1367 </p> |
1329 </dd><dt class="field"><b>occurrences (List<<a href="#type_Occurren
ces">Occurrences</a>>)</b></dt><dd> | 1368 </dd><dt class="field"><b>occurrences: List<<a href="#type_Occurren
ces">Occurrences</a>></b></dt><dd> |
1330 | 1369 |
1331 <p> | 1370 <p> |
1332 The occurrences of references to elements within the | 1371 The occurrences of references to elements within the |
1333 file. | 1372 file. |
1334 </p> | 1373 </p> |
1335 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.outline">analysis.outline</a> (<a href="#notification_analysis.outline">#</a>)<
/dt><dd><div class="box"><pre>notification: { | 1374 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.outline">analysis.outline</a></dt><dd><div class="box"><pre>notification: { |
1336 "event": "analysis.outline" | 1375 "event": "analysis.outline" |
1337 "params": { | 1376 "params": { |
1338 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1377 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1339 "<b>kind</b>": <a href="#type_FileKind">FileKind</a> | 1378 "<b>kind</b>": <a href="#type_FileKind">FileKind</a> |
1340 "<b>libraryName</b>": <span style="color:#999999">optional</span> String | 1379 "<b>libraryName</b>": <span style="color:#999999">optional</span> String |
1341 "<b>outline</b>": <a href="#type_Outline">Outline</a> | 1380 "<b>outline</b>": <a href="#type_Outline">Outline</a> |
1342 } | 1381 } |
1343 }</pre></div> | 1382 }</pre></div> |
1344 <p> | 1383 <p> |
1345 Reports the outline associated with a single file. | 1384 Reports the outline associated with a single file. |
1346 </p> | 1385 </p> |
1347 <p> | 1386 <p> |
1348 This notification is not subscribed to by default. Clients | 1387 This notification is not subscribed to by default. Clients |
1349 can subscribe by including the value <tt>"OUTLINE"</tt> in | 1388 can subscribe by including the value <tt>"OUTLINE"</tt> in |
1350 the list of services passed in an analysis.setSubscriptions | 1389 the list of services passed in an analysis.setSubscriptions |
1351 request. | 1390 request. |
1352 </p> | 1391 </p> |
1353 | 1392 |
1354 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1393 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1355 | 1394 |
1356 <p> | 1395 <p> |
1357 The file with which the outline is associated. | 1396 The file with which the outline is associated. |
1358 </p> | 1397 </p> |
1359 </dd><dt class="field"><b>kind (<a href="#type_FileKind">FileKind</a>)
</b></dt><dd> | 1398 </dd><dt class="field"><b>kind: <a href="#type_FileKind">FileKind</a><
/b></dt><dd> |
1360 | 1399 |
1361 <p> | 1400 <p> |
1362 The kind of the file. | 1401 The kind of the file. |
1363 </p> | 1402 </p> |
1364 </dd><dt class="field"><b>libraryName (<span style="color:#999999">opt
ional</span> String)</b></dt><dd> | 1403 </dd><dt class="field"><b>libraryName: String<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
1365 | 1404 |
1366 <p> | 1405 <p> |
1367 The name of the library defined by the file using a "library" | 1406 The name of the library defined by the file using a "library" |
1368 directive, or referenced by a "part of" directive. If both | 1407 directive, or referenced by a "part of" directive. If both |
1369 "library" and "part of" directives are present, then the | 1408 "library" and "part of" directives are present, then the |
1370 "library" directive takes precedence. | 1409 "library" directive takes precedence. |
1371 This field will be omitted if the file has neither "library" | 1410 This field will be omitted if the file has neither "library" |
1372 nor "part of" directives. | 1411 nor "part of" directives. |
1373 </p> | 1412 </p> |
1374 </dd><dt class="field"><b>outline (<a href="#type_Outline">Outline</a>
)</b></dt><dd> | 1413 </dd><dt class="field"><b>outline: <a href="#type_Outline">Outline</a>
</b></dt><dd> |
1375 | 1414 |
1376 <p> | 1415 <p> |
1377 The outline associated with the file. | 1416 The outline associated with the file. |
1378 </p> | 1417 </p> |
1379 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.overrides">analysis.overrides</a> (<a href="#notification_analysis.overrides">#
</a>)</dt><dd><div class="box"><pre>notification: { | 1418 </dd></dl></dd><dt class="notification"><a name="notification_analysis
.overrides">analysis.overrides</a></dt><dd><div class="box"><pre>notification: { |
1380 "event": "analysis.overrides" | 1419 "event": "analysis.overrides" |
1381 "params": { | 1420 "params": { |
1382 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1421 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1383 "<b>overrides</b>": List<<a href="#type_Override">Override</a>> | 1422 "<b>overrides</b>": List<<a href="#type_Override">Override</a>> |
1384 } | 1423 } |
1385 }</pre></div> | 1424 }</pre></div> |
1386 <p> | 1425 <p> |
1387 Reports the overriding members in a file. | 1426 Reports the overriding members in a file. |
1388 </p> | 1427 </p> |
1389 <p> | 1428 <p> |
1390 This notification is not subscribed to by default. Clients | 1429 This notification is not subscribed to by default. Clients |
1391 can subscribe by including the value <tt>"OVERRIDES"</tt> in | 1430 can subscribe by including the value <tt>"OVERRIDES"</tt> in |
1392 the list of services passed in an analysis.setSubscriptions | 1431 the list of services passed in an analysis.setSubscriptions |
1393 request. | 1432 request. |
1394 </p> | 1433 </p> |
1395 | 1434 |
1396 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1435 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1397 | 1436 |
1398 <p> | 1437 <p> |
1399 The file with which the overrides are associated. | 1438 The file with which the overrides are associated. |
1400 </p> | 1439 </p> |
1401 </dd><dt class="field"><b>overrides (List<<a href="#type_Override">
Override</a>>)</b></dt><dd> | 1440 </dd><dt class="field"><b>overrides: List<<a href="#type_Override">
Override</a>></b></dt><dd> |
1402 | 1441 |
1403 <p> | 1442 <p> |
1404 The overrides associated with the file. | 1443 The overrides associated with the file. |
1405 </p> | 1444 </p> |
1406 </dd></dl></dd></dl> | 1445 </dd></dl></dd></dl> |
1407 <h2 class="domain"><a name="domain_completion">completion domain</a></h2> | 1446 <h2 class="domain"><a name="domain_completion">completion domain</a></h2> |
1408 <p> | 1447 <p> |
1409 The code completion domain contains commands related to | 1448 The code completion domain contains commands related to |
1410 getting code completion suggestions. | 1449 getting code completion suggestions. |
1411 </p> | 1450 </p> |
1412 | 1451 |
1413 | 1452 |
1414 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSugg
estions">completion.getSuggestions</a> (<a href="#request_completion.getSuggesti
ons">#</a>)</dt><dd><div class="box"><pre>request: { | 1453 <h3>Requests</h3><dl><dt class="request"><a name="request_completion.getSugg
estions">completion.getSuggestions</a></dt><dd><div class="box"><pre>request: { |
1415 "id": String | 1454 "id": String |
1416 "method": "completion.getSuggestions" | 1455 "method": "completion.getSuggestions" |
1417 "params": { | 1456 "params": { |
1418 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1457 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1419 "<b>offset</b>": int | 1458 "<b>offset</b>": int |
1420 } | 1459 } |
1421 }</pre><br><pre>response: { | 1460 }</pre><br><pre>response: { |
1422 "<b>id</b>": String | 1461 "<b>id</b>": String |
1423 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1462 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1424 "result": { | 1463 "result": { |
1425 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> | 1464 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> |
1426 } | 1465 } |
1427 }</pre></div> | 1466 }</pre></div> |
1428 <p> | 1467 <p> |
1429 Request that completion suggestions for the given offset in | 1468 Request that completion suggestions for the given offset in |
1430 the given file be returned. | 1469 the given file be returned. |
1431 </p> | 1470 </p> |
1432 | 1471 |
1433 | 1472 |
1434 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1473 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1435 | 1474 |
1436 <p> | 1475 <p> |
1437 The file containing the point at which suggestions are | 1476 The file containing the point at which suggestions are |
1438 to be made. | 1477 to be made. |
1439 </p> | 1478 </p> |
1440 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1479 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1441 | 1480 |
1442 <p> | 1481 <p> |
1443 The offset within the file at which suggestions are to | 1482 The offset within the file at which suggestions are to |
1444 be made. | 1483 be made. |
1445 </p> | 1484 </p> |
1446 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type
_CompletionId">CompletionId</a>)</b></dt><dd> | 1485 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_CompletionId">CompletionId</a></b></dt><dd> |
1447 | 1486 |
1448 <p> | 1487 <p> |
1449 The identifier used to associate results with this | 1488 The identifier used to associate results with this |
1450 completion request. | 1489 completion request. |
1451 </p> | 1490 </p> |
1452 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_completion.results">completion.results</a> (<a href="#not
ification_completion.results">#</a>)</dt><dd><div class="box"><pre>notification:
{ | 1491 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_completion.results">completion.results</a></dt><dd><div c
lass="box"><pre>notification: { |
1453 "event": "completion.results" | 1492 "event": "completion.results" |
1454 "params": { | 1493 "params": { |
1455 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> | 1494 "<b>id</b>": <a href="#type_CompletionId">CompletionId</a> |
1456 "<b>replacementOffset</b>": int | 1495 "<b>replacementOffset</b>": int |
1457 "<b>replacementLength</b>": int | 1496 "<b>replacementLength</b>": int |
1458 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug
gestion</a>> | 1497 "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSug
gestion</a>> |
1459 "<b>isLast</b>": bool | 1498 "<b>isLast</b>": bool |
1460 } | 1499 } |
1461 }</pre></div> | 1500 }</pre></div> |
1462 <p> | 1501 <p> |
1463 Reports the completion suggestions that should be presented | 1502 Reports the completion suggestions that should be presented |
1464 to the user. The set of suggestions included in the | 1503 to the user. The set of suggestions included in the |
1465 notification is always a complete list that supersedes any | 1504 notification is always a complete list that supersedes any |
1466 previously reported suggestions. | 1505 previously reported suggestions. |
1467 </p> | 1506 </p> |
1468 | 1507 |
1469 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_Completion
Id">CompletionId</a>)</b></dt><dd> | 1508 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_Completion
Id">CompletionId</a></b></dt><dd> |
1470 | 1509 |
1471 <p> | 1510 <p> |
1472 The id associated with the completion. | 1511 The id associated with the completion. |
1473 </p> | 1512 </p> |
1474 </dd><dt class="field"><b>replacementOffset (int)</b></dt><dd> | 1513 </dd><dt class="field"><b>replacementOffset: int</b></dt><dd> |
1475 | 1514 |
1476 <p> | 1515 <p> |
1477 The offset of the start of the text to be | 1516 The offset of the start of the text to be |
1478 replaced. This will be different than the offset used | 1517 replaced. This will be different than the offset used |
1479 to request the completion suggestions if there was a | 1518 to request the completion suggestions if there was a |
1480 portion of an identifier before the original | 1519 portion of an identifier before the original |
1481 offset. In particular, the replacementOffset will be | 1520 offset. In particular, the replacementOffset will be |
1482 the offset of the beginning of said identifier. | 1521 the offset of the beginning of said identifier. |
1483 </p> | 1522 </p> |
1484 </dd><dt class="field"><b>replacementLength (int)</b></dt><dd> | 1523 </dd><dt class="field"><b>replacementLength: int</b></dt><dd> |
1485 | 1524 |
1486 <p> | 1525 <p> |
1487 The length of the text to be replaced if the remainder | 1526 The length of the text to be replaced if the remainder |
1488 of the identifier containing the cursor is to be | 1527 of the identifier containing the cursor is to be |
1489 replaced when the suggestion is applied (that is, the | 1528 replaced when the suggestion is applied (that is, the |
1490 number of characters in the existing identifier). | 1529 number of characters in the existing identifier). |
1491 </p> | 1530 </p> |
1492 </dd><dt class="field"><b>results (List<<a href="#type_CompletionSu
ggestion">CompletionSuggestion</a>>)</b></dt><dd> | 1531 </dd><dt class="field"><b>results: List<<a href="#type_CompletionSu
ggestion">CompletionSuggestion</a>></b></dt><dd> |
1493 | 1532 |
1494 <p> | 1533 <p> |
1495 The completion suggestions being reported. The | 1534 The completion suggestions being reported. The |
1496 notification contains all possible completions at the | 1535 notification contains all possible completions at the |
1497 requested cursor position, even those that do not match | 1536 requested cursor position, even those that do not match |
1498 the characters the user has already typed. This allows | 1537 the characters the user has already typed. This allows |
1499 the client to respond to further keystrokes from the | 1538 the client to respond to further keystrokes from the |
1500 user without having to make additional requests. | 1539 user without having to make additional requests. |
1501 </p> | 1540 </p> |
1502 </dd><dt class="field"><b>isLast (bool)</b></dt><dd> | 1541 </dd><dt class="field"><b>isLast: bool</b></dt><dd> |
1503 | 1542 |
1504 <p> | 1543 <p> |
1505 True if this is that last set of results that will be | 1544 True if this is that last set of results that will be |
1506 returned for the indicated completion. | 1545 returned for the indicated completion. |
1507 </p> | 1546 </p> |
1508 </dd></dl></dd></dl> | 1547 </dd></dl></dd></dl> |
1509 <h2 class="domain"><a name="domain_search">search domain</a></h2> | 1548 <h2 class="domain"><a name="domain_search">search domain</a></h2> |
1510 <p> | 1549 <p> |
1511 The search domain contains commands related to searches that | 1550 The search domain contains commands related to searches that |
1512 can be performed against the code base. | 1551 can be performed against the code base. |
1513 </p> | 1552 </p> |
1514 | 1553 |
1515 | 1554 |
1516 | 1555 |
1517 | 1556 |
1518 | 1557 |
1519 | 1558 |
1520 <h3>Requests</h3><dl><dt class="request"><a name="request_search.findElement
References">search.findElementReferences</a> (<a href="#request_search.findEleme
ntReferences">#</a>)</dt><dd><div class="box"><pre>request: { | 1559 <h3>Requests</h3><dl><dt class="request"><a name="request_search.findElement
References">search.findElementReferences</a></dt><dd><div class="box"><pre>reque
st: { |
1521 "id": String | 1560 "id": String |
1522 "method": "search.findElementReferences" | 1561 "method": "search.findElementReferences" |
1523 "params": { | 1562 "params": { |
1524 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1563 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1525 "<b>offset</b>": int | 1564 "<b>offset</b>": int |
1526 "<b>includePotential</b>": bool | 1565 "<b>includePotential</b>": bool |
1527 } | 1566 } |
1528 }</pre><br><pre>response: { | 1567 }</pre><br><pre>response: { |
1529 "<b>id</b>": String | 1568 "<b>id</b>": String |
1530 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1569 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1531 "result": { | 1570 "result": { |
1532 "<b>id</b>": <span style="color:#999999">optional</span> <a href="#type_Sear
chId">SearchId</a> | 1571 "<b>id</b>": <span style="color:#999999">optional</span> <a href="#type_Sear
chId">SearchId</a> |
1533 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type
_Element">Element</a> | 1572 "<b>element</b>": <span style="color:#999999">optional</span> <a href="#type
_Element">Element</a> |
1534 } | 1573 } |
1535 }</pre></div> | 1574 }</pre></div> |
1536 <p> | 1575 <p> |
1537 Perform a search for references to the element defined or | 1576 Perform a search for references to the element defined or |
1538 referenced at the given offset in the given file. | 1577 referenced at the given offset in the given file. |
1539 </p> | 1578 </p> |
1540 <p> | 1579 <p> |
1541 An identifier is returned immediately, and individual | 1580 An identifier is returned immediately, and individual |
1542 results will be returned via the search.results notification | 1581 results will be returned via the search.results notification |
1543 as they become available. | 1582 as they become available. |
1544 </p> | 1583 </p> |
1545 | 1584 |
1546 | 1585 |
1547 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1586 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1548 | 1587 |
1549 <p> | 1588 <p> |
1550 The file containing the declaration of or reference to | 1589 The file containing the declaration of or reference to |
1551 the element used to define the search. | 1590 the element used to define the search. |
1552 </p> | 1591 </p> |
1553 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1592 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1554 | 1593 |
1555 <p> | 1594 <p> |
1556 The offset within the file of the declaration of or | 1595 The offset within the file of the declaration of or |
1557 reference to the element. | 1596 reference to the element. |
1558 </p> | 1597 </p> |
1559 </dd><dt class="field"><b>includePotential (bool)</b></dt><dd> | 1598 </dd><dt class="field"><b>includePotential: bool</b></dt><dd> |
1560 | 1599 |
1561 <p> | 1600 <p> |
1562 True if potential matches are to be included in the | 1601 True if potential matches are to be included in the |
1563 results. | 1602 results. |
1564 </p> | 1603 </p> |
1565 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<span style="c
olor:#999999">optional</span> <a href="#type_SearchId">SearchId</a>)</b></dt><dd
> | 1604 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_SearchId">SearchId</a><span style="color:#999999"> (optional)</span></b></dt><d
d> |
1566 | 1605 |
1567 <p> | 1606 <p> |
1568 The identifier used to associate results with this | 1607 The identifier used to associate results with this |
1569 search request. | 1608 search request. |
1570 </p> | 1609 </p> |
1571 <p> | 1610 <p> |
1572 If no element was found at the given location, this | 1611 If no element was found at the given location, this |
1573 field will be absent, and no results will be reported | 1612 field will be absent, and no results will be reported |
1574 via the search.results notification. | 1613 via the search.results notification. |
1575 </p> | 1614 </p> |
1576 </dd><dt class="field"><b>element (<span style="color:#999999">optiona
l</span> <a href="#type_Element">Element</a>)</b></dt><dd> | 1615 </dd><dt class="field"><b>element: <a href="#type_Element">Element</a>
<span style="color:#999999"> (optional)</span></b></dt><dd> |
1577 | 1616 |
1578 <p> | 1617 <p> |
1579 The element referenced or defined at the given offset | 1618 The element referenced or defined at the given offset |
1580 and whose references will be returned in the search | 1619 and whose references will be returned in the search |
1581 results. | 1620 results. |
1582 </p> | 1621 </p> |
1583 <p> | 1622 <p> |
1584 If no element was found at the given location, this | 1623 If no element was found at the given location, this |
1585 field will be absent. | 1624 field will be absent. |
1586 </p> | 1625 </p> |
1587 </dd></dl></dd><dt class="request"><a name="request_search.findMemberD
eclarations">search.findMemberDeclarations</a> (<a href="#request_search.findMem
berDeclarations">#</a>)</dt><dd><div class="box"><pre>request: { | 1626 </dd></dl></dd><dt class="request"><a name="request_search.findMemberD
eclarations">search.findMemberDeclarations</a></dt><dd><div class="box"><pre>req
uest: { |
1588 "id": String | 1627 "id": String |
1589 "method": "search.findMemberDeclarations" | 1628 "method": "search.findMemberDeclarations" |
1590 "params": { | 1629 "params": { |
1591 "<b>name</b>": String | 1630 "<b>name</b>": String |
1592 } | 1631 } |
1593 }</pre><br><pre>response: { | 1632 }</pre><br><pre>response: { |
1594 "<b>id</b>": String | 1633 "<b>id</b>": String |
1595 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1634 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1596 "result": { | 1635 "result": { |
1597 "<b>id</b>": <a href="#type_SearchId">SearchId</a> | 1636 "<b>id</b>": <a href="#type_SearchId">SearchId</a> |
1598 } | 1637 } |
1599 }</pre></div> | 1638 }</pre></div> |
1600 <p> | 1639 <p> |
1601 Perform a search for declarations of members whose name is | 1640 Perform a search for declarations of members whose name is |
1602 equal to the given name. | 1641 equal to the given name. |
1603 </p> | 1642 </p> |
1604 <p> | 1643 <p> |
1605 An identifier is returned immediately, and individual | 1644 An identifier is returned immediately, and individual |
1606 results will be returned via the search.results notification | 1645 results will be returned via the search.results notification |
1607 as they become available. | 1646 as they become available. |
1608 </p> | 1647 </p> |
1609 | 1648 |
1610 | 1649 |
1611 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> | 1650 <h4>parameters:</h4><dl><dt class="field"><b>name: String</b></dt><dd> |
1612 | 1651 |
1613 <p> | 1652 <p> |
1614 The name of the declarations to be found. | 1653 The name of the declarations to be found. |
1615 </p> | 1654 </p> |
1616 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type
_SearchId">SearchId</a>)</b></dt><dd> | 1655 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_SearchId">SearchId</a></b></dt><dd> |
1617 | 1656 |
1618 <p> | 1657 <p> |
1619 The identifier used to associate results with this | 1658 The identifier used to associate results with this |
1620 search request. | 1659 search request. |
1621 </p> | 1660 </p> |
1622 </dd></dl></dd><dt class="request"><a name="request_search.findMemberR
eferences">search.findMemberReferences</a> (<a href="#request_search.findMemberR
eferences">#</a>)</dt><dd><div class="box"><pre>request: { | 1661 </dd></dl></dd><dt class="request"><a name="request_search.findMemberR
eferences">search.findMemberReferences</a></dt><dd><div class="box"><pre>request
: { |
1623 "id": String | 1662 "id": String |
1624 "method": "search.findMemberReferences" | 1663 "method": "search.findMemberReferences" |
1625 "params": { | 1664 "params": { |
1626 "<b>name</b>": String | 1665 "<b>name</b>": String |
1627 } | 1666 } |
1628 }</pre><br><pre>response: { | 1667 }</pre><br><pre>response: { |
1629 "<b>id</b>": String | 1668 "<b>id</b>": String |
1630 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1669 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1631 "result": { | 1670 "result": { |
1632 "<b>id</b>": <a href="#type_SearchId">SearchId</a> | 1671 "<b>id</b>": <a href="#type_SearchId">SearchId</a> |
1633 } | 1672 } |
1634 }</pre></div> | 1673 }</pre></div> |
1635 <p> | 1674 <p> |
1636 Perform a search for references to members whose name is | 1675 Perform a search for references to members whose name is |
1637 equal to the given name. This search does not check to see | 1676 equal to the given name. This search does not check to see |
1638 that there is a member defined with the given name, so it is | 1677 that there is a member defined with the given name, so it is |
1639 able to find references to undefined members as well. | 1678 able to find references to undefined members as well. |
1640 </p> | 1679 </p> |
1641 <p> | 1680 <p> |
1642 An identifier is returned immediately, and individual | 1681 An identifier is returned immediately, and individual |
1643 results will be returned via the search.results notification | 1682 results will be returned via the search.results notification |
1644 as they become available. | 1683 as they become available. |
1645 </p> | 1684 </p> |
1646 | 1685 |
1647 | 1686 |
1648 <h4>parameters:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> | 1687 <h4>parameters:</h4><dl><dt class="field"><b>name: String</b></dt><dd> |
1649 | 1688 |
1650 <p> | 1689 <p> |
1651 The name of the references to be found. | 1690 The name of the references to be found. |
1652 </p> | 1691 </p> |
1653 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type
_SearchId">SearchId</a>)</b></dt><dd> | 1692 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_SearchId">SearchId</a></b></dt><dd> |
1654 | 1693 |
1655 <p> | 1694 <p> |
1656 The identifier used to associate results with this | 1695 The identifier used to associate results with this |
1657 search request. | 1696 search request. |
1658 </p> | 1697 </p> |
1659 </dd></dl></dd><dt class="request"><a name="request_search.findTopLeve
lDeclarations">search.findTopLevelDeclarations</a> (<a href="#request_search.fin
dTopLevelDeclarations">#</a>)</dt><dd><div class="box"><pre>request: { | 1698 </dd></dl></dd><dt class="request"><a name="request_search.findTopLeve
lDeclarations">search.findTopLevelDeclarations</a></dt><dd><div class="box"><pre
>request: { |
1660 "id": String | 1699 "id": String |
1661 "method": "search.findTopLevelDeclarations" | 1700 "method": "search.findTopLevelDeclarations" |
1662 "params": { | 1701 "params": { |
1663 "<b>pattern</b>": String | 1702 "<b>pattern</b>": String |
1664 } | 1703 } |
1665 }</pre><br><pre>response: { | 1704 }</pre><br><pre>response: { |
1666 "<b>id</b>": String | 1705 "<b>id</b>": String |
1667 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1706 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1668 "result": { | 1707 "result": { |
1669 "<b>id</b>": <a href="#type_SearchId">SearchId</a> | 1708 "<b>id</b>": <a href="#type_SearchId">SearchId</a> |
1670 } | 1709 } |
1671 }</pre></div> | 1710 }</pre></div> |
1672 <p> | 1711 <p> |
1673 Perform a search for declarations of top-level elements | 1712 Perform a search for declarations of top-level elements |
1674 (classes, typedefs, getters, setters, functions and fields) | 1713 (classes, typedefs, getters, setters, functions and fields) |
1675 whose name matches the given pattern. | 1714 whose name matches the given pattern. |
1676 </p> | 1715 </p> |
1677 <p> | 1716 <p> |
1678 An identifier is returned immediately, and individual | 1717 An identifier is returned immediately, and individual |
1679 results will be returned via the search.results notification | 1718 results will be returned via the search.results notification |
1680 as they become available. | 1719 as they become available. |
1681 </p> | 1720 </p> |
1682 | 1721 |
1683 | 1722 |
1684 <h4>parameters:</h4><dl><dt class="field"><b>pattern (String)</b></dt><dd> | 1723 <h4>parameters:</h4><dl><dt class="field"><b>pattern: String</b></dt><dd> |
1685 | 1724 |
1686 <p> | 1725 <p> |
1687 The regular expression used to match the names of the | 1726 The regular expression used to match the names of the |
1688 declarations to be found. | 1727 declarations to be found. |
1689 </p> | 1728 </p> |
1690 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type
_SearchId">SearchId</a>)</b></dt><dd> | 1729 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_SearchId">SearchId</a></b></dt><dd> |
1691 | 1730 |
1692 <p> | 1731 <p> |
1693 The identifier used to associate results with this | 1732 The identifier used to associate results with this |
1694 search request. | 1733 search request. |
1695 </p> | 1734 </p> |
1696 </dd></dl></dd><dt class="request"><a name="request_search.getTypeHier
archy">search.getTypeHierarchy</a> (<a href="#request_search.getTypeHierarchy">#
</a>)</dt><dd><div class="box"><pre>request: { | 1735 </dd></dl></dd><dt class="request"><a name="request_search.getTypeHier
archy">search.getTypeHierarchy</a></dt><dd><div class="box"><pre>request: { |
1697 "id": String | 1736 "id": String |
1698 "method": "search.getTypeHierarchy" | 1737 "method": "search.getTypeHierarchy" |
1699 "params": { | 1738 "params": { |
1700 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1739 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1701 "<b>offset</b>": int | 1740 "<b>offset</b>": int |
1702 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool | 1741 "<b>superOnly</b>": <span style="color:#999999">optional</span> bool |
1703 } | 1742 } |
1704 }</pre><br><pre>response: { | 1743 }</pre><br><pre>response: { |
1705 "id": String | 1744 "id": String |
1706 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1745 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1707 "result": { | 1746 "result": { |
1708 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List<
;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>> | 1747 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List<
;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>> |
1709 } | 1748 } |
1710 }</pre></div> | 1749 }</pre></div> |
1711 <p> | 1750 <p> |
1712 Return the type hierarchy of the class declared or | 1751 Return the type hierarchy of the class declared or |
1713 referenced at the given location. | 1752 referenced at the given location. |
1714 </p> | 1753 </p> |
1715 | 1754 |
1716 | 1755 |
1717 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1756 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1718 | 1757 |
1719 <p> | 1758 <p> |
1720 The file containing the declaration or reference to the | 1759 The file containing the declaration or reference to the |
1721 type for which a hierarchy is being requested. | 1760 type for which a hierarchy is being requested. |
1722 </p> | 1761 </p> |
1723 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1762 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1724 | 1763 |
1725 <p> | 1764 <p> |
1726 The offset of the name of the type within the file. | 1765 The offset of the name of the type within the file. |
1727 </p> | 1766 </p> |
1728 </dd><dt class="field"><b>superOnly (<span style="color:#999999">optio
nal</span> bool)</b></dt><dd> | 1767 </dd><dt class="field"><b>superOnly: bool<span style="color:#999999">
(optional)</span></b></dt><dd> |
1729 | 1768 |
1730 <p> | 1769 <p> |
1731 True if the client is only requesting superclasses and | 1770 True if the client is only requesting superclasses and |
1732 interfaces hierarchy. | 1771 interfaces hierarchy. |
1733 </p> | 1772 </p> |
1734 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hierarchyItems (<s
pan style="color:#999999">optional</span> List<<a href="#type_TypeHierarchyIt
em">TypeHierarchyItem</a>>)</b></dt><dd> | 1773 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>hierarchyItems: Li
st<<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>><span style="co
lor:#999999"> (optional)</span></b></dt><dd> |
1735 | 1774 |
1736 <p> | 1775 <p> |
1737 A list of the types in the requested hierarchy. The | 1776 A list of the types in the requested hierarchy. The |
1738 first element of the list is the item representing the | 1777 first element of the list is the item representing the |
1739 type for which the hierarchy was requested. The index of | 1778 type for which the hierarchy was requested. The index of |
1740 other elements of the list is unspecified, but | 1779 other elements of the list is unspecified, but |
1741 correspond to the integers used to reference supertype | 1780 correspond to the integers used to reference supertype |
1742 and subtype items within the items. | 1781 and subtype items within the items. |
1743 </p> | 1782 </p> |
1744 <p> | 1783 <p> |
1745 This field will be absent if the code at the given file | 1784 This field will be absent if the code at the given file |
1746 and offset does not represent a type, or if the file has | 1785 and offset does not represent a type, or if the file has |
1747 not been sufficiently analyzed to allow a type hierarchy | 1786 not been sufficiently analyzed to allow a type hierarchy |
1748 to be produced. | 1787 to be produced. |
1749 </p> | 1788 </p> |
1750 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_search.results">search.results</a> (<a href="#notificatio
n_search.results">#</a>)</dt><dd><div class="box"><pre>notification: { | 1789 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_search.results">search.results</a></dt><dd><div class="bo
x"><pre>notification: { |
1751 "event": "search.results" | 1790 "event": "search.results" |
1752 "params": { | 1791 "params": { |
1753 "<b>id</b>": <a href="#type_SearchId">SearchId</a> | 1792 "<b>id</b>": <a href="#type_SearchId">SearchId</a> |
1754 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>> | 1793 "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>> |
1755 "<b>isLast</b>": bool | 1794 "<b>isLast</b>": bool |
1756 } | 1795 } |
1757 }</pre></div> | 1796 }</pre></div> |
1758 <p> | 1797 <p> |
1759 Reports some or all of the results of performing a requested | 1798 Reports some or all of the results of performing a requested |
1760 search. Unlike other notifications, this notification | 1799 search. Unlike other notifications, this notification |
1761 contains search results that should be added to any | 1800 contains search results that should be added to any |
1762 previously received search results associated with the same | 1801 previously received search results associated with the same |
1763 search id. | 1802 search id. |
1764 </p> | 1803 </p> |
1765 | 1804 |
1766 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_SearchId">
SearchId</a>)</b></dt><dd> | 1805 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_SearchId">
SearchId</a></b></dt><dd> |
1767 | 1806 |
1768 <p> | 1807 <p> |
1769 The id associated with the search. | 1808 The id associated with the search. |
1770 </p> | 1809 </p> |
1771 </dd><dt class="field"><b>results (List<<a href="#type_SearchResult
">SearchResult</a>>)</b></dt><dd> | 1810 </dd><dt class="field"><b>results: List<<a href="#type_SearchResult
">SearchResult</a>></b></dt><dd> |
1772 | 1811 |
1773 <p> | 1812 <p> |
1774 The search results being reported. | 1813 The search results being reported. |
1775 </p> | 1814 </p> |
1776 </dd><dt class="field"><b>isLast (bool)</b></dt><dd> | 1815 </dd><dt class="field"><b>isLast: bool</b></dt><dd> |
1777 | 1816 |
1778 <p> | 1817 <p> |
1779 True if this is that last set of results that will be | 1818 True if this is that last set of results that will be |
1780 returned for the indicated search. | 1819 returned for the indicated search. |
1781 </p> | 1820 </p> |
1782 </dd></dl></dd></dl> | 1821 </dd></dl></dd></dl> |
1783 <h2 class="domain"><a name="domain_edit">edit domain</a></h2> | 1822 <h2 class="domain"><a name="domain_edit">edit domain</a></h2> |
1784 <p> | 1823 <p> |
1785 The edit domain contains commands related to edits that can be | 1824 The edit domain contains commands related to edits that can be |
1786 applied to the code. | 1825 applied to the code. |
1787 </p> | 1826 </p> |
1788 | 1827 |
1789 | 1828 |
1790 | 1829 |
1791 | 1830 |
1792 | 1831 |
1793 | 1832 |
1794 | 1833 |
1795 | 1834 |
1796 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit.
format</a> (<a href="#request_edit.format">#</a>)</dt><dd><div class="box"><pre>
request: { | 1835 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit.
format</a></dt><dd><div class="box"><pre>request: { |
1797 "id": String | 1836 "id": String |
1798 "method": "edit.format" | 1837 "method": "edit.format" |
1799 "params": { | 1838 "params": { |
1800 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1839 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1801 "<b>selectionOffset</b>": int | 1840 "<b>selectionOffset</b>": int |
1802 "<b>selectionLength</b>": int | 1841 "<b>selectionLength</b>": int |
1803 "<b>lineLength</b>": <span style="color:#999999">optional</span> int | 1842 "<b>lineLength</b>": <span style="color:#999999">optional</span> int |
1804 } | 1843 } |
1805 }</pre><br><pre>response: { | 1844 }</pre><br><pre>response: { |
1806 "id": String | 1845 "id": String |
(...skipping 16 matching lines...) Expand all Loading... |
1823 <p> | 1862 <p> |
1824 If a request is made for a file which does not exist, or which is not | 1863 If a request is made for a file which does not exist, or which is not |
1825 currently subject to analysis (e.g. because it is not associated with | 1864 currently subject to analysis (e.g. because it is not associated with |
1826 any analysis root specified to analysis.setAnalysisRoots), an error of | 1865 any analysis root specified to analysis.setAnalysisRoots), an error of |
1827 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source | 1866 type <tt>FORMAT_INVALID_FILE</tt> will be generated. If the source |
1828 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt> | 1867 contains syntax errors, an error of type <tt>FORMAT_WITH_ERRORS</tt> |
1829 will be generated. | 1868 will be generated. |
1830 </p> | 1869 </p> |
1831 | 1870 |
1832 | 1871 |
1833 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1872 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1834 | 1873 |
1835 <p> | 1874 <p> |
1836 The file containing the code to be formatted. | 1875 The file containing the code to be formatted. |
1837 </p> | 1876 </p> |
1838 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> | 1877 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd> |
1839 | 1878 |
1840 <p> | 1879 <p> |
1841 The offset of the current selection in the file. | 1880 The offset of the current selection in the file. |
1842 </p> | 1881 </p> |
1843 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> | 1882 </dd><dt class="field"><b>selectionLength: int</b></dt><dd> |
1844 | 1883 |
1845 <p> | 1884 <p> |
1846 The length of the current selection in the file. | 1885 The length of the current selection in the file. |
1847 </p> | 1886 </p> |
1848 </dd><dt class="field"><b>lineLength (<span style="color:#999999">opti
onal</span> int)</b></dt><dd> | 1887 </dd><dt class="field"><b>lineLength: int<span style="color:#999999">
(optional)</span></b></dt><dd> |
1849 | 1888 |
1850 <p> | 1889 <p> |
1851 The line length to be used by the formatter. | 1890 The line length to be used by the formatter. |
1852 </p> | 1891 </p> |
1853 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits (List<<a
href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd> | 1892 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edits: List<<a
href="#type_SourceEdit">SourceEdit</a>></b></dt><dd> |
1854 | 1893 |
1855 <p> | 1894 <p> |
1856 The edit(s) to be applied in order to format the code. The list | 1895 The edit(s) to be applied in order to format the code. The list |
1857 will be empty if the code was already formatted (there are no | 1896 will be empty if the code was already formatted (there are no |
1858 changes). | 1897 changes). |
1859 </p> | 1898 </p> |
1860 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> | 1899 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd> |
1861 | 1900 |
1862 <p> | 1901 <p> |
1863 The offset of the selection after formatting the code. | 1902 The offset of the selection after formatting the code. |
1864 </p> | 1903 </p> |
1865 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> | 1904 </dd><dt class="field"><b>selectionLength: int</b></dt><dd> |
1866 | 1905 |
1867 <p> | 1906 <p> |
1868 The length of the selection after formatting the code. | 1907 The length of the selection after formatting the code. |
1869 </p> | 1908 </p> |
1870 </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">e
dit.getAssists</a> (<a href="#request_edit.getAssists">#</a>)</dt><dd><div class
="box"><pre>request: { | 1909 </dd></dl></dd><dt class="request"><a name="request_edit.getAssists">e
dit.getAssists</a></dt><dd><div class="box"><pre>request: { |
1871 "id": String | 1910 "id": String |
1872 "method": "edit.getAssists" | 1911 "method": "edit.getAssists" |
1873 "params": { | 1912 "params": { |
1874 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1913 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1875 "<b>offset</b>": int | 1914 "<b>offset</b>": int |
1876 "<b>length</b>": int | 1915 "<b>length</b>": int |
1877 } | 1916 } |
1878 }</pre><br><pre>response: { | 1917 }</pre><br><pre>response: { |
1879 "id": String | 1918 "id": String |
1880 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1919 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1881 "result": { | 1920 "result": { |
1882 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>> | 1921 "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>> |
1883 } | 1922 } |
1884 }</pre></div> | 1923 }</pre></div> |
1885 <p> | 1924 <p> |
1886 Return the set of assists that are available at the given | 1925 Return the set of assists that are available at the given |
1887 location. An assist is distinguished from a refactoring | 1926 location. An assist is distinguished from a refactoring |
1888 primarily by the fact that it affects a single file and does | 1927 primarily by the fact that it affects a single file and does |
1889 not require user input in order to be performed. | 1928 not require user input in order to be performed. |
1890 </p> | 1929 </p> |
1891 | 1930 |
1892 | 1931 |
1893 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1932 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1894 | 1933 |
1895 <p> | 1934 <p> |
1896 The file containing the code for which assists are being | 1935 The file containing the code for which assists are being |
1897 requested. | 1936 requested. |
1898 </p> | 1937 </p> |
1899 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1938 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1900 | 1939 |
1901 <p> | 1940 <p> |
1902 The offset of the code for which assists are being | 1941 The offset of the code for which assists are being |
1903 requested. | 1942 requested. |
1904 </p> | 1943 </p> |
1905 </dd><dt class="field"><b>length (int)</b></dt><dd> | 1944 </dd><dt class="field"><b>length: int</b></dt><dd> |
1906 | 1945 |
1907 <p> | 1946 <p> |
1908 The length of the code for which assists are being | 1947 The length of the code for which assists are being |
1909 requested. | 1948 requested. |
1910 </p> | 1949 </p> |
1911 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists (List<<
a href="#type_SourceChange">SourceChange</a>>)</b></dt><dd> | 1950 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>assists: List<<
a href="#type_SourceChange">SourceChange</a>></b></dt><dd> |
1912 | 1951 |
1913 <p> | 1952 <p> |
1914 The assists that are available at the given location. | 1953 The assists that are available at the given location. |
1915 </p> | 1954 </p> |
1916 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableR
efactorings">edit.getAvailableRefactorings</a> (<a href="#request_edit.getAvaila
bleRefactorings">#</a>)</dt><dd><div class="box"><pre>request: { | 1955 </dd></dl></dd><dt class="request"><a name="request_edit.getAvailableR
efactorings">edit.getAvailableRefactorings</a></dt><dd><div class="box"><pre>req
uest: { |
1917 "id": String | 1956 "id": String |
1918 "method": "edit.getAvailableRefactorings" | 1957 "method": "edit.getAvailableRefactorings" |
1919 "params": { | 1958 "params": { |
1920 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 1959 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1921 "<b>offset</b>": int | 1960 "<b>offset</b>": int |
1922 "<b>length</b>": int | 1961 "<b>length</b>": int |
1923 } | 1962 } |
1924 }</pre><br><pre>response: { | 1963 }</pre><br><pre>response: { |
1925 "id": String | 1964 "id": String |
1926 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 1965 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1927 "result": { | 1966 "result": { |
1928 "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>&
gt; | 1967 "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>&
gt; |
1929 } | 1968 } |
1930 }</pre></div> | 1969 }</pre></div> |
1931 <p> | 1970 <p> |
1932 Get a list of the kinds of refactorings that are valid for | 1971 Get a list of the kinds of refactorings that are valid for |
1933 the given selection in the given file. | 1972 the given selection in the given file. |
1934 </p> | 1973 </p> |
1935 | 1974 |
1936 | 1975 |
1937 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 1976 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1938 | 1977 |
1939 <p> | 1978 <p> |
1940 The file containing the code on which the refactoring | 1979 The file containing the code on which the refactoring |
1941 would be based. | 1980 would be based. |
1942 </p> | 1981 </p> |
1943 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 1982 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1944 | 1983 |
1945 <p> | 1984 <p> |
1946 The offset of the code on which the refactoring would be | 1985 The offset of the code on which the refactoring would be |
1947 based. | 1986 based. |
1948 </p> | 1987 </p> |
1949 </dd><dt class="field"><b>length (int)</b></dt><dd> | 1988 </dd><dt class="field"><b>length: int</b></dt><dd> |
1950 | 1989 |
1951 <p> | 1990 <p> |
1952 The length of the code on which the refactoring would be | 1991 The length of the code on which the refactoring would be |
1953 based. | 1992 based. |
1954 </p> | 1993 </p> |
1955 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds (List<<a
href="#type_RefactoringKind">RefactoringKind</a>>)</b></dt><dd> | 1994 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>kinds: List<<a
href="#type_RefactoringKind">RefactoringKind</a>></b></dt><dd> |
1956 | 1995 |
1957 <p> | 1996 <p> |
1958 The kinds of refactorings that are valid for the given | 1997 The kinds of refactorings that are valid for the given |
1959 selection. | 1998 selection. |
1960 </p> | 1999 </p> |
1961 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edi
t.getFixes</a> (<a href="#request_edit.getFixes">#</a>)</dt><dd><div class="box"
><pre>request: { | 2000 </dd></dl></dd><dt class="request"><a name="request_edit.getFixes">edi
t.getFixes</a></dt><dd><div class="box"><pre>request: { |
1962 "id": String | 2001 "id": String |
1963 "method": "edit.getFixes" | 2002 "method": "edit.getFixes" |
1964 "params": { | 2003 "params": { |
1965 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 2004 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
1966 "<b>offset</b>": int | 2005 "<b>offset</b>": int |
1967 } | 2006 } |
1968 }</pre><br><pre>response: { | 2007 }</pre><br><pre>response: { |
1969 "id": String | 2008 "id": String |
1970 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2009 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
1971 "result": { | 2010 "result": { |
1972 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe
s</a>> | 2011 "<b>fixes</b>": List<<a href="#type_AnalysisErrorFixes">AnalysisErrorFixe
s</a>> |
1973 } | 2012 } |
1974 }</pre></div> | 2013 }</pre></div> |
1975 <p> | 2014 <p> |
1976 Return the set of fixes that are available for the errors at | 2015 Return the set of fixes that are available for the errors at |
1977 a given offset in a given file. | 2016 a given offset in a given file. |
1978 </p> | 2017 </p> |
1979 | 2018 |
1980 | 2019 |
1981 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 2020 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
1982 | 2021 |
1983 <p> | 2022 <p> |
1984 The file containing the errors for which fixes are being | 2023 The file containing the errors for which fixes are being |
1985 requested. | 2024 requested. |
1986 </p> | 2025 </p> |
1987 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 2026 </dd><dt class="field"><b>offset: int</b></dt><dd> |
1988 | 2027 |
1989 <p> | 2028 <p> |
1990 The offset used to select the errors for which fixes | 2029 The offset used to select the errors for which fixes |
1991 will be returned. | 2030 will be returned. |
1992 </p> | 2031 </p> |
1993 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes (List<<a
href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>>)</b></dt><dd> | 2032 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes: List<<a
href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>></b></dt><dd> |
1994 | 2033 |
1995 <p> | 2034 <p> |
1996 The fixes that are available for the errors at the given offset. | 2035 The fixes that are available for the errors at the given offset. |
1997 </p> | 2036 </p> |
1998 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactorin
g">edit.getRefactoring</a> (<a href="#request_edit.getRefactoring">#</a>)</dt><d
d><div class="box"><pre>request: { | 2037 </dd></dl></dd><dt class="request"><a name="request_edit.getRefactorin
g">edit.getRefactoring</a></dt><dd><div class="box"><pre>request: { |
1999 "id": String | 2038 "id": String |
2000 "method": "edit.getRefactoring" | 2039 "method": "edit.getRefactoring" |
2001 "params": { | 2040 "params": { |
2002 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> | 2041 "<b>kind</b>": <a href="#type_RefactoringKind">RefactoringKind</a> |
2003 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 2042 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
2004 "<b>offset</b>": int | 2043 "<b>offset</b>": int |
2005 "<b>length</b>": int | 2044 "<b>length</b>": int |
2006 "<b>validateOnly</b>": bool | 2045 "<b>validateOnly</b>": bool |
2007 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type
_RefactoringOptions">RefactoringOptions</a> | 2046 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type
_RefactoringOptions">RefactoringOptions</a> |
2008 } | 2047 } |
(...skipping 12 matching lines...) Expand all Loading... |
2021 <p> | 2060 <p> |
2022 Get the changes required to perform a refactoring. | 2061 Get the changes required to perform a refactoring. |
2023 </p> | 2062 </p> |
2024 <p> | 2063 <p> |
2025 If another refactoring request is received during the processing | 2064 If another refactoring request is received during the processing |
2026 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt> | 2065 of this one, an error of type <tt>REFACTORING_REQUEST_CANCELLED</tt> |
2027 will be generated. | 2066 will be generated. |
2028 </p> | 2067 </p> |
2029 | 2068 |
2030 | 2069 |
2031 <h4>parameters:</h4><dl><dt class="field"><b>kind (<a href="#type_Refactor
ingKind">RefactoringKind</a>)</b></dt><dd> | 2070 <h4>parameters:</h4><dl><dt class="field"><b>kind: <a href="#type_Refactor
ingKind">RefactoringKind</a></b></dt><dd> |
2032 | 2071 |
2033 <p> | 2072 <p> |
2034 The kind of refactoring to be performed. | 2073 The kind of refactoring to be performed. |
2035 </p> | 2074 </p> |
2036 </dd><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)
</b></dt><dd> | 2075 </dd><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a><
/b></dt><dd> |
2037 | 2076 |
2038 <p> | 2077 <p> |
2039 The file containing the code involved in the | 2078 The file containing the code involved in the |
2040 refactoring. | 2079 refactoring. |
2041 </p> | 2080 </p> |
2042 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 2081 </dd><dt class="field"><b>offset: int</b></dt><dd> |
2043 | 2082 |
2044 <p> | 2083 <p> |
2045 The offset of the region involved in the refactoring. | 2084 The offset of the region involved in the refactoring. |
2046 </p> | 2085 </p> |
2047 </dd><dt class="field"><b>length (int)</b></dt><dd> | 2086 </dd><dt class="field"><b>length: int</b></dt><dd> |
2048 | 2087 |
2049 <p> | 2088 <p> |
2050 The length of the region involved in the refactoring. | 2089 The length of the region involved in the refactoring. |
2051 </p> | 2090 </p> |
2052 </dd><dt class="field"><b>validateOnly (bool)</b></dt><dd> | 2091 </dd><dt class="field"><b>validateOnly: bool</b></dt><dd> |
2053 | 2092 |
2054 <p> | 2093 <p> |
2055 True if the client is only requesting that the values of | 2094 True if the client is only requesting that the values of |
2056 the options be validated and no change be generated. | 2095 the options be validated and no change be generated. |
2057 </p> | 2096 </p> |
2058 </dd><dt class="field"><b>options (<span style="color:#999999">optiona
l</span> <a href="#type_RefactoringOptions">RefactoringOptions</a>)</b></dt><dd> | 2097 </dd><dt class="field"><b>options: <a href="#type_RefactoringOptions">
RefactoringOptions</a><span style="color:#999999"> (optional)</span></b></dt><dd
> |
2059 | 2098 |
2060 <p> | 2099 <p> |
2061 Data used to provide values provided by the user. The | 2100 Data used to provide values provided by the user. The |
2062 structure of the data is dependent on the kind of | 2101 structure of the data is dependent on the kind of |
2063 refactoring being performed. The data that is expected is | 2102 refactoring being performed. The data that is expected is |
2064 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as | 2103 documented in the section titled <a href="#refactorings">Refactori
ngs</a>, labeled as |
2065 "Options". This field can be omitted if the refactoring | 2104 "Options". This field can be omitted if the refactoring |
2066 does not require any options or if the values of those | 2105 does not require any options or if the values of those |
2067 options are not known. | 2106 options are not known. |
2068 </p> | 2107 </p> |
2069 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems (L
ist<<a href="#type_RefactoringProblem">RefactoringProblem</a>>)</b></dt><d
d> | 2108 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>initialProblems: L
ist<<a href="#type_RefactoringProblem">RefactoringProblem</a>></b></dt><dd
> |
2070 | 2109 |
2071 <p> | 2110 <p> |
2072 The initial status of the refactoring, i.e. problems related to | 2111 The initial status of the refactoring, i.e. problems related to |
2073 the context in which the refactoring is requested. | 2112 the context in which the refactoring is requested. |
2074 The array will be empty if there are no known problems. | 2113 The array will be empty if there are no known problems. |
2075 </p> | 2114 </p> |
2076 </dd><dt class="field"><b>optionsProblems (List<<a href="#type_Refa
ctoringProblem">RefactoringProblem</a>>)</b></dt><dd> | 2115 </dd><dt class="field"><b>optionsProblems: List<<a href="#type_Refa
ctoringProblem">RefactoringProblem</a>></b></dt><dd> |
2077 | 2116 |
2078 <p> | 2117 <p> |
2079 The options validation status, i.e. problems in the given options, | 2118 The options validation status, i.e. problems in the given options, |
2080 such as light-weight validation of a new name, flags | 2119 such as light-weight validation of a new name, flags |
2081 compatibility, etc. | 2120 compatibility, etc. |
2082 The array will be empty if there are no known problems. | 2121 The array will be empty if there are no known problems. |
2083 </p> | 2122 </p> |
2084 </dd><dt class="field"><b>finalProblems (List<<a href="#type_Refact
oringProblem">RefactoringProblem</a>>)</b></dt><dd> | 2123 </dd><dt class="field"><b>finalProblems: List<<a href="#type_Refact
oringProblem">RefactoringProblem</a>></b></dt><dd> |
2085 | 2124 |
2086 <p> | 2125 <p> |
2087 The final status of the refactoring, i.e. problems identified in | 2126 The final status of the refactoring, i.e. problems identified in |
2088 the result of a full, potentially expensive validation and / or | 2127 the result of a full, potentially expensive validation and / or |
2089 change creation. | 2128 change creation. |
2090 The array will be empty if there are no known problems. | 2129 The array will be empty if there are no known problems. |
2091 </p> | 2130 </p> |
2092 </dd><dt class="field"><b>feedback (<span style="color:#999999">option
al</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a>)</b></dt><
dd> | 2131 </dd><dt class="field"><b>feedback: <a href="#type_RefactoringFeedback
">RefactoringFeedback</a><span style="color:#999999"> (optional)</span></b></dt>
<dd> |
2093 | 2132 |
2094 <p> | 2133 <p> |
2095 Data used to provide feedback to the user. The structure | 2134 Data used to provide feedback to the user. The structure |
2096 of the data is dependent on the kind of refactoring | 2135 of the data is dependent on the kind of refactoring |
2097 being created. The data that is returned is documented | 2136 being created. The data that is returned is documented |
2098 in the section titled <a href="#refactorings">Refactorings</a>, la
beled as | 2137 in the section titled <a href="#refactorings">Refactorings</a>, la
beled as |
2099 "Feedback". | 2138 "Feedback". |
2100 </p> | 2139 </p> |
2101 </dd><dt class="field"><b>change (<span style="color:#999999">optional
</span> <a href="#type_SourceChange">SourceChange</a>)</b></dt><dd> | 2140 </dd><dt class="field"><b>change: <a href="#type_SourceChange">SourceC
hange</a><span style="color:#999999"> (optional)</span></b></dt><dd> |
2102 | 2141 |
2103 <p> | 2142 <p> |
2104 The changes that are to be applied to affect the | 2143 The changes that are to be applied to affect the |
2105 refactoring. This field will be omitted if there are | 2144 refactoring. This field will be omitted if there are |
2106 problems that prevent a set of changes from being | 2145 problems that prevent a set of changes from being |
2107 computed, such as having no options specified for a | 2146 computed, such as having no options specified for a |
2108 refactoring that requires them, or if only validation | 2147 refactoring that requires them, or if only validation |
2109 was requested. | 2148 was requested. |
2110 </p> | 2149 </p> |
2111 </dd><dt class="field"><b>potentialEdits (<span style="color:#999999">
optional</span> List<String>)</b></dt><dd> | 2150 </dd><dt class="field"><b>potentialEdits: List<String><span styl
e="color:#999999"> (optional)</span></b></dt><dd> |
2112 | 2151 |
2113 <p> | 2152 <p> |
2114 The ids of source edits that are not known to be valid. An edit is | 2153 The ids of source edits that are not known to be valid. An edit is |
2115 not known to be valid if there was insufficient type information | 2154 not known to be valid if there was insufficient type information |
2116 for the server to be able to determine whether or not the code | 2155 for the server to be able to determine whether or not the code |
2117 needs to be modified, such as when a member is being renamed and | 2156 needs to be modified, such as when a member is being renamed and |
2118 there is a reference to a member from an unknown type. This field | 2157 there is a reference to a member from an unknown type. This field |
2119 will be omitted if the change field is omitted or if there are no | 2158 will be omitted if the change field is omitted or if there are no |
2120 potential edits for the refactoring. | 2159 potential edits for the refactoring. |
2121 </p> | 2160 </p> |
2122 </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers">
edit.sortMembers</a> (<a href="#request_edit.sortMembers">#</a>)</dt><dd><div cl
ass="box"><pre>request: { | 2161 </dd></dl></dd><dt class="request"><a name="request_edit.sortMembers">
edit.sortMembers</a></dt><dd><div class="box"><pre>request: { |
2123 "id": String | 2162 "id": String |
2124 "method": "edit.sortMembers" | 2163 "method": "edit.sortMembers" |
2125 "params": { | 2164 "params": { |
2126 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 2165 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
2127 } | 2166 } |
2128 }</pre><br><pre>response: { | 2167 }</pre><br><pre>response: { |
2129 "id": String | 2168 "id": String |
2130 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2169 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2131 "result": { | 2170 "result": { |
2132 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a> | 2171 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a> |
2133 } | 2172 } |
2134 }</pre></div> | 2173 }</pre></div> |
2135 <p> | 2174 <p> |
2136 Sort all of the directives, unit and class members | 2175 Sort all of the directives, unit and class members |
2137 of the given Dart file. | 2176 of the given Dart file. |
2138 </p> | 2177 </p> |
2139 <p> | 2178 <p> |
2140 If a request is made for a file that does not exist, does not belong | 2179 If a request is made for a file that does not exist, does not belong |
2141 to an analysis root or is not a Dart file, | 2180 to an analysis root or is not a Dart file, |
2142 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated. | 2181 <tt>SORT_MEMBERS_INVALID_FILE</tt> will be generated. |
2143 </p> | 2182 </p> |
2144 <p> | 2183 <p> |
2145 If the Dart file has scan or parse errors, | 2184 If the Dart file has scan or parse errors, |
2146 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated. | 2185 <tt>SORT_MEMBERS_PARSE_ERRORS</tt> will be generated. |
2147 </p> | 2186 </p> |
2148 | 2187 |
2149 | 2188 |
2150 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 2189 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
2151 | 2190 |
2152 <p> | 2191 <p> |
2153 The Dart file to sort. | 2192 The Dart file to sort. |
2154 </p> | 2193 </p> |
2155 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty
pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd> | 2194 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#ty
pe_SourceFileEdit">SourceFileEdit</a></b></dt><dd> |
2156 | 2195 |
2157 <p> | 2196 <p> |
2158 The file edit that is to be applied to the given file to effect | 2197 The file edit that is to be applied to the given file to effect |
2159 the sorting. | 2198 the sorting. |
2160 </p> | 2199 </p> |
2161 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec
tives">edit.organizeDirectives</a> (<a href="#request_edit.organizeDirectives">#
</a>)</dt><dd><div class="box"><pre>request: { | 2200 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec
tives">edit.organizeDirectives</a></dt><dd><div class="box"><pre>request: { |
2162 "id": String | 2201 "id": String |
2163 "method": "edit.organizeDirectives" | 2202 "method": "edit.organizeDirectives" |
2164 "params": { | 2203 "params": { |
2165 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 2204 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
2166 } | 2205 } |
2167 }</pre><br><pre>response: { | 2206 }</pre><br><pre>response: { |
2168 "id": String | 2207 "id": String |
2169 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2208 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2170 "result": { | 2209 "result": { |
2171 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a> | 2210 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a> |
(...skipping 10 matching lines...) Expand all Loading... |
2182 <tt>FILE_NOT_ANALYZED</tt> will be generated. | 2221 <tt>FILE_NOT_ANALYZED</tt> will be generated. |
2183 </p> | 2222 </p> |
2184 <p> | 2223 <p> |
2185 If directives of the Dart file cannot be organized, for example | 2224 If directives of the Dart file cannot be organized, for example |
2186 because it has scan or parse errors, or by other reasons, | 2225 because it has scan or parse errors, or by other reasons, |
2187 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message | 2226 <tt>ORGANIZE_DIRECTIVES_ERROR</tt> will be generated. The message |
2188 will provide details about the reason. | 2227 will provide details about the reason. |
2189 </p> | 2228 </p> |
2190 | 2229 |
2191 | 2230 |
2192 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 2231 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
2193 | 2232 |
2194 <p> | 2233 <p> |
2195 The Dart file to organize directives in. | 2234 The Dart file to organize directives in. |
2196 </p> | 2235 </p> |
2197 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit (<a href="#ty
pe_SourceFileEdit">SourceFileEdit</a>)</b></dt><dd> | 2236 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#ty
pe_SourceFileEdit">SourceFileEdit</a></b></dt><dd> |
2198 | 2237 |
2199 <p> | 2238 <p> |
2200 The file edit that is to be applied to the given file to effect | 2239 The file edit that is to be applied to the given file to effect |
2201 the organizing. | 2240 the organizing. |
2202 </p> | 2241 </p> |
2203 </dd></dl></dd></dl> | 2242 </dd></dl></dd></dl> |
2204 <h2 class="domain"><a name="domain_execution">execution domain</a></h2> | 2243 <h2 class="domain"><a name="domain_execution">execution domain</a></h2> |
2205 <p> | 2244 <p> |
2206 The execution domain contains commands related to providing an execution | 2245 The execution domain contains commands related to providing an execution |
2207 or debugging experience. | 2246 or debugging experience. |
2208 </p> | 2247 </p> |
2209 | 2248 |
2210 | 2249 |
2211 | 2250 |
2212 | 2251 |
2213 | 2252 |
2214 <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createCo
ntext">execution.createContext</a> (<a href="#request_execution.createContext">#
</a>)</dt><dd><div class="box"><pre>request: { | 2253 <h3>Requests</h3><dl><dt class="request"><a name="request_execution.createCo
ntext">execution.createContext</a></dt><dd><div class="box"><pre>request: { |
2215 "id": String | 2254 "id": String |
2216 "method": "execution.createContext" | 2255 "method": "execution.createContext" |
2217 "params": { | 2256 "params": { |
2218 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a> | 2257 "<b>contextRoot</b>": <a href="#type_FilePath">FilePath</a> |
2219 } | 2258 } |
2220 }</pre><br><pre>response: { | 2259 }</pre><br><pre>response: { |
2221 "<b>id</b>": String | 2260 "<b>id</b>": String |
2222 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2261 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2223 "result": { | 2262 "result": { |
2224 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> | 2263 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> |
2225 } | 2264 } |
2226 }</pre></div> | 2265 }</pre></div> |
2227 <p> | 2266 <p> |
2228 Create an execution context for the executable file with the given | 2267 Create an execution context for the executable file with the given |
2229 path. The context that is created will persist until | 2268 path. The context that is created will persist until |
2230 execution.deleteContext is used to delete it. Clients, therefore, are | 2269 execution.deleteContext is used to delete it. Clients, therefore, are |
2231 responsible for managing the lifetime of execution contexts. | 2270 responsible for managing the lifetime of execution contexts. |
2232 </p> | 2271 </p> |
2233 | 2272 |
2234 | 2273 |
2235 <h4>parameters:</h4><dl><dt class="field"><b>contextRoot (<a href="#type_F
ilePath">FilePath</a>)</b></dt><dd> | 2274 <h4>parameters:</h4><dl><dt class="field"><b>contextRoot: <a href="#type_F
ilePath">FilePath</a></b></dt><dd> |
2236 | 2275 |
2237 <p> | 2276 <p> |
2238 The path of the Dart or HTML file that will be launched, or the | 2277 The path of the Dart or HTML file that will be launched, or the |
2239 path of the directory containing the file. | 2278 path of the directory containing the file. |
2240 </p> | 2279 </p> |
2241 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id (<a href="#type
_ExecutionContextId">ExecutionContextId</a>)</b></dt><dd> | 2280 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>id: <a href="#type
_ExecutionContextId">ExecutionContextId</a></b></dt><dd> |
2242 | 2281 |
2243 <p> | 2282 <p> |
2244 The identifier used to refer to the execution context that was | 2283 The identifier used to refer to the execution context that was |
2245 created. | 2284 created. |
2246 </p> | 2285 </p> |
2247 </dd></dl></dd><dt class="request"><a name="request_execution.deleteCo
ntext">execution.deleteContext</a> (<a href="#request_execution.deleteContext">#
</a>)</dt><dd><div class="box"><pre>request: { | 2286 </dd></dl></dd><dt class="request"><a name="request_execution.deleteCo
ntext">execution.deleteContext</a></dt><dd><div class="box"><pre>request: { |
2248 "<b>id</b>": String | 2287 "<b>id</b>": String |
2249 "method": "execution.deleteContext" | 2288 "method": "execution.deleteContext" |
2250 "params": { | 2289 "params": { |
2251 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> | 2290 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> |
2252 } | 2291 } |
2253 }</pre><br><pre>response: { | 2292 }</pre><br><pre>response: { |
2254 "id": String | 2293 "id": String |
2255 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2294 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2256 }</pre></div> | 2295 }</pre></div> |
2257 <p> | 2296 <p> |
2258 Delete the execution context with the given identifier. The context id | 2297 Delete the execution context with the given identifier. The context id |
2259 is no longer valid after this command. The server is allowed to re-use | 2298 is no longer valid after this command. The server is allowed to re-use |
2260 ids when they are no longer valid. | 2299 ids when they are no longer valid. |
2261 </p> | 2300 </p> |
2262 | 2301 |
2263 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC
ontextId">ExecutionContextId</a>)</b></dt><dd> | 2302 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_ExecutionC
ontextId">ExecutionContextId</a></b></dt><dd> |
2264 | 2303 |
2265 <p> | 2304 <p> |
2266 The identifier of the execution context that is to be deleted. | 2305 The identifier of the execution context that is to be deleted. |
2267 </p> | 2306 </p> |
2268 </dd></dl></dd><dt class="request"><a name="request_execution.mapUri">
execution.mapUri</a> (<a href="#request_execution.mapUri">#</a>)</dt><dd><div cl
ass="box"><pre>request: { | 2307 </dd></dl></dd><dt class="request"><a name="request_execution.mapUri">
execution.mapUri</a></dt><dd><div class="box"><pre>request: { |
2269 "<b>id</b>": String | 2308 "<b>id</b>": String |
2270 "method": "execution.mapUri" | 2309 "method": "execution.mapUri" |
2271 "params": { | 2310 "params": { |
2272 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> | 2311 "<b>id</b>": <a href="#type_ExecutionContextId">ExecutionContextId</a> |
2273 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi
lePath">FilePath</a> | 2312 "<b>file</b>": <span style="color:#999999">optional</span> <a href="#type_Fi
lePath">FilePath</a> |
2274 "<b>uri</b>": <span style="color:#999999">optional</span> String | 2313 "<b>uri</b>": <span style="color:#999999">optional</span> String |
2275 } | 2314 } |
2276 }</pre><br><pre>response: { | 2315 }</pre><br><pre>response: { |
2277 "id": String | 2316 "id": String |
2278 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2317 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
(...skipping 25 matching lines...) Expand all Loading... |
2304 does not exist or something other than a file), then an error of type | 2343 does not exist or something other than a file), then an error of type |
2305 <tt>INVALID_PARAMETER</tt> will be generated. | 2344 <tt>INVALID_PARAMETER</tt> will be generated. |
2306 </p> | 2345 </p> |
2307 <p> | 2346 <p> |
2308 If the contextRoot used to create the execution context does not | 2347 If the contextRoot used to create the execution context does not |
2309 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will | 2348 exist, then an error of type <tt>INVALID_EXECUTION_CONTEXT</tt> will |
2310 be generated. | 2349 be generated. |
2311 </p> | 2350 </p> |
2312 | 2351 |
2313 | 2352 |
2314 <h4>parameters:</h4><dl><dt class="field"><b>id (<a href="#type_ExecutionC
ontextId">ExecutionContextId</a>)</b></dt><dd> | 2353 <h4>parameters:</h4><dl><dt class="field"><b>id: <a href="#type_ExecutionC
ontextId">ExecutionContextId</a></b></dt><dd> |
2315 | 2354 |
2316 <p> | 2355 <p> |
2317 The identifier of the execution context in which the URI is to be | 2356 The identifier of the execution context in which the URI is to be |
2318 mapped. | 2357 mapped. |
2319 </p> | 2358 </p> |
2320 </dd><dt class="field"><b>file (<span style="color:#999999">optional</
span> <a href="#type_FilePath">FilePath</a>)</b></dt><dd> | 2359 </dd><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a><
span style="color:#999999"> (optional)</span></b></dt><dd> |
2321 | 2360 |
2322 <p> | 2361 <p> |
2323 The path of the file to be mapped into a URI. | 2362 The path of the file to be mapped into a URI. |
2324 </p> | 2363 </p> |
2325 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s
pan> String)</b></dt><dd> | 2364 </dd><dt class="field"><b>uri: String<span style="color:#999999"> (opt
ional)</span></b></dt><dd> |
2326 | 2365 |
2327 <p> | 2366 <p> |
2328 The URI to be mapped into a file path. | 2367 The URI to be mapped into a file path. |
2329 </p> | 2368 </p> |
2330 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>file (<span style=
"color:#999999">optional</span> <a href="#type_FilePath">FilePath</a>)</b></dt><
dd> | 2369 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>file: <a href="#ty
pe_FilePath">FilePath</a><span style="color:#999999"> (optional)</span></b></dt>
<dd> |
2331 | 2370 |
2332 <p> | 2371 <p> |
2333 The file to which the URI was mapped. This field is omitted if the | 2372 The file to which the URI was mapped. This field is omitted if the |
2334 uri field was not given in the request. | 2373 uri field was not given in the request. |
2335 </p> | 2374 </p> |
2336 </dd><dt class="field"><b>uri (<span style="color:#999999">optional</s
pan> String)</b></dt><dd> | 2375 </dd><dt class="field"><b>uri: String<span style="color:#999999"> (opt
ional)</span></b></dt><dd> |
2337 | 2376 |
2338 <p> | 2377 <p> |
2339 The URI to which the file path was mapped. This field is omitted | 2378 The URI to which the file path was mapped. This field is omitted |
2340 if the file field was not given in the request. | 2379 if the file field was not given in the request. |
2341 </p> | 2380 </p> |
2342 </dd></dl></dd><dt class="request"><a name="request_execution.setSubsc
riptions">execution.setSubscriptions</a> (<a href="#request_execution.setSubscri
ptions">#</a>)</dt><dd><div class="box"><pre>request: { | 2381 </dd></dl></dd><dt class="request deprecated"><a name="request_executi
on.setSubscriptions">execution.setSubscriptions</a></dt><dd><div class="box"><pr
e>request: { |
2343 "id": String | 2382 "id": String |
2344 "method": "execution.setSubscriptions" | 2383 "method": "execution.setSubscriptions" |
2345 "params": { | 2384 "params": { |
2346 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe
rvice</a>> | 2385 "<b>subscriptions</b>": List<<a href="#type_ExecutionService">ExecutionSe
rvice</a>> |
2347 } | 2386 } |
2348 }</pre><br><pre>response: { | 2387 }</pre><br><pre>response: { |
2349 "id": String | 2388 "id": String |
2350 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2389 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2351 }</pre></div> | 2390 }</pre></div> |
2352 <p> | 2391 <p> |
2353 <b><i>Deprecated</i></b>: the analysis server no longer fires | 2392 <b>Deprecated:</b> the analysis server no longer fires |
2354 <tt>LAUNCH_DATA</tt> events. | 2393 <tt>LAUNCH_DATA</tt> events. |
2355 </p> | 2394 </p> |
2356 <p> | 2395 <p> |
2357 Subscribe for services. All previous subscriptions are replaced by the | 2396 Subscribe for services. All previous subscriptions are replaced by the |
2358 given set of services. | 2397 given set of services. |
2359 </p> | 2398 </p> |
2360 <p> | 2399 <p> |
2361 It is an error if any of the elements in the list are not valid | 2400 It is an error if any of the elements in the list are not valid |
2362 services. If there is an error, then the current subscriptions will | 2401 services. If there is an error, then the current subscriptions will |
2363 remain unchanged. | 2402 remain unchanged. |
2364 </p> | 2403 </p> |
2365 | 2404 |
2366 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions (List<<a hre
f="#type_ExecutionService">ExecutionService</a>>)</b></dt><dd> | 2405 <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: List<<a hre
f="#type_ExecutionService">ExecutionService</a>></b></dt><dd> |
2367 | 2406 |
2368 <p> | 2407 <p> |
2369 A list of the services being subscribed to. | 2408 A list of the services being subscribed to. |
2370 </p> | 2409 </p> |
2371 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_execution.launchData">execution.launchData</a> (<a href="
#notification_execution.launchData">#</a>)</dt><dd><div class="box"><pre>notific
ation: { | 2410 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification"
><a name="notification_execution.launchData">execution.launchData</a></dt><dd><d
iv class="box"><pre>notification: { |
2372 "event": "execution.launchData" | 2411 "event": "execution.launchData" |
2373 "params": { | 2412 "params": { |
2374 "<b>file</b>": <a href="#type_FilePath">FilePath</a> | 2413 "<b>file</b>": <a href="#type_FilePath">FilePath</a> |
2375 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex
ecutableKind">ExecutableKind</a> | 2414 "<b>kind</b>": <span style="color:#999999">optional</span> <a href="#type_Ex
ecutableKind">ExecutableKind</a> |
2376 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l
t;<a href="#type_FilePath">FilePath</a>> | 2415 "<b>referencedFiles</b>": <span style="color:#999999">optional</span> List&l
t;<a href="#type_FilePath">FilePath</a>> |
2377 } | 2416 } |
2378 }</pre></div> | 2417 }</pre></div> |
2379 <p> | 2418 <p> |
2380 Reports information needed to allow a single file to be launched. | 2419 Reports information needed to allow a single file to be launched. |
2381 </p> | 2420 </p> |
2382 <p> | 2421 <p> |
2383 This notification is not subscribed to by default. Clients can | 2422 This notification is not subscribed to by default. Clients can |
2384 subscribe by including the value "LAUNCH_DATA" in the list of services | 2423 subscribe by including the value "LAUNCH_DATA" in the list of services |
2385 passed in an <tt>execution.setSubscriptions</tt> request. | 2424 passed in an <tt>execution.setSubscriptions</tt> request. |
2386 </p> | 2425 </p> |
2387 | 2426 |
2388 <h4>parameters:</h4><dl><dt class="field"><b>file (<a href="#type_FilePath
">FilePath</a>)</b></dt><dd> | 2427 <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath
">FilePath</a></b></dt><dd> |
2389 | 2428 |
2390 <p> | 2429 <p> |
2391 The file for which launch data is being provided. This will either | 2430 The file for which launch data is being provided. This will either |
2392 be a Dart library or an HTML file. | 2431 be a Dart library or an HTML file. |
2393 </p> | 2432 </p> |
2394 </dd><dt class="field"><b>kind (<span style="color:#999999">optional</
span> <a href="#type_ExecutableKind">ExecutableKind</a>)</b></dt><dd> | 2433 </dd><dt class="field"><b>kind: <a href="#type_ExecutableKind">Executa
bleKind</a><span style="color:#999999"> (optional)</span></b></dt><dd> |
2395 | 2434 |
2396 <p> | 2435 <p> |
2397 The kind of the executable file. This field is omitted if the file | 2436 The kind of the executable file. This field is omitted if the file |
2398 is not a Dart file. | 2437 is not a Dart file. |
2399 </p> | 2438 </p> |
2400 </dd><dt class="field"><b>referencedFiles (<span style="color:#999999"
>optional</span> List<<a href="#type_FilePath">FilePath</a>>)</b></dt><dd> | 2439 </dd><dt class="field"><b>referencedFiles: List<<a href="#type_File
Path">FilePath</a>><span style="color:#999999"> (optional)</span></b></dt><dd
> |
2401 | 2440 |
2402 <p> | 2441 <p> |
2403 A list of the Dart files that are referenced by the file. This | 2442 A list of the Dart files that are referenced by the file. This |
2404 field is omitted if the file is not an HTML file. | 2443 field is omitted if the file is not an HTML file. |
2405 </p> | 2444 </p> |
2406 </dd></dl></dd></dl> | 2445 </dd></dl></dd></dl> |
2407 <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2> | 2446 <h2 class="domain"><a name="domain_diagnostic">diagnostic domain</a></h2> |
2408 <p> | 2447 <p> |
2409 The diagnostic domain contains server diagnostics APIs. | 2448 The diagnostic domain contains server diagnostics APIs. |
2410 </p> | 2449 </p> |
2411 | 2450 |
2412 | 2451 |
2413 <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiag
nostics">diagnostic.getDiagnostics</a> (<a href="#request_diagnostic.getDiagnost
ics">#</a>)</dt><dd><div class="box"><pre>request: { | 2452 <h3>Requests</h3><dl><dt class="request"><a name="request_diagnostic.getDiag
nostics">diagnostic.getDiagnostics</a></dt><dd><div class="box"><pre>request: { |
2414 "id": String | 2453 "id": String |
2415 "method": "diagnostic.getDiagnostics" | 2454 "method": "diagnostic.getDiagnostics" |
2416 }</pre><br><pre>response: { | 2455 }</pre><br><pre>response: { |
2417 "id": String | 2456 "id": String |
2418 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2457 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2419 "result": { | 2458 "result": { |
2420 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>> | 2459 "<b>contexts</b>": List<<a href="#type_ContextData">ContextData</a>> |
2421 } | 2460 } |
2422 }</pre></div> | 2461 }</pre></div> |
2423 <p>Return server diagnostics.</p> | 2462 <p>Return server diagnostics.</p> |
2424 | 2463 |
2425 <h4>returns:</h4><dl><dt class="field"><b>contexts (List<<a href="#type
_ContextData">ContextData</a>>)</b></dt><dd> | 2464 <h4>returns:</h4><dl><dt class="field"><b>contexts: List<<a href="#type
_ContextData">ContextData</a>></b></dt><dd> |
2426 | 2465 |
2427 <p>The list of analysis contexts.</p> | 2466 <p>The list of analysis contexts.</p> |
2428 </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServ
erPort">diagnostic.getServerPort</a> (<a href="#request_diagnostic.getServerPort
">#</a>)</dt><dd><div class="box"><pre>request: { | 2467 </dd></dl></dd><dt class="request"><a name="request_diagnostic.getServ
erPort">diagnostic.getServerPort</a></dt><dd><div class="box"><pre>request: { |
2429 "id": String | 2468 "id": String |
2430 "method": "diagnostic.getServerPort" | 2469 "method": "diagnostic.getServerPort" |
2431 }</pre><br><pre>response: { | 2470 }</pre><br><pre>response: { |
2432 "id": String | 2471 "id": String |
2433 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 2472 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
2434 "result": { | 2473 "result": { |
2435 "<b>port</b>": int | 2474 "<b>port</b>": int |
2436 } | 2475 } |
2437 }</pre></div> | 2476 }</pre></div> |
2438 <p> | 2477 <p> |
2439 Return the port of the diagnostic web server. If the server is not run
ning | 2478 Return the port of the diagnostic web server. If the server is not run
ning |
2440 this call will start the server. If unable to start the diagnostic web
server, | 2479 this call will start the server. If unable to start the diagnostic web
server, |
2441 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</
tt>. | 2480 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</
tt>. |
2442 </p> | 2481 </p> |
2443 | 2482 |
2444 <h4>returns:</h4><dl><dt class="field"><b>port (int)</b></dt><dd> | 2483 <h4>returns:</h4><dl><dt class="field"><b>port: int</b></dt><dd> |
2445 | 2484 |
2446 <p>The diagnostic server port.</p> | 2485 <p>The diagnostic server port.</p> |
2447 </dd></dl></dd></dl> | 2486 </dd></dl></dd></dl> |
2448 | 2487 |
2449 <h2 class="domain"><a name="types">Types</a></h2> | 2488 <h2 class="domain"><a name="types">Types</a></h2> |
2450 <p> | 2489 <p> |
2451 This section contains descriptions of the data types referenced | 2490 This section contains descriptions of the data types referenced |
2452 in the API’s of the various domains. | 2491 in the API’s of the various domains. |
2453 </p> | 2492 </p> |
2454 | 2493 |
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2515 A directive to begin overlaying the contents of a file. The | 2554 A directive to begin overlaying the contents of a file. The |
2516 supplied content will be used for analysis in place of the | 2555 supplied content will be used for analysis in place of the |
2517 file contents in the filesystem. | 2556 file contents in the filesystem. |
2518 </p> | 2557 </p> |
2519 <p> | 2558 <p> |
2520 If this directive is used on a file that already has a file | 2559 If this directive is used on a file that already has a file |
2521 content overlay, the old overlay is discarded and replaced | 2560 content overlay, the old overlay is discarded and replaced |
2522 with the new one. | 2561 with the new one. |
2523 </p> | 2562 </p> |
2524 | 2563 |
2525 <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field"><
b>content (String)</b></dt><dd> | 2564 <dl><dt class="field"><b>type = "add"</b></dt><dd></dd><dt class="field"><
b>content: String</b></dt><dd> |
2526 | 2565 |
2527 <p> | 2566 <p> |
2528 The new content of the file. | 2567 The new content of the file. |
2529 </p> | 2568 </p> |
2530 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError"
>AnalysisError: object</a></dt><dd> | 2569 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError"
>AnalysisError: object</a></dt><dd> |
2531 <p> | 2570 <p> |
2532 An indication of an error, warning, or hint that was produced | 2571 An indication of an error, warning, or hint that was produced |
2533 by the analysis. | 2572 by the analysis. |
2534 </p> | 2573 </p> |
2535 | 2574 |
2536 <dl><dt class="field"><b>severity (<a href="#type_AnalysisErrorSeverity">A
nalysisErrorSeverity</a>)</b></dt><dd> | 2575 <dl><dt class="field"><b>severity: <a href="#type_AnalysisErrorSeverity">A
nalysisErrorSeverity</a></b></dt><dd> |
2537 | 2576 |
2538 <p> | 2577 <p> |
2539 The severity of the error. | 2578 The severity of the error. |
2540 </p> | 2579 </p> |
2541 </dd><dt class="field"><b>type (<a href="#type_AnalysisErrorType">Anal
ysisErrorType</a>)</b></dt><dd> | 2580 </dd><dt class="field"><b>type: <a href="#type_AnalysisErrorType">Anal
ysisErrorType</a></b></dt><dd> |
2542 | 2581 |
2543 <p> | 2582 <p> |
2544 The type of the error. | 2583 The type of the error. |
2545 </p> | 2584 </p> |
2546 </dd><dt class="field"><b>location (<a href="#type_Location">Location<
/a>)</b></dt><dd> | 2585 </dd><dt class="field"><b>location: <a href="#type_Location">Location<
/a></b></dt><dd> |
2547 | 2586 |
2548 <p> | 2587 <p> |
2549 The location associated with the error. | 2588 The location associated with the error. |
2550 </p> | 2589 </p> |
2551 </dd><dt class="field"><b>message (String)</b></dt><dd> | 2590 </dd><dt class="field"><b>message: String</b></dt><dd> |
2552 | 2591 |
2553 <p> | 2592 <p> |
2554 The message to be displayed for this error. The message | 2593 The message to be displayed for this error. The message |
2555 should indicate what is wrong with the code and why it is | 2594 should indicate what is wrong with the code and why it is |
2556 wrong. | 2595 wrong. |
2557 </p> | 2596 </p> |
2558 </dd><dt class="field"><b>correction (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 2597 </dd><dt class="field"><b>correction: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
2559 | 2598 |
2560 <p> | 2599 <p> |
2561 The correction message to be displayed for this error. The | 2600 The correction message to be displayed for this error. The |
2562 correction message should indicate how the user can fix | 2601 correction message should indicate how the user can fix |
2563 the error. The field is omitted if there is no correction | 2602 the error. The field is omitted if there is no correction |
2564 message associated with the error code. | 2603 message associated with the error code. |
2565 </p> | 2604 </p> |
2566 </dd><dt class="field"><b>code (String)</b></dt><dd> | 2605 </dd><dt class="field"><b>code: String</b></dt><dd> |
2567 | 2606 |
2568 <p> | 2607 <p> |
2569 The name, as a string, of the error code associated with this erro
r. | 2608 The name, as a string, of the error code associated with this erro
r. |
2570 </p> | 2609 </p> |
2571 </dd><dt class="field"><b>hasFix (<span style="color:#999999">optional
</span> bool)</b></dt><dd> | 2610 </dd><dt class="field"><b>hasFix: bool<span style="color:#999999"> (op
tional)</span></b></dt><dd> |
2572 | 2611 |
2573 <p> | 2612 <p> |
2574 A hint to indicate to interested clients that this error has | 2613 A hint to indicate to interested clients that this error has |
2575 an associated fix (or fixes). The absence of this field implies | 2614 an associated fix (or fixes). The absence of this field implies |
2576 there are not known to be fixes. Note that since the operation | 2615 there are not known to be fixes. Note that since the operation |
2577 to calculate whether fixes apply needs to be performant it is | 2616 to calculate whether fixes apply needs to be performant it is |
2578 possible that complicated tests will be skipped and a false | 2617 possible that complicated tests will be skipped and a false |
2579 negative returned. For this reason, this attribute should be | 2618 negative returned. For this reason, this attribute should be |
2580 treated as a "hint". Despite the possibility of false negatives, | 2619 treated as a "hint". Despite the possibility of false negatives, |
2581 no false positives should be returned. If a client sees this | 2620 no false positives should be returned. If a client sees this |
2582 flag set they can proceed with the confidence that there are in | 2621 flag set they can proceed with the confidence that there are in |
2583 fact associated fixes. | 2622 fact associated fixes. |
2584 </p> | 2623 </p> |
2585 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF
ixes">AnalysisErrorFixes: object</a></dt><dd> | 2624 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorF
ixes">AnalysisErrorFixes: object</a></dt><dd> |
2586 <p> | 2625 <p> |
2587 A list of fixes associated with a specific error | 2626 A list of fixes associated with a specific error |
2588 </p> | 2627 </p> |
2589 | 2628 |
2590 <dl><dt class="field"><b>error (<a href="#type_AnalysisError">AnalysisErro
r</a>)</b></dt><dd> | 2629 <dl><dt class="field"><b>error: <a href="#type_AnalysisError">AnalysisErro
r</a></b></dt><dd> |
2591 | 2630 |
2592 <p> | 2631 <p> |
2593 The error with which the fixes are associated. | 2632 The error with which the fixes are associated. |
2594 </p> | 2633 </p> |
2595 </dd><dt class="field"><b>fixes (List<<a href="#type_SourceChange">
SourceChange</a>>)</b></dt><dd> | 2634 </dd><dt class="field"><b>fixes: List<<a href="#type_SourceChange">
SourceChange</a>></b></dt><dd> |
2596 | 2635 |
2597 <p> | 2636 <p> |
2598 The fixes associated with the error. | 2637 The fixes associated with the error. |
2599 </p> | 2638 </p> |
2600 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS
everity">AnalysisErrorSeverity: String</a></dt><dd> | 2639 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorS
everity">AnalysisErrorSeverity: String</a></dt><dd> |
2601 <p> | 2640 <p> |
2602 An enumeration of the possible severities of analysis | 2641 An enumeration of the possible severities of analysis |
2603 errors. | 2642 errors. |
2604 </p> | 2643 </p> |
2605 | 2644 |
2606 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va
lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorT
ype">AnalysisErrorType: String</a></dt><dd> | 2645 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va
lue">ERROR</dt></dl></dd><dt class="typeDefinition"><a name="type_AnalysisErrorT
ype">AnalysisErrorType: String</a></dt><dd> |
2607 <p> | 2646 <p> |
2608 An enumeration of the possible types of analysis errors. | 2647 An enumeration of the possible types of analysis errors. |
2609 </p> | 2648 </p> |
2610 | 2649 |
2611 <dl><dt class="value">CHECKED_MODE_COMPILE_TIME_ERROR</dt><dt class="value
">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">LINT</dt><
dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><d
t class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt cla
ss="typeDefinition"><a name="type_AnalysisOptions">AnalysisOptions: object</a></
dt><dd> | 2650 <dl><dt class="value">CHECKED_MODE_COMPILE_TIME_ERROR</dt><dt class="value
">COMPILE_TIME_ERROR</dt><dt class="value">HINT</dt><dt class="value">LINT</dt><
dt class="value">STATIC_TYPE_WARNING</dt><dt class="value">STATIC_WARNING</dt><d
t class="value">SYNTACTIC_ERROR</dt><dt class="value">TODO</dt></dl></dd><dt cla
ss="typeDefinition deprecated"><a name="type_AnalysisOptions">AnalysisOptions: o
bject</a></dt><dd> |
2612 <p><b><i>Deprecated</i></b>: the only reference to this type has been | 2651 <p><b>Deprecated:</b> the only reference to this type has been |
2613 deprecated.</p> | 2652 deprecated.</p> |
2614 <p> | 2653 <p> |
2615 A set of options controlling what kind of analysis is to be | 2654 A set of options controlling what kind of analysis is to be |
2616 performed. If the value of a field is omitted the value of the | 2655 performed. If the value of a field is omitted the value of the |
2617 option will not be changed. | 2656 option will not be changed. |
2618 </p> | 2657 </p> |
2619 | 2658 |
2620 <dl><dt class="field"><b>enableAsync (<span style="color:#999999">optional
</span> bool)</b></dt><dd> | 2659 <dl><dt class="field"><b><span class="deprecated">enableAsync</span>: bool
<span style="color:#999999"> (optional)</span></b></dt><dd> |
2621 | 2660 |
2622 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> | 2661 <p><b>Deprecated:</b> this feature is always enabled.</p> |
2623 <p> | 2662 <p> |
2624 True if the client wants to enable support for the | 2663 True if the client wants to enable support for the |
2625 proposed async feature. | 2664 proposed async feature. |
2626 </p> | 2665 </p> |
2627 </dd><dt class="field"><b>enableDeferredLoading (<span style="color:#9
99999">optional</span> bool)</b></dt><dd> | 2666 </dd><dt class="field"><b><span class="deprecated">enableDeferredLoadi
ng</span>: bool<span style="color:#999999"> (optional)</span></b></dt><dd> |
2628 | 2667 |
2629 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> | 2668 <p><b>Deprecated:</b> this feature is always enabled.</p> |
2630 <p> | 2669 <p> |
2631 True if the client wants to enable support for the | 2670 True if the client wants to enable support for the |
2632 proposed deferred loading feature. | 2671 proposed deferred loading feature. |
2633 </p> | 2672 </p> |
2634 </dd><dt class="field"><b>enableEnums (<span style="color:#999999">opt
ional</span> bool)</b></dt><dd> | 2673 </dd><dt class="field"><b><span class="deprecated">enableEnums</span>:
bool<span style="color:#999999"> (optional)</span></b></dt><dd> |
2635 | 2674 |
2636 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> | 2675 <p><b>Deprecated:</b> this feature is always enabled.</p> |
2637 <p> | 2676 <p> |
2638 True if the client wants to enable support for the | 2677 True if the client wants to enable support for the |
2639 proposed enum feature. | 2678 proposed enum feature. |
2640 </p> | 2679 </p> |
2641 </dd><dt class="field"><b>enableNullAwareOperators (<span style="color
:#999999">optional</span> bool)</b></dt><dd> | 2680 </dd><dt class="field"><b><span class="deprecated">enableNullAwareOper
ators</span>: bool<span style="color:#999999"> (optional)</span></b></dt><dd> |
2642 | 2681 |
2643 <p><b><i>Deprecated</i></b>: this feature is always enabled.</p> | 2682 <p><b>Deprecated:</b> this feature is always enabled.</p> |
2644 <p> | 2683 <p> |
2645 True if the client wants to enable support for the | 2684 True if the client wants to enable support for the |
2646 proposed "null aware operators" feature. | 2685 proposed "null aware operators" feature. |
2647 </p> | 2686 </p> |
2648 </dd><dt class="field"><b>enableSuperMixins (<span style="color:#99999
9">optional</span> bool)</b></dt><dd> | 2687 </dd><dt class="field"><b>enableSuperMixins: bool<span style="color:#9
99999"> (optional)</span></b></dt><dd> |
2649 | 2688 |
2650 <p> | 2689 <p> |
2651 True if the client wants to enable support for the | 2690 True if the client wants to enable support for the |
2652 proposed "less restricted mixins" proposal (DEP 34). | 2691 proposed "less restricted mixins" proposal (DEP 34). |
2653 </p> | 2692 </p> |
2654 </dd><dt class="field"><b>generateDart2jsHints (<span style="color:#99
9999">optional</span> bool)</b></dt><dd> | 2693 </dd><dt class="field"><b>generateDart2jsHints: bool<span style="color
:#999999"> (optional)</span></b></dt><dd> |
2655 | 2694 |
2656 <p> | 2695 <p> |
2657 True if hints that are specific to dart2js should be | 2696 True if hints that are specific to dart2js should be |
2658 generated. This option is ignored if generateHints is false. | 2697 generated. This option is ignored if generateHints is false. |
2659 </p> | 2698 </p> |
2660 </dd><dt class="field"><b>generateHints (<span style="color:#999999">o
ptional</span> bool)</b></dt><dd> | 2699 </dd><dt class="field"><b>generateHints: bool<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
2661 | 2700 |
2662 <p> | 2701 <p> |
2663 True if hints should be generated as part of generating | 2702 True if hints should be generated as part of generating |
2664 errors and warnings. | 2703 errors and warnings. |
2665 </p> | 2704 </p> |
2666 </dd><dt class="field"><b>generateLints (<span style="color:#999999">o
ptional</span> bool)</b></dt><dd> | 2705 </dd><dt class="field"><b>generateLints: bool<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
2667 | 2706 |
2668 <p> | 2707 <p> |
2669 True if lints should be generated as part of generating | 2708 True if lints should be generated as part of generating |
2670 errors and warnings. | 2709 errors and warnings. |
2671 </p> | 2710 </p> |
2672 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic
e">AnalysisService: String</a></dt><dd> | 2711 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic
e">AnalysisService: String</a></dt><dd> |
2673 <p> | 2712 <p> |
2674 An enumeration of the services provided by the analysis domain that | 2713 An enumeration of the services provided by the analysis domain that |
2675 are related to a specific list of files. | 2714 are related to a specific list of files. |
2676 </p> | 2715 </p> |
2677 | 2716 |
2678 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla
ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd> | 2717 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla
ss="value">IMPLEMENTED</dt><dt class="value">INVALIDATE</dt><dd> |
2679 | 2718 |
2680 <p> | 2719 <p> |
2681 This service is not currently implemented and will become a | 2720 This service is not currently implemented and will become a |
2682 GeneralAnalysisService in a future release. | 2721 GeneralAnalysisService in a future release. |
2683 </p> | 2722 </p> |
2684 </dd><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</d
t><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt cl
ass="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></d
t><dd> | 2723 </dd><dt class="value">NAVIGATION</dt><dt class="value">OCCURRENCES</d
t><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt cl
ass="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: object</a></d
t><dd> |
2685 <p> | 2724 <p> |
2686 An indication of the current state of analysis. | 2725 An indication of the current state of analysis. |
2687 </p> | 2726 </p> |
2688 | 2727 |
2689 <dl><dt class="field"><b>isAnalyzing (bool)</b></dt><dd> | 2728 <dl><dt class="field"><b>isAnalyzing: bool</b></dt><dd> |
2690 | 2729 |
2691 <p>True if analysis is currently being performed.</p> | 2730 <p>True if analysis is currently being performed.</p> |
2692 </dd><dt class="field"><b>analysisTarget (<span style="color:#999999">
optional</span> String)</b></dt><dd> | 2731 </dd><dt class="field"><b>analysisTarget: String<span style="color:#99
9999"> (optional)</span></b></dt><dd> |
2693 | 2732 |
2694 <p> | 2733 <p> |
2695 The name of the current target of analysis. This field is | 2734 The name of the current target of analysis. This field is |
2696 omitted if analyzing is false. | 2735 omitted if analyzing is false. |
2697 </p> | 2736 </p> |
2698 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO
verlay">ChangeContentOverlay: object</a></dt><dd> | 2737 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO
verlay">ChangeContentOverlay: object</a></dt><dd> |
2699 <p> | 2738 <p> |
2700 A directive to modify an existing file content overlay. One or more | 2739 A directive to modify an existing file content overlay. One or more |
2701 ranges of text are deleted from the old file content overlay and | 2740 ranges of text are deleted from the old file content overlay and |
2702 replaced with new text. | 2741 replaced with new text. |
2703 </p> | 2742 </p> |
2704 <p> | 2743 <p> |
2705 The edits are applied in the order in which they occur in the list. | 2744 The edits are applied in the order in which they occur in the list. |
2706 This means that the offset of each edit must be correct under the | 2745 This means that the offset of each edit must be correct under the |
2707 assumption that all previous edits have been applied. | 2746 assumption that all previous edits have been applied. |
2708 </p> | 2747 </p> |
2709 <p> | 2748 <p> |
2710 It is an error to use this overlay on a file that does not yet have | 2749 It is an error to use this overlay on a file that does not yet have |
2711 a file content overlay or that has had its overlay removed via | 2750 a file content overlay or that has had its overlay removed via |
2712 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. | 2751 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. |
2713 </p> | 2752 </p> |
2714 <p> | 2753 <p> |
2715 If any of the edits cannot be applied due to its offset or | 2754 If any of the edits cannot be applied due to its offset or |
2716 length being out of range, an INVALID_OVERLAY_CHANGE error | 2755 length being out of range, an INVALID_OVERLAY_CHANGE error |
2717 will be reported. | 2756 will be reported. |
2718 </p> | 2757 </p> |
2719 | 2758 |
2720 <dl><dt class="field"><b>type = "change"</b></dt><dd></dd><dt class="field
"><b>edits (List<<a href="#type_SourceEdit">SourceEdit</a>>)</b></dt><dd> | 2759 <dl><dt class="field"><b>type = "change"</b></dt><dd></dd><dt class="field
"><b>edits: List<<a href="#type_SourceEdit">SourceEdit</a>></b></dt><dd> |
2721 | 2760 |
2722 <p> | 2761 <p> |
2723 The edits to be applied to the file. | 2762 The edits to be applied to the file. |
2724 </p> | 2763 </p> |
2725 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> | 2764 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> |
2726 | 2765 |
2727 <p> | 2766 <p> |
2728 An identifier used to associate completion results with a | 2767 An identifier used to associate completion results with a |
2729 completion request. | 2768 completion request. |
2730 </p> | 2769 </p> |
2731 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple
tionSuggestion: object</a></dt><dd> | 2770 </dd><dt class="typeDefinition"><a name="type_CompletionSuggestion">Comple
tionSuggestion: object</a></dt><dd> |
2732 <p> | 2771 <p> |
2733 A suggestion for how to complete partially entered text. Many | 2772 A suggestion for how to complete partially entered text. Many |
2734 of the fields are optional, depending on the kind of element | 2773 of the fields are optional, depending on the kind of element |
2735 being suggested. | 2774 being suggested. |
2736 </p> | 2775 </p> |
2737 | 2776 |
2738 <dl><dt class="field"><b>kind (<a href="#type_CompletionSuggestionKind">Co
mpletionSuggestionKind</a>)</b></dt><dd> | 2777 <dl><dt class="field"><b>kind: <a href="#type_CompletionSuggestionKind">Co
mpletionSuggestionKind</a></b></dt><dd> |
2739 | 2778 |
2740 <p> | 2779 <p> |
2741 The kind of element being suggested. | 2780 The kind of element being suggested. |
2742 </p> | 2781 </p> |
2743 </dd><dt class="field"><b>relevance (int)</b></dt><dd> | 2782 </dd><dt class="field"><b>relevance: int</b></dt><dd> |
2744 | 2783 |
2745 <p> | 2784 <p> |
2746 The relevance of this completion suggestion | 2785 The relevance of this completion suggestion |
2747 where a higher number indicates a higher relevance. | 2786 where a higher number indicates a higher relevance. |
2748 </p> | 2787 </p> |
2749 </dd><dt class="field"><b>completion (String)</b></dt><dd> | 2788 </dd><dt class="field"><b>completion: String</b></dt><dd> |
2750 | 2789 |
2751 <p> | 2790 <p> |
2752 The identifier to be inserted if the suggestion is | 2791 The identifier to be inserted if the suggestion is |
2753 selected. If the suggestion is for a method or function, | 2792 selected. If the suggestion is for a method or function, |
2754 the client might want to additionally insert a template | 2793 the client might want to additionally insert a template |
2755 for the parameters. The information required in order to | 2794 for the parameters. The information required in order to |
2756 do so is contained in other fields. | 2795 do so is contained in other fields. |
2757 </p> | 2796 </p> |
2758 </dd><dt class="field"><b>selectionOffset (int)</b></dt><dd> | 2797 </dd><dt class="field"><b>selectionOffset: int</b></dt><dd> |
2759 | 2798 |
2760 <p> | 2799 <p> |
2761 The offset, relative to the beginning of the completion, | 2800 The offset, relative to the beginning of the completion, |
2762 of where the selection should be placed after insertion. | 2801 of where the selection should be placed after insertion. |
2763 </p> | 2802 </p> |
2764 </dd><dt class="field"><b>selectionLength (int)</b></dt><dd> | 2803 </dd><dt class="field"><b>selectionLength: int</b></dt><dd> |
2765 | 2804 |
2766 <p> | 2805 <p> |
2767 The number of characters that should be selected after | 2806 The number of characters that should be selected after |
2768 insertion. | 2807 insertion. |
2769 </p> | 2808 </p> |
2770 </dd><dt class="field"><b>isDeprecated (bool)</b></dt><dd> | 2809 </dd><dt class="field"><b>isDeprecated: bool</b></dt><dd> |
2771 | 2810 |
2772 <p> | 2811 <p> |
2773 True if the suggested element is deprecated. | 2812 True if the suggested element is deprecated. |
2774 </p> | 2813 </p> |
2775 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd> | 2814 </dd><dt class="field"><b>isPotential: bool</b></dt><dd> |
2776 | 2815 |
2777 <p> | 2816 <p> |
2778 True if the element is not known to be valid for the | 2817 True if the element is not known to be valid for the |
2779 target. This happens if the type of the target is dynamic. | 2818 target. This happens if the type of the target is dynamic. |
2780 </p> | 2819 </p> |
2781 </dd><dt class="field"><b>docSummary (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 2820 </dd><dt class="field"><b>docSummary: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
2782 | 2821 |
2783 <p> | 2822 <p> |
2784 An abbreviated version of the Dartdoc associated with the | 2823 An abbreviated version of the Dartdoc associated with the |
2785 element being suggested, This field is omitted if there is | 2824 element being suggested, This field is omitted if there is |
2786 no Dartdoc associated with the element. | 2825 no Dartdoc associated with the element. |
2787 </p> | 2826 </p> |
2788 </dd><dt class="field"><b>docComplete (<span style="color:#999999">opt
ional</span> String)</b></dt><dd> | 2827 </dd><dt class="field"><b>docComplete: String<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
2789 | 2828 |
2790 <p> | 2829 <p> |
2791 The Dartdoc associated with the element being suggested, | 2830 The Dartdoc associated with the element being suggested, |
2792 This field is omitted if there is no Dartdoc associated | 2831 This field is omitted if there is no Dartdoc associated |
2793 with the element. | 2832 with the element. |
2794 </p> | 2833 </p> |
2795 </dd><dt class="field"><b>declaringType (<span style="color:#999999">o
ptional</span> String)</b></dt><dd> | 2834 </dd><dt class="field"><b>declaringType: String<span style="color:#999
999"> (optional)</span></b></dt><dd> |
2796 | 2835 |
2797 <p> | 2836 <p> |
2798 The class that declares the element being suggested. This | 2837 The class that declares the element being suggested. This |
2799 field is omitted if the suggested element is not a member | 2838 field is omitted if the suggested element is not a member |
2800 of a class. | 2839 of a class. |
2801 </p> | 2840 </p> |
2802 </dd><dt class="field"><b>defaultArgumentListString (<span style="colo
r:#999999">optional</span> String)</b></dt><dd> | 2841 </dd><dt class="field"><b>defaultArgumentListString: String<span style
="color:#999999"> (optional)</span></b></dt><dd> |
2803 | 2842 |
2804 <p> | 2843 <p> |
2805 A default String for use in generating argument list | 2844 A default String for use in generating argument list |
2806 source contents on the client side. | 2845 source contents on the client side. |
2807 </p> | 2846 </p> |
2808 </dd><dt class="field"><b>defaultArgumentListTextRanges (<span style="
color:#999999">optional</span> List<int>)</b></dt><dd> | 2847 </dd><dt class="field"><b>defaultArgumentListTextRanges: List<int&g
t;<span style="color:#999999"> (optional)</span></b></dt><dd> |
2809 | 2848 |
2810 <p> | 2849 <p> |
2811 Pairs of offsets and lengths describing 'defaultArgumentListString
' | 2850 Pairs of offsets and lengths describing 'defaultArgumentListString
' |
2812 text ranges suitable for use by clients to set up linked edits of | 2851 text ranges suitable for use by clients to set up linked edits of |
2813 default argument source contents. For example, given an argument | 2852 default argument source contents. For example, given an argument |
2814 list string 'x, y', the corresponding text range [0, 1, 3, 1], | 2853 list string 'x, y', the corresponding text range [0, 1, 3, 1], |
2815 indicates two text ranges of length 1, starting at offsets 0 and 3
. | 2854 indicates two text ranges of length 1, starting at offsets 0 and 3
. |
2816 Clients can use these ranges to treat the 'x' and 'y' values | 2855 Clients can use these ranges to treat the 'x' and 'y' values |
2817 specially for linked edits. | 2856 specially for linked edits. |
2818 </p> | 2857 </p> |
2819 </dd><dt class="field"><b>element (<span style="color:#999999">optiona
l</span> <a href="#type_Element">Element</a>)</b></dt><dd> | 2858 </dd><dt class="field"><b>element: <a href="#type_Element">Element</a>
<span style="color:#999999"> (optional)</span></b></dt><dd> |
2820 | 2859 |
2821 <p> | 2860 <p> |
2822 Information about the element reference being suggested. | 2861 Information about the element reference being suggested. |
2823 </p> | 2862 </p> |
2824 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 2863 </dd><dt class="field"><b>returnType: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
2825 | 2864 |
2826 <p> | 2865 <p> |
2827 The return type of the getter, function or method | 2866 The return type of the getter, function or method |
2828 or the type of the field being suggested. | 2867 or the type of the field being suggested. |
2829 This field is omitted if the suggested element | 2868 This field is omitted if the suggested element |
2830 is not a getter, function or method. | 2869 is not a getter, function or method. |
2831 </p> | 2870 </p> |
2832 </dd><dt class="field"><b>parameterNames (<span style="color:#999999">
optional</span> List<String>)</b></dt><dd> | 2871 </dd><dt class="field"><b>parameterNames: List<String><span styl
e="color:#999999"> (optional)</span></b></dt><dd> |
2833 | 2872 |
2834 <p> | 2873 <p> |
2835 The names of the parameters of the function or method | 2874 The names of the parameters of the function or method |
2836 being suggested. This field is omitted if the suggested | 2875 being suggested. This field is omitted if the suggested |
2837 element is not a setter, function or method. | 2876 element is not a setter, function or method. |
2838 </p> | 2877 </p> |
2839 </dd><dt class="field"><b>parameterTypes (<span style="color:#999999">
optional</span> List<String>)</b></dt><dd> | 2878 </dd><dt class="field"><b>parameterTypes: List<String><span styl
e="color:#999999"> (optional)</span></b></dt><dd> |
2840 | 2879 |
2841 <p> | 2880 <p> |
2842 The types of the parameters of the function or method | 2881 The types of the parameters of the function or method |
2843 being suggested. This field is omitted if the | 2882 being suggested. This field is omitted if the |
2844 parameterNames field is omitted. | 2883 parameterNames field is omitted. |
2845 </p> | 2884 </p> |
2846 </dd><dt class="field"><b>requiredParameterCount (<span style="color:#
999999">optional</span> int)</b></dt><dd> | 2885 </dd><dt class="field"><b>requiredParameterCount: int<span style="colo
r:#999999"> (optional)</span></b></dt><dd> |
2847 | 2886 |
2848 <p> | 2887 <p> |
2849 The number of required parameters for the function or | 2888 The number of required parameters for the function or |
2850 method being suggested. This field is omitted if the | 2889 method being suggested. This field is omitted if the |
2851 parameterNames field is omitted. | 2890 parameterNames field is omitted. |
2852 </p> | 2891 </p> |
2853 </dd><dt class="field"><b>hasNamedParameters (<span style="color:#9999
99">optional</span> bool)</b></dt><dd> | 2892 </dd><dt class="field"><b>hasNamedParameters: bool<span style="color:#
999999"> (optional)</span></b></dt><dd> |
2854 | 2893 |
2855 <p> | 2894 <p> |
2856 True if the function or method being suggested has at | 2895 True if the function or method being suggested has at |
2857 least one named parameter. This field is omitted if the | 2896 least one named parameter. This field is omitted if the |
2858 parameterNames field is omitted. | 2897 parameterNames field is omitted. |
2859 </p> | 2898 </p> |
2860 </dd><dt class="field"><b>parameterName (<span style="color:#999999">o
ptional</span> String)</b></dt><dd> | 2899 </dd><dt class="field"><b>parameterName: String<span style="color:#999
999"> (optional)</span></b></dt><dd> |
2861 | 2900 |
2862 <p> | 2901 <p> |
2863 The name of the optional parameter being suggested. This | 2902 The name of the optional parameter being suggested. This |
2864 field is omitted if the suggestion is not the addition of | 2903 field is omitted if the suggestion is not the addition of |
2865 an optional argument within an argument list. | 2904 an optional argument within an argument list. |
2866 </p> | 2905 </p> |
2867 </dd><dt class="field"><b>parameterType (<span style="color:#999999">o
ptional</span> String)</b></dt><dd> | 2906 </dd><dt class="field"><b>parameterType: String<span style="color:#999
999"> (optional)</span></b></dt><dd> |
2868 | 2907 |
2869 <p> | 2908 <p> |
2870 The type of the options parameter being suggested. This | 2909 The type of the options parameter being suggested. This |
2871 field is omitted if the parameterName field is omitted. | 2910 field is omitted if the parameterName field is omitted. |
2872 </p> | 2911 </p> |
2873 </dd><dt class="field"><b>importUri (<span style="color:#999999">optio
nal</span> String)</b></dt><dd> | 2912 </dd><dt class="field"><b>importUri: String<span style="color:#999999"
> (optional)</span></b></dt><dd> |
2874 | 2913 |
2875 <p> | 2914 <p> |
2876 The import to be added if the suggestion is out of scope | 2915 The import to be added if the suggestion is out of scope |
2877 and needs an import to be added to be in scope. | 2916 and needs an import to be added to be in scope. |
2878 </p> | 2917 </p> |
2879 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg
estionKind">CompletionSuggestionKind: String</a></dt><dd> | 2918 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg
estionKind">CompletionSuggestionKind: String</a></dt><dd> |
2880 <p> | 2919 <p> |
2881 An enumeration of the kinds of elements that can be included | 2920 An enumeration of the kinds of elements that can be included |
2882 in a completion suggestion. | 2921 in a completion suggestion. |
2883 </p> | 2922 </p> |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2917 <p> | 2956 <p> |
2918 A named argument for the current callsite is being suggested. | 2957 A named argument for the current callsite is being suggested. |
2919 For suggestions of this kind, the completion is | 2958 For suggestions of this kind, the completion is |
2920 the named argument identifier including a trailing ':' and space. | 2959 the named argument identifier including a trailing ':' and space. |
2921 </p> | 2960 </p> |
2922 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMET
ER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextDa
ta: object</a></dt><dd> | 2961 </dd><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMET
ER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContextData">ContextDa
ta: object</a></dt><dd> |
2923 <p> | 2962 <p> |
2924 Information about an analysis context. | 2963 Information about an analysis context. |
2925 </p> | 2964 </p> |
2926 | 2965 |
2927 <dl><dt class="field"><b>name (String)</b></dt><dd> | 2966 <dl><dt class="field"><b>name: String</b></dt><dd> |
2928 | 2967 |
2929 <p> | 2968 <p> |
2930 The name of the context. | 2969 The name of the context. |
2931 </p> | 2970 </p> |
2932 </dd><dt class="field"><b>explicitFileCount (int)</b></dt><dd> | 2971 </dd><dt class="field"><b>explicitFileCount: int</b></dt><dd> |
2933 | 2972 |
2934 <p> | 2973 <p> |
2935 Explicitly analyzed files. | 2974 Explicitly analyzed files. |
2936 </p> | 2975 </p> |
2937 </dd><dt class="field"><b>implicitFileCount (int)</b></dt><dd> | 2976 </dd><dt class="field"><b>implicitFileCount: int</b></dt><dd> |
2938 | 2977 |
2939 <p> | 2978 <p> |
2940 Implicitly analyzed files. | 2979 Implicitly analyzed files. |
2941 </p> | 2980 </p> |
2942 </dd><dt class="field"><b>workItemQueueLength (int)</b></dt><dd> | 2981 </dd><dt class="field"><b>workItemQueueLength: int</b></dt><dd> |
2943 | 2982 |
2944 <p> | 2983 <p> |
2945 The number of work items in the queue. | 2984 The number of work items in the queue. |
2946 </p> | 2985 </p> |
2947 </dd><dt class="field"><b>cacheEntryExceptions (List<String>)</b
></dt><dd> | 2986 </dd><dt class="field"><b>cacheEntryExceptions: List<String></b>
</dt><dd> |
2948 | 2987 |
2949 <p> | 2988 <p> |
2950 Exceptions associated with cache entries. | 2989 Exceptions associated with cache entries. |
2951 </p> | 2990 </p> |
2952 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme
nt: object</a></dt><dd> | 2991 </dd></dl></dd><dt class="typeDefinition"><a name="type_Element">Eleme
nt: object</a></dt><dd> |
2953 <p> | 2992 <p> |
2954 Information about an element (something that can be declared | 2993 Information about an element (something that can be declared |
2955 in code). | 2994 in code). |
2956 </p> | 2995 </p> |
2957 | 2996 |
2958 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>
)</b></dt><dd> | 2997 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a>
</b></dt><dd> |
2959 | 2998 |
2960 <p> | 2999 <p> |
2961 The kind of the element. | 3000 The kind of the element. |
2962 </p> | 3001 </p> |
2963 </dd><dt class="field"><b>name (String)</b></dt><dd> | 3002 </dd><dt class="field"><b>name: String</b></dt><dd> |
2964 | 3003 |
2965 <p> | 3004 <p> |
2966 The name of the element. This is typically used as the | 3005 The name of the element. This is typically used as the |
2967 label in the outline. | 3006 label in the outline. |
2968 </p> | 3007 </p> |
2969 </dd><dt class="field"><b>location (<span style="color:#999999">option
al</span> <a href="#type_Location">Location</a>)</b></dt><dd> | 3008 </dd><dt class="field"><b>location: <a href="#type_Location">Location<
/a><span style="color:#999999"> (optional)</span></b></dt><dd> |
2970 | 3009 |
2971 <p> | 3010 <p> |
2972 The location of the name in the declaration of the | 3011 The location of the name in the declaration of the |
2973 element. | 3012 element. |
2974 </p> | 3013 </p> |
2975 </dd><dt class="field"><b>flags (int)</b></dt><dd> | 3014 </dd><dt class="field"><b>flags: int</b></dt><dd> |
2976 | 3015 |
2977 <p> | 3016 <p> |
2978 A bit-map containing the following flags: | 3017 A bit-map containing the following flags: |
2979 </p> | 3018 </p> |
2980 <ul> | 3019 <ul> |
2981 <li>0x01 - set if the element is explicitly or implicitly abstract
</li> | 3020 <li>0x01 - set if the element is explicitly or implicitly abstract
</li> |
2982 <li>0x02 - set if the element was declared to be ‘const’</li> | 3021 <li>0x02 - set if the element was declared to be ‘const’</li> |
2983 <li>0x04 - set if the element was declared to be ‘final’</li> | 3022 <li>0x04 - set if the element was declared to be ‘final’</li> |
2984 <li>0x08 - set if the element is a static member of a class or is
a top-level function or field</li> | 3023 <li>0x08 - set if the element is a static member of a class or is
a top-level function or field</li> |
2985 <li>0x10 - set if the element is private</li> | 3024 <li>0x10 - set if the element is private</li> |
2986 <li>0x20 - set if the element is deprecated</li> | 3025 <li>0x20 - set if the element is deprecated</li> |
2987 </ul> | 3026 </ul> |
2988 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 3027 </dd><dt class="field"><b>parameters: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
2989 | 3028 |
2990 <p> | 3029 <p> |
2991 The parameter list for the element. If the element is not | 3030 The parameter list for the element. If the element is not |
2992 a method or function this field will not be defined. If | 3031 a method or function this field will not be defined. If |
2993 the element doesn't have parameters (e.g. getter), this field | 3032 the element doesn't have parameters (e.g. getter), this field |
2994 will not be defined. If the element has zero parameters, this | 3033 will not be defined. If the element has zero parameters, this |
2995 field will have a value of "()". | 3034 field will have a value of "()". |
2996 </p> | 3035 </p> |
2997 </dd><dt class="field"><b>returnType (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 3036 </dd><dt class="field"><b>returnType: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
2998 | 3037 |
2999 <p> | 3038 <p> |
3000 The return type of the element. If the element is not a | 3039 The return type of the element. If the element is not a |
3001 method or function this field will not be defined. If the | 3040 method or function this field will not be defined. If the |
3002 element does not have a declared return type, this field | 3041 element does not have a declared return type, this field |
3003 will contain an empty string. | 3042 will contain an empty string. |
3004 </p> | 3043 </p> |
3005 </dd><dt class="field"><b>typeParameters (<span style="color:#999999">
optional</span> String)</b></dt><dd> | 3044 </dd><dt class="field"><b>typeParameters: String<span style="color:#99
9999"> (optional)</span></b></dt><dd> |
3006 | 3045 |
3007 <p> | 3046 <p> |
3008 The type parameter list for the element. If the element doesn't | 3047 The type parameter list for the element. If the element doesn't |
3009 have type parameters, this field will not be defined. | 3048 have type parameters, this field will not be defined. |
3010 </p> | 3049 </p> |
3011 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E
lementKind: String</a></dt><dd> | 3050 </dd></dl></dd><dt class="typeDefinition"><a name="type_ElementKind">E
lementKind: String</a></dt><dd> |
3012 <p> | 3051 <p> |
3013 An enumeration of the kinds of elements. | 3052 An enumeration of the kinds of elements. |
3014 </p> | 3053 </p> |
3015 | 3054 |
3016 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt
class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class=
"value">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">FUN
CTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><d
t class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="valu
e">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt c
lass="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="valu
e">TYPE_PARAMETER</dt><dt class="value">UNIT_TEST_GROUP</dt><dd> | 3055 <dl><dt class="value">CLASS</dt><dt class="value">CLASS_TYPE_ALIAS</dt><dt
class="value">COMPILATION_UNIT</dt><dt class="value">CONSTRUCTOR</dt><dt class=
"value">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">FUN
CTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">LABEL</dt><d
t class="value">LIBRARY</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="valu
e">METHOD</dt><dt class="value">PARAMETER</dt><dt class="value">PREFIX</dt><dt c
lass="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="valu
e">TYPE_PARAMETER</dt><dt class="value deprecated">UNIT_TEST_GROUP</dt><dd> |
3017 | 3056 |
3018 <p><b><i>Deprecated</i></b>: support for tests was removed.</p> | 3057 <p><b>Deprecated:</b> support for tests was removed.</p> |
3019 </dd><dt class="value">UNIT_TEST_TEST</dt><dd> | 3058 </dd><dt class="value deprecated">UNIT_TEST_TEST</dt><dd> |
3020 | 3059 |
3021 <p><b><i>Deprecated</i></b>: support for tests was removed.</p> | 3060 <p><b>Deprecated:</b> support for tests was removed.</p> |
3022 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition
"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd> | 3061 </dd><dt class="value">UNKNOWN</dt></dl></dd><dt class="typeDefinition
"><a name="type_ExecutableFile">ExecutableFile: object</a></dt><dd> |
3023 <p> | 3062 <p> |
3024 A description of an executable file. | 3063 A description of an executable file. |
3025 </p> | 3064 </p> |
3026 | 3065 |
3027 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b><
/dt><dd> | 3066 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></
dt><dd> |
3028 | 3067 |
3029 <p> | 3068 <p> |
3030 The path of the executable file. | 3069 The path of the executable file. |
3031 </p> | 3070 </p> |
3032 </dd><dt class="field"><b>kind (<a href="#type_ExecutableKind">Executa
bleKind</a>)</b></dt><dd> | 3071 </dd><dt class="field"><b>kind: <a href="#type_ExecutableKind">Executa
bleKind</a></b></dt><dd> |
3033 | 3072 |
3034 <p> | 3073 <p> |
3035 The kind of the executable file. | 3074 The kind of the executable file. |
3036 </p> | 3075 </p> |
3037 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind
">ExecutableKind: String</a></dt><dd> | 3076 </dd></dl></dd><dt class="typeDefinition"><a name="type_ExecutableKind
">ExecutableKind: String</a></dt><dd> |
3038 <p> | 3077 <p> |
3039 An enumeration of the kinds of executable files. | 3078 An enumeration of the kinds of executable files. |
3040 </p> | 3079 </p> |
3041 | 3080 |
3042 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v
alue">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeD
efinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt>
<dd> | 3081 <dl><dt class="value">CLIENT</dt><dt class="value">EITHER</dt><dt class="v
alue">NOT_EXECUTABLE</dt><dt class="value">SERVER</dt></dl></dd><dt class="typeD
efinition"><a name="type_ExecutionContextId">ExecutionContextId: String</a></dt>
<dd> |
(...skipping 25 matching lines...) Expand all Loading... |
3068 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St
ring</a></dt><dd> | 3107 </dd><dt class="typeDefinition"><a name="type_FoldingKind">FoldingKind: St
ring</a></dt><dd> |
3069 <p> | 3108 <p> |
3070 An enumeration of the kinds of folding regions. | 3109 An enumeration of the kinds of folding regions. |
3071 </p> | 3110 </p> |
3072 | 3111 |
3073 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c
lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas
s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name
="type_FoldingRegion">FoldingRegion: object</a></dt><dd> | 3112 <dl><dt class="value">COMMENT</dt><dt class="value">CLASS_MEMBER</dt><dt c
lass="value">DIRECTIVES</dt><dt class="value">DOCUMENTATION_COMMENT</dt><dt clas
s="value">TOP_LEVEL_DECLARATION</dt></dl></dd><dt class="typeDefinition"><a name
="type_FoldingRegion">FoldingRegion: object</a></dt><dd> |
3074 <p> | 3113 <p> |
3075 A description of a region that can be folded. | 3114 A description of a region that can be folded. |
3076 </p> | 3115 </p> |
3077 | 3116 |
3078 <dl><dt class="field"><b>kind (<a href="#type_FoldingKind">FoldingKind</a>
)</b></dt><dd> | 3117 <dl><dt class="field"><b>kind: <a href="#type_FoldingKind">FoldingKind</a>
</b></dt><dd> |
3079 | 3118 |
3080 <p> | 3119 <p> |
3081 The kind of the region. | 3120 The kind of the region. |
3082 </p> | 3121 </p> |
3083 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3122 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3084 | 3123 |
3085 <p> | 3124 <p> |
3086 The offset of the region to be folded. | 3125 The offset of the region to be folded. |
3087 </p> | 3126 </p> |
3088 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3127 </dd><dt class="field"><b>length: int</b></dt><dd> |
3089 | 3128 |
3090 <p> | 3129 <p> |
3091 The length of the region to be folded. | 3130 The length of the region to be folded. |
3092 </p> | 3131 </p> |
3093 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi
sService">GeneralAnalysisService: String</a></dt><dd> | 3132 </dd></dl></dd><dt class="typeDefinition"><a name="type_GeneralAnalysi
sService">GeneralAnalysisService: String</a></dt><dd> |
3094 <p> | 3133 <p> |
3095 An enumeration of the services provided by the analysis domain that ar
e | 3134 An enumeration of the services provided by the analysis domain that ar
e |
3096 general in nature (that is, are not specific to some list of files). | 3135 general in nature (that is, are not specific to some list of files). |
3097 </p> | 3136 </p> |
3098 | 3137 |
3099 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti
on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd> | 3138 <dl><dt class="value">ANALYZED_FILES</dt></dl></dd><dt class="typeDefiniti
on"><a name="type_HighlightRegion">HighlightRegion: object</a></dt><dd> |
3100 <p> | 3139 <p> |
3101 A description of a region that could have special highlighting | 3140 A description of a region that could have special highlighting |
3102 associated with it. | 3141 associated with it. |
3103 </p> | 3142 </p> |
3104 | 3143 |
3105 <dl><dt class="field"><b>type (<a href="#type_HighlightRegionType">Highlig
htRegionType</a>)</b></dt><dd> | 3144 <dl><dt class="field"><b>type: <a href="#type_HighlightRegionType">Highlig
htRegionType</a></b></dt><dd> |
3106 | 3145 |
3107 <p> | 3146 <p> |
3108 The type of highlight associated with the region. | 3147 The type of highlight associated with the region. |
3109 </p> | 3148 </p> |
3110 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3149 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3111 | 3150 |
3112 <p> | 3151 <p> |
3113 The offset of the region to be highlighted. | 3152 The offset of the region to be highlighted. |
3114 </p> | 3153 </p> |
3115 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3154 </dd><dt class="field"><b>length: int</b></dt><dd> |
3116 | 3155 |
3117 <p> | 3156 <p> |
3118 The length of the region to be highlighted. | 3157 The length of the region to be highlighted. |
3119 </p> | 3158 </p> |
3120 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio
nType">HighlightRegionType: String</a></dt><dd> | 3159 </dd></dl></dd><dt class="typeDefinition"><a name="type_HighlightRegio
nType">HighlightRegionType: String</a></dt><dd> |
3121 <p> | 3160 <p> |
3122 An enumeration of the kinds of highlighting that can be | 3161 An enumeration of the kinds of highlighting that can be |
3123 applied to files. | 3162 applied to files. |
3124 </p> | 3163 </p> |
3125 | 3164 |
(...skipping 142 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3268 | 3307 |
3269 <p>Only for version 2 of highlight.</p> | 3308 <p>Only for version 2 of highlight.</p> |
3270 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd> | 3309 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd> |
3271 | 3310 |
3272 <p>Only for version 2 of highlight.</p> | 3311 <p>Only for version 2 of highlight.</p> |
3273 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati
on">HoverInformation: object</a></dt><dd> | 3312 </dd></dl></dd><dt class="typeDefinition"><a name="type_HoverInformati
on">HoverInformation: object</a></dt><dd> |
3274 <p> | 3313 <p> |
3275 The hover information associated with a specific location. | 3314 The hover information associated with a specific location. |
3276 </p> | 3315 </p> |
3277 | 3316 |
3278 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 3317 <dl><dt class="field"><b>offset: int</b></dt><dd> |
3279 | 3318 |
3280 <p> | 3319 <p> |
3281 The offset of the range of characters that encompasses the | 3320 The offset of the range of characters that encompasses the |
3282 cursor position and has the same hover information as the | 3321 cursor position and has the same hover information as the |
3283 cursor position. | 3322 cursor position. |
3284 </p> | 3323 </p> |
3285 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3324 </dd><dt class="field"><b>length: int</b></dt><dd> |
3286 | 3325 |
3287 <p> | 3326 <p> |
3288 The length of the range of characters that encompasses the | 3327 The length of the range of characters that encompasses the |
3289 cursor position and has the same hover information as the | 3328 cursor position and has the same hover information as the |
3290 cursor position. | 3329 cursor position. |
3291 </p> | 3330 </p> |
3292 </dd><dt class="field"><b>containingLibraryPath (<span style="color:#9
99999">optional</span> String)</b></dt><dd> | 3331 </dd><dt class="field"><b>containingLibraryPath: String<span style="co
lor:#999999"> (optional)</span></b></dt><dd> |
3293 | 3332 |
3294 <p> | 3333 <p> |
3295 The path to the defining compilation unit of the library | 3334 The path to the defining compilation unit of the library |
3296 in which the referenced element is declared. This data is | 3335 in which the referenced element is declared. This data is |
3297 omitted if there is no referenced element, or if the | 3336 omitted if there is no referenced element, or if the |
3298 element is declared inside an HTML file. | 3337 element is declared inside an HTML file. |
3299 </p> | 3338 </p> |
3300 </dd><dt class="field"><b>containingLibraryName (<span style="color:#9
99999">optional</span> String)</b></dt><dd> | 3339 </dd><dt class="field"><b>containingLibraryName: String<span style="co
lor:#999999"> (optional)</span></b></dt><dd> |
3301 | 3340 |
3302 <p> | 3341 <p> |
3303 The name of the library in which the referenced element is | 3342 The name of the library in which the referenced element is |
3304 declared. This data is omitted if there is no referenced | 3343 declared. This data is omitted if there is no referenced |
3305 element, or if the element is declared inside an HTML | 3344 element, or if the element is declared inside an HTML |
3306 file. | 3345 file. |
3307 </p> | 3346 </p> |
3308 </dd><dt class="field"><b>containingClassDescription (<span style="col
or:#999999">optional</span> String)</b></dt><dd> | 3347 </dd><dt class="field"><b>containingClassDescription: String<span styl
e="color:#999999"> (optional)</span></b></dt><dd> |
3309 | 3348 |
3310 <p> | 3349 <p> |
3311 A human-readable description of the class declaring the element | 3350 A human-readable description of the class declaring the element |
3312 being referenced. This data is omitted if there is no referenced | 3351 being referenced. This data is omitted if there is no referenced |
3313 element, or if the element is not a class member. | 3352 element, or if the element is not a class member. |
3314 </p> | 3353 </p> |
3315 </dd><dt class="field"><b>dartdoc (<span style="color:#999999">optiona
l</span> String)</b></dt><dd> | 3354 </dd><dt class="field"><b>dartdoc: String<span style="color:#999999">
(optional)</span></b></dt><dd> |
3316 | 3355 |
3317 <p> | 3356 <p> |
3318 The dartdoc associated with the referenced element. Other | 3357 The dartdoc associated with the referenced element. Other |
3319 than the removal of the comment delimiters, including | 3358 than the removal of the comment delimiters, including |
3320 leading asterisks in the case of a block comment, the | 3359 leading asterisks in the case of a block comment, the |
3321 dartdoc is unprocessed markdown. This data is omitted if | 3360 dartdoc is unprocessed markdown. This data is omitted if |
3322 there is no referenced element, or if the element has no | 3361 there is no referenced element, or if the element has no |
3323 dartdoc. | 3362 dartdoc. |
3324 </p> | 3363 </p> |
3325 </dd><dt class="field"><b>elementDescription (<span style="color:#9999
99">optional</span> String)</b></dt><dd> | 3364 </dd><dt class="field"><b>elementDescription: String<span style="color
:#999999"> (optional)</span></b></dt><dd> |
3326 | 3365 |
3327 <p> | 3366 <p> |
3328 A human-readable description of the element being | 3367 A human-readable description of the element being |
3329 referenced. This data is omitted if there is no referenced | 3368 referenced. This data is omitted if there is no referenced |
3330 element. | 3369 element. |
3331 </p> | 3370 </p> |
3332 </dd><dt class="field"><b>elementKind (<span style="color:#999999">opt
ional</span> String)</b></dt><dd> | 3371 </dd><dt class="field"><b>elementKind: String<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
3333 | 3372 |
3334 <p> | 3373 <p> |
3335 A human-readable description of the kind of element being | 3374 A human-readable description of the kind of element being |
3336 referenced (such as "class" or "function type | 3375 referenced (such as "class" or "function type |
3337 alias"). This data is omitted if there is no referenced | 3376 alias"). This data is omitted if there is no referenced |
3338 element. | 3377 element. |
3339 </p> | 3378 </p> |
3340 </dd><dt class="field"><b>isDeprecated (<span style="color:#999999">op
tional</span> bool)</b></dt><dd> | 3379 </dd><dt class="field"><b>isDeprecated: bool<span style="color:#999999
"> (optional)</span></b></dt><dd> |
3341 | 3380 |
3342 <p> | 3381 <p> |
3343 True if the referenced element is deprecated. | 3382 True if the referenced element is deprecated. |
3344 </p> | 3383 </p> |
3345 </dd><dt class="field"><b>parameter (<span style="color:#999999">optio
nal</span> String)</b></dt><dd> | 3384 </dd><dt class="field"><b>parameter: String<span style="color:#999999"
> (optional)</span></b></dt><dd> |
3346 | 3385 |
3347 <p> | 3386 <p> |
3348 A human-readable description of the parameter | 3387 A human-readable description of the parameter |
3349 corresponding to the expression being hovered over. This | 3388 corresponding to the expression being hovered over. This |
3350 data is omitted if the location is not in an argument to a | 3389 data is omitted if the location is not in an argument to a |
3351 function. | 3390 function. |
3352 </p> | 3391 </p> |
3353 </dd><dt class="field"><b>propagatedType (<span style="color:#999999">
optional</span> String)</b></dt><dd> | 3392 </dd><dt class="field"><b>propagatedType: String<span style="color:#99
9999"> (optional)</span></b></dt><dd> |
3354 | 3393 |
3355 <p> | 3394 <p> |
3356 The name of the propagated type of the expression. This | 3395 The name of the propagated type of the expression. This |
3357 data is omitted if the location does not correspond to an | 3396 data is omitted if the location does not correspond to an |
3358 expression or if there is no propagated type information. | 3397 expression or if there is no propagated type information. |
3359 </p> | 3398 </p> |
3360 </dd><dt class="field"><b>staticType (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 3399 </dd><dt class="field"><b>staticType: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
3361 | 3400 |
3362 <p> | 3401 <p> |
3363 The name of the static type of the expression. This data | 3402 The name of the static type of the expression. This data |
3364 is omitted if the location does not correspond to an | 3403 is omitted if the location does not correspond to an |
3365 expression. | 3404 expression. |
3366 </p> | 3405 </p> |
3367 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla
ss">ImplementedClass: object</a></dt><dd> | 3406 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedCla
ss">ImplementedClass: object</a></dt><dd> |
3368 <p> | 3407 <p> |
3369 A description of a class that is implemented or extended. | 3408 A description of a class that is implemented or extended. |
3370 </p> | 3409 </p> |
3371 | 3410 |
3372 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 3411 <dl><dt class="field"><b>offset: int</b></dt><dd> |
3373 | 3412 |
3374 <p> | 3413 <p> |
3375 The offset of the name of the implemented class. | 3414 The offset of the name of the implemented class. |
3376 </p> | 3415 </p> |
3377 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3416 </dd><dt class="field"><b>length: int</b></dt><dd> |
3378 | 3417 |
3379 <p> | 3418 <p> |
3380 The length of the name of the implemented class. | 3419 The length of the name of the implemented class. |
3381 </p> | 3420 </p> |
3382 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem
ber">ImplementedMember: object</a></dt><dd> | 3421 </dd></dl></dd><dt class="typeDefinition"><a name="type_ImplementedMem
ber">ImplementedMember: object</a></dt><dd> |
3383 <p> | 3422 <p> |
3384 A description of a class member that is implemented or overridden. | 3423 A description of a class member that is implemented or overridden. |
3385 </p> | 3424 </p> |
3386 | 3425 |
3387 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 3426 <dl><dt class="field"><b>offset: int</b></dt><dd> |
3388 | 3427 |
3389 <p> | 3428 <p> |
3390 The offset of the name of the implemented member. | 3429 The offset of the name of the implemented member. |
3391 </p> | 3430 </p> |
3392 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3431 </dd><dt class="field"><b>length: int</b></dt><dd> |
3393 | 3432 |
3394 <p> | 3433 <p> |
3395 The length of the name of the implemented member. | 3434 The length of the name of the implemented member. |
3396 </p> | 3435 </p> |
3397 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou
p">LinkedEditGroup: object</a></dt><dd> | 3436 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGrou
p">LinkedEditGroup: object</a></dt><dd> |
3398 <p> | 3437 <p> |
3399 A collection of positions that should be linked (edited | 3438 A collection of positions that should be linked (edited |
3400 simultaneously) for the purposes of updating code after a | 3439 simultaneously) for the purposes of updating code after a |
3401 source change. For example, if a set of edits introduced a | 3440 source change. For example, if a set of edits introduced a |
3402 new variable name, the group would contain all of the | 3441 new variable name, the group would contain all of the |
3403 positions of the variable name so that if the client wanted | 3442 positions of the variable name so that if the client wanted |
3404 to let the user edit the variable name after the operation, | 3443 to let the user edit the variable name after the operation, |
3405 all occurrences of the name could be edited simultaneously. | 3444 all occurrences of the name could be edited simultaneously. |
3406 </p> | 3445 </p> |
3407 | 3446 |
3408 <dl><dt class="field"><b>positions (List<<a href="#type_Position">Posit
ion</a>>)</b></dt><dd> | 3447 <dl><dt class="field"><b>positions: List<<a href="#type_Position">Posit
ion</a>></b></dt><dd> |
3409 | 3448 |
3410 <p> | 3449 <p> |
3411 The positions of the regions that should be edited | 3450 The positions of the regions that should be edited |
3412 simultaneously. | 3451 simultaneously. |
3413 </p> | 3452 </p> |
3414 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3453 </dd><dt class="field"><b>length: int</b></dt><dd> |
3415 | 3454 |
3416 <p> | 3455 <p> |
3417 The length of the regions that should be edited | 3456 The length of the regions that should be edited |
3418 simultaneously. | 3457 simultaneously. |
3419 </p> | 3458 </p> |
3420 </dd><dt class="field"><b>suggestions (List<<a href="#type_LinkedEd
itSuggestion">LinkedEditSuggestion</a>>)</b></dt><dd> | 3459 </dd><dt class="field"><b>suggestions: List<<a href="#type_LinkedEd
itSuggestion">LinkedEditSuggestion</a>></b></dt><dd> |
3421 | 3460 |
3422 <p> | 3461 <p> |
3423 Pre-computed suggestions for what every region might | 3462 Pre-computed suggestions for what every region might |
3424 want to be changed to. | 3463 want to be changed to. |
3425 </p> | 3464 </p> |
3426 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estion">LinkedEditSuggestion: object</a></dt><dd> | 3465 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estion">LinkedEditSuggestion: object</a></dt><dd> |
3427 <p> | 3466 <p> |
3428 A suggestion of a value that could be used to replace all of | 3467 A suggestion of a value that could be used to replace all of |
3429 the linked edit regions in a LinkedEditGroup. | 3468 the linked edit regions in a LinkedEditGroup. |
3430 </p> | 3469 </p> |
3431 | 3470 |
3432 <dl><dt class="field"><b>value (String)</b></dt><dd> | 3471 <dl><dt class="field"><b>value: String</b></dt><dd> |
3433 | 3472 |
3434 <p> | 3473 <p> |
3435 The value that could be used to replace all of the linked | 3474 The value that could be used to replace all of the linked |
3436 edit regions. | 3475 edit regions. |
3437 </p> | 3476 </p> |
3438 </dd><dt class="field"><b>kind (<a href="#type_LinkedEditSuggestionKin
d">LinkedEditSuggestionKind</a>)</b></dt><dd> | 3477 </dd><dt class="field"><b>kind: <a href="#type_LinkedEditSuggestionKin
d">LinkedEditSuggestionKind</a></b></dt><dd> |
3439 | 3478 |
3440 <p> | 3479 <p> |
3441 The kind of value being proposed. | 3480 The kind of value being proposed. |
3442 </p> | 3481 </p> |
3443 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estionKind">LinkedEditSuggestionKind: String</a></dt><dd> | 3482 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditSugg
estionKind">LinkedEditSuggestionKind: String</a></dt><dd> |
3444 <p> | 3483 <p> |
3445 An enumeration of the kind of values that can be suggested | 3484 An enumeration of the kind of values that can be suggested |
3446 for a linked edit. | 3485 for a linked edit. |
3447 </p> | 3486 </p> |
3448 | 3487 |
3449 <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class
="value">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefini
tion"><a name="type_Location">Location: object</a></dt><dd> | 3488 <dl><dt class="value">METHOD</dt><dt class="value">PARAMETER</dt><dt class
="value">TYPE</dt><dt class="value">VARIABLE</dt></dl></dd><dt class="typeDefini
tion"><a name="type_Location">Location: object</a></dt><dd> |
3450 <p> | 3489 <p> |
3451 A location (character range) within a file. | 3490 A location (character range) within a file. |
3452 </p> | 3491 </p> |
3453 | 3492 |
3454 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b><
/dt><dd> | 3493 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></
dt><dd> |
3455 | 3494 |
3456 <p> | 3495 <p> |
3457 The file containing the range. | 3496 The file containing the range. |
3458 </p> | 3497 </p> |
3459 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3498 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3460 | 3499 |
3461 <p> | 3500 <p> |
3462 The offset of the range. | 3501 The offset of the range. |
3463 </p> | 3502 </p> |
3464 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3503 </dd><dt class="field"><b>length: int</b></dt><dd> |
3465 | 3504 |
3466 <p> | 3505 <p> |
3467 The length of the range. | 3506 The length of the range. |
3468 </p> | 3507 </p> |
3469 </dd><dt class="field"><b>startLine (int)</b></dt><dd> | 3508 </dd><dt class="field"><b>startLine: int</b></dt><dd> |
3470 | 3509 |
3471 <p> | 3510 <p> |
3472 The one-based index of the line containing the first | 3511 The one-based index of the line containing the first |
3473 character of the range. | 3512 character of the range. |
3474 </p> | 3513 </p> |
3475 </dd><dt class="field"><b>startColumn (int)</b></dt><dd> | 3514 </dd><dt class="field"><b>startColumn: int</b></dt><dd> |
3476 | 3515 |
3477 <p> | 3516 <p> |
3478 The one-based index of the column containing the first | 3517 The one-based index of the column containing the first |
3479 character of the range. | 3518 character of the range. |
3480 </p> | 3519 </p> |
3481 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi
on">NavigationRegion: object</a></dt><dd> | 3520 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationRegi
on">NavigationRegion: object</a></dt><dd> |
3482 <p> | 3521 <p> |
3483 A description of a region from which the user can navigate to | 3522 A description of a region from which the user can navigate to |
3484 the declaration of an element. | 3523 the declaration of an element. |
3485 </p> | 3524 </p> |
3486 | 3525 |
3487 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 3526 <dl><dt class="field"><b>offset: int</b></dt><dd> |
3488 | 3527 |
3489 <p> | 3528 <p> |
3490 The offset of the region from which the user can navigate. | 3529 The offset of the region from which the user can navigate. |
3491 </p> | 3530 </p> |
3492 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3531 </dd><dt class="field"><b>length: int</b></dt><dd> |
3493 | 3532 |
3494 <p> | 3533 <p> |
3495 The length of the region from which the user can navigate. | 3534 The length of the region from which the user can navigate. |
3496 </p> | 3535 </p> |
3497 </dd><dt class="field"><b>targets (List<int>)</b></dt><dd> | 3536 </dd><dt class="field"><b>targets: List<int></b></dt><dd> |
3498 | 3537 |
3499 <p> | 3538 <p> |
3500 The indexes of the targets (in the enclosing navigation response) | 3539 The indexes of the targets (in the enclosing navigation response) |
3501 to which the given region is bound. By opening the target, clients | 3540 to which the given region is bound. By opening the target, clients |
3502 can implement one form of navigation. This list cannot be empty. | 3541 can implement one form of navigation. This list cannot be empty. |
3503 </p> | 3542 </p> |
3504 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg
et">NavigationTarget: object</a></dt><dd> | 3543 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg
et">NavigationTarget: object</a></dt><dd> |
3505 <p> | 3544 <p> |
3506 A description of a target to which the user can navigate. | 3545 A description of a target to which the user can navigate. |
3507 </p> | 3546 </p> |
3508 | 3547 |
3509 <dl><dt class="field"><b>kind (<a href="#type_ElementKind">ElementKind</a>
)</b></dt><dd> | 3548 <dl><dt class="field"><b>kind: <a href="#type_ElementKind">ElementKind</a>
</b></dt><dd> |
3510 | 3549 |
3511 <p> | 3550 <p> |
3512 The kind of the element. | 3551 The kind of the element. |
3513 </p> | 3552 </p> |
3514 </dd><dt class="field"><b>fileIndex (int)</b></dt><dd> | 3553 </dd><dt class="field"><b>fileIndex: int</b></dt><dd> |
3515 | 3554 |
3516 <p> | 3555 <p> |
3517 The index of the file (in the enclosing navigation response) to | 3556 The index of the file (in the enclosing navigation response) to |
3518 navigate to. | 3557 navigate to. |
3519 </p> | 3558 </p> |
3520 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3559 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3521 | 3560 |
3522 <p> | 3561 <p> |
3523 The offset of the region to which the user can navigate. | 3562 The offset of the region to which the user can navigate. |
3524 </p> | 3563 </p> |
3525 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3564 </dd><dt class="field"><b>length: int</b></dt><dd> |
3526 | 3565 |
3527 <p> | 3566 <p> |
3528 The length of the region to which the user can navigate. | 3567 The length of the region to which the user can navigate. |
3529 </p> | 3568 </p> |
3530 </dd><dt class="field"><b>startLine (int)</b></dt><dd> | 3569 </dd><dt class="field"><b>startLine: int</b></dt><dd> |
3531 | 3570 |
3532 <p> | 3571 <p> |
3533 The one-based index of the line containing the first | 3572 The one-based index of the line containing the first |
3534 character of the region. | 3573 character of the region. |
3535 </p> | 3574 </p> |
3536 </dd><dt class="field"><b>startColumn (int)</b></dt><dd> | 3575 </dd><dt class="field"><b>startColumn: int</b></dt><dd> |
3537 | 3576 |
3538 <p> | 3577 <p> |
3539 The one-based index of the column containing the first | 3578 The one-based index of the column containing the first |
3540 character of the region. | 3579 character of the region. |
3541 </p> | 3580 </p> |
3542 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O
ccurrences: object</a></dt><dd> | 3581 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O
ccurrences: object</a></dt><dd> |
3543 <p> | 3582 <p> |
3544 A description of the references to a single element within a | 3583 A description of the references to a single element within a |
3545 single file. | 3584 single file. |
3546 </p> | 3585 </p> |
3547 | 3586 |
3548 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b>
</dt><dd> | 3587 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b><
/dt><dd> |
3549 | 3588 |
3550 <p> | 3589 <p> |
3551 The element that was referenced. | 3590 The element that was referenced. |
3552 </p> | 3591 </p> |
3553 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> | 3592 </dd><dt class="field"><b>offsets: List<int></b></dt><dd> |
3554 | 3593 |
3555 <p> | 3594 <p> |
3556 The offsets of the name of the referenced element within | 3595 The offsets of the name of the referenced element within |
3557 the file. | 3596 the file. |
3558 </p> | 3597 </p> |
3559 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3598 </dd><dt class="field"><b>length: int</b></dt><dd> |
3560 | 3599 |
3561 <p> | 3600 <p> |
3562 The length of the name of the referenced element. | 3601 The length of the name of the referenced element. |
3563 </p> | 3602 </p> |
3564 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli
ne: object</a></dt><dd> | 3603 </dd></dl></dd><dt class="typeDefinition"><a name="type_Outline">Outli
ne: object</a></dt><dd> |
3565 <p> | 3604 <p> |
3566 An node in the outline structure of a file. | 3605 An node in the outline structure of a file. |
3567 </p> | 3606 </p> |
3568 | 3607 |
3569 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b>
</dt><dd> | 3608 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b><
/dt><dd> |
3570 | 3609 |
3571 <p> | 3610 <p> |
3572 A description of the element represented by this node. | 3611 A description of the element represented by this node. |
3573 </p> | 3612 </p> |
3574 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3613 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3575 | 3614 |
3576 <p> | 3615 <p> |
3577 The offset of the first character of the element. This is | 3616 The offset of the first character of the element. This is |
3578 different than the offset in the Element, which if the | 3617 different than the offset in the Element, which if the |
3579 offset of the name of the element. It can be used, for | 3618 offset of the name of the element. It can be used, for |
3580 example, to map locations in the file back to an outline. | 3619 example, to map locations in the file back to an outline. |
3581 </p> | 3620 </p> |
3582 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3621 </dd><dt class="field"><b>length: int</b></dt><dd> |
3583 | 3622 |
3584 <p> | 3623 <p> |
3585 The length of the element. | 3624 The length of the element. |
3586 </p> | 3625 </p> |
3587 </dd><dt class="field"><b>children (<span style="color:#999999">option
al</span> List<<a href="#type_Outline">Outline</a>>)</b></dt><dd> | 3626 </dd><dt class="field"><b>children: List<<a href="#type_Outline">Ou
tline</a>><span style="color:#999999"> (optional)</span></b></dt><dd> |
3588 | 3627 |
3589 <p> | 3628 <p> |
3590 The children of the node. The field will be omitted if the | 3629 The children of the node. The field will be omitted if the |
3591 node has no children. | 3630 node has no children. |
3592 </p> | 3631 </p> |
3593 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over
ride: object</a></dt><dd> | 3632 </dd></dl></dd><dt class="typeDefinition"><a name="type_Override">Over
ride: object</a></dt><dd> |
3594 <p> | 3633 <p> |
3595 A description of a member that overrides an inherited member. | 3634 A description of a member that overrides an inherited member. |
3596 </p> | 3635 </p> |
3597 | 3636 |
3598 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 3637 <dl><dt class="field"><b>offset: int</b></dt><dd> |
3599 | 3638 |
3600 <p> | 3639 <p> |
3601 The offset of the name of the overriding member. | 3640 The offset of the name of the overriding member. |
3602 </p> | 3641 </p> |
3603 </dd><dt class="field"><b>length (int)</b></dt><dd> | 3642 </dd><dt class="field"><b>length: int</b></dt><dd> |
3604 | 3643 |
3605 <p> | 3644 <p> |
3606 The length of the name of the overriding member. | 3645 The length of the name of the overriding member. |
3607 </p> | 3646 </p> |
3608 </dd><dt class="field"><b>superclassMember (<span style="color:#999999
">optional</span> <a href="#type_OverriddenMember">OverriddenMember</a>)</b></dt
><dd> | 3647 </dd><dt class="field"><b>superclassMember: <a href="#type_OverriddenM
ember">OverriddenMember</a><span style="color:#999999"> (optional)</span></b></d
t><dd> |
3609 | 3648 |
3610 <p> | 3649 <p> |
3611 The member inherited from a superclass that is overridden | 3650 The member inherited from a superclass that is overridden |
3612 by the overriding member. The field is omitted if there is | 3651 by the overriding member. The field is omitted if there is |
3613 no superclass member, in which case there must be at least | 3652 no superclass member, in which case there must be at least |
3614 one interface member. | 3653 one interface member. |
3615 </p> | 3654 </p> |
3616 </dd><dt class="field"><b>interfaceMembers (<span style="color:#999999
">optional</span> List<<a href="#type_OverriddenMember">OverriddenMember</a>&
gt;)</b></dt><dd> | 3655 </dd><dt class="field"><b>interfaceMembers: List<<a href="#type_Ove
rriddenMember">OverriddenMember</a>><span style="color:#999999"> (optional)</
span></b></dt><dd> |
3617 | 3656 |
3618 <p> | 3657 <p> |
3619 The members inherited from interfaces that are overridden | 3658 The members inherited from interfaces that are overridden |
3620 by the overriding member. The field is omitted if there | 3659 by the overriding member. The field is omitted if there |
3621 are no interface members, in which case there must be a | 3660 are no interface members, in which case there must be a |
3622 superclass member. | 3661 superclass member. |
3623 </p> | 3662 </p> |
3624 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb
er">OverriddenMember: object</a></dt><dd> | 3663 </dd></dl></dd><dt class="typeDefinition"><a name="type_OverriddenMemb
er">OverriddenMember: object</a></dt><dd> |
3625 <p> | 3664 <p> |
3626 A description of a member that is being overridden. | 3665 A description of a member that is being overridden. |
3627 </p> | 3666 </p> |
3628 | 3667 |
3629 <dl><dt class="field"><b>element (<a href="#type_Element">Element</a>)</b>
</dt><dd> | 3668 <dl><dt class="field"><b>element: <a href="#type_Element">Element</a></b><
/dt><dd> |
3630 | 3669 |
3631 <p> | 3670 <p> |
3632 The element that is being overridden. | 3671 The element that is being overridden. |
3633 </p> | 3672 </p> |
3634 </dd><dt class="field"><b>className (String)</b></dt><dd> | 3673 </dd><dt class="field"><b>className: String</b></dt><dd> |
3635 | 3674 |
3636 <p> | 3675 <p> |
3637 The name of the class in which the member is defined. | 3676 The name of the class in which the member is defined. |
3638 </p> | 3677 </p> |
3639 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi
tion: object</a></dt><dd> | 3678 </dd></dl></dd><dt class="typeDefinition"><a name="type_Position">Posi
tion: object</a></dt><dd> |
3640 <p> | 3679 <p> |
3641 A position within a file. | 3680 A position within a file. |
3642 </p> | 3681 </p> |
3643 | 3682 |
3644 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b><
/dt><dd> | 3683 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></
dt><dd> |
3645 | 3684 |
3646 <p> | 3685 <p> |
3647 The file containing the position. | 3686 The file containing the position. |
3648 </p> | 3687 </p> |
3649 </dd><dt class="field"><b>offset (int)</b></dt><dd> | 3688 </dd><dt class="field"><b>offset: int</b></dt><dd> |
3650 | 3689 |
3651 <p> | 3690 <p> |
3652 The offset of the position. | 3691 The offset of the position. |
3653 </p> | 3692 </p> |
3654 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub
Status: object</a></dt><dd> | 3693 </dd></dl></dd><dt class="typeDefinition"><a name="type_PubStatus">Pub
Status: object</a></dt><dd> |
3655 <p> | 3694 <p> |
3656 An indication of the current state of pub execution. | 3695 An indication of the current state of pub execution. |
3657 </p> | 3696 </p> |
3658 | 3697 |
3659 <dl><dt class="field"><b>isListingPackageDirs (bool)</b></dt><dd> | 3698 <dl><dt class="field"><b>isListingPackageDirs: bool</b></dt><dd> |
3660 | 3699 |
3661 <p> | 3700 <p> |
3662 True if the server is currently running pub to produce a list of | 3701 True if the server is currently running pub to produce a list of |
3663 package directories. | 3702 package directories. |
3664 </p> | 3703 </p> |
3665 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin
d">RefactoringKind: String</a></dt><dd> | 3704 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringKin
d">RefactoringKind: String</a></dt><dd> |
3666 <p> | 3705 <p> |
3667 An enumeration of the kinds of refactorings that can be | 3706 An enumeration of the kinds of refactorings that can be |
3668 created. | 3707 created. |
3669 </p> | 3708 </p> |
3670 | 3709 |
3671 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE
RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="
value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class=
"value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENA
ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><
a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a><
/dt><dd> | 3710 <dl><dt class="value">CONVERT_GETTER_TO_METHOD</dt><dt class="value">CONVE
RT_METHOD_TO_GETTER</dt><dt class="value">EXTRACT_LOCAL_VARIABLE</dt><dt class="
value">EXTRACT_METHOD</dt><dt class="value">INLINE_LOCAL_VARIABLE</dt><dt class=
"value">INLINE_METHOD</dt><dt class="value">MOVE_FILE</dt><dt class="value">RENA
ME</dt><dt class="value">SORT_MEMBERS</dt></dl></dd><dt class="typeDefinition"><
a name="type_RefactoringMethodParameter">RefactoringMethodParameter: object</a><
/dt><dd> |
3672 <p> | 3711 <p> |
3673 A description of a parameter in a method refactoring. | 3712 A description of a parameter in a method refactoring. |
3674 </p> | 3713 </p> |
3675 | 3714 |
3676 <dl><dt class="field"><b>id (<span style="color:#999999">optional</span> S
tring)</b></dt><dd> | 3715 <dl><dt class="field"><b>id: String<span style="color:#999999"> (optional)
</span></b></dt><dd> |
3677 | 3716 |
3678 <p> | 3717 <p> |
3679 The unique identifier of the parameter. | 3718 The unique identifier of the parameter. |
3680 Clients may omit this field for the parameters they want to add. | 3719 Clients may omit this field for the parameters they want to add. |
3681 </p> | 3720 </p> |
3682 </dd><dt class="field"><b>kind (<a href="#type_RefactoringMethodParame
terKind">RefactoringMethodParameterKind</a>)</b></dt><dd> | 3721 </dd><dt class="field"><b>kind: <a href="#type_RefactoringMethodParame
terKind">RefactoringMethodParameterKind</a></b></dt><dd> |
3683 | 3722 |
3684 <p> | 3723 <p> |
3685 The kind of the parameter. | 3724 The kind of the parameter. |
3686 </p> | 3725 </p> |
3687 </dd><dt class="field"><b>type (String)</b></dt><dd> | 3726 </dd><dt class="field"><b>type: String</b></dt><dd> |
3688 | 3727 |
3689 <p> | 3728 <p> |
3690 The type that should be given to the parameter, or the return type | 3729 The type that should be given to the parameter, or the return type |
3691 of the parameter's function type. | 3730 of the parameter's function type. |
3692 </p> | 3731 </p> |
3693 </dd><dt class="field"><b>name (String)</b></dt><dd> | 3732 </dd><dt class="field"><b>name: String</b></dt><dd> |
3694 | 3733 |
3695 <p> | 3734 <p> |
3696 The name that should be given to the parameter. | 3735 The name that should be given to the parameter. |
3697 </p> | 3736 </p> |
3698 </dd><dt class="field"><b>parameters (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 3737 </dd><dt class="field"><b>parameters: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
3699 | 3738 |
3700 <p> | 3739 <p> |
3701 The parameter list of the parameter's function type. | 3740 The parameter list of the parameter's function type. |
3702 If the parameter is not of a function type, this field will | 3741 If the parameter is not of a function type, this field will |
3703 not be defined. If the function type has zero parameters, this | 3742 not be defined. If the function type has zero parameters, this |
3704 field will have a value of "()". | 3743 field will have a value of "()". |
3705 </p> | 3744 </p> |
3706 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee
dback">RefactoringFeedback: object</a></dt><dd> | 3745 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringFee
dback">RefactoringFeedback: object</a></dt><dd> |
3707 <p> | 3746 <p> |
3708 An abstract superclass of all refactoring feedbacks. | 3747 An abstract superclass of all refactoring feedbacks. |
3709 </p> | 3748 </p> |
3710 | 3749 |
3711 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions"
>RefactoringOptions: object</a></dt><dd> | 3750 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringOptions"
>RefactoringOptions: object</a></dt><dd> |
3712 <p> | 3751 <p> |
3713 An abstract superclass of all refactoring options. | 3752 An abstract superclass of all refactoring options. |
3714 </p> | 3753 </p> |
3715 | 3754 |
3716 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa
rameterKind">RefactoringMethodParameterKind: String</a></dt><dd> | 3755 <dl></dl></dd><dt class="typeDefinition"><a name="type_RefactoringMethodPa
rameterKind">RefactoringMethodParameterKind: String</a></dt><dd> |
3717 <p> | 3756 <p> |
3718 An enumeration of the kinds of parameters. | 3757 An enumeration of the kinds of parameters. |
3719 </p> | 3758 </p> |
3720 | 3759 |
3721 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl
ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto
ringProblem">RefactoringProblem: object</a></dt><dd> | 3760 <dl><dt class="value">REQUIRED</dt><dt class="value">POSITIONAL</dt><dt cl
ass="value">NAMED</dt></dl></dd><dt class="typeDefinition"><a name="type_Refacto
ringProblem">RefactoringProblem: object</a></dt><dd> |
3722 <p> | 3761 <p> |
3723 A description of a problem related to a refactoring. | 3762 A description of a problem related to a refactoring. |
3724 </p> | 3763 </p> |
3725 | 3764 |
3726 <dl><dt class="field"><b>severity (<a href="#type_RefactoringProblemSeveri
ty">RefactoringProblemSeverity</a>)</b></dt><dd> | 3765 <dl><dt class="field"><b>severity: <a href="#type_RefactoringProblemSeveri
ty">RefactoringProblemSeverity</a></b></dt><dd> |
3727 | 3766 |
3728 <p> | 3767 <p> |
3729 The severity of the problem being represented. | 3768 The severity of the problem being represented. |
3730 </p> | 3769 </p> |
3731 </dd><dt class="field"><b>message (String)</b></dt><dd> | 3770 </dd><dt class="field"><b>message: String</b></dt><dd> |
3732 | 3771 |
3733 <p> | 3772 <p> |
3734 A human-readable description of the problem being | 3773 A human-readable description of the problem being |
3735 represented. | 3774 represented. |
3736 </p> | 3775 </p> |
3737 </dd><dt class="field"><b>location (<span style="color:#999999">option
al</span> <a href="#type_Location">Location</a>)</b></dt><dd> | 3776 </dd><dt class="field"><b>location: <a href="#type_Location">Location<
/a><span style="color:#999999"> (optional)</span></b></dt><dd> |
3738 | 3777 |
3739 <p> | 3778 <p> |
3740 The location of the problem being represented. | 3779 The location of the problem being represented. |
3741 This field is omitted unless there is a specific location | 3780 This field is omitted unless there is a specific location |
3742 associated with the problem (such as a location where an element | 3781 associated with the problem (such as a location where an element |
3743 being renamed will be shadowed). | 3782 being renamed will be shadowed). |
3744 </p> | 3783 </p> |
3745 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro
blemSeverity">RefactoringProblemSeverity: String</a></dt><dd> | 3784 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro
blemSeverity">RefactoringProblemSeverity: String</a></dt><dd> |
3746 <p> | 3785 <p> |
3747 An enumeration of the severities of problems that can be | 3786 An enumeration of the severities of problems that can be |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3788 If this directive is used on a file that doesn't currently | 3827 If this directive is used on a file that doesn't currently |
3789 have a content overlay, it has no effect. | 3828 have a content overlay, it has no effect. |
3790 </p> | 3829 </p> |
3791 | 3830 |
3792 <dl><dt class="field"><b>type = "remove"</b></dt><dd></dd></dl></dd><dt cl
ass="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><d
d> | 3831 <dl><dt class="field"><b>type = "remove"</b></dt><dd></dd></dl></dd><dt cl
ass="typeDefinition"><a name="type_RequestError">RequestError: object</a></dt><d
d> |
3793 <p> | 3832 <p> |
3794 An indication of a problem with the execution of the server, | 3833 An indication of a problem with the execution of the server, |
3795 typically in response to a request. | 3834 typically in response to a request. |
3796 </p> | 3835 </p> |
3797 | 3836 |
3798 <dl><dt class="field"><b>code (<a href="#type_RequestErrorCode">RequestErr
orCode</a>)</b></dt><dd> | 3837 <dl><dt class="field"><b>code: <a href="#type_RequestErrorCode">RequestErr
orCode</a></b></dt><dd> |
3799 | 3838 |
3800 <p> | 3839 <p> |
3801 A code that uniquely identifies the error that occurred. | 3840 A code that uniquely identifies the error that occurred. |
3802 </p> | 3841 </p> |
3803 </dd><dt class="field"><b>message (String)</b></dt><dd> | 3842 </dd><dt class="field"><b>message: String</b></dt><dd> |
3804 | 3843 |
3805 <p> | 3844 <p> |
3806 A short description of the error. | 3845 A short description of the error. |
3807 </p> | 3846 </p> |
3808 </dd><dt class="field"><b>stackTrace (<span style="color:#999999">opti
onal</span> String)</b></dt><dd> | 3847 </dd><dt class="field"><b>stackTrace: String<span style="color:#999999
"> (optional)</span></b></dt><dd> |
3809 | 3848 |
3810 <p> | 3849 <p> |
3811 The stack trace associated with processing the request, | 3850 The stack trace associated with processing the request, |
3812 used for debugging the server. | 3851 used for debugging the server. |
3813 </p> | 3852 </p> |
3814 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo
de">RequestErrorCode: String</a></dt><dd> | 3853 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo
de">RequestErrorCode: String</a></dt><dd> |
3815 <p> | 3854 <p> |
3816 An enumeration of the types of errors that can occur in the | 3855 An enumeration of the types of errors that can occur in the |
3817 execution of the server. | 3856 execution of the server. |
3818 </p> | 3857 </p> |
(...skipping 172 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3991 | 4030 |
3992 <p> | 4031 <p> |
3993 An identifier used to associate search results with a search | 4032 An identifier used to associate search results with a search |
3994 request. | 4033 request. |
3995 </p> | 4034 </p> |
3996 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult:
object</a></dt><dd> | 4035 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult:
object</a></dt><dd> |
3997 <p> | 4036 <p> |
3998 A single result from a search request. | 4037 A single result from a search request. |
3999 </p> | 4038 </p> |
4000 | 4039 |
4001 <dl><dt class="field"><b>location (<a href="#type_Location">Location</a>)<
/b></dt><dd> | 4040 <dl><dt class="field"><b>location: <a href="#type_Location">Location</a></
b></dt><dd> |
4002 | 4041 |
4003 <p> | 4042 <p> |
4004 The location of the code that matched the search criteria. | 4043 The location of the code that matched the search criteria. |
4005 </p> | 4044 </p> |
4006 </dd><dt class="field"><b>kind (<a href="#type_SearchResultKind">Searc
hResultKind</a>)</b></dt><dd> | 4045 </dd><dt class="field"><b>kind: <a href="#type_SearchResultKind">Searc
hResultKind</a></b></dt><dd> |
4007 | 4046 |
4008 <p> | 4047 <p> |
4009 The kind of element that was found or the kind of | 4048 The kind of element that was found or the kind of |
4010 reference that was found. | 4049 reference that was found. |
4011 </p> | 4050 </p> |
4012 </dd><dt class="field"><b>isPotential (bool)</b></dt><dd> | 4051 </dd><dt class="field"><b>isPotential: bool</b></dt><dd> |
4013 | 4052 |
4014 <p> | 4053 <p> |
4015 True if the result is a potential match but cannot be | 4054 True if the result is a potential match but cannot be |
4016 confirmed to be a match. For example, if all references to | 4055 confirmed to be a match. For example, if all references to |
4017 a method m defined in some class were requested, and a | 4056 a method m defined in some class were requested, and a |
4018 reference to a method m from an unknown class were found, | 4057 reference to a method m from an unknown class were found, |
4019 it would be marked as being a potential match. | 4058 it would be marked as being a potential match. |
4020 </p> | 4059 </p> |
4021 </dd><dt class="field"><b>path (List<<a href="#type_Element">Elemen
t</a>>)</b></dt><dd> | 4060 </dd><dt class="field"><b>path: List<<a href="#type_Element">Elemen
t</a>></b></dt><dd> |
4022 | 4061 |
4023 <p> | 4062 <p> |
4024 The elements that contain the result, starting with the | 4063 The elements that contain the result, starting with the |
4025 most immediately enclosing ancestor and ending with the | 4064 most immediately enclosing ancestor and ending with the |
4026 library. | 4065 library. |
4027 </p> | 4066 </p> |
4028 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi
nd">SearchResultKind: String</a></dt><dd> | 4067 </dd></dl></dd><dt class="typeDefinition"><a name="type_SearchResultKi
nd">SearchResultKind: String</a></dt><dd> |
4029 <p> | 4068 <p> |
4030 An enumeration of the kinds of search results returned by the | 4069 An enumeration of the kinds of search results returned by the |
4031 search domain. | 4070 search domain. |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4070 <p> | 4109 <p> |
4071 An enumeration of the services provided by the server domain. | 4110 An enumeration of the services provided by the server domain. |
4072 </p> | 4111 </p> |
4073 | 4112 |
4074 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n
ame="type_SourceChange">SourceChange: object</a></dt><dd> | 4113 <dl><dt class="value">STATUS</dt></dl></dd><dt class="typeDefinition"><a n
ame="type_SourceChange">SourceChange: object</a></dt><dd> |
4075 <p> | 4114 <p> |
4076 A description of a set of edits that implement a single | 4115 A description of a set of edits that implement a single |
4077 conceptual change. | 4116 conceptual change. |
4078 </p> | 4117 </p> |
4079 | 4118 |
4080 <dl><dt class="field"><b>message (String)</b></dt><dd> | 4119 <dl><dt class="field"><b>message: String</b></dt><dd> |
4081 | 4120 |
4082 <p> | 4121 <p> |
4083 A human-readable description of the change to be applied. | 4122 A human-readable description of the change to be applied. |
4084 </p> | 4123 </p> |
4085 </dd><dt class="field"><b>edits (List<<a href="#type_SourceFileEdit
">SourceFileEdit</a>>)</b></dt><dd> | 4124 </dd><dt class="field"><b>edits: List<<a href="#type_SourceFileEdit
">SourceFileEdit</a>></b></dt><dd> |
4086 | 4125 |
4087 <p> | 4126 <p> |
4088 A list of the edits used to effect the change, grouped by | 4127 A list of the edits used to effect the change, grouped by |
4089 file. | 4128 file. |
4090 </p> | 4129 </p> |
4091 </dd><dt class="field"><b>linkedEditGroups (List<<a href="#type_Lin
kedEditGroup">LinkedEditGroup</a>>)</b></dt><dd> | 4130 </dd><dt class="field"><b>linkedEditGroups: List<<a href="#type_Lin
kedEditGroup">LinkedEditGroup</a>></b></dt><dd> |
4092 | 4131 |
4093 <p> | 4132 <p> |
4094 A list of the linked editing groups used to customize | 4133 A list of the linked editing groups used to customize |
4095 the changes that were made. | 4134 the changes that were made. |
4096 </p> | 4135 </p> |
4097 </dd><dt class="field"><b>selection (<span style="color:#999999">optio
nal</span> <a href="#type_Position">Position</a>)</b></dt><dd> | 4136 </dd><dt class="field"><b>selection: <a href="#type_Position">Position
</a><span style="color:#999999"> (optional)</span></b></dt><dd> |
4098 | 4137 |
4099 <p> | 4138 <p> |
4100 The position that should be selected after the edits | 4139 The position that should be selected after the edits |
4101 have been applied. | 4140 have been applied. |
4102 </p> | 4141 </p> |
4103 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So
urceEdit: object</a></dt><dd> | 4142 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceEdit">So
urceEdit: object</a></dt><dd> |
4104 <p> | 4143 <p> |
4105 A description of a single change to a single file. | 4144 A description of a single change to a single file. |
4106 </p> | 4145 </p> |
4107 | 4146 |
4108 <dl><dt class="field"><b>offset (int)</b></dt><dd> | 4147 <dl><dt class="field"><b>offset: int</b></dt><dd> |
4109 | 4148 |
4110 <p> | 4149 <p> |
4111 The offset of the region to be modified. | 4150 The offset of the region to be modified. |
4112 </p> | 4151 </p> |
4113 </dd><dt class="field"><b>length (int)</b></dt><dd> | 4152 </dd><dt class="field"><b>length: int</b></dt><dd> |
4114 | 4153 |
4115 <p> | 4154 <p> |
4116 The length of the region to be modified. | 4155 The length of the region to be modified. |
4117 </p> | 4156 </p> |
4118 </dd><dt class="field"><b>replacement (String)</b></dt><dd> | 4157 </dd><dt class="field"><b>replacement: String</b></dt><dd> |
4119 | 4158 |
4120 <p> | 4159 <p> |
4121 The code that is to replace the specified region in the | 4160 The code that is to replace the specified region in the |
4122 original code. | 4161 original code. |
4123 </p> | 4162 </p> |
4124 </dd><dt class="field"><b>id (<span style="color:#999999">optional</sp
an> String)</b></dt><dd> | 4163 </dd><dt class="field"><b>id: String<span style="color:#999999"> (opti
onal)</span></b></dt><dd> |
4125 | 4164 |
4126 <p> | 4165 <p> |
4127 An identifier that uniquely identifies this source edit from other | 4166 An identifier that uniquely identifies this source edit from other |
4128 edits in the same response. This field is omitted unless a | 4167 edits in the same response. This field is omitted unless a |
4129 containing structure needs to be able to identify the edit for | 4168 containing structure needs to be able to identify the edit for |
4130 some reason. | 4169 some reason. |
4131 </p> | 4170 </p> |
4132 <p> | 4171 <p> |
4133 For example, some refactoring operations can produce edits that | 4172 For example, some refactoring operations can produce edits that |
4134 might not be appropriate (referred to as potential edits). Such | 4173 might not be appropriate (referred to as potential edits). Such |
4135 edits will have an id so that they can be referenced. Edits in | 4174 edits will have an id so that they can be referenced. Edits in |
4136 the same response that do not need to be referenced will not have | 4175 the same response that do not need to be referenced will not have |
4137 an id. | 4176 an id. |
4138 </p> | 4177 </p> |
4139 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit
">SourceFileEdit: object</a></dt><dd> | 4178 </dd></dl></dd><dt class="typeDefinition"><a name="type_SourceFileEdit
">SourceFileEdit: object</a></dt><dd> |
4140 <p> | 4179 <p> |
4141 A description of a set of changes to a single file. | 4180 A description of a set of changes to a single file. |
4142 </p> | 4181 </p> |
4143 | 4182 |
4144 <dl><dt class="field"><b>file (<a href="#type_FilePath">FilePath</a>)</b><
/dt><dd> | 4183 <dl><dt class="field"><b>file: <a href="#type_FilePath">FilePath</a></b></
dt><dd> |
4145 | 4184 |
4146 <p> | 4185 <p> |
4147 The file containing the code to be modified. | 4186 The file containing the code to be modified. |
4148 </p> | 4187 </p> |
4149 </dd><dt class="field"><b>fileStamp (long)</b></dt><dd> | 4188 </dd><dt class="field"><b>fileStamp: long</b></dt><dd> |
4150 | 4189 |
4151 <p> | 4190 <p> |
4152 The modification stamp of the file at the moment when the change | 4191 The modification stamp of the file at the moment when the change |
4153 was created, in milliseconds since the "Unix epoch". Will be -1 if | 4192 was created, in milliseconds since the "Unix epoch". Will be -1 if |
4154 the file did not exist and should be created. The client may use | 4193 the file did not exist and should be created. The client may use |
4155 this field to make sure that the file was not changed since then, | 4194 this field to make sure that the file was not changed since then, |
4156 so it is safe to apply the change. | 4195 so it is safe to apply the change. |
4157 </p> | 4196 </p> |
4158 </dd><dt class="field"><b>edits (List<<a href="#type_SourceEdit">So
urceEdit</a>>)</b></dt><dd> | 4197 </dd><dt class="field"><b>edits: List<<a href="#type_SourceEdit">So
urceEdit</a>></b></dt><dd> |
4159 | 4198 |
4160 <p> | 4199 <p> |
4161 A list of the edits used to effect the change. | 4200 A list of the edits used to effect the change. |
4162 </p> | 4201 </p> |
4163 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI
tem">TypeHierarchyItem: object</a></dt><dd> | 4202 </dd></dl></dd><dt class="typeDefinition"><a name="type_TypeHierarchyI
tem">TypeHierarchyItem: object</a></dt><dd> |
4164 <p> | 4203 <p> |
4165 A representation of a class in a type hierarchy. | 4204 A representation of a class in a type hierarchy. |
4166 </p> | 4205 </p> |
4167 | 4206 |
4168 <dl><dt class="field"><b>classElement (<a href="#type_Element">Element</a>
)</b></dt><dd> | 4207 <dl><dt class="field"><b>classElement: <a href="#type_Element">Element</a>
</b></dt><dd> |
4169 | 4208 |
4170 <p> | 4209 <p> |
4171 The class element represented by this item. | 4210 The class element represented by this item. |
4172 </p> | 4211 </p> |
4173 </dd><dt class="field"><b>displayName (<span style="color:#999999">opt
ional</span> String)</b></dt><dd> | 4212 </dd><dt class="field"><b>displayName: String<span style="color:#99999
9"> (optional)</span></b></dt><dd> |
4174 | 4213 |
4175 <p> | 4214 <p> |
4176 The name to be displayed for the class. This field will be | 4215 The name to be displayed for the class. This field will be |
4177 omitted if the display name is the same as the name of the | 4216 omitted if the display name is the same as the name of the |
4178 element. The display name is different if there is | 4217 element. The display name is different if there is |
4179 additional type information to be displayed, such as type | 4218 additional type information to be displayed, such as type |
4180 arguments. | 4219 arguments. |
4181 </p> | 4220 </p> |
4182 </dd><dt class="field"><b>memberElement (<span style="color:#999999">o
ptional</span> <a href="#type_Element">Element</a>)</b></dt><dd> | 4221 </dd><dt class="field"><b>memberElement: <a href="#type_Element">Eleme
nt</a><span style="color:#999999"> (optional)</span></b></dt><dd> |
4183 | 4222 |
4184 <p> | 4223 <p> |
4185 The member in the class corresponding to the member on | 4224 The member in the class corresponding to the member on |
4186 which the hierarchy was requested. This field will be | 4225 which the hierarchy was requested. This field will be |
4187 omitted if the hierarchy was not requested for a member or | 4226 omitted if the hierarchy was not requested for a member or |
4188 if the class does not have a corresponding member. | 4227 if the class does not have a corresponding member. |
4189 </p> | 4228 </p> |
4190 </dd><dt class="field"><b>superclass (<span style="color:#999999">opti
onal</span> int)</b></dt><dd> | 4229 </dd><dt class="field"><b>superclass: int<span style="color:#999999">
(optional)</span></b></dt><dd> |
4191 | 4230 |
4192 <p> | 4231 <p> |
4193 The index of the item representing the superclass of | 4232 The index of the item representing the superclass of |
4194 this class. This field will be omitted if this item | 4233 this class. This field will be omitted if this item |
4195 represents the class Object. | 4234 represents the class Object. |
4196 </p> | 4235 </p> |
4197 </dd><dt class="field"><b>interfaces (List<int>)</b></dt><dd> | 4236 </dd><dt class="field"><b>interfaces: List<int></b></dt><dd> |
4198 | 4237 |
4199 <p> | 4238 <p> |
4200 The indexes of the items representing the interfaces | 4239 The indexes of the items representing the interfaces |
4201 implemented by this class. The list will be empty if | 4240 implemented by this class. The list will be empty if |
4202 there are no implemented interfaces. | 4241 there are no implemented interfaces. |
4203 </p> | 4242 </p> |
4204 </dd><dt class="field"><b>mixins (List<int>)</b></dt><dd> | 4243 </dd><dt class="field"><b>mixins: List<int></b></dt><dd> |
4205 | 4244 |
4206 <p> | 4245 <p> |
4207 The indexes of the items representing the mixins | 4246 The indexes of the items representing the mixins |
4208 referenced by this class. The list will be empty if | 4247 referenced by this class. The list will be empty if |
4209 there are no classes mixed in to this class. | 4248 there are no classes mixed in to this class. |
4210 </p> | 4249 </p> |
4211 </dd><dt class="field"><b>subclasses (List<int>)</b></dt><dd> | 4250 </dd><dt class="field"><b>subclasses: List<int></b></dt><dd> |
4212 | 4251 |
4213 <p> | 4252 <p> |
4214 The indexes of the items representing the subtypes of | 4253 The indexes of the items representing the subtypes of |
4215 this class. The list will be empty if there are no | 4254 this class. The list will be empty if there are no |
4216 subtypes or if this item represents a supertype of the | 4255 subtypes or if this item represents a supertype of the |
4217 pivot type. | 4256 pivot type. |
4218 </p> | 4257 </p> |
4219 </dd></dl></dd></dl> | 4258 </dd></dl></dd></dl> |
4220 | 4259 |
4221 <h2><a name="refactorings">Refactorings</a></h2> | 4260 <h2><a name="refactorings">Refactorings</a></h2> |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4258 <p> | 4297 <p> |
4259 Create a local variable initialized by the expression that covers | 4298 Create a local variable initialized by the expression that covers |
4260 the specified selection. | 4299 the specified selection. |
4261 </p> | 4300 </p> |
4262 <p> | 4301 <p> |
4263 It is an error if the selection range is not covered by a | 4302 It is an error if the selection range is not covered by a |
4264 complete expression. | 4303 complete expression. |
4265 </p> | 4304 </p> |
4266 | 4305 |
4267 | 4306 |
4268 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets (<spa
n style="color:#999999">optional</span> List<int>)</b></dt><dd> | 4307 <h4>Feedback:</h4><dl><dt class="field"><b>coveringExpressionOffsets: List
<int><span style="color:#999999"> (optional)</span></b></dt><dd> |
4269 | 4308 |
4270 <p> | 4309 <p> |
4271 The offsets of the expressions that cover the specified | 4310 The offsets of the expressions that cover the specified |
4272 selection, from the down most to the up most. | 4311 selection, from the down most to the up most. |
4273 </p> | 4312 </p> |
4274 </dd><dt class="field"><b>coveringExpressionLengths (<span style="colo
r:#999999">optional</span> List<int>)</b></dt><dd> | 4313 </dd><dt class="field"><b>coveringExpressionLengths: List<int><s
pan style="color:#999999"> (optional)</span></b></dt><dd> |
4275 | 4314 |
4276 <p> | 4315 <p> |
4277 The lengths of the expressions that cover the specified | 4316 The lengths of the expressions that cover the specified |
4278 selection, from the down most to the up most. | 4317 selection, from the down most to the up most. |
4279 </p> | 4318 </p> |
4280 </dd><dt class="field"><b>names (List<String>)</b></dt><dd> | 4319 </dd><dt class="field"><b>names: List<String></b></dt><dd> |
4281 | 4320 |
4282 <p> | 4321 <p> |
4283 The proposed names for the local variable. | 4322 The proposed names for the local variable. |
4284 </p> | 4323 </p> |
4285 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> | 4324 </dd><dt class="field"><b>offsets: List<int></b></dt><dd> |
4286 | 4325 |
4287 <p> | 4326 <p> |
4288 The offsets of the expressions that would be replaced by | 4327 The offsets of the expressions that would be replaced by |
4289 a reference to the variable. | 4328 a reference to the variable. |
4290 </p> | 4329 </p> |
4291 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd> | 4330 </dd><dt class="field"><b>lengths: List<int></b></dt><dd> |
4292 | 4331 |
4293 <p> | 4332 <p> |
4294 The lengths of the expressions that would be replaced by | 4333 The lengths of the expressions that would be replaced by |
4295 a reference to the variable. The lengths correspond to | 4334 a reference to the variable. The lengths correspond to |
4296 the offsets. In other words, for a given expression, if | 4335 the offsets. In other words, for a given expression, if |
4297 the offset of that expression is offsets[i], then the | 4336 the offset of that expression is offsets[i], then the |
4298 length of that expression is lengths[i]. | 4337 length of that expression is lengths[i]. |
4299 </p> | 4338 </p> |
4300 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name (String)</b><
/dt><dd> | 4339 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>name: String</b></
dt><dd> |
4301 | 4340 |
4302 <p> | 4341 <p> |
4303 The name that the local variable should be given. | 4342 The name that the local variable should be given. |
4304 </p> | 4343 </p> |
4305 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> | 4344 </dd><dt class="field"><b>extractAll: bool</b></dt><dd> |
4306 | 4345 |
4307 <p> | 4346 <p> |
4308 True if all occurrences of the expression within the | 4347 True if all occurrences of the expression within the |
4309 scope in which the variable will be defined should be | 4348 scope in which the variable will be defined should be |
4310 replaced by a reference to the local variable. The | 4349 replaced by a reference to the local variable. The |
4311 expression used to initiate the refactoring will always | 4350 expression used to initiate the refactoring will always |
4312 be replaced. | 4351 be replaced. |
4313 </p> | 4352 </p> |
4314 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd> | 4353 </dd></dl></dd><dt class="refactoring">EXTRACT_METHOD</dt><dd> |
4315 <p> | 4354 <p> |
4316 Create a method whose body is the specified expression or | 4355 Create a method whose body is the specified expression or |
4317 list of statements, possibly augmented with a return | 4356 list of statements, possibly augmented with a return |
4318 statement. | 4357 statement. |
4319 </p> | 4358 </p> |
4320 <p> | 4359 <p> |
4321 It is an error if the range contains anything other than a | 4360 It is an error if the range contains anything other than a |
4322 complete expression (no partial expressions are allowed) or | 4361 complete expression (no partial expressions are allowed) or |
4323 a complete sequence of statements. | 4362 a complete sequence of statements. |
4324 </p> | 4363 </p> |
4325 | 4364 |
4326 | 4365 |
4327 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> | 4366 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd> |
4328 | 4367 |
4329 <p> | 4368 <p> |
4330 The offset to the beginning of the expression or | 4369 The offset to the beginning of the expression or |
4331 statements that will be extracted. | 4370 statements that will be extracted. |
4332 </p> | 4371 </p> |
4333 </dd><dt class="field"><b>length (int)</b></dt><dd> | 4372 </dd><dt class="field"><b>length: int</b></dt><dd> |
4334 | 4373 |
4335 <p> | 4374 <p> |
4336 The length of the expression or statements that will be | 4375 The length of the expression or statements that will be |
4337 extracted. | 4376 extracted. |
4338 </p> | 4377 </p> |
4339 </dd><dt class="field"><b>returnType (String)</b></dt><dd> | 4378 </dd><dt class="field"><b>returnType: String</b></dt><dd> |
4340 | 4379 |
4341 <p> | 4380 <p> |
4342 The proposed return type for the method. | 4381 The proposed return type for the method. |
4343 If the returned element does not have a declared return type, | 4382 If the returned element does not have a declared return type, |
4344 this field will contain an empty string. | 4383 this field will contain an empty string. |
4345 </p> | 4384 </p> |
4346 </dd><dt class="field"><b>names (List<String>)</b></dt><dd> | 4385 </dd><dt class="field"><b>names: List<String></b></dt><dd> |
4347 | 4386 |
4348 <p> | 4387 <p> |
4349 The proposed names for the method. | 4388 The proposed names for the method. |
4350 </p> | 4389 </p> |
4351 </dd><dt class="field"><b>canCreateGetter (bool)</b></dt><dd> | 4390 </dd><dt class="field"><b>canCreateGetter: bool</b></dt><dd> |
4352 | 4391 |
4353 <p> | 4392 <p> |
4354 True if a getter could be created rather than a method. | 4393 True if a getter could be created rather than a method. |
4355 </p> | 4394 </p> |
4356 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori
ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd> | 4395 </dd><dt class="field"><b>parameters: List<<a href="#type_Refactori
ngMethodParameter">RefactoringMethodParameter</a>></b></dt><dd> |
4357 | 4396 |
4358 <p> | 4397 <p> |
4359 The proposed parameters for the method. | 4398 The proposed parameters for the method. |
4360 </p> | 4399 </p> |
4361 </dd><dt class="field"><b>offsets (List<int>)</b></dt><dd> | 4400 </dd><dt class="field"><b>offsets: List<int></b></dt><dd> |
4362 | 4401 |
4363 <p> | 4402 <p> |
4364 The offsets of the expressions or statements that would | 4403 The offsets of the expressions or statements that would |
4365 be replaced by an invocation of the method. | 4404 be replaced by an invocation of the method. |
4366 </p> | 4405 </p> |
4367 </dd><dt class="field"><b>lengths (List<int>)</b></dt><dd> | 4406 </dd><dt class="field"><b>lengths: List<int></b></dt><dd> |
4368 | 4407 |
4369 <p> | 4408 <p> |
4370 The lengths of the expressions or statements that would | 4409 The lengths of the expressions or statements that would |
4371 be replaced by an invocation of the method. The lengths | 4410 be replaced by an invocation of the method. The lengths |
4372 correspond to the offsets. In other words, for a given | 4411 correspond to the offsets. In other words, for a given |
4373 expression (or block of statements), if the offset of | 4412 expression (or block of statements), if the offset of |
4374 that expression is offsets[i], then the length of that | 4413 that expression is offsets[i], then the length of that |
4375 expression is lengths[i]. | 4414 expression is lengths[i]. |
4376 </p> | 4415 </p> |
4377 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType (String
)</b></dt><dd> | 4416 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>returnType: String
</b></dt><dd> |
4378 | 4417 |
4379 <p> | 4418 <p> |
4380 The return type that should be defined for the method. | 4419 The return type that should be defined for the method. |
4381 </p> | 4420 </p> |
4382 </dd><dt class="field"><b>createGetter (bool)</b></dt><dd> | 4421 </dd><dt class="field"><b>createGetter: bool</b></dt><dd> |
4383 | 4422 |
4384 <p> | 4423 <p> |
4385 True if a getter should be created rather than a | 4424 True if a getter should be created rather than a |
4386 method. It is an error if this field is true and the | 4425 method. It is an error if this field is true and the |
4387 list of parameters is non-empty. | 4426 list of parameters is non-empty. |
4388 </p> | 4427 </p> |
4389 </dd><dt class="field"><b>name (String)</b></dt><dd> | 4428 </dd><dt class="field"><b>name: String</b></dt><dd> |
4390 | 4429 |
4391 <p> | 4430 <p> |
4392 The name that the method should be given. | 4431 The name that the method should be given. |
4393 </p> | 4432 </p> |
4394 </dd><dt class="field"><b>parameters (List<<a href="#type_Refactori
ngMethodParameter">RefactoringMethodParameter</a>>)</b></dt><dd> | 4433 </dd><dt class="field"><b>parameters: List<<a href="#type_Refactori
ngMethodParameter">RefactoringMethodParameter</a>></b></dt><dd> |
4395 | 4434 |
4396 <p> | 4435 <p> |
4397 The parameters that should be defined for the method. | 4436 The parameters that should be defined for the method. |
4398 </p> | 4437 </p> |
4399 <p> | 4438 <p> |
4400 It is an error if a REQUIRED or NAMED parameter follows a | 4439 It is an error if a REQUIRED or NAMED parameter follows a |
4401 POSITIONAL parameter. | 4440 POSITIONAL parameter. |
4402 It is an error if a REQUIRED or POSITIONAL parameter follows a | 4441 It is an error if a REQUIRED or POSITIONAL parameter follows a |
4403 NAMED parameter. | 4442 NAMED parameter. |
4404 </p> | 4443 </p> |
4405 <ul> | 4444 <ul> |
4406 <li> | 4445 <li> |
4407 To change the order and/or update proposed parameters, add | 4446 To change the order and/or update proposed parameters, add |
4408 parameters with the same identifiers as proposed. | 4447 parameters with the same identifiers as proposed. |
4409 </li> | 4448 </li> |
4410 <li>To add new parameters, omit their identifier.</li> | 4449 <li>To add new parameters, omit their identifier.</li> |
4411 <li>To remove some parameters, omit them in this list.</li> | 4450 <li>To remove some parameters, omit them in this list.</li> |
4412 </ul> | 4451 </ul> |
4413 </dd><dt class="field"><b>extractAll (bool)</b></dt><dd> | 4452 </dd><dt class="field"><b>extractAll: bool</b></dt><dd> |
4414 | 4453 |
4415 <p> | 4454 <p> |
4416 True if all occurrences of the expression or statements | 4455 True if all occurrences of the expression or statements |
4417 should be replaced by an invocation of the method. The | 4456 should be replaced by an invocation of the method. The |
4418 expression or statements used to initiate the | 4457 expression or statements used to initiate the |
4419 refactoring will always be replaced. | 4458 refactoring will always be replaced. |
4420 </p> | 4459 </p> |
4421 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd> | 4460 </dd></dl></dd><dt class="refactoring">INLINE_LOCAL_VARIABLE</dt><dd> |
4422 <p> | 4461 <p> |
4423 Inline the initializer expression of a local variable in | 4462 Inline the initializer expression of a local variable in |
4424 place of any references to that variable. | 4463 place of any references to that variable. |
4425 </p> | 4464 </p> |
4426 <p> | 4465 <p> |
4427 It is an error if the range contains anything other than all | 4466 It is an error if the range contains anything other than all |
4428 or part of the name of a single local variable. | 4467 or part of the name of a single local variable. |
4429 </p> | 4468 </p> |
4430 | 4469 |
4431 <h4>Feedback:</h4><dl><dt class="field"><b>name (String)</b></dt><dd> | 4470 <h4>Feedback:</h4><dl><dt class="field"><b>name: String</b></dt><dd> |
4432 | 4471 |
4433 <p> | 4472 <p> |
4434 The name of the variable being inlined. | 4473 The name of the variable being inlined. |
4435 </p> | 4474 </p> |
4436 </dd><dt class="field"><b>occurrences (int)</b></dt><dd> | 4475 </dd><dt class="field"><b>occurrences: int</b></dt><dd> |
4437 | 4476 |
4438 <p> | 4477 <p> |
4439 The number of times the variable occurs. | 4478 The number of times the variable occurs. |
4440 </p> | 4479 </p> |
4441 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INL
INE_METHOD</dt><dd> | 4480 </dd></dl><h4>Options:</h4><p>none</p></dd><dt class="refactoring">INL
INE_METHOD</dt><dd> |
4442 <p> | 4481 <p> |
4443 Inline a method in place of one or all references to that | 4482 Inline a method in place of one or all references to that |
4444 method. | 4483 method. |
4445 </p> | 4484 </p> |
4446 <p> | 4485 <p> |
4447 It is an error if the range contains anything other than all | 4486 It is an error if the range contains anything other than all |
4448 or part of the name of a single method. | 4487 or part of the name of a single method. |
4449 </p> | 4488 </p> |
4450 | 4489 |
4451 | 4490 |
4452 <h4>Feedback:</h4><dl><dt class="field"><b>className (<span style="color:#
999999">optional</span> String)</b></dt><dd> | 4491 <h4>Feedback:</h4><dl><dt class="field"><b>className: String<span style="c
olor:#999999"> (optional)</span></b></dt><dd> |
4453 | 4492 |
4454 <p> | 4493 <p> |
4455 The name of the class enclosing the method being inlined. | 4494 The name of the class enclosing the method being inlined. |
4456 If not a class member is being inlined, this field will be absent. | 4495 If not a class member is being inlined, this field will be absent. |
4457 </p> | 4496 </p> |
4458 </dd><dt class="field"><b>methodName (String)</b></dt><dd> | 4497 </dd><dt class="field"><b>methodName: String</b></dt><dd> |
4459 | 4498 |
4460 <p> | 4499 <p> |
4461 The name of the method (or function) being inlined. | 4500 The name of the method (or function) being inlined. |
4462 </p> | 4501 </p> |
4463 </dd><dt class="field"><b>isDeclaration (bool)</b></dt><dd> | 4502 </dd><dt class="field"><b>isDeclaration: bool</b></dt><dd> |
4464 | 4503 |
4465 <p> | 4504 <p> |
4466 True if the declaration of the method is selected. | 4505 True if the declaration of the method is selected. |
4467 So all references should be inlined. | 4506 So all references should be inlined. |
4468 </p> | 4507 </p> |
4469 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource (bool
)</b></dt><dd> | 4508 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>deleteSource: bool
</b></dt><dd> |
4470 | 4509 |
4471 <p> | 4510 <p> |
4472 True if the method being inlined should be removed. | 4511 True if the method being inlined should be removed. |
4473 It is an error if this field is true and inlineAll is false. | 4512 It is an error if this field is true and inlineAll is false. |
4474 </p> | 4513 </p> |
4475 </dd><dt class="field"><b>inlineAll (bool)</b></dt><dd> | 4514 </dd><dt class="field"><b>inlineAll: bool</b></dt><dd> |
4476 | 4515 |
4477 <p> | 4516 <p> |
4478 True if all invocations of the method should be inlined, | 4517 True if all invocations of the method should be inlined, |
4479 or false if only the invocation site used to create this | 4518 or false if only the invocation site used to create this |
4480 refactoring should be inlined. | 4519 refactoring should be inlined. |
4481 </p> | 4520 </p> |
4482 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd> | 4521 </dd></dl></dd><dt class="refactoring">MOVE_FILE</dt><dd> |
4483 <p> | 4522 <p> |
4484 Move the given file and update all of the references to that file | 4523 Move the given file and update all of the references to that file |
4485 and from it. The move operation is supported in general case - for | 4524 and from it. The move operation is supported in general case - for |
4486 renaming a file in the same folder, moving it to a different folder | 4525 renaming a file in the same folder, moving it to a different folder |
4487 or both. | 4526 or both. |
4488 </p> | 4527 </p> |
4489 <p> | 4528 <p> |
4490 The refactoring must be activated before an actual file moving | 4529 The refactoring must be activated before an actual file moving |
4491 operation is performed. | 4530 operation is performed. |
4492 </p> | 4531 </p> |
4493 <p> | 4532 <p> |
4494 The "offset" and "length" fields from the request are ignored, but the | 4533 The "offset" and "length" fields from the request are ignored, but the |
4495 file specified in the request specifies the file to be moved. | 4534 file specified in the request specifies the file to be moved. |
4496 </p> | 4535 </p> |
4497 | 4536 |
4498 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>new
File (<a href="#type_FilePath">FilePath</a>)</b></dt><dd> | 4537 <h4>Feedback:</h4><p>none</p><h4>Options:</h4><dl><dt class="field"><b>new
File: <a href="#type_FilePath">FilePath</a></b></dt><dd> |
4499 | 4538 |
4500 <p> | 4539 <p> |
4501 The new file path to which the given file is being moved. | 4540 The new file path to which the given file is being moved. |
4502 </p> | 4541 </p> |
4503 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd> | 4542 </dd></dl></dd><dt class="refactoring">RENAME</dt><dd> |
4504 <p> | 4543 <p> |
4505 Rename a given element and all of the references to that | 4544 Rename a given element and all of the references to that |
4506 element. | 4545 element. |
4507 </p> | 4546 </p> |
4508 <p> | 4547 <p> |
4509 It is an error if the range contains anything other than all | 4548 It is an error if the range contains anything other than all |
4510 or part of the name of a single function (including methods, | 4549 or part of the name of a single function (including methods, |
4511 getters and setters), variable (including fields, parameters | 4550 getters and setters), variable (including fields, parameters |
4512 and local variables), class or function type. | 4551 and local variables), class or function type. |
4513 </p> | 4552 </p> |
4514 | 4553 |
4515 | 4554 |
4516 <h4>Feedback:</h4><dl><dt class="field"><b>offset (int)</b></dt><dd> | 4555 <h4>Feedback:</h4><dl><dt class="field"><b>offset: int</b></dt><dd> |
4517 | 4556 |
4518 <p> | 4557 <p> |
4519 The offset to the beginning of the name selected to be | 4558 The offset to the beginning of the name selected to be |
4520 renamed. | 4559 renamed. |
4521 </p> | 4560 </p> |
4522 </dd><dt class="field"><b>length (int)</b></dt><dd> | 4561 </dd><dt class="field"><b>length: int</b></dt><dd> |
4523 | 4562 |
4524 <p> | 4563 <p> |
4525 The length of the name selected to be renamed. | 4564 The length of the name selected to be renamed. |
4526 </p> | 4565 </p> |
4527 </dd><dt class="field"><b>elementKindName (String)</b></dt><dd> | 4566 </dd><dt class="field"><b>elementKindName: String</b></dt><dd> |
4528 | 4567 |
4529 <p> | 4568 <p> |
4530 The human-readable description of the kind of element being | 4569 The human-readable description of the kind of element being |
4531 renamed (such as "class" or "function type | 4570 renamed (such as "class" or "function type |
4532 alias"). | 4571 alias"). |
4533 </p> | 4572 </p> |
4534 </dd><dt class="field"><b>oldName (String)</b></dt><dd> | 4573 </dd><dt class="field"><b>oldName: String</b></dt><dd> |
4535 | 4574 |
4536 <p> | 4575 <p> |
4537 The old name of the element before the refactoring. | 4576 The old name of the element before the refactoring. |
4538 </p> | 4577 </p> |
4539 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName (String)</
b></dt><dd> | 4578 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b
></dt><dd> |
4540 | 4579 |
4541 <p> | 4580 <p> |
4542 The name that the element should have after the | 4581 The name that the element should have after the |
4543 refactoring. | 4582 refactoring. |
4544 </p> | 4583 </p> |
4545 </dd></dl></dd></dl> | 4584 </dd></dl></dd></dl> |
4546 <h2>Errors</h2> | 4585 <h2>Errors</h2> |
4547 <p> | 4586 <p> |
4548 This section contains a list of all of the errors that are | 4587 This section contains a list of all of the errors that are |
4549 produced by the server and the data that is returned with each. | 4588 produced by the server and the data that is returned with each. |
4550 </p> | 4589 </p> |
4551 <p> | 4590 <p> |
4552 TODO: TBD | 4591 TODO: TBD |
4553 </p> | 4592 </p> |
4554 <h2 class="domain"><a name="index">Index</a></h2> | 4593 <h2 class="domain"><a name="index">Index</a></h2> |
4555 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachable
Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</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><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href=
"#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">
↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag
nostic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.g
etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>
)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent
Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h
ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana
lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr
orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp
tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon
tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl
etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a
></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a><
/li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme
nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h
ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK
ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont
extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li>
<a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath<
/a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F
oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G
eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio
n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l
i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I
mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">
ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a
></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li>
<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a
href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav
igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a><
/li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli
ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="#
type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos
ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type
_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa
rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba
ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori
ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring
MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr
oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS
everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a
></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R
equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId<
/a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type
_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se
rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a
href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S
ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a
></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class
="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT
ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT
_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR
ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET
HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB
LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a
href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM
E">RENAME</a></li></ul></div> | 4594 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getReachable
Sources">getReachableSources</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</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><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href=
"#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h4>diagnostic (<a href="#domain_diagnostic">
↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag
nostic.getDiagnostics">getDiagnostics</a></li><li><a href="#request_diagnostic.g
etServerPort">getServerPort</a></li></ul></div><h3>Types (<a href="#types">↑</a>
)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContent
Overlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a h
ref="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Ana
lysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErr
orType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOp
tions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a
href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCon
tentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Compl
etionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a
></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a><
/li><li><a href="#type_ContextData">ContextData</a></li><li><a href="#type_Eleme
nt">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a h
ref="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_ExecutableK
ind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">ExecutionCont
extId</a></li><li><a href="#type_ExecutionService">ExecutionService</a></li><li>
<a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath">FilePath<
/a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_F
oldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysisService">G
eneralAnalysisService</a></li><li><a href="#type_HighlightRegion">HighlightRegio
n</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><l
i><a href="#type_HoverInformation">HoverInformation</a></li><li><a href="#type_I
mplementedClass">ImplementedClass</a></li><li><a href="#type_ImplementedMember">
ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a
></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li>
<a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a
href="#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Nav
igationRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a><
/li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outli
ne">Outline</a></li><li><a href="#type_Override">Override</a></li><li><a href="#
type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Position">Pos
ition</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a href="#type
_RefactoringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodPa
rameter">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringFeedba
ck">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions">Refactori
ngOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring
MethodParameterKind</a></li><li><a href="#type_RefactoringProblem">RefactoringPr
oblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemS
everity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a
></li><li><a href="#type_RequestError">RequestError</a></li><li><a href="#type_R
equestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId">SearchId<
/a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a href="#type
_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerService">Se
rverService</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a
href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">S
ourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierarchyItem</a
></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class
="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETT
ER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT
_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTR
ACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_MET
HOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIAB
LE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a
href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring_RENAM
E">RENAME</a></li></ul></div> |
4556 | 4595 |
4557 | 4596 |
4558 </body></html> | 4597 </body></html> |
OLD | NEW |