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

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

Issue 8540012: Enable extension APIs for content scripts. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: rebase 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 "unprivileged": true,
5 "types": [ 4 "types": [
6 { 5 {
7 "id": "MessageSender", 6 "id": "MessageSender",
8 "type": "object", 7 "type": "object",
9 "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.",
10 "properties": { 9 "properties": {
11 "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."},
12 "id": {"type": "string", "description": "The extension ID of the exten sion that opened the connection."} 11 "id": {"type": "string", "description": "The extension ID of the exten sion that opened the connection."}
13 } 12 }
14 }, 13 },
(...skipping 1005 matching lines...) Expand 10 before | Expand all | Expand 10 after
1020 "type": "any", 1019 "type": "any",
1021 "description": "The new value of the setting.", 1020 "description": "The new value of the setting.",
1022 "optional": true 1021 "optional": true
1023 } 1022 }
1024 } 1023 }
1025 } 1024 }
1026 ], 1025 ],
1027 "functions": [ 1026 "functions": [
1028 { 1027 {
1029 "name": "get", 1028 "name": "get",
1029 "unprivileged": true,
1030 "type": "function", 1030 "type": "function",
1031 "description": "Gets one or more values from settings.", 1031 "description": "Gets one or more values from settings.",
1032 "parameters": [ 1032 "parameters": [
1033 { 1033 {
1034 "name": "keys", 1034 "name": "keys",
1035 "choices": [ 1035 "choices": [
1036 { "type": "string" }, 1036 { "type": "string" },
1037 { "type": "array", "items": { "type": "string" } }, 1037 { "type": "array", "items": { "type": "string" } },
1038 { 1038 {
1039 "type": "object", 1039 "type": "object",
(...skipping 16 matching lines...) Expand all
1056 "properties": {}, 1056 "properties": {},
1057 "additionalProperties": { "type": "any" }, 1057 "additionalProperties": { "type": "any" },
1058 "description": "Object with given keys set to settings values." 1058 "description": "Object with given keys set to settings values."
1059 } 1059 }
1060 ] 1060 ]
1061 } 1061 }
1062 ] 1062 ]
1063 }, 1063 },
1064 { 1064 {
1065 "name": "set", 1065 "name": "set",
1066 "unprivileged": true,
1066 "type": "function", 1067 "type": "function",
1067 "description": "Sets multiple settings values.", 1068 "description": "Sets multiple settings values.",
1068 "parameters": [ 1069 "parameters": [
1069 { 1070 {
1070 "name": "settings", 1071 "name": "settings",
1071 "type": "object", 1072 "type": "object",
1072 "properties": {}, 1073 "properties": {},
1073 "additionalProperties": { "type": "any" }, 1074 "additionalProperties": { "type": "any" },
1074 "description": "Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored." 1075 "description": "Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored."
1075 }, 1076 },
1076 { 1077 {
1077 "name": "callback", 1078 "name": "callback",
1078 "type": "function", 1079 "type": "function",
1079 "description": "Callback on success, or on failure (in which case la stError will be set).", 1080 "description": "Callback on success, or on failure (in which case la stError will be set).",
1080 "parameters": [], 1081 "parameters": [],
1081 "optional": true 1082 "optional": true
1082 } 1083 }
1083 ] 1084 ]
1084 }, 1085 },
1085 { 1086 {
1086 "name": "remove", 1087 "name": "remove",
1088 "unprivileged": true,
1087 "type": "function", 1089 "type": "function",
1088 "description": "Removes one or more values from settings.", 1090 "description": "Removes one or more values from settings.",
1089 "parameters": [ 1091 "parameters": [
1090 { 1092 {
1091 "name": "keys", 1093 "name": "keys",
1092 "choices": [ 1094 "choices": [
1093 {"type": "string"}, 1095 {"type": "string"},
1094 {"type": "array", "items": {"type": "string"}, "minItems": 1} 1096 {"type": "array", "items": {"type": "string"}, "minItems": 1}
1095 ], 1097 ],
1096 "description": "A single key or a list of keys to remove from settin gs." 1098 "description": "A single key or a list of keys to remove from settin gs."
1097 }, 1099 },
1098 { 1100 {
1099 "name": "callback", 1101 "name": "callback",
1100 "type": "function", 1102 "type": "function",
1101 "description": "Callback on success, or on failure (in which case la stError will be set).", 1103 "description": "Callback on success, or on failure (in which case la stError will be set).",
1102 "parameters": [], 1104 "parameters": [],
1103 "optional": true 1105 "optional": true
1104 } 1106 }
1105 ] 1107 ]
1106 }, 1108 },
1107 { 1109 {
1108 "name": "clear", 1110 "name": "clear",
1111 "unprivileged": true,
1109 "type": "function", 1112 "type": "function",
1110 "description": "Removes all values from settings.", 1113 "description": "Removes all values from settings.",
1111 "parameters": [ 1114 "parameters": [
1112 { 1115 {
1113 "name": "callback", 1116 "name": "callback",
1114 "type": "function", 1117 "type": "function",
1115 "description": "Callback on success, or on failure (in which case la stError will be set).", 1118 "description": "Callback on success, or on failure (in which case la stError will be set).",
1116 "parameters": [], 1119 "parameters": [],
1117 "optional": true 1120 "optional": true
1118 } 1121 }
1119 ] 1122 ]
1120 } 1123 }
1121 ], 1124 ],
1122 "events": [ 1125 "events": [
1123 { 1126 {
1124 "name": "onChanged", 1127 "name": "onChanged",
1128 "unprivileged": true,
1125 "type": "function", 1129 "type": "function",
1126 "description": "Fired when one or more settings change.", 1130 "description": "Fired when one or more settings change.",
1127 "parameters": [ 1131 "parameters": [
1128 { 1132 {
1129 "name": "changes", 1133 "name": "changes",
1130 "type": "array", 1134 "type": "array",
1131 "items": {"$ref": "SettingChange"} 1135 "items": {"$ref": "SettingChange"}
1132 } 1136 }
1133 ] 1137 ]
1134 } 1138 }
(...skipping 241 matching lines...) Expand 10 before | Expand all | Expand 10 after
1376 "optional": true, 1380 "optional": true,
1377 "description": "List of origin permissions." 1381 "description": "List of origin permissions."
1378 } 1382 }
1379 } 1383 }
1380 } 1384 }
1381 ], 1385 ],
1382 "events": [ 1386 "events": [
1383 { 1387 {
1384 "name": "onAdded", 1388 "name": "onAdded",
1385 "type": "function", 1389 "type": "function",
1386 "unprivileged": true,
1387 "description": "Fired when the extension acquires new permissions.", 1390 "description": "Fired when the extension acquires new permissions.",
1388 "parameters": [ 1391 "parameters": [
1389 { 1392 {
1390 "$ref": "Permissions", 1393 "$ref": "Permissions",
1391 "name": "permissions", 1394 "name": "permissions",
1392 "description": "The newly acquired permissions." 1395 "description": "The newly acquired permissions."
1393 } 1396 }
1394 ] 1397 ]
1395 }, 1398 },
1396 { 1399 {
1397 "name": "onRemoved", 1400 "name": "onRemoved",
1398 "type": "function", 1401 "type": "function",
1399 "unprivileged": true,
1400 "description": "Fired when access to permissions has been removed from t he extension.", 1402 "description": "Fired when access to permissions has been removed from t he extension.",
1401 "parameters": [ 1403 "parameters": [
1402 { 1404 {
1403 "$ref": "Permissions", 1405 "$ref": "Permissions",
1404 "name": "permissions", 1406 "name": "permissions",
1405 "description": "The permissions that have been removed." 1407 "description": "The permissions that have been removed."
1406 } 1408 }
1407 ] 1409 ]
1408 } 1410 }
1409 ], 1411 ],
1410 "functions": [ 1412 "functions": [
1411 { 1413 {
1412 "name": "getAll", 1414 "name": "getAll",
1413 "type": "function", 1415 "type": "function",
1414 "unprivileged": true,
1415 "description": "Gets the extension's current set of permissions.", 1416 "description": "Gets the extension's current set of permissions.",
1416 "parameters": [ 1417 "parameters": [
1417 { 1418 {
1418 "name": "callback", 1419 "name": "callback",
1419 "type": "function", 1420 "type": "function",
1420 "parameters": [ 1421 "parameters": [
1421 { 1422 {
1422 "name": "permissions", 1423 "name": "permissions",
1423 "$ref": "Permissions", 1424 "$ref": "Permissions",
1424 "description": "The extension's active permissions." 1425 "description": "The extension's active permissions."
1425 } 1426 }
1426 ] 1427 ]
1427 } 1428 }
1428 ] 1429 ]
1429 }, 1430 },
1430 { 1431 {
1431 "name": "contains", 1432 "name": "contains",
1432 "type": "function", 1433 "type": "function",
1433 "unprivileged": true,
1434 "description": "Checks if the extension has the specified permissions.", 1434 "description": "Checks if the extension has the specified permissions.",
1435 "parameters": [ 1435 "parameters": [
1436 { 1436 {
1437 "name": "permissions", 1437 "name": "permissions",
1438 "$ref": "Permissions" 1438 "$ref": "Permissions"
1439 }, 1439 },
1440 { 1440 {
1441 "name": "callback", 1441 "name": "callback",
1442 "type": "function", 1442 "type": "function",
1443 "parameters": [ 1443 "parameters": [
1444 { 1444 {
1445 "name": "result", 1445 "name": "result",
1446 "type": "boolean", 1446 "type": "boolean",
1447 "description": "True if the extension has the specified permissi ons." 1447 "description": "True if the extension has the specified permissi ons."
1448 } 1448 }
1449 ] 1449 ]
1450 } 1450 }
1451 ] 1451 ]
1452 }, 1452 },
1453 { 1453 {
1454 "name": "request", 1454 "name": "request",
1455 "type": "function", 1455 "type": "function",
1456 "unprivileged": true,
1457 "description": "Requests access to the specified permissions. These perm issions must be defined in the optional_permissions field of the manifest. If th ere are any problems requesting the permissions, <a href='extension.html#propert y-lastError'>chrome.extension.lastError</a> will be set.", 1456 "description": "Requests access to the specified permissions. These perm issions must be defined in the optional_permissions field of the manifest. If th ere are any problems requesting the permissions, <a href='extension.html#propert y-lastError'>chrome.extension.lastError</a> will be set.",
1458 "parameters": [ 1457 "parameters": [
1459 { 1458 {
1460 "name": "permissions", 1459 "name": "permissions",
1461 "$ref": "Permissions" 1460 "$ref": "Permissions"
1462 }, 1461 },
1463 { 1462 {
1464 "name": "callback", 1463 "name": "callback",
1465 "type": "function", 1464 "type": "function",
1466 "optional": true, 1465 "optional": true,
1467 "parameters": [ 1466 "parameters": [
1468 { 1467 {
1469 "name": "granted", 1468 "name": "granted",
1470 "type": "boolean", 1469 "type": "boolean",
1471 "description": "True if the user granted the specified permissio ns." 1470 "description": "True if the user granted the specified permissio ns."
1472 } 1471 }
1473 ] 1472 ]
1474 } 1473 }
1475 ] 1474 ]
1476 }, 1475 },
1477 { 1476 {
1478 "name": "remove", 1477 "name": "remove",
1479 "type": "function", 1478 "type": "function",
1480 "unprivileged": true,
1481 "description": "Removes access to the specified permissions. If there ar e any problems removing the permissions, <a href='extension.html#property-lastEr ror'>chrome.extension.lastError</a> will be set.", 1479 "description": "Removes access to the specified permissions. If there ar e any problems removing the permissions, <a href='extension.html#property-lastEr ror'>chrome.extension.lastError</a> will be set.",
1482 "parameters": [ 1480 "parameters": [
1483 { 1481 {
1484 "name": "permissions", 1482 "name": "permissions",
1485 "$ref": "Permissions" 1483 "$ref": "Permissions"
1486 }, 1484 },
1487 { 1485 {
1488 "name": "callback", 1486 "name": "callback",
1489 "type": "function", 1487 "type": "function",
1490 "optional": true, 1488 "optional": true,
(...skipping 1637 matching lines...) Expand 10 before | Expand all | Expand 10 after
3128 "name": "newState", 3126 "name": "newState",
3129 "type": "string", 3127 "type": "string",
3130 "enum": ["active"] 3128 "enum": ["active"]
3131 } 3129 }
3132 ] 3130 ]
3133 } 3131 }
3134 ] 3132 ]
3135 }, 3133 },
3136 { 3134 {
3137 "namespace": "i18n", 3135 "namespace": "i18n",
3138 "unprivileged": true,
3139 "types": [], 3136 "types": [],
3140 "functions": [ 3137 "functions": [
3141 { 3138 {
3142 "name": "getAcceptLanguages", 3139 "name": "getAcceptLanguages",
3143 "type": "function", 3140 "type": "function",
3144 "description": "Gets the accept-languages of the browser. This is differ ent from the locale used by the browser; to get the locale, use <code>window.nav igator.language</code>.", 3141 "description": "Gets the accept-languages of the browser. This is differ ent from the locale used by the browser; to get the locale, use <code>window.nav igator.language</code>.",
3145 "parameters": [ 3142 "parameters": [
3146 { 3143 {
3147 "type": "function", 3144 "type": "function",
3148 "name": "callback", 3145 "name": "callback",
(...skipping 1111 matching lines...) Expand 10 before | Expand all | Expand 10 after
4260 } 4257 }
4261 ] 4258 ]
4262 }, 4259 },
4263 { 4260 {
4264 "namespace": "experimental.downloads", 4261 "namespace": "experimental.downloads",
4265 "nodoc": "true", 4262 "nodoc": "true",
4266 "events": [ 4263 "events": [
4267 { 4264 {
4268 "name": "onCreated", 4265 "name": "onCreated",
4269 "type": "function", 4266 "type": "function",
4270 "unprivileged": true,
4271 "description": "This event fires with the DownloadItem object when a dow nload begins.", 4267 "description": "This event fires with the DownloadItem object when a dow nload begins.",
4272 "parameters": [ 4268 "parameters": [
4273 {"$ref": "DownloadItem"} 4269 {"$ref": "DownloadItem"}
4274 ] 4270 ]
4275 }, 4271 },
4276 { 4272 {
4277 "name": "onChanged", 4273 "name": "onChanged",
4278 "type": "function", 4274 "type": "function",
4279 "unprivileged": true,
4280 "description": "When any of a DownloadItem's properties except |bytesRec eived| changes, this event fires with the download id and an object containing t he properties that changed.", 4275 "description": "When any of a DownloadItem's properties except |bytesRec eived| changes, this event fires with the download id and an object containing t he properties that changed.",
4281 "parameters": [ 4276 "parameters": [
4282 {"$ref": "DownloadDelta"} 4277 {"$ref": "DownloadDelta"}
4283 ] 4278 ]
4284 }, 4279 },
4285 { 4280 {
4286 "name": "onErased", 4281 "name": "onErased",
4287 "type": "function", 4282 "type": "function",
4288 "unprivileged": true,
4289 "description": "Fires with the download id when a download is erased fro m history.", 4283 "description": "Fires with the download id when a download is erased fro m history.",
4290 "parameters": [ 4284 "parameters": [
4291 {"type": "integer", "name": "downloadId"} 4285 {"type": "integer", "name": "downloadId"}
4292 ] 4286 ]
4293 } 4287 }
4294 ], 4288 ],
4295 "properties": { 4289 "properties": {
4296 "STATE_IN_PROGRESS": { 4290 "STATE_IN_PROGRESS": {
4297 "type": "string", 4291 "type": "string",
4298 "value": "in_progress", 4292 "value": "in_progress",
(...skipping 947 matching lines...) Expand 10 before | Expand all | Expand 10 after
5246 "type": "function", 5240 "type": "function",
5247 "description": "Records an elapsed time of no more than 1 hour. The sam ple value is specified in milliseconds.", 5241 "description": "Records an elapsed time of no more than 1 hour. The sam ple value is specified in milliseconds.",
5248 "parameters": [ 5242 "parameters": [
5249 {"name": "metricName", "type": "string"}, 5243 {"name": "metricName", "type": "string"},
5250 {"name": "value", "type": "integer"} 5244 {"name": "value", "type": "integer"}
5251 ] 5245 ]
5252 }, 5246 },
5253 { 5247 {
5254 "name": "recordValue", 5248 "name": "recordValue",
5255 "type": "function", 5249 "type": "function",
5256 "unprivileged": true,
5257 "description": "Adds a value to the given metric.", 5250 "description": "Adds a value to the given metric.",
5258 "parameters": [ 5251 "parameters": [
5259 {"name": "metric", "$ref": "MetricType"}, 5252 {"name": "metric", "$ref": "MetricType"},
5260 {"name": "value", "type": "integer"} 5253 {"name": "value", "type": "integer"}
5261 ] 5254 ]
5262 } 5255 }
5263 ], 5256 ],
5264 "events": [] 5257 "events": []
5265 }, 5258 },
5266 { 5259 {
(...skipping 1071 matching lines...) Expand 10 before | Expand all | Expand 10 after
6338 } 6331 }
6339 } 6332 }
6340 } 6333 }
6341 } 6334 }
6342 ] 6335 ]
6343 } 6336 }
6344 ] 6337 ]
6345 }, 6338 },
6346 { 6339 {
6347 "name": "notifyFail", 6340 "name": "notifyFail",
6341 "unprivileged": true,
6348 "type": "function", 6342 "type": "function",
6349 "description": "Notifies the browser process that test code running in t he extension failed. This is only used for internal unit testing.", 6343 "description": "Notifies the browser process that test code running in t he extension failed. This is only used for internal unit testing.",
6350 "parameters": [ 6344 "parameters": [
6351 {"type": "string", "name": "message"} 6345 {"type": "string", "name": "message"}
6352 ] 6346 ]
6353 }, 6347 },
6354 { 6348 {
6355 "name": "notifyPass", 6349 "name": "notifyPass",
6350 "unprivileged": true,
6356 "type": "function", 6351 "type": "function",
6357 "description": "Notifies the browser process that test code running in t he extension passed. This is only used for internal unit testing.", 6352 "description": "Notifies the browser process that test code running in t he extension passed. This is only used for internal unit testing.",
6358 "parameters": [ 6353 "parameters": [
6359 {"type": "string", "name": "message", "optional": true} 6354 {"type": "string", "name": "message", "optional": true}
6360 ] 6355 ]
6361 }, 6356 },
6362 { 6357 {
6363 "name": "resetQuota", 6358 "name": "resetQuota",
6364 "type": "function", 6359 "type": "function",
6365 "description": "Resets all accumulated quota state for all extensions. This is only used for internal unit testing.", 6360 "description": "Resets all accumulated quota state for all extensions. This is only used for internal unit testing.",
(...skipping 355 matching lines...) Expand 10 before | Expand all | Expand 10 after
6721 "description": "The sidebar's title. It is displayed in a toolti p over the sidebar's mini tab." 6716 "description": "The sidebar's title. It is displayed in a toolti p over the sidebar's mini tab."
6722 } 6717 }
6723 } 6718 }
6724 } 6719 }
6725 ] 6720 ]
6726 } 6721 }
6727 ], 6722 ],
6728 "events": [ 6723 "events": [
6729 { 6724 {
6730 "name": "onStateChanged", 6725 "name": "onStateChanged",
6731 "unprivileged": true,
6732 "type": "function", 6726 "type": "function",
6733 "description": "Notifies about sidebar state changes.", 6727 "description": "Notifies about sidebar state changes.",
6734 "parameters": [ 6728 "parameters": [
6735 { 6729 {
6736 "type": "object", 6730 "type": "object",
6737 "name": "details", 6731 "name": "details",
6738 "properties": { 6732 "properties": {
6739 "tabId": { 6733 "tabId": {
6740 "type": "integer", 6734 "type": "integer",
6741 "minimum": 0 6735 "minimum": 0
(...skipping 2472 matching lines...) Expand 10 before | Expand all | Expand 10 after
9214 } 9208 }
9215 } 9209 }
9216 } 9210 }
9217 ] 9211 ]
9218 } 9212 }
9219 ] 9213 ]
9220 } 9214 }
9221 ] 9215 ]
9222 } 9216 }
9223 ] 9217 ]
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.cc ('k') | chrome/common/extensions/api/extension_api_unittest.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698