tools/telemetry/docs/telemetry.core.tab.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Unified Diff: tools/telemetry/docs/telemetry.core.tab.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: tools/telemetry/docs/telemetry.core.tab.html

diff --git a/tools/telemetry/docs/telemetry.core.tab.html b/tools/telemetry/docs/telemetry.core.tab.html

index 91895eefa8fa96da47fa57af8075aa990e0e1827..e18f8f62488450c04ba9a09dab4f2ece63e8def8 100644

--- a/tools/telemetry/docs/telemetry.core.tab.html

+++ b/tools/telemetry/docs/telemetry.core.tab.html

@@ -19,8 +19,9 @@

<big>Modules</big></td></tr>

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.web_contents.html">telemetry.core.web_contents</a>

-</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.bitmap.html">telemetry.core.bitmap</a>

+</td><td width="25%" valign=top><a href="telemetry.core.web_contents.html">telemetry.core.web_contents</a>

+</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

@@ -28,6 +29,12 @@

+<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

+</dt><dd>

+<dl>

+<dt><a href="telemetry.core.tab.html#BoundingBoxNotFoundException">BoundingBoxNotFoundException</a>

+</dt></dl>

+</dd>

<dt><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

</dt><dd>

<dl>

@@ -39,6 +46,64 @@

+<a name="BoundingBoxNotFoundException">class BoundingBoxNotFoundException</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

+<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

+<td width="100%"><dl><dt>Method resolution order:</dt>

+<dd><a href="telemetry.core.tab.html#BoundingBoxNotFoundException">BoundingBoxNotFoundException</a></dd>

+<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

+<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

+<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

+</dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+<hr>

+Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt><a name="BoundingBoxNotFoundException-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

+<hr>

+Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#BoundingBoxNotFoundException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

+<hr>

+Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt><a name="BoundingBoxNotFoundException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__setstate__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="BoundingBoxNotFoundException-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt>__dict__</dt>

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

+</td></tr></table>

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

<a name="Tab">class Tab</a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>)</td></tr>

@@ -69,12 +134,24 @@ and the page's documentVisibilityState becoming 'visibl

delay until the actual tab is visible to the user. None of these delays

are included in this call.</tt></dd></dl>

-<dl><dt><a name="Tab-ClearCache">ClearCache</a>(self)</dt><dd><tt>Clears the browser's HTTP disk cache and the tab's HTTP memory cache.</tt></dd></dl>

+<dl><dt><a name="Tab-ClearCache">ClearCache</a>(self, force)</dt><dd><tt>Clears the browser's networking related disk, memory and other caches.

+

+Args:

+  force: Iff true, navigates to about:blank which destroys the previous

+      renderer, ensuring that even "live" resources in the memory cache are

+      cleared.</tt></dd></dl>

+<dl><dt><a name="Tab-ClearHighlight">ClearHighlight</a>(self, color)</dt><dd><tt>Clears a highlight of the given bitmap.RgbaColor.</tt></dd></dl>

<dl><dt><a name="Tab-CollectGarbage">CollectGarbage</a>(self)</dt></dl>

<dl><dt><a name="Tab-GetCookieByName">GetCookieByName</a>(self, name, timeout=60)</dt><dd><tt>Returns the value of the cookie by the given |name|.</tt></dd></dl>

+<dl><dt><a name="Tab-Highlight">Highlight</a>(self, color)</dt><dd><tt>Synchronously highlights entire tab contents with the given RgbaColor.

+

+TODO(tonyg): It is possible that the z-index hack here might not work for

+all pages. If this happens, DevTools also provides a method for this.</tt></dd></dl>

<dl><dt><a name="Tab-Navigate">Navigate</a>(self, url, script_to_evaluate_on_commit=None, timeout=60)</dt><dd><tt>Navigates to url.

If |script_to_evaluate_on_commit| is given, the script source string will be

@@ -87,9 +164,32 @@ action_function must be a Python function that&nbs

This function returns when the navigation is complete or when

the timeout has been exceeded.</tt></dd></dl>

-<dl><dt><a name="Tab-Screenshot">Screenshot</a>(self, timeout=60)</dt><dd><tt>Capture a screenshot of the window for rendering validation</tt></dd></dl>

+<dl><dt><a name="Tab-Screenshot">Screenshot</a>(self, timeout=60)</dt><dd><tt>Capture a screenshot of the tab's contents.

+

+Returns:

+  A telemetry.core.Bitmap.</tt></dd></dl>

-<dl><dt><a name="Tab-__del__">__del__</a>(self)</dt></dl>

+<dl><dt><a name="Tab-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps)</dt><dd><tt>Starts capturing video of the tab's contents.

+

+This works by flashing the entire tab contents to a arbitrary color and then

+starting video recording. When the frames are processed, we can look for

+that flash as the content bounds.

+

+Args:

+  min_bitrate_mbps: The minimum caputre bitrate in MegaBits Per Second.

+      The platform is free to deliver a higher bitrate if it can do so

+      without increasing overhead.</tt></dd></dl>

+<dl><dt><a name="Tab-StopVideoCapture">StopVideoCapture</a>(self)</dt><dd><tt>Stops recording video of the tab's contents.

+

+This looks for the initial color flash in the first frame to establish the

+tab content boundaries and then omits all frames displaying the flash.

+

+Yields:

+  (time_ms, bitmap) tuples representing each video keyframe. Only the first

+  frame in a run of sequential duplicate bitmaps is typically included.

+    time_ms is milliseconds since navigationStart.

+    bitmap is a telemetry.core.Bitmap.</tt></dd></dl>

<dl><dt><a name="Tab-__init__">__init__</a>(self, inspector_backend)</dt></dl>

@@ -108,11 +208,16 @@ Currently this dictionary contains:

'event_listener_count': integer

}</tt></dd>

</dl>

+<dl><dt>is_video_capture_running</dt>

+</dl>

<dl><dt>screenshot_supported</dt>

-<dd><tt>True if the browser instance is capable of capturing screenshots</tt></dd>

+<dd><tt>True if the browser instance is capable of capturing screenshots.</tt></dd>

</dl>

</dl>

+<dl><dt>video_capture_supported</dt>

+<dd><tt>True if the browser instance is capable of capturing video.</tt></dd>

+</dl>

<hr>

Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:

<dl><dt><a name="Tab-Close">Close</a>(self)</dt><dd><tt>Closes this page.

@@ -120,9 +225,7 @@ Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te

Not all browsers or browser versions support this method.

Be sure to check browser.supports_tab_control.</tt></dd></dl>

-<dl><dt><a name="Tab-Disconnect">Disconnect</a>(self)</dt></dl>

-<dl><dt><a name="Tab-EvaluateJavaScript">EvaluateJavaScript</a>(self, expr, timeout=60)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.

+<dl><dt><a name="Tab-EvaluateJavaScript">EvaluateJavaScript</a>(self, expr, timeout=90)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.

Consider using ExecuteJavaScript for cases where the result of the

expression is not needed.

@@ -133,17 +236,35 @@ be raised.

If the result of the evaluation cannot be JSONized, then an

EvaluationException will be raised.</tt></dd></dl>

-<dl><dt><a name="Tab-ExecuteJavaScript">ExecuteJavaScript</a>(self, expr, timeout=60)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.

+<dl><dt><a name="Tab-EvaluateJavaScriptInContext">EvaluateJavaScriptInContext</a>(self, expr, context_id, timeout=90)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.

+The main page has context_id=1, the first iframe context_id=2, etc.</tt></dd></dl>

+<dl><dt><a name="Tab-ExecuteJavaScript">ExecuteJavaScript</a>(self, expr, timeout=90)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.

If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl>

-<dl><dt><a name="Tab-StartTimelineRecording">StartTimelineRecording</a>(self)</dt></dl>

+<dl><dt><a name="Tab-ExecuteJavaScriptInContext">ExecuteJavaScriptInContext</a>(self, expr, context_id, timeout=90)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.

+The main page has context_id=1, the first iframe context_id=2, etc.</tt></dd></dl>

+<dl><dt><a name="Tab-HasReachedQuiescence">HasReachedQuiescence</a>(self)</dt><dd><tt>Determine whether the page has reached quiescence after loading.

+

+Returns:

+  True if 2 seconds have passed since last resource received, false

+  otherwise.</tt></dd></dl>

+<dl><dt><a name="Tab-StartTimelineRecording">StartTimelineRecording</a>(self, options=None)</dt></dl>

<dl><dt><a name="Tab-StopTimelineRecording">StopTimelineRecording</a>(self)</dt></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete">WaitForDocumentReadyStateToBeComplete</a>(self, timeout=60)</dt></dl>

+<dl><dt><a name="Tab-TakeJSHeapSnapshot">TakeJSHeapSnapshot</a>(self, timeout=120)</dt></dl>

+<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete">WaitForDocumentReadyStateToBeComplete</a>(self, timeout=90)</dt></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter">WaitForDocumentReadyStateToBeInteractiveOrBetter</a>(self, timeout=60)</dt></dl>

+<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter">WaitForDocumentReadyStateToBeInteractiveOrBetter</a>(self, timeout=90)</dt></dl>

+<dl><dt><a name="Tab-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>(self, expr, timeout)</dt><dd><tt>Waits for the given JavaScript expression to be True.

+

+This method is robust against any given Evaluation timing out.</tt></dd></dl>

<hr>

Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:

@@ -153,6 +274,8 @@ Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon

<dl><dt>__weakref__</dt>

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

+<dl><dt>is_timeline_recording_running</dt>

+</dl>

<dl><dt>message_output_stream</dt>

</dl>

<dl><dt>timeline_model</dt>

« no previous file with comments | « tools/telemetry/docs/telemetry.core.profile_types.html ('k') | tools/telemetry/docs/telemetry.core.timeline.html » ('j') | no next file with comments »