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": "debugger", | 7 "namespace": "debugger", |
8 "description": "The <code>chrome.debugger</code> API serves as an alternate
transport for Chrome's <a href='http://code.google.com/chrome/devtools/docs/remo
te-debugging.html'>remote debugging protocol</a>. Use <code>chrome.debugger</cod
e> to attach to one or more tabs to instrument network interaction, debug JavaSc
ript, mutate the DOM and CSS, etc. Use the Debuggee <code>tabId</code> to target
tabs with sendCommand and route events by <code>tabId</code> from onEvent callb
acks.", | 8 "description": "The <code>chrome.debugger</code> API serves as an alternate
transport for Chrome's <a href='http://code.google.com/chrome/devtools/docs/remo
te-debugging'>remote debugging protocol</a>. Use <code>chrome.debugger</code> to
attach to one or more tabs to instrument network interaction, debug JavaScript,
mutate the DOM and CSS, etc. Use the Debuggee <code>tabId</code> to target tabs
with sendCommand and route events by <code>tabId</code> from onEvent callbacks.
", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
11 "id": "Debuggee", | 11 "id": "Debuggee", |
12 "type": "object", | 12 "type": "object", |
13 "description": "Debuggee identifier. Either tabId or extensionId must be
specified", | 13 "description": "Debuggee identifier. Either tabId or extensionId must be
specified", |
14 "properties": { | 14 "properties": { |
15 "tabId": { "type": "integer", "optional": true, "description": "The id
of the tab which you intend to debug." }, | 15 "tabId": { "type": "integer", "optional": true, "description": "The id
of the tab which you intend to debug." }, |
16 "extensionId": { "type": "string", "optional": true, "description": "T
he id of the extension which you intend to debug. Attaching to an extension back
ground page is only possible when 'enable-silent-debugging' flag is enabled on t
he target browser." }, | 16 "extensionId": { "type": "string", "optional": true, "description": "T
he id of the extension which you intend to debug. Attaching to an extension back
ground page is only possible when 'enable-silent-debugging' flag is enabled on t
he target browser." }, |
17 "targetId": { "type": "string", "optional": true, "description": "The
opaque id of the debug target." } | 17 "targetId": { "type": "string", "optional": true, "description": "The
opaque id of the debug target." } |
18 } | 18 } |
(...skipping 25 matching lines...) Expand all Loading... |
44 "description": "Attaches debugger to the given target.", | 44 "description": "Attaches debugger to the given target.", |
45 "parameters": [ | 45 "parameters": [ |
46 { | 46 { |
47 "$ref": "Debuggee", | 47 "$ref": "Debuggee", |
48 "name": "target", | 48 "name": "target", |
49 "description": "Debugging target to which you want to attach." | 49 "description": "Debugging target to which you want to attach." |
50 }, | 50 }, |
51 { | 51 { |
52 "type": "string", | 52 "type": "string", |
53 "name": "requiredVersion", | 53 "name": "requiredVersion", |
54 "description": "Required debugging protocol version (\"0.1\"). One c
an only attach to the debuggee with matching major version and greater or equal
minor version. List of the protocol versions can be obtained <a href='http://cod
e.google.com/chrome/devtools/docs/remote-debugging.html'>here</a>." | 54 "description": "Required debugging protocol version (\"0.1\"). One c
an only attach to the debuggee with matching major version and greater or equal
minor version. List of the protocol versions can be obtained <a href='http://cod
e.google.com/chrome/devtools/docs/remote-debugging'>here</a>." |
55 }, | 55 }, |
56 { | 56 { |
57 "type": "function", | 57 "type": "function", |
58 "name": "callback", | 58 "name": "callback", |
59 "optional": true, | 59 "optional": true, |
60 "parameters": [], | 60 "parameters": [], |
61 "description": "Called once the attach operation succeeds or fails.
Callback receives no arguments. If the attach fails, $(ref:runtime.lastError) wi
ll be set to the error message." | 61 "description": "Called once the attach operation succeeds or fails.
Callback receives no arguments. If the attach fails, $(ref:runtime.lastError) wi
ll be set to the error message." |
62 } | 62 } |
63 ] | 63 ] |
64 }, | 64 }, |
(...skipping 22 matching lines...) Expand all Loading... |
87 "description": "Sends given command to the debugging target.", | 87 "description": "Sends given command to the debugging target.", |
88 "parameters": [ | 88 "parameters": [ |
89 { | 89 { |
90 "$ref": "Debuggee", | 90 "$ref": "Debuggee", |
91 "name": "target", | 91 "name": "target", |
92 "description": "Debugging target to which you want to send the comma
nd." | 92 "description": "Debugging target to which you want to send the comma
nd." |
93 }, | 93 }, |
94 { | 94 { |
95 "type": "string", | 95 "type": "string", |
96 "name": "method", | 96 "name": "method", |
97 "description": "Method name. Should be one of the methods defined by
the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging.html'
>remote debugging protocol</a>." | 97 "description": "Method name. Should be one of the methods defined by
the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging'>remo
te debugging protocol</a>." |
98 }, | 98 }, |
99 { | 99 { |
100 "type": "object", | 100 "type": "object", |
101 "name": "commandParams", | 101 "name": "commandParams", |
102 "optional": true, | 102 "optional": true, |
103 "additionalProperties": { "type": "any" }, | 103 "additionalProperties": { "type": "any" }, |
104 "description": "JSON object with request parameters. This object mus
t conform to the remote debugging params scheme for given method." | 104 "description": "JSON object with request parameters. This object mus
t conform to the remote debugging params scheme for given method." |
105 }, | 105 }, |
106 { | 106 { |
107 "type": "function", | 107 "type": "function", |
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
147 "description": "Fired whenever debugging target issues instrumentation e
vent.", | 147 "description": "Fired whenever debugging target issues instrumentation e
vent.", |
148 "parameters": [ | 148 "parameters": [ |
149 { | 149 { |
150 "$ref": "Debuggee", | 150 "$ref": "Debuggee", |
151 "name": "source", | 151 "name": "source", |
152 "description": "The debuggee that generated this event." | 152 "description": "The debuggee that generated this event." |
153 }, | 153 }, |
154 { | 154 { |
155 "type": "string", | 155 "type": "string", |
156 "name": "method", | 156 "name": "method", |
157 "description": "Method name. Should be one of the notifications defi
ned by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging
.html'>remote debugging protocol</a>." | 157 "description": "Method name. Should be one of the notifications defi
ned by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging
'>remote debugging protocol</a>." |
158 }, | 158 }, |
159 { | 159 { |
160 "type": "object", | 160 "type": "object", |
161 "name": "params", | 161 "name": "params", |
162 "optional": true, | 162 "optional": true, |
163 "additionalProperties": { "type": "any" }, | 163 "additionalProperties": { "type": "any" }, |
164 "description": "JSON object with the parameters. Structure of the pa
rameters varies depending on the method name and is defined by the 'parameters'
attribute of the event description in the remote debugging protocol." | 164 "description": "JSON object with the parameters. Structure of the pa
rameters varies depending on the method name and is defined by the 'parameters'
attribute of the event description in the remote debugging protocol." |
165 } | 165 } |
166 ] | 166 ] |
167 }, | 167 }, |
(...skipping 11 matching lines...) Expand all Loading... |
179 "type": "string", | 179 "type": "string", |
180 "name": "reason", | 180 "name": "reason", |
181 "description": "Connection termination reason.", | 181 "description": "Connection termination reason.", |
182 "enum": [ "target_closed", "canceled_by_user", "replaced_with_devtoo
ls" ] | 182 "enum": [ "target_closed", "canceled_by_user", "replaced_with_devtoo
ls" ] |
183 } | 183 } |
184 ] | 184 ] |
185 } | 185 } |
186 ] | 186 ] |
187 } | 187 } |
188 ] | 188 ] |
OLD | NEW |