aboutConfigPrefs.json (2123B)
1 [ 2 { 3 "namespace": "aboutConfigPrefs", 4 "description": "experimental API extension to allow access to about:config preferences", 5 "events": [ 6 { 7 "name": "onPrefChange", 8 "type": "function", 9 "parameters": [ 10 { 11 "name": "name", 12 "type": "string", 13 "description": "The preference which changed" 14 } 15 ], 16 "extraParameters": [ 17 { 18 "name": "name", 19 "type": "string", 20 "description": "The preference to monitor" 21 } 22 ] 23 } 24 ], 25 "functions": [ 26 { 27 "name": "getCheckableGlobalPrefs", 28 "type": "function", 29 "description": "Lists the global prefs the addon may read", 30 "parameters": [], 31 "returns": { 32 "type": "array", 33 "description": "The list of pref names.", 34 "items": { 35 "type": "string" 36 } 37 } 38 }, 39 { 40 "name": "getPref", 41 "type": "function", 42 "description": "Get a preference's value", 43 "parameters": [ 44 { 45 "name": "name", 46 "type": "string", 47 "description": "The preference name" 48 }, 49 { 50 "name": "defaultValue", 51 "type": "boolean", 52 "optional": true, 53 "description": "Default value to return if the pref is not set" 54 } 55 ], 56 "returns": { 57 "choices": [ 58 { "type": "boolean" }, 59 { "type": "integer" }, 60 { "type": "string" } 61 ], 62 "optional": true, 63 "description": "returns the value of a pref." 64 } 65 }, 66 { 67 "name": "setPref", 68 "type": "function", 69 "description": "Set a preference's value", 70 "parameters": [ 71 { 72 "name": "name", 73 "type": "string", 74 "description": "The preference name" 75 }, 76 { 77 "name": "value", 78 "type": "any", 79 "description": "The new value" 80 } 81 ] 82 } 83 ] 84 } 85 ]