tools/telemetry/docs/telemetry.core.tab.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

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

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 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

new file mode 100644

index 0000000000000000000000000000000000000000..1fba4ac4633da7c59c5b84f6e2c2ce25af02b14c

--- /dev/null

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

@@ -0,0 +1,166 @@

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

+<html><head><title>Python: module telemetry.core.tab</title>

+</head><body bgcolor="#f0f0f8">

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

+<tr bgcolor="#7799ee">

+<td valign=bottom>

+  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.core.html">core</a>.tab</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab.py</a></td></tr></table>

+ <tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.

+# Use of this source code is governed by a BSD-style license that can be

+# found in the LICENSE file.</tt>

+

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

+<tr bgcolor="#aa55cc">

+<td colspan=3 valign=bottom>

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

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

+<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>

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

+<tr bgcolor="#ee77aa">

+<td colspan=3 valign=bottom>

+<big>Classes</big></td></tr>

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

+<td width="100%"><dl>

+<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>

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

+</dt></dl>

+</dd>

+</dl>

+

+<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>

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

+<td colspan=2><tt>Represents a tab in the browser

+

+The important parts of the <a href="#Tab">Tab</a> object are in the runtime and page objects.

+E.g.:

+    # Navigates the tab to a given url.

+    tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http://www.google.com/">http://www.google.com/</a>')

+

+    # Evaluates 1+1 in the tab's JavaScript context.

+    tab.Evaluate('1+1')  </tt></td></tr>

+<tr><td> </td>

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

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

+<dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a></dd>

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

+</dl>

+<hr>

+Methods defined here:

+<dl><dt><a name="Tab-Activate">Activate</a>(self)</dt><dd><tt>Brings this tab to the foreground asynchronously.

+

+Not all browsers or browser versions support this method.

+Be sure to check browser.supports_tab_control.

+

+Please note: this is asynchronous. There is a delay between this call

+and the page's documentVisibilityState becoming 'visible', and yet more

+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-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-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

+evaluated when the navigation is committed. This is after the context of

+the page exists, but before any script on the page itself has executed.</tt></dd></dl>

+<dl><dt><a name="Tab-PerformActionAndWaitForNavigate">PerformActionAndWaitForNavigate</a>(self, action_function, timeout=60)</dt><dd><tt>Executes action_function, and waits for the navigation to complete.

+

+action_function must be a Python function that results in a navigation.

+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-__del__">__del__</a>(self)</dt></dl>

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

+<hr>

+Data descriptors defined here:

+<dl><dt>browser</dt>

+<dd><tt>The browser in which this tab resides.</tt></dd>

+</dl>

+<dl><dt>dom_stats</dt>

+<dd><tt>A dictionary populated with measured DOM statistics.

+

+Currently this dictionary contains:

+{

+  'document_count': integer,

+  'node_count': integer,

+  'event_listener_count': integer

+}</tt></dd>

+</dl>

+<dl><dt>screenshot_supported</dt>

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

+</dl>

+<dl><dt>url</dt>

+</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.

+

+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.

+

+Consider using ExecuteJavaScript for cases where the result of the

+expression is not needed.

+

+If evaluation throws in JavaScript, a Python EvaluateException will

+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.

+

+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-StopTimelineRecording">StopTimelineRecording</a>(self)</dt></dl>

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

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

+<hr>

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

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

+<dd><tt>dictionary for instance variables (if defined)</tt></dd>

+</dl>

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

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

+</dl>

+<dl><dt>message_output_stream</dt>

+</dl>

+<dl><dt>timeline_model</dt>

+</dl>

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

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

+<tr bgcolor="#55aa55">

+<td colspan=3 valign=bottom>

+<big>Data</big></td></tr>

+<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>

+<td width="100%">DEFAULT_TAB_TIMEOUT = 60</td></tr></table>

+</body></html>

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