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

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

Issue 8352042: Update contentSettings extension API docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 2 months 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, 4 "unprivileged": true,
5 "types": [ 5 "types": [
6 { 6 {
7 "id": "MessageSender", 7 "id": "MessageSender",
8 "type": "object", 8 "type": "object",
9 "description": "An object containing information about the script contex t that sent a message or request.", 9 "description": "An object containing information about the script contex t that sent a message or request.",
10 "properties": { 10 "properties": {
(...skipping 8158 matching lines...) Expand 10 before | Expand all | Expand 10 after
8169 }, 8169 },
8170 { 8170 {
8171 "namespace": "contentSettings", 8171 "namespace": "contentSettings",
8172 "types": [ 8172 "types": [
8173 { 8173 {
8174 "id": "ResourceIdentifier", 8174 "id": "ResourceIdentifier",
8175 "type": "object", 8175 "type": "object",
8176 "properties": { 8176 "properties": {
8177 "id": { 8177 "id": {
8178 "type": "string", 8178 "type": "string",
8179 "description": "The resource identifier for the given content type." 8179 "description": "The resource identifier for the given content type."
battre 2011/10/20 22:32:12 Do you want to state whether these IDs are stable
Bernhard Bauer 2011/10/21 14:04:18 Done (in static/).
8180 }, 8180 },
8181 "description": { 8181 "description": {
8182 "type": "string", 8182 "type": "string",
8183 "optional": true, 8183 "optional": true,
8184 "description": "A human readable description of the resource." 8184 "description": "A human readable description of the resource."
8185 } 8185 }
8186 }, 8186 },
8187 "description": "The only content type using resource identifiers is <var >plugins</var>. Using a resource identifier allows an extension to specify conte nt settings applying only to a specific plug-in. If no rule for the specific plu g-in is found, the rules without resource identifiers are applied." 8187 "description": "The only content type using resource identifiers is <a h ref=\"contentSettings.html#property-plugins\"><var>plugins</var></a>. For more i nformation, see <a href=\"contentSettings.html#resource-identifiers\">Resource I dentifiers.</a>"
battre 2011/10/20 22:32:12 nit end with </a>." (move period)
battre 2011/10/20 22:32:12 #resource-identifiers is not a valid anchor
Bernhard Bauer 2011/10/21 14:04:18 Done.
Bernhard Bauer 2011/10/21 14:04:18 fixed.
8188 }, 8188 },
8189 { 8189 {
8190 "id": "ContentSetting", 8190 "id": "ContentSetting",
8191 "type": "object", 8191 "type": "object",
8192 "functions": [ 8192 "functions": [
8193 { 8193 {
8194 "name": "clear", 8194 "name": "clear",
8195 "type": "function", 8195 "type": "function",
8196 "description": "Clear all content setting rules set by this extensio n.", 8196 "description": "Clear all content setting rules set by this extensio n.",
8197 "parameters": [ 8197 "parameters": [
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
8267 "name": "set", 8267 "name": "set",
8268 "type": "function", 8268 "type": "function",
8269 "description": "Applies a new content setting rule.", 8269 "description": "Applies a new content setting rule.",
8270 "parameters": [ 8270 "parameters": [
8271 { 8271 {
8272 "name": "details", 8272 "name": "details",
8273 "type": "object", 8273 "type": "object",
8274 "properties": { 8274 "properties": {
8275 "primaryPattern": { 8275 "primaryPattern": {
8276 "type": "string", 8276 "type": "string",
8277 "description": "The pattern for the primary URL. For details on the format of a pattern, see <a href='match_patterns.html'>Match Patterns</a >." 8277 "description": "The pattern for the primary URL. For details on the format of a pattern, see <a href='contentSettings.html#patterns'>Content Setting Patterns</a>."
8278 }, 8278 },
8279 "secondaryPattern": { 8279 "secondaryPattern": {
8280 "type": "string", 8280 "type": "string",
8281 "description": "The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see <a href='match _patterns.html'>Match Patterns</a>.", 8281 "description": "The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see <a href='conte ntSettings.html#patterns'>Content Setting Patterns</a>.",
8282 "optional": true 8282 "optional": true
8283 }, 8283 },
8284 "resourceIdentifier": { 8284 "resourceIdentifier": {
8285 "$ref": "ResourceIdentifier", 8285 "$ref": "ResourceIdentifier",
8286 "optional": true, 8286 "optional": true,
8287 "description": "The resource identifier for the content type ." 8287 "description": "The resource identifier for the content type ."
8288 }, 8288 },
8289 "setting": { 8289 "setting": {
8290 "type": "any", 8290 "type": "any",
8291 "description": "The setting applied by this rule. See the de scription of the individual ContentSetting objects for the possible values." 8291 "description": "The setting applied by this rule. See the de scription of the individual ContentSetting objects for the possible values."
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
8326 ] 8326 ]
8327 } 8327 }
8328 ] 8328 ]
8329 } 8329 }
8330 ] 8330 ]
8331 } 8331 }
8332 ], 8332 ],
8333 "properties": { 8333 "properties": {
8334 "cookies": { 8334 "cookies": {
8335 "$ref": "ContentSetting", 8335 "$ref": "ContentSetting",
8336 "description": "Whether to allow cookies and other local data to be set by websites. One of<br><var>allow</var>: Accept cookies,<br><var>block</var>: Bl ock cookies,<br><var>session_only</var>: Accept cookies only for the current ses sion. Default is <var>allow</var>.<br>The primary URL is the URL representing th e cookie origin. The secondary URL is the URL of the top-level frame.", 8336 "description": "Whether to allow cookies and other local data to be set by websites. One of<br><var>allow</var>: Accept cookies,<br><var>block</var>: Bl ock cookies,<br><var>session_only</var>: Accept cookies only for the current ses sion. Default is <var>allow</var>.<br>The primary URL is the URL representing th e cookie origin. The secondary URL is the URL of the top-level frame.",
battre 2011/10/20 22:32:12 <br> before "Default is..." also in other occurren
Bernhard Bauer 2011/10/21 14:04:18 Done.
8337 "value": [ 8337 "value": [
8338 "cookies", 8338 "cookies",
8339 {"type":"string", "enum": ["allow", "block", "session_only"]} 8339 {"type":"string", "enum": ["allow", "block", "session_only"]}
8340 ] 8340 ]
8341 }, 8341 },
8342 "images": { 8342 "images": {
8343 "$ref": "ContentSetting", 8343 "$ref": "ContentSetting",
8344 "description": "Whether to show images. One of<br><var>allow</var>: Show images,<br><var>block</var>: Don't show images. Default is <var>allow</var>.<br >The primary URL is the main-frame URL. The secondary URL is not used.", 8344 "description": "Whether to show images. One of<br><var>allow</var>: Show images,<br><var>block</var>: Don't show images. Default is <var>allow</var>.<br >The primary URL is the main-frame URL. The secondary URL is not used.",
battre 2011/10/20 22:32:12 Whether to *display*? (also other occurrences in t
Bernhard Bauer 2011/10/21 14:04:18 I'm using the same wording as in chrome://settings
8345 "value": [ 8345 "value": [
8346 "images", 8346 "images",
8347 {"type":"string", "enum": ["allow", "block"]} 8347 {"type":"string", "enum": ["allow", "block"]}
8348 ] 8348 ]
8349 }, 8349 },
8350 "javascript": { 8350 "javascript": {
8351 "$ref": "ContentSetting", 8351 "$ref": "ContentSetting",
8352 "description": "Whether to run Javascript. One of<br><var>allow</var>: R un Javascript,<br><var>block</var>: Don't run Javascript. Default is <var>allow< /var>.<br>The primary URL is the main-frame URL. The secondary URL is not used." , 8352 "description": "Whether to run Javascript. One of<br><var>allow</var>: R un Javascript,<br><var>block</var>: Don't run Javascript. Default is <var>allow< /var>.<br>The primary URL is the main-frame URL. The secondary URL is not used." ,
battre 2011/10/20 22:32:12 Whether to *execute* Java*S*cript (also other occu
Bernhard Bauer 2011/10/21 14:04:18 Changed capitalization of JavaScript. Kept the "ex
8353 "value": [ 8353 "value": [
8354 "javascript", 8354 "javascript",
8355 {"type":"string", "enum": ["allow", "block"]} 8355 {"type":"string", "enum": ["allow", "block"]}
8356 ] 8356 ]
8357 }, 8357 },
8358 "plugins": { 8358 "plugins": {
8359 "$ref": "ContentSetting", 8359 "$ref": "ContentSetting",
8360 "description": "Whether to run plug-ins. One of<br><var>allow</var>: Run plug-ins automatically,<br><var>block</var>: Don't run plug-ins automatically. Default is <var>allow</var>.<br>The primary URL is the main-frame URL. The secon dary URL is not used.", 8360 "description": "Whether to run plug-ins. One of<br><var>allow</var>: Run plug-ins automatically,<br><var>block</var>: Don't run plug-ins automatically. Default is <var>allow</var>.<br>The primary URL is the main-frame URL. The secon dary URL is not used.",
8361 "value": [ 8361 "value": [
8362 "plugins", 8362 "plugins",
(...skipping 712 matching lines...) Expand 10 before | Expand all | Expand 10 after
9075 "type": "array", 9075 "type": "array",
9076 "items": { "$ref": "mimeTypeEnum" } 9076 "items": { "$ref": "mimeTypeEnum" }
9077 } 9077 }
9078 ] 9078 ]
9079 } 9079 }
9080 ] 9080 ]
9081 } 9081 }
9082 ] 9082 ]
9083 } 9083 }
9084 ] 9084 ]
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698