OLD | NEW |
(Empty) | |
| 1 { |
| 2 "domain": "Runtime", |
| 3 "version": { |
| 4 "major": "1", |
| 5 "minor": "1" |
| 6 }, |
| 7 "description": "Runtime domain exposes JavaScript runtime by means of remote
evaluation and mirror objects. Evaluation results are returned as mirror object
that expose object type, string representation and unique identifier that can b
e used for further object reference. Original objects are maintained in memory u
nless they are either explicitly released or are released along with the other o
bjects in their object group.", |
| 8 "types": [ |
| 9 { |
| 10 "id": "RemoteObjectId", |
| 11 "type": "string", |
| 12 "description": "Unique object identifier." |
| 13 }, |
| 14 { |
| 15 "id": "RemoteObject", |
| 16 "type": "object", |
| 17 "description": "Mirror object referencing original JavaScript object
.", |
| 18 "properties": [ |
| 19 { |
| 20 "name": "type", |
| 21 "type": "string", |
| 22 "enum": [ |
| 23 "object", |
| 24 "function", |
| 25 "undefined", |
| 26 "string", |
| 27 "number", |
| 28 "boolean" |
| 29 ], |
| 30 "description": "Object type." |
| 31 }, |
| 32 { |
| 33 "name": "subtype", |
| 34 "type": "string", |
| 35 "optional": true, |
| 36 "enum": [ |
| 37 "array", |
| 38 "null", |
| 39 "node", |
| 40 "regexp", |
| 41 "date" |
| 42 ], |
| 43 "description": "Object subtype hint. Specified for <code>obj
ect</code> type values only." |
| 44 }, |
| 45 { |
| 46 "name": "className", |
| 47 "type": "string", |
| 48 "optional": true, |
| 49 "description": "Object class (constructor) name. Specified f
or <code>object</code> type values only." |
| 50 }, |
| 51 { |
| 52 "name": "value", |
| 53 "type": "any", |
| 54 "optional": true, |
| 55 "description": "Remote object value (in case of primitive va
lues or JSON values if it was requested)." |
| 56 }, |
| 57 { |
| 58 "name": "description", |
| 59 "type": "string", |
| 60 "optional": true, |
| 61 "description": "String representation of the object." |
| 62 }, |
| 63 { |
| 64 "name": "objectId", |
| 65 "$ref": "RemoteObjectId", |
| 66 "optional": true, |
| 67 "description": "Unique object identifier (for non-primitive
values)." |
| 68 }, |
| 69 { |
| 70 "name": "preview", |
| 71 "$ref": "ObjectPreview", |
| 72 "optional": true, |
| 73 "description": "Preview containing abbreviated property valu
es.", |
| 74 "hidden": true |
| 75 } |
| 76 ] |
| 77 }, |
| 78 { |
| 79 "id": "ObjectPreview", |
| 80 "type": "object", |
| 81 "hidden": true, |
| 82 "description": "Object containing abbreviated remote object value.", |
| 83 "properties": [ |
| 84 { |
| 85 "name": "lossless", |
| 86 "type": "boolean", |
| 87 "description": "Determines whether preview is lossless (cont
ains all information of the original object)." |
| 88 }, |
| 89 { |
| 90 "name": "overflow", |
| 91 "type": "boolean", |
| 92 "description": "True iff some of the properties of the origi
nal did not fit." |
| 93 }, |
| 94 { |
| 95 "name": "properties", |
| 96 "type": "array", |
| 97 "items": { |
| 98 "$ref": "PropertyPreview" |
| 99 }, |
| 100 "description": "List of the properties." |
| 101 } |
| 102 ] |
| 103 }, |
| 104 { |
| 105 "id": "PropertyPreview", |
| 106 "type": "object", |
| 107 "hidden": true, |
| 108 "properties": [ |
| 109 { |
| 110 "name": "name", |
| 111 "type": "string", |
| 112 "description": "Property name." |
| 113 }, |
| 114 { |
| 115 "name": "type", |
| 116 "type": "string", |
| 117 "enum": [ |
| 118 "object", |
| 119 "function", |
| 120 "undefined", |
| 121 "string", |
| 122 "number", |
| 123 "boolean" |
| 124 ], |
| 125 "description": "Object type." |
| 126 }, |
| 127 { |
| 128 "name": "value", |
| 129 "type": "string", |
| 130 "optional": true, |
| 131 "description": "User-friendly property value string." |
| 132 }, |
| 133 { |
| 134 "name": "valuePreview", |
| 135 "$ref": "ObjectPreview", |
| 136 "optional": true, |
| 137 "description": "Nested value preview." |
| 138 }, |
| 139 { |
| 140 "name": "subtype", |
| 141 "type": "string", |
| 142 "optional": true, |
| 143 "enum": [ |
| 144 "array", |
| 145 "null", |
| 146 "node", |
| 147 "regexp", |
| 148 "date" |
| 149 ], |
| 150 "description": "Object subtype hint. Specified for <code>obj
ect</code> type values only." |
| 151 } |
| 152 ] |
| 153 }, |
| 154 { |
| 155 "id": "PropertyDescriptor", |
| 156 "type": "object", |
| 157 "description": "Object property descriptor.", |
| 158 "properties": [ |
| 159 { |
| 160 "name": "name", |
| 161 "type": "string", |
| 162 "description": "Property name." |
| 163 }, |
| 164 { |
| 165 "name": "value", |
| 166 "$ref": "RemoteObject", |
| 167 "optional": true, |
| 168 "description": "The value associated with the property." |
| 169 }, |
| 170 { |
| 171 "name": "writable", |
| 172 "type": "boolean", |
| 173 "optional": true, |
| 174 "description": "True if the value associated with the proper
ty may be changed (data descriptors only)." |
| 175 }, |
| 176 { |
| 177 "name": "get", |
| 178 "$ref": "RemoteObject", |
| 179 "optional": true, |
| 180 "description": "A function which serves as a getter for the
property, or <code>undefined</code> if there is no getter (accessor descriptors
only)." |
| 181 }, |
| 182 { |
| 183 "name": "set", |
| 184 "$ref": "RemoteObject", |
| 185 "optional": true, |
| 186 "description": "A function which serves as a setter for the
property, or <code>undefined</code> if there is no setter (accessor descriptors
only)." |
| 187 }, |
| 188 { |
| 189 "name": "configurable", |
| 190 "type": "boolean", |
| 191 "description": "True if the type of this property descriptor
may be changed and if the property may be deleted from the corresponding object
." |
| 192 }, |
| 193 { |
| 194 "name": "enumerable", |
| 195 "type": "boolean", |
| 196 "description": "True if this property shows up during enumer
ation of the properties on the corresponding object." |
| 197 }, |
| 198 { |
| 199 "name": "wasThrown", |
| 200 "type": "boolean", |
| 201 "optional": true, |
| 202 "description": "True if the result was thrown during the eva
luation." |
| 203 }, |
| 204 { |
| 205 "name": "isOwn", |
| 206 "optional": true, |
| 207 "type": "boolean", |
| 208 "description": "True if the property is owned for the object
.", |
| 209 "hidden": true |
| 210 } |
| 211 ] |
| 212 }, |
| 213 { |
| 214 "id": "InternalPropertyDescriptor", |
| 215 "type": "object", |
| 216 "description": "Object internal property descriptor. This property i
sn't normally visible in JavaScript code.", |
| 217 "properties": [ |
| 218 { |
| 219 "name": "name", |
| 220 "type": "string", |
| 221 "description": "Conventional property name." |
| 222 }, |
| 223 { |
| 224 "name": "value", |
| 225 "$ref": "RemoteObject", |
| 226 "optional": true, |
| 227 "description": "The value associated with the property." |
| 228 } |
| 229 ], |
| 230 "hidden": true |
| 231 }, |
| 232 { |
| 233 "id": "CallArgument", |
| 234 "type": "object", |
| 235 "description": "Represents function call argument. Either remote obj
ect id <code>objectId</code> or primitive <code>value</code> or neither of (for
undefined) them should be specified.", |
| 236 "properties": [ |
| 237 { |
| 238 "name": "value", |
| 239 "type": "any", |
| 240 "optional": true, |
| 241 "description": "Primitive value." |
| 242 }, |
| 243 { |
| 244 "name": "objectId", |
| 245 "$ref": "RemoteObjectId", |
| 246 "optional": true, |
| 247 "description": "Remote object handle." |
| 248 } |
| 249 ] |
| 250 }, |
| 251 { |
| 252 "id": "ExecutionContextId", |
| 253 "type": "integer", |
| 254 "description": "Id of an execution context." |
| 255 }, |
| 256 { |
| 257 "id": "ExecutionContextDescription", |
| 258 "type": "object", |
| 259 "description": "Description of an isolated world.", |
| 260 "properties": [ |
| 261 { |
| 262 "name": "id", |
| 263 "$ref": "ExecutionContextId", |
| 264 "description": "Unique id of the execution context. It can b
e used to specify in which execution context script evaluation should be perform
ed." |
| 265 }, |
| 266 { |
| 267 "name": "isPageContext", |
| 268 "type": "boolean", |
| 269 "description": "True if this is a context where inpspected w
eb page scripts run. False if it is a content script isolated context.", |
| 270 "hidden": true |
| 271 }, |
| 272 { |
| 273 "name": "name", |
| 274 "type": "string", |
| 275 "description": "Human readable name describing given context
.", |
| 276 "hidden": true |
| 277 }, |
| 278 { |
| 279 "name": "frameId", |
| 280 "type": "string", |
| 281 "description": "Id of the owning frame." |
| 282 } |
| 283 ] |
| 284 } |
| 285 ], |
| 286 "commands": [ |
| 287 { |
| 288 "name": "evaluate", |
| 289 "parameters": [ |
| 290 { |
| 291 "name": "expression", |
| 292 "type": "string", |
| 293 "description": "Expression to evaluate." |
| 294 }, |
| 295 { |
| 296 "name": "objectGroup", |
| 297 "type": "string", |
| 298 "optional": true, |
| 299 "description": "Symbolic group name that can be used to rele
ase multiple objects." |
| 300 }, |
| 301 { |
| 302 "name": "includeCommandLineAPI", |
| 303 "type": "boolean", |
| 304 "optional": true, |
| 305 "description": "Determines whether Command Line API should b
e available during the evaluation.", |
| 306 "hidden": true |
| 307 }, |
| 308 { |
| 309 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 310 "type": "boolean", |
| 311 "optional": true, |
| 312 "description": "Specifies whether evaluation should stop on
exceptions and mute console. Overrides setPauseOnException state.", |
| 313 "hidden": true |
| 314 }, |
| 315 { |
| 316 "name": "contextId", |
| 317 "$ref": "Runtime.ExecutionContextId", |
| 318 "optional": true, |
| 319 "description": "Specifies in which isolated context to perfo
rm evaluation. Each content script lives in an isolated context and this paramet
er may be used to specify one of those contexts. If the parameter is omitted or
0 the evaluation will be performed in the context of the inspected page." |
| 320 }, |
| 321 { |
| 322 "name": "returnByValue", |
| 323 "type": "boolean", |
| 324 "optional": true, |
| 325 "description": "Whether the result is expected to be a JSON
object that should be sent by value." |
| 326 }, |
| 327 { |
| 328 "name": "generatePreview", |
| 329 "type": "boolean", |
| 330 "optional": true, |
| 331 "hidden": true, |
| 332 "description": "Whether preview should be generated for the
result." |
| 333 } |
| 334 ], |
| 335 "returns": [ |
| 336 { |
| 337 "name": "result", |
| 338 "$ref": "RemoteObject", |
| 339 "description": "Evaluation result." |
| 340 }, |
| 341 { |
| 342 "name": "wasThrown", |
| 343 "type": "boolean", |
| 344 "optional": true, |
| 345 "description": "True if the result was thrown during the eva
luation." |
| 346 } |
| 347 ], |
| 348 "description": "Evaluates expression on global object." |
| 349 }, |
| 350 { |
| 351 "name": "callFunctionOn", |
| 352 "parameters": [ |
| 353 { |
| 354 "name": "objectId", |
| 355 "$ref": "RemoteObjectId", |
| 356 "description": "Identifier of the object to call function on
." |
| 357 }, |
| 358 { |
| 359 "name": "functionDeclaration", |
| 360 "type": "string", |
| 361 "description": "Declaration of the function to call." |
| 362 }, |
| 363 { |
| 364 "name": "arguments", |
| 365 "type": "array", |
| 366 "items": { |
| 367 "$ref": "CallArgument", |
| 368 "description": "Call argument." |
| 369 }, |
| 370 "optional": true, |
| 371 "description": "Call arguments. All call arguments must belo
ng to the same JavaScript world as the target object." |
| 372 }, |
| 373 { |
| 374 "name": "doNotPauseOnExceptionsAndMuteConsole", |
| 375 "type": "boolean", |
| 376 "optional": true, |
| 377 "description": "Specifies whether function call should stop
on exceptions and mute console. Overrides setPauseOnException state.", |
| 378 "hidden": true |
| 379 }, |
| 380 { |
| 381 "name": "returnByValue", |
| 382 "type": "boolean", |
| 383 "optional": true, |
| 384 "description": "Whether the result is expected to be a JSON
object which should be sent by value." |
| 385 }, |
| 386 { |
| 387 "name": "generatePreview", |
| 388 "type": "boolean", |
| 389 "optional": true, |
| 390 "hidden": true, |
| 391 "description": "Whether preview should be generated for the
result." |
| 392 } |
| 393 ], |
| 394 "returns": [ |
| 395 { |
| 396 "name": "result", |
| 397 "$ref": "RemoteObject", |
| 398 "description": "Call result." |
| 399 }, |
| 400 { |
| 401 "name": "wasThrown", |
| 402 "type": "boolean", |
| 403 "optional": true, |
| 404 "description": "True if the result was thrown during the eva
luation." |
| 405 } |
| 406 ], |
| 407 "description": "Calls function with given declaration on the given o
bject. Object group of the result is inherited from the target object." |
| 408 }, |
| 409 { |
| 410 "name": "getProperties", |
| 411 "parameters": [ |
| 412 { |
| 413 "name": "objectId", |
| 414 "$ref": "RemoteObjectId", |
| 415 "description": "Identifier of the object to return propertie
s for." |
| 416 }, |
| 417 { |
| 418 "name": "ownProperties", |
| 419 "optional": true, |
| 420 "type": "boolean", |
| 421 "description": "If true, returns properties belonging only t
o the element itself, not to its prototype chain." |
| 422 }, |
| 423 { |
| 424 "name": "accessorPropertiesOnly", |
| 425 "optional": true, |
| 426 "type": "boolean", |
| 427 "description": "If true, returns accessor properties (with g
etter/setter) only; internal properties are not returned either.", |
| 428 "hidden": true |
| 429 } |
| 430 ], |
| 431 "returns": [ |
| 432 { |
| 433 "name": "result", |
| 434 "type": "array", |
| 435 "items": { |
| 436 "$ref": "PropertyDescriptor" |
| 437 }, |
| 438 "description": "Object properties." |
| 439 }, |
| 440 { |
| 441 "name": "internalProperties", |
| 442 "optional": true, |
| 443 "type": "array", |
| 444 "items": { |
| 445 "$ref": "InternalPropertyDescriptor" |
| 446 }, |
| 447 "description": "Internal object properties (only of the elem
ent itself).", |
| 448 "hidden": true |
| 449 } |
| 450 ], |
| 451 "description": "Returns properties of a given object. Object group o
f the result is inherited from the target object." |
| 452 }, |
| 453 { |
| 454 "name": "releaseObject", |
| 455 "parameters": [ |
| 456 { |
| 457 "name": "objectId", |
| 458 "$ref": "RemoteObjectId", |
| 459 "description": "Identifier of the object to release." |
| 460 } |
| 461 ], |
| 462 "description": "Releases remote object with given id." |
| 463 }, |
| 464 { |
| 465 "name": "releaseObjectGroup", |
| 466 "parameters": [ |
| 467 { |
| 468 "name": "objectGroup", |
| 469 "type": "string", |
| 470 "description": "Symbolic object group name." |
| 471 } |
| 472 ], |
| 473 "description": "Releases all remote objects that belong to a given g
roup." |
| 474 }, |
| 475 { |
| 476 "name": "run", |
| 477 "hidden": true, |
| 478 "description": "Tells inspected instance(worker or page) that it can
run in case it was started paused." |
| 479 }, |
| 480 { |
| 481 "name": "enable", |
| 482 "description": "Enables reporting of execution contexts creation by
means of <code>executionContextCreated</code> event. When the reporting gets ena
bled the event will be sent immediately for each existing execution context." |
| 483 }, |
| 484 { |
| 485 "name": "disable", |
| 486 "hidden": true, |
| 487 "description": "Disables reporting of execution contexts creation." |
| 488 } |
| 489 ], |
| 490 "events": [ |
| 491 { |
| 492 "name": "executionContextCreated", |
| 493 "parameters": [ |
| 494 { |
| 495 "name": "context", |
| 496 "$ref": "ExecutionContextDescription", |
| 497 "description": "A newly created execution contex." |
| 498 } |
| 499 ], |
| 500 "description": "Issued when new execution context is created." |
| 501 } |
| 502 ] |
| 503 } |
OLD | NEW |