xpcom/base/nsIMacPreferencesReader.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupportsPrimitives.idl"
   6
   7 %{C++
   8 #define ENTERPRISE_POLICIES_ENABLED_KEY "EnterprisePoliciesEnabled"
   9 %}
  10
  11 /**
  12  * This interface is designed to provide scriptable access to the macOS
  13  * preferences system.
  14  *
  15  * This interface is highly macOS specific.
  16  */
  17 [builtinclass, scriptable, uuid(b0f20595-88ce-4738-a1a4-24de78eb8051)]
  18 interface nsIMacPreferencesReader : nsISupports
  19 {
  20   /**
  21    * This method checks whether macOS policies are enabled.
  22    *
  23    * @return true if macOS policies are enabled, false otherwise.
  24    */
  25   boolean policiesEnabled();
  26
  27   /**
  28    * This method reads and returns the macOS preferences.
  29    *
  30    * @return A JSON object containing all macOS preferences.
  31    */
  32   [implicit_jscontext]
  33   jsval readPreferences();
  34 };