OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 [ | 5 [ |
6 { | 6 { |
7 "namespace": "webNavigation", | 7 "namespace": "webNavigation", |
8 "description": "Use the <code>chrome.webNavigation</code> API to receive not
ifications about the status of navigation requests in-flight.", | 8 "description": "Use the <code>chrome.webNavigation</code> API to receive not
ifications about the status of navigation requests in-flight.", |
9 "types": [], | 9 "types": [ |
| 10 { |
| 11 "id": "TransitionType", |
| 12 "type": "string", |
| 13 "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subf
rame", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_g
enerated"], |
| 14 "description": "Cause of the navigation. The same transition types as de
fined in the history API are used. These are the same transition types as define
d in the <a href=\"history#transition_types\">history API</a> except with <code>
\"start_page\"</code> in place of <code>\"auto_toplevel\"</code> (for backwards
compatibility)." |
| 15 }, |
| 16 { |
| 17 "id": "TransitionQualifier", |
| 18 "type": "string", |
| 19 "enum": ["client_redirect", "server_redirect", "forward_back", "from_add
ress_bar"] |
| 20 } |
| 21 ], |
10 "functions": [ | 22 "functions": [ |
11 { | 23 { |
12 "name": "getFrame", | 24 "name": "getFrame", |
13 "type": "function", | 25 "type": "function", |
14 "description": "Retrieves information about the given frame. A frame ref
ers to an <iframe> or a <frame> of a web page and is identified by a
tab ID and a frame ID.", | 26 "description": "Retrieves information about the given frame. A frame ref
ers to an <iframe> or a <frame> of a web page and is identified by a
tab ID and a frame ID.", |
15 "parameters": [ | 27 "parameters": [ |
16 { | 28 { |
17 "type": "object", | 29 "type": "object", |
18 "name": "details", | 30 "name": "details", |
19 "description": "Information about the frame to retrieve information
about.", | 31 "description": "Information about the frame to retrieve information
about.", |
(...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
142 ], | 154 ], |
143 "parameters": [ | 155 "parameters": [ |
144 { | 156 { |
145 "type": "object", | 157 "type": "object", |
146 "name": "details", | 158 "name": "details", |
147 "properties": { | 159 "properties": { |
148 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 160 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
149 "url": {"type": "string"}, | 161 "url": {"type": "string"}, |
150 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 162 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, |
151 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 163 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
152 "transitionType": {"type": "string", "enum": ["link", "typed", "au
to_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "fo
rm_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of
the navigation. The same transition types as defined in the history API are used
. These are the same transition types as defined in the <a href=\"history#transi
tion_types\">history API</a> except with <code>\"start_page\"</code> in place of
<code>\"auto_toplevel\"</code> (for backwards compatibility)."}, | 164 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
153 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect
", "server_redirect", "forward_back", "from_address_bar"]}}, | 165 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
154 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 166 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
155 } | 167 } |
156 } | 168 } |
157 ] | 169 ] |
158 }, | 170 }, |
159 { | 171 { |
160 "name": "onDOMContentLoaded", | 172 "name": "onDOMContentLoaded", |
161 "type": "function", | 173 "type": "function", |
162 "description": "Fired when the page's DOM is fully constructed, but the
referenced resources may not finish loading.", | 174 "description": "Fired when the page's DOM is fully constructed, but the
referenced resources may not finish loading.", |
163 "filters": [ | 175 "filters": [ |
(...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
276 ], | 288 ], |
277 "parameters": [ | 289 "parameters": [ |
278 { | 290 { |
279 "type": "object", | 291 "type": "object", |
280 "name": "details", | 292 "name": "details", |
281 "properties": { | 293 "properties": { |
282 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 294 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
283 "url": {"type": "string"}, | 295 "url": {"type": "string"}, |
284 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 296 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, |
285 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 297 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
286 "transitionType": {"type": "string", "enum": ["link", "typed", "au
to_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "fo
rm_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of
the navigation. The same transition types as defined in the history API are used
. These are the same transition types as defined in the <a href=\"history#transi
tion_types\">history API</a> except with <code>\"start_page\"</code> in place of
<code>\"auto_toplevel\"</code> (for backwards compatibility)."}, | 298 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
287 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect
", "server_redirect", "forward_back", "from_address_bar"]}}, | 299 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
288 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 300 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
289 } | 301 } |
290 } | 302 } |
291 ] | 303 ] |
292 }, | 304 }, |
293 { | 305 { |
294 "name": "onTabReplaced", | 306 "name": "onTabReplaced", |
295 "type": "function", | 307 "type": "function", |
296 "description": "Fired when the contents of the tab is replaced by a diff
erent (usually previously pre-rendered) tab.", | 308 "description": "Fired when the contents of the tab is replaced by a diff
erent (usually previously pre-rendered) tab.", |
297 "parameters": [ | 309 "parameters": [ |
(...skipping 22 matching lines...) Expand all Loading... |
320 ], | 332 ], |
321 "parameters": [ | 333 "parameters": [ |
322 { | 334 { |
323 "type": "object", | 335 "type": "object", |
324 "name": "details", | 336 "name": "details", |
325 "properties": { | 337 "properties": { |
326 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, | 338 "tabId": {"type": "integer", "description": "The ID of the tab in
which the navigation occurs."}, |
327 "url": {"type": "string"}, | 339 "url": {"type": "string"}, |
328 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, | 340 "processId": {"type": "integer", "description": "The ID of the pro
cess runs the renderer for this tab."}, |
329 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, | 341 "frameId": {"type": "integer", "description": "0 indicates the nav
igation happens in the tab content window; a positive value indicates navigation
in a subframe. Frame IDs are unique within a tab."}, |
330 "transitionType": {"type": "string", "enum": ["link", "typed", "au
to_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "fo
rm_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of
the navigation. The same transition types as defined in the history API are used
. These are the same transition types as defined in the <a href=\"history#transi
tion_types\">history API</a> except with <code>\"start_page\"</code> in place of
<code>\"auto_toplevel\"</code> (for backwards compatibility)."}, | 342 "transitionType": {"$ref": "TransitionType", "description": "Cause
of the navigation."}, |
331 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"type": "string", "enum": ["client_redirect
", "server_redirect", "forward_back", "from_address_bar"]}}, | 343 "transitionQualifiers": {"type": "array", "description": "A list o
f transition qualifiers.", "items": {"$ref": "TransitionQualifier"}}, |
332 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} | 344 "timeStamp": {"type": "number", "description": "The time when the
navigation was committed, in milliseconds since the epoch."} |
333 } | 345 } |
334 } | 346 } |
335 ] | 347 ] |
336 } | 348 } |
337 ] | 349 ] |
338 } | 350 } |
339 ] | 351 ] |
OLD | NEW |