1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.internal.backends.chrome_inspector.inspector_backend</title> 4 <meta charset="utf-8"> 5 </head><body bgcolor="#f0f0f8"> 6 7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8 <tr bgcolor="#7799ee"> 9 <td valign=bottom> <br> 10 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.backends.html"><font color="#ffffff">backends</font></a>.<a href="telemetry.internal.backends.chrome_inspector.html"><font color="#ffffff">chrome_inspector</font></a>.inspector_backend</strong></big></big></font></td 11 ><td align=right valign=bottom 12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/backends/chrome_inspector/inspector_backend.py">telemetry/internal/backends/chrome_inspector/inspector_backend.py</a></font></td></tr></table> 13 <p><tt># Copyright 2013 The Chromium Authors. All rights reserved.<br> 14 # Use of this source code is governed by a BSD-style license that can be<br> 15 # found in the LICENSE file.</tt></p> 16 <p> 17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 18 <tr bgcolor="#aa55cc"> 19 <td colspan=3 valign=bottom> <br> 20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 21 22 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.decorators.html">telemetry.decorators</a><br> 24 <a href="telemetry.internal.backends.chrome_inspector.devtools_http.html">telemetry.internal.backends.chrome_inspector.devtools_http</a><br> 25 <a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> 26 <a href="functools.html">functools</a><br> 27 <a href="telemetry.internal.backends.chrome_inspector.inspector_console.html">telemetry.internal.backends.chrome_inspector.inspector_console</a><br> 28 </td><td width="25%" valign=top><a href="telemetry.internal.backends.chrome_inspector.inspector_memory.html">telemetry.internal.backends.chrome_inspector.inspector_memory</a><br> 29 <a href="telemetry.internal.backends.chrome_inspector.inspector_network.html">telemetry.internal.backends.chrome_inspector.inspector_network</a><br> 30 <a href="telemetry.internal.backends.chrome_inspector.inspector_page.html">telemetry.internal.backends.chrome_inspector.inspector_page</a><br> 31 <a href="telemetry.internal.backends.chrome_inspector.inspector_runtime.html">telemetry.internal.backends.chrome_inspector.inspector_runtime</a><br> 32 <a href="telemetry.internal.backends.chrome_inspector.inspector_websocket.html">telemetry.internal.backends.chrome_inspector.inspector_websocket</a><br> 33 </td><td width="25%" valign=top><a href="logging.html">logging</a><br> 34 <a href="os.html">os</a><br> 35 <a href="socket.html">socket</a><br> 36 <a href="sys.html">sys</a><br> 37 <a href="telemetry.timeline.model.html">telemetry.timeline.model</a><br> 38 </td><td width="25%" valign=top><a href="telemetry.timeline.trace_data.html">telemetry.timeline.trace_data</a><br> 39 <a href="telemetry.internal.backends.chrome_inspector.websocket.html">telemetry.internal.backends.chrome_inspector.websocket</a><br> 40 </td></tr></table></td></tr></table><p> 41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 42 <tr bgcolor="#ee77aa"> 43 <td colspan=3 valign=bottom> <br> 44 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 45 46 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 47 <td width="100%"><dl> 48 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 49 </font></dt><dd> 50 <dl> 51 <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.inspector_backend.html#InspectorBackend">InspectorBackend</a> 52 </font></dt></dl> 53 </dd> 54 </dl> 55 <p> 56 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 57 <tr bgcolor="#ffc8d8"> 58 <td colspan=3 valign=bottom> <br> 59 <font color="#000000" face="helvetica, arial"><a name="InspectorBackend">class <strong>InspectorBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 60 61 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 62 <td colspan=2><tt>Class for communicating with a devtools client.<br> 63 <br> 64 The owner of an instance of this class is responsible for calling<br> 65 <a href="#InspectorBackend-Disconnect">Disconnect</a>() before disposing of the instance.<br> </tt></td></tr> 66 <tr><td> </td> 67 <td width="100%">Methods defined here:<br> 68 <dl><dt><a name="InspectorBackend-ClearCache"><strong>ClearCache</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 69 70 <dl><dt><a name="InspectorBackend-CollectGarbage"><strong>CollectGarbage</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 71 72 <dl><dt><a name="InspectorBackend-Disconnect"><strong>Disconnect</strong></a>(self)</dt><dd><tt>Disconnects the inspector websocket.<br> 73 <br> 74 This method intentionally leaves the self.<strong>_websocket</strong> <a href="__builtin__.html#object">object</a> around, so that<br> 75 future calls it to it will fail with a relevant error.</tt></dd></dl> 76 77 <dl><dt><a name="InspectorBackend-EnableAllContexts"><strong>EnableAllContexts</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Allows access to iframes.<br> 78 <br> 79 Raises:<br> 80 exceptions.WebSocketDisconnected<br> 81 exceptions.TimeoutException<br> 82 exceptions.DevtoolsTargetCrashException</tt></dd></dl> 83 84 <dl><dt><a name="InspectorBackend-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Evaluates a javascript expression and returns the result.<br> 85 <br> 86 Raises:<br> 87 exceptions.EvaluateException<br> 88 exceptions.WebSocketDisconnected<br> 89 exceptions.TimeoutException<br> 90 exceptions.DevtoolsTargetCrashException</tt></dd></dl> 91 92 <dl><dt><a name="InspectorBackend-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Executes a javascript expression without returning the result.<br> 93 <br> 94 Raises:<br> 95 exceptions.EvaluateException<br> 96 exceptions.WebSocketDisconnected<br> 97 exceptions.TimeoutException<br> 98 exceptions.DevtoolsTargetCrashException</tt></dd></dl> 99 100 <dl><dt><a name="InspectorBackend-GetCookieByName"><strong>GetCookieByName</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 101 102 <dl><dt><a name="InspectorBackend-GetDOMStats"><strong>GetDOMStats</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Gets memory stats from the DOM.<br> 103 <br> 104 Raises:<br> 105 inspector_memory.InspectorMemoryException<br> 106 exceptions.TimeoutException<br> 107 exceptions.DevtoolsTargetCrashException</tt></dd></dl> 108 109 <dl><dt><a name="InspectorBackend-GetWebviewInspectorBackends"><strong>GetWebviewInspectorBackends</strong></a>(self)</dt><dd><tt>Returns a list of <a href="#InspectorBackend">InspectorBackend</a> instances associated with webviews.<br> 110 <br> 111 Raises:<br> 112 devtools_http.DevToolsClientConnectionError</tt></dd></dl> 113 114 <dl><dt><a name="InspectorBackend-IsInspectable"><strong>IsInspectable</strong></a>(self)</dt><dd><tt>Whether the tab is inspectable, as reported by devtools.</tt></dd></dl> 115 116 <dl><dt><a name="InspectorBackend-Navigate"><strong>Navigate</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 117 118 <dl><dt><a name="InspectorBackend-Screenshot"><strong>Screenshot</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 119 120 <dl><dt><a name="InspectorBackend-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 121 122 <dl><dt><a name="InspectorBackend-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 123 124 <dl><dt><a name="InspectorBackend-SynthesizeScrollGesture"><strong>SynthesizeScrollGesture</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Runs an inspector command that causes a repeatable browser driven scroll.<br> 125 <br> 126 Args:<br> 127 x: X coordinate of the start of the gesture in CSS pixels.<br> 128 y: Y coordinate of the start of the gesture in CSS pixels.<br> 129 xDistance: Distance to scroll along the X axis (positive to scroll left).<br> 130 yDistance: Distance to scroll along the Y axis (positive to scroll up).<br> 131 xOverscroll: Number of additional pixels to scroll back along the X axis.<br> 132 xOverscroll: Number of additional pixels to scroll back along the Y axis.<br> 133 preventFling: Prevents a fling gesture.<br> 134 speed: Swipe speed in pixels per second.<br> 135 gestureSourceType: Which type of input events to be generated.<br> 136 repeatCount: Number of additional repeats beyond the first scroll.<br> 137 repeatDelayMs: Number of milliseconds delay between each repeat.<br> 138 interactionMarkerName: The name of the interaction markers to generate.<br> 139 <br> 140 Raises:<br> 141 exceptions.TimeoutException<br> 142 exceptions.DevtoolsTargetCrashException</tt></dd></dl> 143 144 <dl><dt><a name="InspectorBackend-WaitForNavigate"><strong>WaitForNavigate</strong></a>(inspector_backend, *args, **kwargs)</dt></dl> 145 146 <dl><dt><a name="InspectorBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl> 147 148 <dl><dt><a name="InspectorBackend-__init__"><strong>__init__</strong></a>(self, app, devtools_client, context, timeout<font color="#909090">=60</font>)</dt></dl> 149 150 <hr> 151 Data descriptors defined here:<br> 152 <dl><dt><strong>__dict__</strong></dt> 153 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 154 </dl> 155 <dl><dt><strong>__weakref__</strong></dt> 156 <dd><tt>list of weak references to the object (if defined)</tt></dd> 157 </dl> 158 <dl><dt><strong>app</strong></dt> 159 </dl> 160 <dl><dt><strong>debugger_url</strong></dt> 161 </dl> 162 <dl><dt><strong>id</strong></dt> 163 </dl> 164 <dl><dt><strong>message_output_stream</strong></dt> 165 </dl> 166 <dl><dt><strong>screenshot_supported</strong></dt> 167 </dl> 168 <dl><dt><strong>timeline_model</strong></dt> 169 </dl> 170 <dl><dt><strong>url</strong></dt> 171 <dd><tt>Returns the URL of the tab, as reported by devtools.<br> 172 <br> 173 Raises:<br> 174 devtools_http.DevToolsClientConnectionError</tt></dd> 175 </dl> 176 </td></tr></table></td></tr></table> 177 </body></html>