gecko-dev/toolkit/components/telemetry/nsITelemetryPing.idl
Rafael Ávila de Espíndola 598e83db0d Bug 819240 - Document all functions in nsITelemetryPing.idl. r=vladan.
--HG--
extra : rebase_source : 90858f60619c22c7ec027209479273ca5e543307
2012-12-07 13:49:21 -05:00

57 lines
1.4 KiB
Plaintext

/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsIObserver.idl"
interface nsIFile;
[scriptable, uuid(077ee790-3a9d-11e2-81c1-0800200c9a66)]
interface nsITelemetryPing : nsIObserver {
/**
* Return the current telemetry payload.
*/
jsval getPayload();
/**
* Save histograms to a file.
*
* @param aFile - File to load from.
* @param aSync - Use sync writes.
*/
void saveHistograms(in nsIFile aFile, in boolean aSync);
/**
* Collect and store information about startup.
*/
void gatherStartup();
/**
* Notify observers when loads and saves finish. Used only for testing.
*/
void enableLoadSaveNotifications();
/**
* Inform the ping which AddOns are installed.
*
* @param aAddOns - The AddOns.
*/
void setAddOns(in AString aAddOns);
/**
* Send a ping to a test server. Used only for testing.
*
* @param aServer - The server.
*/
void testPing(in AString aServer);
/**
* Load histograms from a file.
*
* @param aFile - File to load from.
* @param aSync - Use sync reads.
*/
void testLoadHistograms(in nsIFile aFile, in boolean aSync);
};