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

Side by Side Diff: pkg/analysis_server/tool/spec/generated/java/AnalysisServer.java

Issue 2922603002: Add an analytics domain to the analysis server. (Closed)
Patch Set: improved docs Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 /* 1 /*
2 * Copyright (c) 2015, the Dart project authors. 2 * Copyright (c) 2015, the Dart project authors.
3 * 3 *
4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u se this file except 4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u se this file except
5 * in compliance with the License. You may obtain a copy of the License at 5 * in compliance with the License. You may obtain a copy of the License at
6 * 6 *
7 * http://www.eclipse.org/legal/epl-v10.html 7 * http://www.eclipse.org/legal/epl-v10.html
8 * 8 *
9 * Unless required by applicable law or agreed to in writing, software distribut ed under the License 9 * Unless required by applicable law or agreed to in writing, software distribut ed under the License
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K IND, either express 10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K IND, either express
(...skipping 267 matching lines...) Expand 10 before | Expand all | Expand 10 after
278 * not included in the analysis options will not be changed. If there are opti ons in the analysis 278 * not included in the analysis options will not be changed. If there are opti ons in the analysis
279 * options that are not valid, they will be silently ignored. 279 * options that are not valid, they will be silently ignored.
280 * 280 *
281 * @param options The options that are to be used to control analysis. 281 * @param options The options that are to be used to control analysis.
282 * 282 *
283 * @deprecated 283 * @deprecated
284 */ 284 */
285 public void analysis_updateOptions(AnalysisOptions options); 285 public void analysis_updateOptions(AnalysisOptions options);
286 286
287 /** 287 /**
288 * {@code analytics.enable}
289 *
290 * Enable or disable the sending of analytics data. Note that there are other ways for users to
291 * change this setting, so clients cannot assume that they have complete contr ol over this setting.
292 * In particular, there is no guarantee that the result returned by the isEnab led request will
293 * match the last value set via this request.
294 *
295 * @param value Enable or disable analytics.
296 */
297 public void analytics_enable(boolean value);
298
299 /**
300 * {@code analytics.isEnabled}
301 *
302 * Query whether analytics is enabled.
303 *
304 * This flag controls whether the analysis server sends any analytics data to the cloud. If
305 * disabled, the analysis server doesn not send any analytics data, and any da ta sent to it by
306 * clients (from sendEvent and sendTiming) will be ignored.
307 *
308 * The value of this flag can be changed by other tools outside of the analysi s server's process.
309 * When you query the flag, you get the value of the flag at a given moment. C lients should not use
310 * the value returned to decide whether or not to send the sendEvent and sendT iming requests. Those
311 * requests should be used unconditionally and server will determine whether o r not it is
312 * appropriate to forward the information to the cloud at the time each reques t is received.
313 */
314 public void analytics_isEnabled(IsEnabledConsumer consumer);
315
316 /**
317 * {@code analytics.sendEvent}
318 *
319 * Send information about client events.
320 *
321 * Ask the analysis server to include the fact that an action was performed in the client as part
322 * of the analytics data being sent. The data will only be included if the sen ding of analytics
323 * data is enabled at the time the request is processed. The action that was p erformed is indicated
324 * by the value of the action field.
325 *
326 * The value of the action field should not include the identity of the client . The analytics data
327 * sent by server will include the client id passed in using the --client-id c ommand-line argument.
328 * The request will be ignored if the client id was not provided when server w as started.
329 *
330 * @param action The value used to indicate which action was performed.
331 */
332 public void analytics_sendEvent(String action);
333
334 /**
335 * {@code analytics.sendTiming}
336 *
337 * Send timing information for client events (e.g. code completions).
338 *
339 * Ask the analysis server to include the fact that a timed event occurred as part of the analytics
340 * data being sent. The data will only be included if the sending of analytics data is enabled at
341 * the time the request is processed.
342 *
343 * The value of the event field should not include the identity of the client. The analytics data
344 * sent by server will include the client id passed in using the --client-id c ommand-line argument.
345 * The request will be ignored if the client id was not provided when server w as started.
346 *
347 * @param event The name of the event.
348 * @param millis The duration of the event in milliseconds.
349 */
350 public void analytics_sendTiming(String event, int millis);
351
352 /**
288 * {@code completion.getSuggestions} 353 * {@code completion.getSuggestions}
289 * 354 *
290 * Request that completion suggestions for the given offset in the given file be returned. 355 * Request that completion suggestions for the given offset in the given file be returned.
291 * 356 *
292 * @param file The file containing the point at which suggestions are to be ma de. 357 * @param file The file containing the point at which suggestions are to be ma de.
293 * @param offset The offset within the file at which suggestions are to be mad e. 358 * @param offset The offset within the file at which suggestions are to be mad e.
294 */ 359 */
295 public void completion_getSuggestions(String file, int offset, GetSuggestionsC onsumer consumer); 360 public void completion_getSuggestions(String file, int offset, GetSuggestionsC onsumer consumer);
296 361
297 /** 362 /**
(...skipping 308 matching lines...) Expand 10 before | Expand all | Expand 10 after
606 * the response to this request has been sent. 671 * the response to this request has been sent.
607 */ 672 */
608 public void server_shutdown(); 673 public void server_shutdown();
609 674
610 /** 675 /**
611 * Start the analysis server. 676 * Start the analysis server.
612 */ 677 */
613 public void start() throws Exception; 678 public void start() throws Exception;
614 679
615 } 680 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698