monaca-lib

{ "domains": [{ "domain": "Inspector", "hidden": true, "types": [], "commands": [ { "name": "enable", "description": "Enables inspector domain notifications." }, { "name": "disable", "description": "Disables inspector domain notifications." } ], "events": [ { "name": "evaluateForTestInFrontend", "parameters": [ { "name": "testCallId", "type": "integer" }, { "name": "script", "type": "string" } ] }, { "name": "inspect", "parameters": [ { "name": "object", "$ref": "Runtime.RemoteObject" }, { "name": "hints", "type": "object" } ] }, { "name": "didCreateWorker", "parameters": [ { "name": "id", "type": "integer" }, { "name": "url", "type": "string" }, { "name": "isShared", "type": "boolean" } ] }, { "name": "didDestroyWorker", "parameters": [ { "name": "id", "type": "integer" } ] } ] }, { "domain": "Memory", "hidden": true, "types": [ { "id": "NodeCount", "type": "object", "properties": [ { "name": "nodeName", "type": "string" }, { "name": "count", "type": "integer" } ], "description": "Number of nodes with given name." }, { "id": "ListenerCount", "type": "object", "properties": [ { "name": "type", "type": "string" }, { "name": "count", "type": "integer" } ], "description": "Number of JS event listeners by event type." }, { "id": "StringStatistics", "type": "object", "properties": [ { "name": "dom", "type": "integer" }, { "name": "js", "type": "integer" }, { "name": "shared", "type": "integer" } ], "description": "Character data statistics for the page." }, { "id": "DOMGroup", "type": "object", "properties": [ { "name": "size", "type": "integer" }, { "name": "title", "type": "string" }, { "name": "documentURI", "type": "string", "optional": true }, { "name": "nodeCount", "type": "array", "items": { "$ref": "NodeCount" }}, { "name": "listenerCount", "type": "array", "items": { "$ref": "ListenerCount" }} ] } ], "commands": [ { "name": "getDOMNodeCount", "returns": [ { "name": "domGroups", "type": "array", "items": { "$ref": "DOMGroup" }}, { "name": "strings", "$ref": "StringStatistics" } ] } ] }, { "domain": "Page", "description": "Actions and events related to the inspected page belong to the page domain.", "types": [ { "id": "ResourceType", "type": "string", "enum": ["Document", "Stylesheet", "Image", "Font", "Script", "XHR", "WebSocket", "Other"], "description": "Resource type as it was perceived by the rendering engine." }, { "id": "Frame", "type": "object", "description": "Information about the Frame on the page.", "properties": [ { "name": "id", "type": "string", "description": "Frame unique identifier." }, { "name": "parentId", "type": "string", "optional": true, "description": "Parent frame identifier." }, { "name": "loaderId", "$ref": "Network.LoaderId", "description": "Identifier of the loader associated with this frame." }, { "name": "name", "type": "string", "optional": true, "description": "Frame's name as specified in the tag." }, { "name": "url", "type": "string", "description": "Frame document's URL." }, { "name": "securityOrigin", "type": "string", "optional": true, "description": "Frame document's security origin." }, { "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." } ], "hidden": true }, { "id": "FrameResourceTree", "type": "object", "description": "Information about the Frame hierarchy along with their cached resources.", "properties": [ { "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." }, { "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." }, { "name": "resources", "type": "array", "items": { "type": "object", "properties": [ { "name": "url", "type": "string", "description": "Resource URL." }, { "name": "type", "$ref": "ResourceType", "description": "Type of this resource." }, { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." } ] }, "description": "Information about frame resources." } ], "hidden": true }, { "id": "SearchMatch", "type": "object", "description": "Search match for resource.", "properties": [ { "name": "lineNumber", "type": "number", "description": "Line number in resource content." }, { "name": "lineContent", "type": "string", "description": "Line with match content." } ], "hidden": true }, { "id": "SearchResult", "type": "object", "description": "Search result for resource.", "properties": [ { "name": "url", "type": "string", "description": "Resource URL." }, { "name": "frameId", "$ref": "Network.FrameId", "description": "Resource frame id." }, { "name": "matchesCount", "type": "number", "description": "Number of matches in the resource content." } ], "hidden": true }, { "id": "Cookie", "type": "object", "description": "Cookie object", "properties": [ { "name": "name", "type": "string", "description": "Cookie name." }, { "name": "value", "type": "string", "description": "Cookie value." }, { "name": "domain", "type": "string", "description": "Cookie domain." }, { "name": "path", "type": "string", "description": "Cookie path." }, { "name": "expires", "type": "integer", "description": "Cookie expires." }, { "name": "size", "type": "integer", "description": "Cookie size." }, { "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." }, { "name": "secure", "type": "boolean", "description": "True if cookie is secure." }, { "name": "session", "type": "boolean", "description": "True in case of session cookie." } ], "hidden": true }, { "id": "ScriptIdentifier", "type": "string", "description": "Unique script identifier.", "hidden": true } ], "commands": [ { "name": "enable", "description": "Enables page domain notifications." }, { "name": "disable", "description": "Disables page domain notifications." }, { "name": "addScriptToEvaluateOnLoad", "parameters": [ { "name": "scriptSource", "type": "string" } ], "returns": [ { "name": "identifier", "$ref": "ScriptIdentifier", "description": "Identifier of the added script." } ], "hidden": true }, { "name": "removeScriptToEvaluateOnLoad", "parameters": [ { "name": "identifier", "$ref": "ScriptIdentifier" } ], "hidden": true }, { "name": "reload", "parameters": [ { "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." }, { "name": "scriptToEvaluateOnLoad", "type": "string", "optional": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." } ], "description": "Reloads given page optionally ignoring the cache." }, { "name": "navigate", "parameters": [ { "name": "url", "type": "string", "description": "URL to navigate the page to." } ], "description": "Navigates current page to the given URL." }, { "name": "getCookies", "returns": [ { "name": "cookies", "type": "array", "items": { "$ref": "Cookie"}, "description": "Array of cookie objects." }, { "name": "cookiesString", "type": "string", "description": "document.cookie string representation of the cookies." } ], "description": "Returns all browser cookies. Depending on the backend support, will either return detailed cookie information in the <code>cookie</code> field or string cookie representation using <code>cookieString</code>.", "hidden": true }, { "name": "deleteCookie", "parameters": [ { "name": "cookieName", "type": "string", "description": "Name of the cookie to remove." }, { "name": "domain", "type": "string", "description": "Domain of the cookie to remove." } ], "description": "Deletes browser cookie with given name for the given domain.", "hidden": true }, { "name": "getResourceTree", "description": "Returns present frame / resource tree structure.", "returns": [ { "name": "frameTree", "$ref": "FrameResourceTree", "description": "Present frame / resource tree structure." } ], "hidden": true }, { "name": "getResourceContent", "description": "Returns content of the given resource.", "parameters": [ { "name": "frameId", "$ref": "Network.FrameId", "description": "Frame id to get resource for." }, { "name": "url", "type": "string", "description": "URL of the resource to get content for." } ], "returns": [ { "name": "content", "type": "string", "description": "Resource content." }, { "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." } ], "hidden": true }, { "name": "searchInResource", "description": "Searches for given string in resource content.", "parameters": [ { "name": "frameId", "$ref": "Network.FrameId", "description": "Frame id for resource to search in." }, { "name": "url", "type": "string", "description": "URL of the resource to search in." }, { "name": "query", "type": "string", "description": "String to search for." }, { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." }, { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." } ], "returns": [ { "name": "result", "type": "array", "items": { "$ref": "SearchMatch" }, "description": "List of search matches." } ], "hidden": true }, { "name": "searchInResources", "description": "Searches for given string in frame / resource tree structure.", "parameters": [ { "name": "text", "type": "string", "description": "String to search for." }, { "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." }, { "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." } ], "returns": [ { "name": "result", "type": "array", "items": { "$ref": "SearchResult" }, "description": "List of search results." } ], "hidden": true }, { "name": "setDocumentContent", "description": "Sets given markup as the document's HTML.", "parameters": [ { "name": "frameId", "$ref": "Network.FrameId", "description": "Frame id to set HTML for." }, { "name": "html", "type": "string", "description": "HTML content to set." } ], "hidden": true }, { "name": "setScreenSizeOverride", "description": "Overrides the values of window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and \"device-width\"/\"device-height\"-related CSS media query results", "parameters": [ { "name": "width", "type": "integer", "description": "Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override." }, { "name": "height", "type": "integer", "description": "Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override." } ], "hidden": true } ], "events": [ { "name": "domContentEventFired", "parameters": [ { "name": "timestamp", "type": "number" } ] }, { "name": "loadEventFired", "parameters": [ { "name": "timestamp", "type": "number" } ] }, { "name": "frameNavigated", "description": "Fired once navigation of the frame has completed. Frame is now associated with the new loader.", "parameters": [ { "name": "frame", "$ref": "Frame", "description": "Frame object." } ], "hidden": true }, { "name": "frameDetached", "description": "Fired when frame has been detached from its parent.", "parameters": [ { "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has been detached." } ], "hidden": true } ] }, { "domain": "Runtime", "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 be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.", "types": [ { "id": "RemoteObjectId", "type": "string", "description": "Unique object identifier." }, { "id": "RemoteObject", "type": "object", "description": "Mirror object referencing original JavaScript object.", "properties": [ { "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean"], "description": "Object type." }, { "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date"], "description": "Object subtype hint. Specified for <code>object</code> type values only." }, { "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." }, { "name": "value", "type": "any", "optional": true, "description": "Remote object value (in case of primitive values or JSON values if it was requested)." }, { "name": "description", "type": "string", "optional": true, "description": "String representation of the object." }, { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." } ] }, { "id": "PropertyDescriptor", "type": "object", "description": "Object property descriptor.", "properties": [ { "name": "name", "type": "string", "description": "Property name." }, { "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }, { "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." }, { "name": "get", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only)." }, { "name": "set", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only)." }, { "name": "configurable", "type": "boolean", "description": "True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object." }, { "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." }, { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." } ] }, { "id": "CallArgument", "type": "object", "description": "Represents function call argument. Either remote object id <code>objectId</code> or primitive <code>value</code> or neither of (for undefined) them should be specified.", "properties": [ { "name": "value", "type": "any", "optional": true, "description": "Primitive value." }, { "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." } ] } ], "commands": [ { "name": "evaluate", "parameters": [ { "name": "expression", "type": "string", "description": "Expression to evaluate." }, { "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }, { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation.", "hidden": true }, { "name": "doNotPauseOnExceptions", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions. Overrides setPauseOnException state.", "hidden": true }, { "name": "frameId", "$ref": "Network.FrameId", "optional": true, "description": "Specifies in which frame to perform evaluation.", "hidden": true }, { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." } ], "returns": [ { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." }, { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." } ], "description": "Evaluates expression on global object." }, { "name": "callFunctionOn", "parameters": [ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." }, { "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." }, { "name": "arguments", "type": "array", "items": { "$ref": "CallArgument", "description": "Call argument." }, "optional": true, "description": "Call arguments. All call arguments must belong to the same JavaScript world as the target object." }, { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." } ], "returns": [ { "name": "result", "$ref": "RemoteObject", "description": "Call result." }, { "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." } ], "description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object." }, { "name": "getProperties", "parameters": [ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." }, { "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the element itself, not to its prototype chain." } ], "returns": [ { "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor"}, "description": "Object properties." } ], "description": "Returns properties of a given object. Object group of the result is inherited from the target object." }, { "name": "releaseObject", "parameters": [ { "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." } ], "description": "Releases remote object with given id." }, { "name": "releaseObjectGroup", "parameters": [ { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." } ], "description": "Releases all remote objects that belong to a given group." }, { "name": "run", "hidden": true, "description": "Tells inspected instance(worker or page) that it can run in case it was started paused." } ] }, { "domain": "Console", "description": "Console domain defines methods and events for interaction with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console API</a>. One needs to enable this domain using <code>enable</code> command in order to start receiving the console messages. Browser collects messages issued while console domain is not enabled as well and reports them using <code>messageAdded</code> notification upon enabling.", "types": [ { "id": "ConsoleMessage", "type": "object", "description": "Console message.", "properties": [ { "name": "source", "type": "string", "enum": ["html", "wml", "xml", "javascript", "network", "console-api", "other"], "description": "Message source." }, { "name": "level", "type": "string", "enum": ["tip", "log", "warning", "error", "debug"], "description": "Message severity." }, { "name": "text", "type": "string", "description": "Message text." }, { "name": "type", "type": "string", "optional": true, "enum": ["log", "dir", "dirxml", "trace", "startGroup", "startGroupCollapsed", "endGroup", "assert"], "description": "Console message type." }, { "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." }, { "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." }, { "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." }, { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters in case of the formatted message." }, { "name": "stackTrace", "$ref": "StackTrace", "optional": true, "description": "JavaScript stack trace for assertions and error messages." }, { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." } ] }, { "id": "CallFrame", "type": "object", "description": "Stack entry for console errors and assertions.", "properties": [ { "name": "functionName", "type": "string", "description": "JavaScript function name." }, { "name": "url", "type": "string", "description": "JavaScript script name or url." }, { "name": "lineNumber", "type": "integer", "description": "JavaScript script line number." }, { "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." } ] }, { "id": "StackTrace", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call frames for assertions or error messages." } ], "commands": [ { "name": "enable", "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification." }, { "name": "disable", "description": "Disables console domain, prevents further console messages from being reported to the client." }, { "name": "clearMessages", "description": "Clears console messages collected in the browser." }, { "name": "setMonitoringXHREnabled", "parameters": [ { "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." } ], "description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.", "hidden": true }, { "name": "addInspectedNode", "parameters": [ { "name": "nodeId", "$ref": "DOM.NodeId", "description": "DOM node id to be accessible by means of $x command line API." } ], "description": "Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).", "hidden": true } ], "events": [ { "name": "messageAdded", "parameters": [ { "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." } ], "description": "Issued when new console message is added." }, { "name": "messageRepeatCountUpdated", "parameters": [ { "name": "count", "type": "integer", "description": "New repeat count value." } ], "description": "Issued when subsequent message(s) are equal to the previous one(s)." }, { "name": "messagesCleared", "description": "Issued when console is cleared. This happens either upon <code>clearMessages</code> command or after page navigation." } ] }, { "domain": "Network", "description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.", "types": [ { "id": "LoaderId", "type": "string", "description": "Unique loader identifier." }, { "id": "FrameId", "type": "string", "description": "Unique frame identifier.", "hidden": true }, { "id": "RequestId", "type": "string", "description": "Unique request identifier." }, { "id": "Timestamp", "type": "number", "description": "Number of seconds since epoch." }, { "id": "Headers", "type": "object", "description": "Request / response headers as keys / values of JSON object." }, { "id": "ResourceTiming", "type": "object", "description": "Timing information for the request.", "properties": [ { "name": "requestTime", "type": "number", "description": "Timing's requestTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this requestTime." }, { "name": "proxyStart", "type": "number", "description": "Started resolving proxy." }, { "name": "proxyEnd", "type": "number", "description": "Finished resolving proxy." }, { "name": "dnsStart", "type": "number", "description": "Started DNS address resolve." }, { "name": "dnsEnd", "type": "number", "description": "Finished DNS address resolve." }, { "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." }, { "name": "connectEnd", "type": "number", "description": "Connected to the remote host." }, { "name": "sslStart", "type": "number", "description": "Started SSL handshake." }, { "name": "sslEnd", "type": "number", "description": "Finished SSL handshake." }, { "name": "sendStart", "type": "number", "description": "Started sending request." }, { "name": "sendEnd", "type": "number", "description": "Finished sending request." }, { "name": "receiveHeadersEnd", "type": "number", "description": "Finished receiving response headers." } ] }, { "id": "Request", "type": "object", "description": "HTTP request data.", "properties": [ { "name": "url", "type": "string", "description": "Request URL." }, { "name": "method", "type": "string", "description": "HTTP request method." }, { "name": "headers", "$ref": "Headers", "description": "HTTP request headers." }, { "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." } ] }, { "id": "Response", "type": "object", "description": "HTTP response data.", "properties": [ { "name": "url", "type": "string", "description": "Response URL." }, { "name": "status", "type": "number", "description": "HTTP response status code." }, { "name": "statusText", "type": "string", "description": "HTTP response status text." }, { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }, { "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." }, { "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." }, { "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." }, { "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." }, { "name": "connectionReused", "type": "boolean", "description": "Specifies whether physical connection was actually reused for this request." }, { "name": "connectionId", "type": "number", "description": "Physical connection id that was actually used for this request." }, { "name": "fromDiskCache", "type": "boolean", "optional": true, "description": "Specifies that the request was served from the disk cache." }, { "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." } ] }, { "id": "WebSocketRequest", "type": "object", "description": "WebSocket request data.", "hidden": true, "properties": [ { "name": "requestKey3", "type": "string", "description": "HTTP response status text." }, { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." } ] }, { "id": "WebSocketResponse", "type": "object", "description": "WebSocket response data.", "hidden": true, "properties": [ { "name": "status", "type": "number", "description": "HTTP response status code." }, { "name": "statusText", "type": "string", "description": "HTTP response status text." }, { "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }, { "name": "challengeResponse", "type": "string", "description": "Challenge response." } ] }, { "id": "CachedResource", "type": "object", "description": "Information about the cached resource.", "properties": [ { "name": "url", "type": "string", "description": "Resource URL." }, { "name": "type", "$ref": "Page.ResourceType", "description": "Type of this resource." }, { "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." }, { "name": "bodySize", "type": "number", "description": "Cached response body size." } ] }, { "id": "Initiator", "type": "object", "description": "Information about the request initiator.", "properties": [ { "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." }, { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." }, { "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." }, { "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." } ] } ], "commands": [ { "name": "enable", "description": "Enables network tracking, network events will now be delivered to the client." }, { "name": "disable", "description": "Disables network tracking, prevents network events from being sent to the client." }, { "name": "setUserAgentOverride", "description": "Allows overriding user agent with the given string.", "parameters": [ { "name": "userAgent", "type": "string", "description": "User agent to use." } ] }, { "name": "setExtraHTTPHeaders", "description": "Specifies whether to always send extra HTTP headers with the requests from this page.", "parameters": [ { "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." } ] }, { "name": "getResponseBody", "description": "Returns content served for the given request.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." } ], "returns": [ { "name": "body", "type": "string", "description": "Response body." }, { "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." } ] }, { "name": "canClearBrowserCache", "description": "Tells whether clearing browser cache is supported.", "returns": [ { "name": "result", "type": "boolean", "description": "True if browser cache can be cleared." } ] }, { "name": "clearBrowserCache", "description": "Clears browser cache." }, { "name": "canClearBrowserCookies", "description": "Tells whether clearing browser cookies is supported.", "returns": [ { "name": "result", "type": "boolean", "description": "True if browser cookies can be cleared." } ] }, { "name": "clearBrowserCookies", "description": "Clears browser cookies." }, { "name": "setCacheDisabled", "parameters": [ { "name": "cacheDisabled", "type": "boolean", "description": "Cache disabled state." } ], "description": "Toggles ignoring cache for each request. If <code>true</code>, cache will not be used." } ], "events": [ { "name": "requestWillBeSent", "description": "Fired when page is about to send HTTP request.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "frameId", "$ref": "FrameId", "description": "Frame identifier.", "hidden": true }, { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." }, { "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." }, { "name": "request", "$ref": "Request", "description": "Request data." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "initiator", "$ref": "Initiator", "description": "Request initiator." }, { "name": "stackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "JavaScript stack trace upon issuing this request." }, { "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." } ] }, { "name": "requestServedFromCache", "description": "Fired if request ended up loading from cache.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." } ] }, { "name": "responseReceived", "description": "Fired when HTTP response is available.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "frameId", "$ref": "FrameId", "description": "Frame identifier.", "hidden": true }, { "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." }, { "name": "response", "$ref": "Response", "description": "Response data." } ] }, { "name": "dataReceived", "description": "Fired when data chunk was received over the network.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "dataLength", "type": "integer", "description": "Data chunk length." }, { "name": "encodedDataLength", "type": "integer", "description": "Actual bytes received (might be less than dataLength for compressed encodings)." } ] }, { "name": "loadingFinished", "description": "Fired when HTTP request has finished loading.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." } ] }, { "name": "loadingFailed", "description": "Fired when HTTP request has failed to load.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "errorText", "type": "string", "description": "User friendly error message." }, { "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." } ] }, { "name": "webSocketWillSendHandshakeRequest", "description": "Fired when WebSocket is about to initiate handshake.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "request", "$ref": "WebSocketRequest", "description": "WebSocket request data." } ], "hidden": true }, { "name": "webSocketHandshakeResponseReceived", "description": "Fired when WebSocket handshake response becomes available.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }, { "name": "response", "$ref": "WebSocketResponse", "description": "WebSocket response data." } ], "hidden": true }, { "name": "webSocketCreated", "description": "Fired upon WebSocket creation.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "url", "type": "string", "description": "WebSocket request URL." } ], "hidden": true }, { "name": "webSocketClosed", "description": "Fired when WebSocket is closed.", "parameters": [ { "name": "requestId", "$ref": "RequestId", "description": "Request identifier." }, { "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." } ], "hidden": true } ] }, { "domain": "Database", "hidden": true, "types": [ { "id": "Database", "type": "object", "description": "Database object.", "hidden": true, "properties": [ { "name": "id", "type": "string", "description": "Database ID." }, { "name": "domain", "type": "string", "description": "Database domain." }, { "name": "name", "type": "string", "description": "Database name." }, { "name": "version", "type": "string", "description": "Database version." } ] }, { "id": "Error", "type": "object", "description": "Database error." } ], "commands": [ { "name": "enable", "description": "Enables database tracking, database events will now be delivered to the client." }, { "name": "disable", "description": "Disables database tracking, prevents database events from being sent to the client." }, { "name": "getDatabaseTableNames", "parameters": [ { "name": "databaseId", "type": "integer" } ], "returns": [ { "name": "tableNames", "type": "array", "items": { "type": "string" } } ] }, { "name": "executeSQL", "parameters": [ { "name": "databaseId", "type": "integer" }, { "name": "query", "type": "string" } ], "returns": [ { "name": "success", "type": "boolean" }, { "name": "transactionId", "type": "integer" } ] } ], "events": [ { "name": "addDatabase", "parameters": [