tools/telemetry/docs/telemetry.page.actions.page_action.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Unified Diff: tools/telemetry/docs/telemetry.page.actions.page_action.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

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html ('k') | tools/telemetry/docs/telemetry.page.actions.play.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/telemetry.page.actions.page_action.html

diff --git a/tools/telemetry/docs/telemetry.page.actions.page_action.html b/tools/telemetry/docs/telemetry.page.actions.page_action.html

index 6e22906f864935f4af59f30573fab56db1e12487..380dabdf7f40196f17074a9631eeebb674e9aae7 100644

--- a/tools/telemetry/docs/telemetry.page.actions.page_action.html

+++ b/tools/telemetry/docs/telemetry.page.actions.page_action.html

@@ -14,6 +14,15 @@

# found in the LICENSE file.</tt>

+<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.timeline.bounds.html">telemetry.core.timeline.bounds</a>

+</td><td width="25%" valign=top><a href="telemetry.page.actions.wait_until.html">telemetry.page.actions.wait_until</a>

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

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

@@ -30,6 +39,7 @@

</dt><dd>

<dl>

<dt><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a>

+</dt><dt><a href="telemetry.page.actions.page_action.html#PageActionInvalidTimelineMarker">PageActionInvalidTimelineMarker</a>

</dt><dt><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</a>

</dt></dl>

</dd>

@@ -61,23 +71,32 @@ to return True so that a test knows it&n

<dl><dt><a name="PageAction-CleanUp">CleanUp</a>(self, page, tab)</dt></dl>

-<dl><dt><a name="PageAction-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions

-<a href="__builtin__.html#object">object</a>.</tt></dd></dl>

+<dl><dt><a name="PageAction-CustomizeBrowserOptionsForPageSet">CustomizeBrowserOptionsForPageSet</a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions

+<a href="__builtin__.html#object">object</a>. These options will be set for the whole page set.

+

+If the browser is not being restarted for every page in the page set then

+all browser options required for the action must be set here. This, however,

+requires that they do not conflict with options require by other actions

+used up by the page set.</tt></dd></dl>

-<dl><dt><a name="PageAction-RunAction">RunAction</a>(self, page, tab, previous_action)</dt></dl>

+<dl><dt><a name="PageAction-GetActiveRangeOnTimeline">GetActiveRangeOnTimeline</a>(self, timeline)</dt></dl>

-<dl><dt><a name="PageAction-RunsPreviousAction">RunsPreviousAction</a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the

-previous action. For example, wait for href change needs to record the old

-href before the previous action changes it. Therefore, we allow actions to

-run the previous action. An action that does this should override this to

-return True in order to prevent the previous action from being run twice.</tt></dd></dl>

+<dl><dt><a name="PageAction-RunAction">RunAction</a>(self, page, tab)</dt></dl>

+<dl><dt><a name="PageAction-RunActionAndMaybeWait">RunActionAndMaybeWait</a>(self, page, tab)</dt></dl>

<dl><dt><a name="PageAction-WillRunAction">WillRunAction</a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before

Test.WillRunAction is called.</tt></dd></dl>

+<dl><dt><a name="PageAction-WillWaitAfterRun">WillWaitAfterRun</a>(self)</dt></dl>

<dl><dt><a name="PageAction-__init__">__init__</a>(self, attributes=None)</dt></dl>

<hr>

+Static methods defined here:

+<dl><dt><a name="PageAction-ResetNextTimelineMarkerId">ResetNextTimelineMarkerId</a>()</dt></dl>

+<hr>

Data descriptors defined here:

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

@@ -147,6 +166,64 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio

+<a name="PageActionInvalidTimelineMarker">class PageActionInvalidTimelineMarker</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.page.actions.page_action.html#PageActionInvalidTimelineMarker">PageActionInvalidTimelineMarker</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="PageActionInvalidTimelineMarker-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__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="#PageActionInvalidTimelineMarker-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> 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="PageActionInvalidTimelineMarker-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

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

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

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

+

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

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

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

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

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

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

+<dl><dt><a name="PageActionInvalidTimelineMarker-__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="PageActionNotSupported">class PageActionNotSupported</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>