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

Unified Diff: chrome/common/extensions/api/web_navigation.json

Issue 10855015: Add documentation for filtered events. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: rebase again Created 8 years, 4 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | chrome/common/extensions/docs/apps/events.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/api/web_navigation.json
diff --git a/chrome/common/extensions/api/web_navigation.json b/chrome/common/extensions/api/web_navigation.json
index de0a45838c55fbf49e82e845a762b9da58a1bdc8..8d7cf34806f94ac931ae5d85250a47a215709c41 100644
--- a/chrome/common/extensions/api/web_navigation.json
+++ b/chrome/common/extensions/api/web_navigation.json
@@ -96,11 +96,14 @@
"name": "onBeforeNavigate",
"type": "function",
"description": "Fired when a navigation is about to occur.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -119,11 +122,14 @@
"name": "onCommitted",
"type": "function",
"description": "Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the browser has decided to switch to the new document.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -144,11 +150,14 @@
"name": "onDOMContentLoaded",
"type": "function",
"description": "Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -167,11 +176,14 @@
"name": "onCompleted",
"type": "function",
"description": "Fired when a document, including the resources it refers to, is completely loaded and initialized.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -190,11 +202,14 @@
"name": "onErrorOccurred",
"type": "function",
"description": "Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -214,11 +229,14 @@
"name": "onCreatedNavigationTarget",
"type": "function",
"description": "Fired when a new window, or a new tab in an existing window, is created to host a navigation.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -238,11 +256,14 @@
"name": "onReferenceFragmentUpdated",
"type": "function",
"description": "Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
@@ -263,11 +284,6 @@
"name": "onTabReplaced",
"type": "function",
"description": "Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.",
- "options": {
- "supportsFilters": false,
- "supportsListeners": true,
- "supportsRules": false
- },
"parameters": [
{
"type": "object",
@@ -284,11 +300,14 @@
"name": "onHistoryStateUpdated",
"type": "function",
"description": "Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.",
- "options": {
- "supportsFilters": true,
- "supportsListeners": true,
- "supportsRules": false
- },
+ "filters": [
+ {
+ "name": "url",
+ "type": "array",
+ "items": { "$ref": "events.UrlFilter" },
+ "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event."
+ }
+ ],
"parameters": [
{
"type": "object",
« no previous file with comments | « no previous file | chrome/common/extensions/docs/apps/events.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698