docs.json

[
  {
    "Constant" : [

    ],
    "submodules" : [

    ],
    "Function" : [

    ],
    "Variable" : [

    ],
    "stripped_doc" : [

    ],
    "Deprecated" : [

    ],
    "type" : "Module",
    "desc" : "Automatically approves macOS's window picker screen\/audio capture alert for a configurable list of trusted applications.",
    "Constructor" : [

    ],
    "items" : [
      {
        "def" : "AutoAllowScreenCapture:configPath()",
        "stripped_doc" : [
          "Provides the string for the configuration path",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Provides the string for the configuration path\n\nParameters:\n * None\n\nReturns:\n * a string for the path to the configuration file",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:configPath()",
        "type" : "Method",
        "returns" : [
          " * a string for the path to the configuration file"
        ],
        "name" : "configPath",
        "desc" : "Provides the string for the configuration path"
      },
      {
        "def" : "AutoAllowScreenCapture:init()",
        "stripped_doc" : [
          "Initializes the Spoon. Called automatically by hs.loadSpoon().",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Initializes the Spoon. Called automatically by hs.loadSpoon().\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:init()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "init",
        "desc" : "Initializes the Spoon. Called automatically by hs.loadSpoon()."
      },
      {
        "def" : "AutoAllowScreenCapture:reloadApps()",
        "stripped_doc" : [
          "Re-reads and re-validates the config file and restarts the watcher.",
          "Required after any appnames or loglevel change -- there is no",
          "automatic file watching.",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Re-reads and re-validates the config file and restarts the watcher.\nRequired after any appnames or loglevel change -- there is no\nautomatic file watching.\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:reloadApps()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "reloadApps",
        "desc" : "Re-reads and re-validates the config file and restarts the watcher."
      },
      {
        "def" : "AutoAllowScreenCapture:start()",
        "stripped_doc" : [
          "Verifies the preferences were read, then starts hooking window creation to circumvent",
          "the indicated notifications",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Verifies the preferences were read, then starts hooking window creation to circumvent\nthe indicated notifications\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:start()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "start",
        "desc" : "Verifies the preferences were read, then starts hooking window creation to circumvent"
      },
      {
        "def" : "AutoAllowScreenCapture:stop()",
        "stripped_doc" : [
          "Stops notification window monitoring",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Stops notification window monitoring\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:stop()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "stop",
        "desc" : "Stops notification window monitoring"
      }
    ],
    "Method" : [
      {
        "def" : "AutoAllowScreenCapture:init()",
        "stripped_doc" : [
          "Initializes the Spoon. Called automatically by hs.loadSpoon().",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Initializes the Spoon. Called automatically by hs.loadSpoon().\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:init()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "init",
        "desc" : "Initializes the Spoon. Called automatically by hs.loadSpoon()."
      },
      {
        "def" : "AutoAllowScreenCapture:configPath()",
        "stripped_doc" : [
          "Provides the string for the configuration path",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Provides the string for the configuration path\n\nParameters:\n * None\n\nReturns:\n * a string for the path to the configuration file",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:configPath()",
        "type" : "Method",
        "returns" : [
          " * a string for the path to the configuration file"
        ],
        "name" : "configPath",
        "desc" : "Provides the string for the configuration path"
      },
      {
        "def" : "AutoAllowScreenCapture:start()",
        "stripped_doc" : [
          "Verifies the preferences were read, then starts hooking window creation to circumvent",
          "the indicated notifications",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Verifies the preferences were read, then starts hooking window creation to circumvent\nthe indicated notifications\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:start()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "start",
        "desc" : "Verifies the preferences were read, then starts hooking window creation to circumvent"
      },
      {
        "def" : "AutoAllowScreenCapture:stop()",
        "stripped_doc" : [
          "Stops notification window monitoring",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Stops notification window monitoring\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:stop()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "stop",
        "desc" : "Stops notification window monitoring"
      },
      {
        "def" : "AutoAllowScreenCapture:reloadApps()",
        "stripped_doc" : [
          "Re-reads and re-validates the config file and restarts the watcher.",
          "Required after any appnames or loglevel change -- there is no",
          "automatic file watching.",
          ""
        ],
        "parameters" : [
          " * None",
          ""
        ],
        "doc" : "Re-reads and re-validates the config file and restarts the watcher.\nRequired after any appnames or loglevel change -- there is no\nautomatic file watching.\n\nParameters:\n * None\n\nReturns:\n * The AutoAllowScreenCapture object",
        "notes" : [

        ],
        "signature" : "AutoAllowScreenCapture:reloadApps()",
        "type" : "Method",
        "returns" : [
          " * The AutoAllowScreenCapture object"
        ],
        "name" : "reloadApps",
        "desc" : "Re-reads and re-validates the config file and restarts the watcher."
      }
    ],
    "Command" : [

    ],
    "Field" : [

    ],
    "doc" : "Automatically approves macOS's window picker screen\/audio capture alert for a configurable list of trusted applications.\n\nMatch strategy: checks that the window is a genuine OS-presented\nsystem dialog -- role AXWindow, subrole AXSystemDialog, owned by\ncom.apple.UserNotificationCenter -- then looks at its direct children\nfor an AXStaticText whose value exactly matches the expected sentence\nfor one of the configured app names.\n\nConfig file (OUTSIDE this Spoon, in your Hammerspoon config dir):\n\n    <hs.configdir>\/Prefs\/auto-allow-apps.json\n\n\nFormat:\n    { \"appnames\": [\"Thaw\", \"RustDesk\"], \"loglevel\": \"info\" }\n\nappnames: array of app name strings (may be empty -- watcher just\n  won't install).\nloglevel: 'nothing', 'error', 'warning', 'info', 'debug', or\n  'verbose', or the corresponding number 0-5, per hs.logger's own\n  documented levels. Defaults to \"info\" if the file itself is\n  missing; but if the file EXISTS and loglevel is present but not\n  one of these, that's a hard validation failure (see below).\n\nValidation \/ failure behavior: a malformed JSON file, a missing or\nwrong-shaped \"appnames\", or an invalid \"loglevel\" all log a specific\nerror at error level and leave the Spoon inert -- no window watcher\ngets installed. There is no live file-watching: change appnames or\nloglevel, then call reloadApps() (or hs.reload()) to pick it up.\n\nDebugging: logs through hs.logger under \"AutoAllowSC\" (dot syntax\nrequired -- see hs.logger docs). Starts at \"info\" until a valid\nconfig is loaded, which then applies the configured level.\n\n    spoon.AutoAllowScreenCapture.logger.setLogLevel(\"debug\")\n\nTest the label-matching logic against a plain string:\n\n    spoon.AutoAllowScreenCapture:testLabelMatch('\"Thaw\" is requesting to bypass the system private window picker and directly access your screen and audio.')\n\nTest the full gate against a captured window object:\n\n    spoon.AutoAllowScreenCapture:testWindow(x[14])",
    "name" : "AutoAllowScreenCapture"
  }
]