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

Unified Diff: tools/telemetry/docs/telemetry.page.actions.play.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.page_action.html ('k') | tools/telemetry/docs/telemetry.page.actions.reload.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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

index 88ece2442907d8b044ddad9240dcff5080f4245a..ebcdf5fa380d21c414740161204da5b76277bd49 100644

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

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

@@ -25,10 +25,9 @@ the action to wait until playing and ended&nb

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

-</td><td width="25%" valign=top><a href="os.html">os</a>

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

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

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

-</td></tr></table></td></tr></table>

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

@@ -36,7 +35,7 @@ the action to wait until playing and ended&nb

-<dt><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

+<dt><a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)

</dt><dd>

<dl>

<dt><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a>

@@ -47,27 +46,38 @@ the action to wait until playing and ended&nb

-<a name="PlayAction">class PlayAction</a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</td></tr>

+<a name="PlayAction">class PlayAction</a>(<a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>)</td></tr>

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

<dd><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a></dd>

+<dd><a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a></dd>

<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd>

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

</dl>

<hr>

Methods defined here:

-<dl><dt><a name="PlayAction-HasEventCompleted">HasEventCompleted</a>(self, tab, selector, event_name)</dt></dl>

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

-<dl><dt><a name="PlayAction-WaitForEvent">WaitForEvent</a>(self, tab, selector, event_name, timeout)</dt><dd><tt>Halts play action until the selector's event is fired.</tt></dd></dl>

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

<dl><dt><a name="PlayAction-WillRunAction">WillRunAction</a>(self, page, tab)</dt><dd><tt>Load the media metrics JS code prior to running the action.</tt></dd></dl>

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

<hr>

+Methods inherited from <a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>:

+<dl><dt><a name="PlayAction-HasEventCompletedOrError">HasEventCompletedOrError</a>(self, tab, selector, event_name)</dt></dl>

+<dl><dt><a name="PlayAction-LoadJS">LoadJS</a>(self, tab, js_file_name)</dt><dd><tt>Loads and executes a JS file in the tab.</tt></dd></dl>

+<dl><dt><a name="PlayAction-WaitForEvent">WaitForEvent</a>(self, tab, selector, event_name, timeout)</dt><dd><tt>Halts media action until the selector's event is fired.

+

+Args:

+  tab: The tab to check for event on.

+  selector: Media element selector.

+  event_name: Name of the event to check if fired or not.

+  timeout: Timeout to check for event, throws an exception if not fired.</tt></dd></dl>

+<hr>

Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:

<dl><dt><a name="PlayAction-BindMeasurementJavaScript">BindMeasurementJavaScript</a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.

@@ -86,14 +96,23 @@ to return True so that a test knows it&n

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

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

-object.</tt></dd></dl>

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

+object. 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="PlayAction-GetActiveRangeOnTimeline">GetActiveRangeOnTimeline</a>(self, timeline)</dt></dl>

-<dl><dt><a name="PlayAction-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="PlayAction-RunActionAndMaybeWait">RunActionAndMaybeWait</a>(self, page, tab)</dt></dl>

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

+<hr>

+Static methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:

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

<hr>

Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>: