fune/toolkit/components/search/PolicySearchEngine.sys.mjs

66 lines
1.8 KiB
JavaScript

/* 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/. */
/* eslint no-shadow: error, mozilla/no-aArgs: error */
import { SearchEngine } from "resource://gre/modules/SearchEngine.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
SearchUtils: "resource://gre/modules/SearchUtils.sys.mjs",
});
/**
* PolicySearchEngine represents a search engine defined by an enterprise
* policy.
*/
export class PolicySearchEngine extends SearchEngine {
/**
* Creates a PolicySearchEngine.
*
* @param {object} options
* @param {object} [options.details]
* An object with the details for this search engine. See
* nsISearchService.addPolicyEngine for more details.
* @param {object} [options.json]
* An object that represents the saved JSON settings for the engine.
*/
constructor(options = {}) {
super({
loadPath: "[other]addEngineWithDetails:set-via-policy",
});
if (options.details) {
this._initWithDetails(options.details);
} else {
this._initWithJSON(options.json);
}
}
/**
* Returns the appropriate identifier to use for telemetry.
*
* @returns {string}
*/
get telemetryId() {
return `other-${this.name}`;
}
/**
* Updates a search engine that is specified from enterprise policies.
*
* @param {object} details
* An object that simulates the manifest object from a WebExtension. See
* nsISearchService.updatePolicyEngine for more details.
*/
update(details) {
this._urls = [];
this._iconMapObj = null;
this._initWithDetails(details);
lazy.SearchUtils.notifyAction(this, lazy.SearchUtils.MODIFIED_TYPE.CHANGED);
}
}