tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

ipp.json (4740B)

      1 [
      2  {
      3    "namespace": "ippActivator",
      4    "description": "IPP Activator API",
      5    "functions": [
      6      {
      7        "name": "showMessage",
      8        "type": "function",
      9        "description": "Show a message using the browser notification box. Accepts a string or an array of parts to render (with optional strong modifier). Optionally target a specific tab by id.",
     10        "async": true,
     11        "parameters": [
     12          {
     13            "name": "message",
     14            "description": "String label or array of {text, modifier} parts.",
     15            "choices": [
     16              { "type": "string" },
     17              {
     18                "type": "array",
     19                "items": {
     20                  "type": "object",
     21                  "properties": {
     22                    "text": { "type": "string" },
     23                    "modifier": {
     24                      "type": "array",
     25                      "optional": true,
     26                      "items": { "type": "string", "enum": ["strong"] }
     27                    }
     28                  }
     29                }
     30              }
     31            ]
     32          },
     33          {
     34            "name": "tabId",
     35            "type": "integer",
     36            "optional": true,
     37            "description": "Target tab id. Defaults to active tab."
     38          }
     39        ]
     40      },
     41      {
     42        "name": "hideMessage",
     43        "type": "function",
     44        "description": "Hide the IPP notification for the given tab (or active tab by default). No-op if not present.",
     45        "async": true,
     46        "parameters": [
     47          {
     48            "name": "tabId",
     49            "type": "integer",
     50            "optional": true,
     51            "description": "Target tab id. Defaults to active tab."
     52          }
     53        ]
     54      },
     55      {
     56        "name": "getNotifiedDomains",
     57        "type": "function",
     58        "description": "Return the list of base domains for which a notification was already shown.",
     59        "async": true,
     60        "parameters": []
     61      },
     62      {
     63        "name": "addNotifiedDomain",
     64        "type": "function",
     65        "description": "Add a base domain to the suppression list (no-op if present).",
     66        "async": true,
     67        "parameters": [{ "name": "domain", "type": "string" }]
     68      },
     69      {
     70        "name": "isTesting",
     71        "type": "function",
     72        "description": "Return whether we are running in testing mode.",
     73        "async": true,
     74        "parameters": []
     75      },
     76      {
     77        "name": "isIPPActive",
     78        "type": "function",
     79        "description": "Return whether IPP connection is active.",
     80        "async": true,
     81        "parameters": []
     82      },
     83      {
     84        "name": "getDynamicTabBreakages",
     85        "type": "function",
     86        "description": "Return dynamic tab breakages (pref: extensions.ippactivator.dynamicTabBreakages).",
     87        "async": true,
     88        "parameters": []
     89      },
     90      {
     91        "name": "getDynamicWebRequestBreakages",
     92        "type": "function",
     93        "description": "Return dynamic webRequest breakages (pref: extensions.ippactivator.dynamicWebRequestBreakages).",
     94        "async": true,
     95        "parameters": []
     96      },
     97      {
     98        "name": "getBaseDomainFromURL",
     99        "type": "function",
    100        "description": "Return both the eTLD+1 (baseDomain) and full host for the given URL.",
    101        "async": true,
    102        "parameters": [
    103          {
    104            "name": "url",
    105            "type": "string",
    106            "description": "The URL to analyze."
    107          }
    108        ]
    109      },
    110      {
    111        "name": "hasExclusion",
    112        "type": "function",
    113        "description": "Return true if this URL has ipp-vpn permission set to DENY.",
    114        "async": true,
    115        "parameters": [
    116          {
    117            "name": "url",
    118            "type": "string",
    119            "description": "The URL to analyze."
    120          }
    121        ]
    122      }
    123    ],
    124    "events": [
    125      {
    126        "name": "onIPPActivated",
    127        "type": "function",
    128        "description": "Fired when IPProtectionService dispatches 'IPProtectionService:Started'.",
    129        "parameters": [
    130          {
    131            "name": "listener",
    132            "type": "function"
    133          }
    134        ]
    135      },
    136      {
    137        "name": "onDynamicTabBreakagesUpdated",
    138        "type": "function",
    139        "description": "Fired when dynamicTabBreakages preference changes.",
    140        "parameters": [
    141          {
    142            "name": "listener",
    143            "type": "function"
    144          }
    145        ]
    146      },
    147      {
    148        "name": "onDynamicWebRequestBreakagesUpdated",
    149        "type": "function",
    150        "description": "Fired when dynamicWebRequestBreakages preference changes.",
    151        "parameters": [
    152          {
    153            "name": "listener",
    154            "type": "function"
    155          }
    156        ]
    157      }
    158    ]
    159  }
    160 ]