sdk/platform-tools/systrace/catapult/telemetry/docs/pydoc/telemetry.internal.backends.chrome_inspector.inspector_backend.html

   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>&nbsp;<br>
  10 <font color="#ffffff" face="helvetica, arial">&nbsp;<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>#&nbsp;Copyright&nbsp;2013&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  14 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;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>&nbsp;<br>
  20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  21
  22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</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>&nbsp;<br>
  44 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  45
  46 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
  62 <td colspan=2><tt>Class&nbsp;for&nbsp;communicating&nbsp;with&nbsp;a&nbsp;devtools&nbsp;client.<br>
  63 &nbsp;<br>
  64 The&nbsp;owner&nbsp;of&nbsp;an&nbsp;instance&nbsp;of&nbsp;this&nbsp;class&nbsp;is&nbsp;responsible&nbsp;for&nbsp;calling<br>
  65 <a href="#InspectorBackend-Disconnect">Disconnect</a>()&nbsp;before&nbsp;disposing&nbsp;of&nbsp;the&nbsp;instance.<br>&nbsp;</tt></td></tr>
  66 <tr><td>&nbsp;</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&nbsp;the&nbsp;inspector&nbsp;websocket.<br>
  73 &nbsp;<br>
  74 This&nbsp;method&nbsp;intentionally&nbsp;leaves&nbsp;the&nbsp;self.<strong>_websocket</strong>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;around,&nbsp;so&nbsp;that<br>
  75 future&nbsp;calls&nbsp;it&nbsp;to&nbsp;it&nbsp;will&nbsp;fail&nbsp;with&nbsp;a&nbsp;relevant&nbsp;error.</tt></dd></dl>
  76
  77 <dl><dt><a name="InspectorBackend-EnableAllContexts"><strong>EnableAllContexts</strong></a>(inspector_backend, *args, **kwargs)</dt><dd><tt>Allows&nbsp;access&nbsp;to&nbsp;iframes.<br>
  78 &nbsp;<br>
  79 Raises:<br>
  80 &nbsp;&nbsp;exceptions.WebSocketDisconnected<br>
  81 &nbsp;&nbsp;exceptions.TimeoutException<br>
  82 &nbsp;&nbsp;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&nbsp;a&nbsp;javascript&nbsp;expression&nbsp;and&nbsp;returns&nbsp;the&nbsp;result.<br>
  85 &nbsp;<br>
  86 Raises:<br>
  87 &nbsp;&nbsp;exceptions.EvaluateException<br>
  88 &nbsp;&nbsp;exceptions.WebSocketDisconnected<br>
  89 &nbsp;&nbsp;exceptions.TimeoutException<br>
  90 &nbsp;&nbsp;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&nbsp;a&nbsp;javascript&nbsp;expression&nbsp;without&nbsp;returning&nbsp;the&nbsp;result.<br>
  93 &nbsp;<br>
  94 Raises:<br>
  95 &nbsp;&nbsp;exceptions.EvaluateException<br>
  96 &nbsp;&nbsp;exceptions.WebSocketDisconnected<br>
  97 &nbsp;&nbsp;exceptions.TimeoutException<br>
  98 &nbsp;&nbsp;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&nbsp;memory&nbsp;stats&nbsp;from&nbsp;the&nbsp;DOM.<br>
 103 &nbsp;<br>
 104 Raises:<br>
 105 &nbsp;&nbsp;inspector_memory.InspectorMemoryException<br>
 106 &nbsp;&nbsp;exceptions.TimeoutException<br>
 107 &nbsp;&nbsp;exceptions.DevtoolsTargetCrashException</tt></dd></dl>
 108
 109 <dl><dt><a name="InspectorBackend-GetWebviewInspectorBackends"><strong>GetWebviewInspectorBackends</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;<a href="#InspectorBackend">InspectorBackend</a>&nbsp;instances&nbsp;associated&nbsp;with&nbsp;webviews.<br>
 110 &nbsp;<br>
 111 Raises:<br>
 112 &nbsp;&nbsp;devtools_http.DevToolsClientConnectionError</tt></dd></dl>
 113
 114 <dl><dt><a name="InspectorBackend-IsInspectable"><strong>IsInspectable</strong></a>(self)</dt><dd><tt>Whether&nbsp;the&nbsp;tab&nbsp;is&nbsp;inspectable,&nbsp;as&nbsp;reported&nbsp;by&nbsp;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&nbsp;an&nbsp;inspector&nbsp;command&nbsp;that&nbsp;causes&nbsp;a&nbsp;repeatable&nbsp;browser&nbsp;driven&nbsp;scroll.<br>
 125 &nbsp;<br>
 126 Args:<br>
 127 &nbsp;&nbsp;x:&nbsp;X&nbsp;coordinate&nbsp;of&nbsp;the&nbsp;start&nbsp;of&nbsp;the&nbsp;gesture&nbsp;in&nbsp;CSS&nbsp;pixels.<br>
 128 &nbsp;&nbsp;y:&nbsp;Y&nbsp;coordinate&nbsp;of&nbsp;the&nbsp;start&nbsp;of&nbsp;the&nbsp;gesture&nbsp;in&nbsp;CSS&nbsp;pixels.<br>
 129 &nbsp;&nbsp;xDistance:&nbsp;Distance&nbsp;to&nbsp;scroll&nbsp;along&nbsp;the&nbsp;X&nbsp;axis&nbsp;(positive&nbsp;to&nbsp;scroll&nbsp;left).<br>
 130 &nbsp;&nbsp;yDistance:&nbsp;Distance&nbsp;to&nbsp;scroll&nbsp;along&nbsp;the&nbsp;Y&nbsp;axis&nbsp;(positive&nbsp;to&nbsp;scroll&nbsp;up).<br>
 131 &nbsp;&nbsp;xOverscroll:&nbsp;Number&nbsp;of&nbsp;additional&nbsp;pixels&nbsp;to&nbsp;scroll&nbsp;back&nbsp;along&nbsp;the&nbsp;X&nbsp;axis.<br>
 132 &nbsp;&nbsp;xOverscroll:&nbsp;Number&nbsp;of&nbsp;additional&nbsp;pixels&nbsp;to&nbsp;scroll&nbsp;back&nbsp;along&nbsp;the&nbsp;Y&nbsp;axis.<br>
 133 &nbsp;&nbsp;preventFling:&nbsp;Prevents&nbsp;a&nbsp;fling&nbsp;gesture.<br>
 134 &nbsp;&nbsp;speed:&nbsp;Swipe&nbsp;speed&nbsp;in&nbsp;pixels&nbsp;per&nbsp;second.<br>
 135 &nbsp;&nbsp;gestureSourceType:&nbsp;Which&nbsp;type&nbsp;of&nbsp;input&nbsp;events&nbsp;to&nbsp;be&nbsp;generated.<br>
 136 &nbsp;&nbsp;repeatCount:&nbsp;Number&nbsp;of&nbsp;additional&nbsp;repeats&nbsp;beyond&nbsp;the&nbsp;first&nbsp;scroll.<br>
 137 &nbsp;&nbsp;repeatDelayMs:&nbsp;Number&nbsp;of&nbsp;milliseconds&nbsp;delay&nbsp;between&nbsp;each&nbsp;repeat.<br>
 138 &nbsp;&nbsp;interactionMarkerName:&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;interaction&nbsp;markers&nbsp;to&nbsp;generate.<br>
 139 &nbsp;<br>
 140 Raises:<br>
 141 &nbsp;&nbsp;exceptions.TimeoutException<br>
 142 &nbsp;&nbsp;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&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 154 </dl>
 155 <dl><dt><strong>__weakref__</strong></dt>
 156 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;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&nbsp;the&nbsp;URL&nbsp;of&nbsp;the&nbsp;tab,&nbsp;as&nbsp;reported&nbsp;by&nbsp;devtools.<br>
 172 &nbsp;<br>
 173 Raises:<br>
 174 &nbsp;&nbsp;devtools_http.DevToolsClientConnectionError</tt></dd>
 175 </dl>
 176 </td></tr></table></td></tr></table>
 177 </body></html>