gecko/dom/webidl/MozSelfSupport.webidl

42 lines
1.2 KiB
Plaintext

/* 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/. */
/**
* The MozSelfSupport interface allows external Mozilla support sites such as
* FHR and SUMO to access data and control settings that are not otherwise
* exposed to external content.
*
* At the moment, this is a ChromeOnly interface, but the plan is to allow
* specific Mozilla domains to access it directly.
*/
[ChromeOnly,
JSImplementation="@mozilla.org/mozselfsupport;1"]
interface MozSelfSupportImpl
{
/**
* Controls whether uploading FHR data is allowed.
*/
attribute boolean healthReportDataSubmissionEnabled;
/**
* Retrieves the FHR payload object, which is of the form:
*
* {
* version: Number,
* clientID: String,
* clientIDVersion: Number,
* thisPingDate: String,
* geckoAppInfo: Object,
* data: Object
* }
*
* Refer to the getJSONPayload function in healthreporter.jsm for more
* information.
*
* @return Promise<Object>
* Resolved when the FHR payload data has been collected.
*/
Promise getHealthReportPayload();
};