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

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

Issue 3061041: Add the definition of the webRequest and webNavigation APIs. (Closed)
Patch Set: updates Created 10 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 unified diff | Download patch
« no previous file with comments | « chrome/chrome_tests.gypi ('k') | chrome/common/extensions/docs/experimental.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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 2972 matching lines...) Expand 10 before | Expand all | Expand 10 after
2983 "description": "Clears all product-specific RLZ state from the machine, as well as clearing all events for the specified access points.", 2983 "description": "Clears all product-specific RLZ state from the machine, as well as clearing all events for the specified access points.",
2984 "parameters": [ 2984 "parameters": [
2985 {"name": "product", "type": "string", "minLength": 1, "maxLength": 1}, 2985 {"name": "product", "type": "string", "minLength": 1, "maxLength": 1},
2986 {"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1} 2986 {"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1}
2987 ] 2987 ]
2988 } 2988 }
2989 ], 2989 ],
2990 "events": [] 2990 "events": []
2991 }, 2991 },
2992 { 2992 {
2993 "namespace": "experimental.webNavigation",
2994 "types": [],
2995 "functions": [],
2996 "events": [
2997 {
2998 "name": "onBeforeNavigate",
2999 "type": "function",
3000 "description": "Fires when a navigation is about to occur.",
3001 "parameters": [
3002 {
3003 "type": "object",
3004 "name": "details",
3005 "properties": {
3006 "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation is about to occur."},
3007 "url": {"type": "string"},
3008 "frameId": {"type": "integer", "description": "0 indicates the nav igation happens in the tab content window; positive value indicates navigation i n a subframe. Frame IDs are unique within a tab."},
3009 "requestId": {"type": "integer", "description": "The ID of the req uest to retrieve the document of this navigation. Note that this event is fired prior to the corresponding chrome.experimental.webRequest.onBeforeRequest."},
3010 "timeStamp": {"type": "number", "description": "The time when the browser was about to start the navigation, in milliseconds since the epoch."}
3011 }
3012 }
3013 ]
3014 },
3015 {
3016 "name": "onCommitted",
3017 "type": "function",
3018 "description": "Fires when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloa ding, but at least part of the document has been received from the server and th e browser has decided to switch to the new document.",
3019 "parameters": [
3020 {
3021 "type": "object",
3022 "name": "details",
3023 "properties": {
3024 "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
3025 "url": {"type": "string"},
3026 "frameId": {"type": "integer", "description": "0 indicates the nav igation happens in the tab content window; positive value indicates navigation i n a subframe."},
3027 "transitionType": {"type": "string", "enum": ["link", "user_browse r", "redirect_meta_refresh", "redirect_onload", "forward_back", "redirect_javasc ript", "new_window", "reload", "other"], "description": "Cause of the navigation . Set to null for subframe navigations."},
3028 "timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."}
3029 }
3030 }
3031 ]
3032 },
3033 {
3034 "name": "onDOMContentLoaded",
3035 "type": "function",
3036 "description": "Fires when the page's DOM is fully constructed, but the referenced resources may not finish loading.",
3037 "parameters": [
3038 {
3039 "type": "object",
3040 "name": "details",
3041 "properties": {
3042 "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
3043 "url": {"type": "string"},
3044 "frameId": {"type": "integer", "description": "0 indicates the nav igation happens in the tab content window; positive value indicates navigation i n a subframe."},
3045 "timeStamp": {"type": "number", "description": "The time when the page's DOM was fully constructed, in milliseconds since the epoch."}
3046 }
3047 }
3048 ]
3049 },
3050 {
3051 "name": "onCompleted",
3052 "type": "function",
3053 "description": "Fires when a document, including the resources it refers to, is completely loaded and initialized.",
3054 "parameters": [
3055 {
3056 "type": "object",
3057 "name": "details",
3058 "properties": {
3059 "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
3060 "url": {"type": "string"},
3061 "frameId": {"type": "integer", "description": "0 indicates the nav igation happens in the tab content window; positive value indicates navigation i n a subframe."},
3062 "timeStamp": {"type": "number", "description": "The time when the document finished loading, in milliseconds since the epoch."}
3063 }
3064 }
3065 ]
3066 },
3067 {
3068 "name": "onErrorOccurred",
3069 "type": "function",
3070 "description": "Fires when an error occurs.",
3071 "parameters": [
3072 {
3073 "type": "object",
3074 "name": "details",
3075 "properties": {
3076 "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
3077 "url": {"type": "string"},
3078 "frameId": {"type": "integer", "description": "0 indicates the nav igation happens in the tab content window; positive value indicates navigation i n a subframe."},
3079 "error": {"type": "string", "description": "The error description. "},
3080 "timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."}
3081 }
3082 }
3083 ]
3084 },
3085 {
3086 "name": "onBeforeRetarget",
3087 "type": "function",
3088 "description": "Fires when a new window, or a new tab in an existing win dow, is about to be created to host a navigation.",
3089 "parameters": [
3090 {
3091 "type": "object",
3092 "name": "details",
3093 "properties": {
3094 "sourceTabId": {"type": "integer", "description": "The ID of the t ab in which the navigation is triggered."},
3095 "sourceUrl": {"type": "string", "description": "The URL of the doc ument that is opening the new window."},
3096 "targetUrl": {"type": "string", "description": "The URL to be open ed in the new window."},
3097 "timeStamp": {"type": "number", "description": "The time when the browser was about to create a new view, in milliseconds since the epoch."}
3098 }
3099 }
3100 ]
3101 }
3102 ]
3103 },
3104 {
3105 "namespace": "experimental.webRequest",
3106 "types": [],
3107 "functions": [],
3108 "events": [
3109 {
3110 "name": "onBeforeRequest",
3111 "type": "function",
3112 "description": "Fires when a request is about to occur.",
3113 "parameters": [
3114 {
3115 "type": "object",
3116 "name": "details",
3117 "properties": {
3118 "requestId": {"type": "integer", "description": "The ID of the req uest. Request IDs are unique within a browser session. As a result, they could b e used to relate different events of the same request."},
3119 "url": {"type": "string"},
3120 "method": {"type": "string", "description": "Standard HTTP method. "},
3121 "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab ."},
3122 "type": {"type": "string", "enum": ["main_frame", "sub_frame", "st ylesheet", "script", "image", "object", "other"], "description": "How the reques ted resource will be used."},
3123 "timeStamp": {"type": "number", "description": "The time when the browser was about to make the request, in milliseconds since the epoch."}
3124 }
3125 }
3126 ]
3127 },
3128 {
3129 "name": "onRequestSent",
3130 "type": "function",
3131 "description": "Fires when a request is sent to the server.",
3132 "parameters": [
3133 {
3134 "type": "object",
3135 "name": "details",
3136 "properties": {
3137 "requestId": {"type": "integer", "description": "The ID of the req uest."},
3138 "url": {"type": "string"},
3139 "ip": {"type": "string", "description": "The server IP address tha t is actually connected to. Note that it may be a literal IPv6 address."},
3140 "timeStamp": {"type": "number", "description": "The time when the browser finished sending the request, in milliseconds since the epoch."}
3141 }
3142 }
3143 ]
3144 },
3145 {
3146 "name": "onHeadersReceived",
3147 "type": "function",
3148 "description": "Fires when the status line and response headers are rece ived after a request is sent to the server.",
3149 "parameters": [
3150 {
3151 "type": "object",
3152 "name": "details",
3153 "properties": {
3154 "requestId": {"type": "integer", "description": "The ID of the req uest."},
3155 "url": {"type": "string"},
3156 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
3157 "timeStamp": {"type": "number", "description": "The time when the status line and response headers were received, in milliseconds since the epoch. "}
3158 }
3159 }
3160 ]
3161 },
3162 {
3163 "name": "onBeforeRedirect",
3164 "type": "function",
3165 "description": "Fires when a server initiated redirect is about to occur .",
3166 "parameters": [
3167 {
3168 "type": "object",
3169 "name": "details",
3170 "properties": {
3171 "requestId": {"type": "integer", "description": "The ID of the req uest."},
3172 "url": {"type": "string", "description": "The URL of the current r equest."},
3173 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
3174 "redirectUrl": {"type": "string", "description": "The new URL."},
3175 "timeStamp": {"type": "number", "description": "The time when the browser was about to make the redirect, in milliseconds since the epoch."}
3176 }
3177 }
3178 ]
3179 },
3180 {
3181 "name": "onCompleted",
3182 "type": "function",
3183 "description": "Fires when a request is completed.",
3184 "parameters": [
3185 {
3186 "type": "object",
3187 "name": "details",
3188 "properties": {
3189 "requestId": {"type": "integer", "description": "The ID of the req uest."},
3190 "url": {"type": "string", "description": "The URL of the current r equest."},
3191 "statusCode": {"type": "integer", "description": "Standard HTTP st atus code returned by the server."},
3192 "timeStamp": {"type": "number", "description": "The time when the response was received completely, in milliseconds since the epoch."}
3193 }
3194 }
3195 ]
3196 },
3197 {
3198 "name": "onErrorOccurred",
3199 "type": "function",
3200 "description": "Fires when an error occurs.",
3201 "parameters": [
3202 {
3203 "type": "object",
3204 "name": "details",
3205 "properties": {
3206 "requestId": {"type": "integer", "description": "The ID of the req uest."},
3207 "url": {"type": "string", "description": "The URL of the current r equest."},
3208 "error": {"type": "string", "description": "The error description. "},
3209 "timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."}
3210 }
3211 }
3212 ]
3213 }
3214 ]
3215 },
3216 {
2993 "namespace": "test", 3217 "namespace": "test",
2994 "nodoc": true, 3218 "nodoc": true,
2995 "types": [], 3219 "types": [],
2996 "functions": [ 3220 "functions": [
2997 { 3221 {
2998 "name": "notifyFail", 3222 "name": "notifyFail",
2999 "type": "function", 3223 "type": "function",
3000 "description": "Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.", 3224 "description": "Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.",
3001 "parameters": [ 3225 "parameters": [
3002 {"type": "string", "name": "message"} 3226 {"type": "string", "name": "message"}
(...skipping 216 matching lines...) Expand 10 before | Expand all | Expand 10 after
3219 { 3443 {
3220 "name": "onInputCancelled", 3444 "name": "onInputCancelled",
3221 "perExtensionEvent": true, 3445 "perExtensionEvent": true,
3222 "type": "function", 3446 "type": "function",
3223 "description": "User has ended the keyword input session without accepti ng the input.", 3447 "description": "User has ended the keyword input session without accepti ng the input.",
3224 "parameters": [] 3448 "parameters": []
3225 } 3449 }
3226 ] 3450 ]
3227 } 3451 }
3228 ] 3452 ]
OLDNEW
« no previous file with comments | « chrome/chrome_tests.gypi ('k') | chrome/common/extensions/docs/experimental.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698