summaryrefslogtreecommitdiffstats
path: root/browser/extensions/webcompat/experiment-apis/trackingProtection.json
blob: c495f39add7284e27398fa0c65337cdfe139e928 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
[
  {
    "namespace": "trackingProtection",
    "description": "experimental API allow requests through ETP",
    "functions": [
      {
        "name": "isDFPIActive",
        "type": "function",
        "description": "Returns whether dFPI is active for private/non-private browsing tabs",
        "parameters": [
          {
            "type": "boolean",
            "name": "isPrivate"
          }
        ],
        "async": true
      },
      {
        "name": "shim",
        "type": "function",
        "description": "Set specified URL patterns as intended to be shimmed",
        "parameters": [
          {
            "name": "allowlistId",
            "description": "Identfier for the allow-list, so it may be added-to or revoked",
            "type": "string"
          },
          {
            "name": "patterns",
            "description": "Array of match patterns",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          {
            "name": "notHosts",
            "description": "Hosts on which to not shim these patterns",
            "type": "array",
            "optional": true,
            "items": {
              "type": "string"
            }
          }
        ]
      },
      {
        "name": "allow",
        "type": "function",
        "description": "Set specified URL patterns as intended to be allowed through the content blocker for the specified top hosts",
        "parameters": [
          {
            "name": "allowlistId",
            "description": "Identfier for the allow-list, so it may be added-to or revoked",
            "type": "string"
          },
          {
            "name": "patterns",
            "description": "Array of match patterns",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          {
            "name": "hosts",
            "description": "Hosts to allow the patterns on",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "async": true
      },
      {
        "name": "revoke",
        "type": "function",
        "description": "Revokes the given allow-list entirely (both shims and allows)",
        "parameters": [
          {
            "name": "allowListId",
            "type": "string"
          }
        ],
        "async": true
      },
      {
        "name": "wasRequestUnblocked",
        "type": "function",
        "description": "Whether the given requestId was unblocked by any allowList",
        "parameters": [
          {
            "name": "requestId",
            "type": "string"
          }
        ],
        "async": true
      }
    ]
  }
]