Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1)

Side by Side Diff: chrome/common/extensions/api/extension_api.json

Issue 8670012: Extension Settings API: move the API functions into an object SettingsNamepace, (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 [ 1 [
2 { 2 {
3 "namespace": "extension", 3 "namespace": "extension",
4 "types": [ 4 "types": [
5 { 5 {
6 "id": "MessageSender", 6 "id": "MessageSender",
7 "type": "object", 7 "type": "object",
8 "description": "An object containing information about the script contex t that sent a message or request.", 8 "description": "An object containing information about the script contex t that sent a message or request.",
9 "properties": { 9 "properties": {
10 "tab": {"$ref": "Tab", "optional": true, "description":"This property will <b>only</b> be present when the connection was opened from a tab or content script."}, 10 "tab": {"$ref": "Tab", "optional": true, "description":"This property will <b>only</b> be present when the connection was opened from a tab or content script."},
(...skipping 1015 matching lines...) Expand 10 before | Expand all | Expand 10 after
1026 "type": "any", 1026 "type": "any",
1027 "description": "The old value of the setting, before it changed.", 1027 "description": "The old value of the setting, before it changed.",
1028 "optional": true 1028 "optional": true
1029 }, 1029 },
1030 "newValue": { 1030 "newValue": {
1031 "type": "any", 1031 "type": "any",
1032 "description": "The new value of the setting.", 1032 "description": "The new value of the setting.",
1033 "optional": true 1033 "optional": true
1034 } 1034 }
1035 } 1035 }
1036 } 1036 },
1037 ],
1038 "functions": [
1039 { 1037 {
1040 "name": "get", 1038 "id": "StorageNamespace",
not at google - send to devlin 2011/11/23 02:24:43 so apparently rietveld is bad at diffs
1041 "unprivileged": true, 1039 "type": "object",
1042 "type": "function", 1040 "functions": [
1043 "description": "Gets one or more values from settings.",
1044 "parameters": [
1045 { 1041 {
1046 "name": "keys", 1042 "name": "get",
1047 "choices": [ 1043 "unprivileged": true,
1048 { "type": "string" }, 1044 "type": "function",
1049 { "type": "array", "items": { "type": "string" } }, 1045 "description": "Gets one or more values from settings.",
1046 "parameters": [
1050 { 1047 {
1051 "type": "object", 1048 "name": "keys",
1052 "description": "Settings object to return in the callback, where the values are replaced with those from settings if they exist.", 1049 "choices": [
1053 "properties": {}, 1050 { "type": "string" },
1054 "additionalProperties": { "type": "any" } 1051 { "type": "array", "items": { "type": "string" } },
1052 {
1053 "type": "object",
1054 "description": "Settings object to return in the callback, w here the values are replaced with those from settings if they exist.",
1055 "properties": {},
1056 "additionalProperties": { "type": "any" }
1057 }
1058 ],
1059 "description": "A single key to get, list of keys to get, or a d ictionary specifying default values (see description of the object). An empty l ist or object will return an empty settings object. Pass in null or undefined t o get the entire contents of settings; this should only be used for debugging.",
1060 "optional": true
1061 },
1062 {
1063 "name": "callback",
1064 "type": "function",
1065 "description": "Callback with settings values, or on failure (in which case lastError will be set).",
1066 "parameters": [
1067 {
1068 "name": "settings",
1069 "type": "object",
1070 "properties": {},
1071 "additionalProperties": { "type": "any" },
1072 "description": "Object with given keys set to settings value s."
1073 }
1074 ]
1055 } 1075 }
1056 ], 1076 ]
1057 "description": "A single key to get, list of keys to get, or a dicti onary specifying default values (see description of the object). An empty list or object will return an empty settings object. Pass in null or undefined to ge t the entire contents of settings; this should only be used for debugging.",
1058 "optional": true
1059 }, 1077 },
1060 { 1078 {
1061 "name": "callback", 1079 "name": "set",
1080 "unprivileged": true,
1062 "type": "function", 1081 "type": "function",
1063 "description": "Callback with settings values, or on failure (in whi ch case lastError will be set).", 1082 "description": "Sets multiple settings values.",
1064 "parameters": [ 1083 "parameters": [
1065 { 1084 {
1066 "name": "settings", 1085 "name": "settings",
1067 "type": "object", 1086 "type": "object",
1068 "properties": {}, 1087 "properties": {},
1069 "additionalProperties": { "type": "any" }, 1088 "additionalProperties": { "type": "any" },
1070 "description": "Object with given keys set to settings values." 1089 "description": "Object to augment settings with. Values that can not be serialized (functions, etc) will be ignored."
1090 },
1091 {
1092 "name": "callback",
1093 "type": "function",
1094 "description": "Callback on success, or on failure (in which cas e lastError will be set).",
1095 "parameters": [],
1096 "optional": true
1097 }
1098 ]
1099 },
1100 {
1101 "name": "remove",
1102 "unprivileged": true,
1103 "type": "function",
1104 "description": "Removes one or more values from settings.",
1105 "parameters": [
1106 {
1107 "name": "keys",
1108 "choices": [
1109 {"type": "string"},
1110 {"type": "array", "items": {"type": "string"}, "minItems": 1}
1111 ],
1112 "description": "A single key or a list of keys to remove from se ttings."
1113 },
1114 {
1115 "name": "callback",
1116 "type": "function",
1117 "description": "Callback on success, or on failure (in which cas e lastError will be set).",
1118 "parameters": [],
1119 "optional": true
1120 }
1121 ]
1122 },
1123 {
1124 "name": "clear",
1125 "unprivileged": true,
1126 "type": "function",
1127 "description": "Removes all values from settings.",
1128 "parameters": [
1129 {
1130 "name": "callback",
1131 "type": "function",
1132 "description": "Callback on success, or on failure (in which cas e lastError will be set).",
1133 "parameters": [],
1134 "optional": true
1071 } 1135 }
1072 ] 1136 ]
1073 } 1137 }
1074 ] 1138 ]
1075 },
1076 {
1077 "name": "set",
1078 "unprivileged": true,
1079 "type": "function",
1080 "description": "Sets multiple settings values.",
1081 "parameters": [
1082 {
1083 "name": "settings",
1084 "type": "object",
1085 "properties": {},
1086 "additionalProperties": { "type": "any" },
1087 "description": "Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored."
1088 },
1089 {
1090 "name": "callback",
1091 "type": "function",
1092 "description": "Callback on success, or on failure (in which case la stError will be set).",
1093 "parameters": [],
1094 "optional": true
1095 }
1096 ]
1097 },
1098 {
1099 "name": "remove",
1100 "unprivileged": true,
1101 "type": "function",
1102 "description": "Removes one or more values from settings.",
1103 "parameters": [
1104 {
1105 "name": "keys",
1106 "choices": [
1107 {"type": "string"},
1108 {"type": "array", "items": {"type": "string"}, "minItems": 1}
1109 ],
1110 "description": "A single key or a list of keys to remove from settin gs."
1111 },
1112 {
1113 "name": "callback",
1114 "type": "function",
1115 "description": "Callback on success, or on failure (in which case la stError will be set).",
1116 "parameters": [],
1117 "optional": true
1118 }
1119 ]
1120 },
1121 {
1122 "name": "clear",
1123 "unprivileged": true,
1124 "type": "function",
1125 "description": "Removes all values from settings.",
1126 "parameters": [
1127 {
1128 "name": "callback",
1129 "type": "function",
1130 "description": "Callback on success, or on failure (in which case la stError will be set).",
1131 "parameters": [],
1132 "optional": true
1133 }
1134 ]
1135 } 1139 }
1136 ], 1140 ],
1137 "events": [ 1141 "events": [
1138 { 1142 {
1139 "name": "onChanged", 1143 "name": "onChanged",
1140 "unprivileged": true, 1144 "unprivileged": true,
1141 "type": "function", 1145 "type": "function",
1142 "description": "Fired when one or more settings change.", 1146 "description": "Fired when one or more settings change.",
1143 "parameters": [ 1147 "parameters": [
1144 { 1148 {
1145 "name": "changes", 1149 "name": "changes",
1146 "type": "array", 1150 "type": "array",
1147 "items": {"$ref": "SettingChange"} 1151 "items": {"$ref": "SettingChange"}
1152 },
1153 {
1154 "name": "namespace",
1155 "type": "string",
1156 "description": "The namespace (e.g. sync or local) of the area the c hanges are for."
1148 } 1157 }
1149 ] 1158 ]
1150 } 1159 }
1151 ] 1160 ],
1161 "properties": {
1162 "sync": {
1163 "$ref": "StorageNamespace",
1164 "description": "Settings under the \"sync\" namespace are synced using C hrome Sync.",
1165 "value": [ "sync" ]
1166 },
1167 "local": {
1168 "$ref": "StorageNamespace",
1169 "description": "Settings under the \"local\" namespace are local to each browser.",
Matt Perry 2011/11/23 03:35:05 "local to each machine"?
not at google - send to devlin 2011/11/23 11:04:52 Done.
1170 "value": [ "local" ]
1171 }
1172 }
1152 }, 1173 },
1153 { 1174 {
1154 "namespace": "windows", 1175 "namespace": "windows",
1155 "types": [ 1176 "types": [
1156 { 1177 {
1157 "id": "Window", 1178 "id": "Window",
1158 "type": "object", 1179 "type": "object",
1159 "properties": { 1180 "properties": {
1160 "id": {"type": "integer", "minimum": 0, "description": "The ID of the window. Window IDs are unique within a browser session."}, 1181 "id": {"type": "integer", "minimum": 0, "description": "The ID of the window. Window IDs are unique within a browser session."},
1161 "focused": {"type": "boolean", "description": "Whether the window is c urrently the focused window."}, 1182 "focused": {"type": "boolean", "description": "Whether the window is c urrently the focused window."},
(...skipping 8073 matching lines...) Expand 10 before | Expand all | Expand 10 after
9235 } 9256 }
9236 } 9257 }
9237 } 9258 }
9238 ] 9259 ]
9239 } 9260 }
9240 ] 9261 ]
9241 } 9262 }
9242 ] 9263 ]
9243 } 9264 }
9244 ] 9265 ]
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698