Google Git
Sign in
chromium / android_tools / 9a70d48fcdd68cd0e7e968f342bd767ee6323bd1 / . / sdk / platform-tools / systrace / catapult / telemetry / docs / pydoc / telemetry.page.html
blob: e403666fc08dd40dfa6cc9360b10d7217464d2b2 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package telemetry.page</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.page</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/__init__.py">telemetry/page/__init__.py</a></font></td></tr></table>
<p><tt>#&nbsp;Copyright&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
#&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>
#&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.action_runner.html">action_runner</a><br>
<a href="telemetry.page.page.html">page</a><br>
</td><td width="25%" valign=top><a href="telemetry.page.page_run_end_to_end_unittest.html">page_run_end_to_end_unittest</a><br>
<a href="telemetry.page.page_test.html">page_test</a><br>
</td><td width="25%" valign=top><a href="telemetry.page.page_test_unittest.html">page_test_unittest</a><br>
<a href="telemetry.page.page_unittest.html">page_unittest</a><br>
</td><td width="25%" valign=top><a href="telemetry.page.shared_page_state.html">shared_page_state</a><br>
<a href="telemetry.page.shared_page_state_unittest.html">shared_page_state_unittest</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.page.html#Page">Page</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Page">class <strong>Page</strong></a>(<a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.page.html#Page">Page</a></dd>
<dd><a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Page-AddCustomizeBrowserOptions"><strong>AddCustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Inherit&nbsp;page&nbsp;overrides&nbsp;this&nbsp;to&nbsp;add&nbsp;customized&nbsp;browser&nbsp;options.</tt></dd></dl>
<dl><dt><a name="Page-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>Converts&nbsp;a&nbsp;page&nbsp;object&nbsp;to&nbsp;a&nbsp;dict&nbsp;suitable&nbsp;for&nbsp;JSON&nbsp;output.</tt></dd></dl>
<dl><dt><a name="Page-GetSyntheticDelayCategories"><strong>GetSyntheticDelayCategories</strong></a>(self)</dt></dl>
<dl><dt><a name="Page-Run"><strong>Run</strong></a>(self, shared_state)</dt></dl>
<dl><dt><a name="Page-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, action_runner)</dt></dl>
<dl><dt><a name="Page-RunPageInteractions"><strong>RunPageInteractions</strong></a>(self, action_runner)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;define&nbsp;custom&nbsp;interactions&nbsp;with&nbsp;the&nbsp;page.<br>
e.g:<br>
&nbsp;&nbsp;def&nbsp;<a href="#Page-RunPageInteractions">RunPageInteractions</a>(self,&nbsp;action_runner):<br>
&nbsp;&nbsp;&nbsp;&nbsp;action_runner.ScrollPage()<br>
&nbsp;&nbsp;&nbsp;&nbsp;action_runner.TapElement(text='Next')</tt></dd></dl>
<dl><dt><a name="Page-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="Page-__init__"><strong>__init__</strong></a>(self, url, page_set<font color="#909090">=None</font>, base_dir<font color="#909090">=None</font>, name<font color="#909090">=''</font>, credentials_path<font color="#909090">=None</font>, credentials_bucket<font color="#909090">='chromium-telemetry'</font>, labels<font color="#909090">=None</font>, startup_url<font color="#909090">=''</font>, make_javascript_deterministic<font color="#909090">=True</font>, shared_page_state_class<font color="#909090">=&lt;class 'telemetry.page.shared_page_state.SharedPageState'&gt;</font>)</dt></dl>
<dl><dt><a name="Page-__lt__"><strong>__lt__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="Page-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>base_dir</strong></dt>
</dl>
<dl><dt><strong>credentials_path</strong></dt>
</dl>
<dl><dt><strong>display_name</strong></dt>
</dl>
<dl><dt><strong>file_path</strong></dt>
<dd><tt>Returns&nbsp;the&nbsp;path&nbsp;of&nbsp;the&nbsp;file,&nbsp;stripping&nbsp;the&nbsp;scheme&nbsp;and&nbsp;query&nbsp;string.</tt></dd>
</dl>
<dl><dt><strong>file_path_url</strong></dt>
<dd><tt>Returns&nbsp;the&nbsp;file&nbsp;path,&nbsp;including&nbsp;the&nbsp;params,&nbsp;query,&nbsp;and&nbsp;fragment.</tt></dd>
</dl>
<dl><dt><strong>file_path_url_with_scheme</strong></dt>
</dl>
<dl><dt><strong>is_file</strong></dt>
<dd><tt>Returns&nbsp;True&nbsp;iff&nbsp;this&nbsp;URL&nbsp;points&nbsp;to&nbsp;a&nbsp;file.</tt></dd>
</dl>
<dl><dt><strong>page_set</strong></dt>
</dl>
<dl><dt><strong>serving_dir</strong></dt>
</dl>
<dl><dt><strong>startup_url</strong></dt>
</dl>
<dl><dt><strong>story_set</strong></dt>
</dl>
<dl><dt><strong>url</strong></dt>
</dl>
<hr>
Data descriptors inherited from <a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>file_safe_name</strong></dt>
<dd><tt>A&nbsp;version&nbsp;of&nbsp;display_name&nbsp;that's&nbsp;safe&nbsp;to&nbsp;use&nbsp;as&nbsp;a&nbsp;filename.<br>
&nbsp;<br>
The&nbsp;default&nbsp;implementation&nbsp;sanitizes&nbsp;special&nbsp;characters&nbsp;with&nbsp;underscores,<br>
but&nbsp;it's&nbsp;okay&nbsp;to&nbsp;override&nbsp;it&nbsp;with&nbsp;a&nbsp;more&nbsp;specific&nbsp;implementation&nbsp;in<br>
subclasses.</tt></dd>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<dl><dt><strong>is_local</strong></dt>
<dd><tt>Returns&nbsp;True&nbsp;iff&nbsp;this&nbsp;story&nbsp;does&nbsp;not&nbsp;require&nbsp;network.</tt></dd>
</dl>
<dl><dt><strong>labels</strong></dt>
</dl>
<dl><dt><strong>make_javascript_deterministic</strong></dt>
</dl>
<dl><dt><strong>name</strong></dt>
</dl>
<dl><dt><strong>shared_state_class</strong></dt>
</dl>
</td></tr></table></td></tr></table>
</body></html>