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

Side by Side Diff: tools/telemetry/docs/telemetry.page.actions.wait.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 unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.scroll.html ('k') | tools/telemetry/docs/telemetry.page.block_page_measurement_results.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1	1

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

3 <html><head><title>Python: module telemetry.page.actions.wait</title>	3 <html><head><title>Python: module telemetry.page.actions.wait</title>

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

5	5

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

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.wait</strong></big></big></font ></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.wait</strong></big></big></font ></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/actions/wait.py">telemetry/page/actions/wait.py</a></font></t d></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/actions/wait.py">telemetry/page/actions/wait.py</a></font></t d></tr></table>

12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>	12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>

13 # Use of this source code is governed by  a BSD-style license that can be<br>	13 # Use of this source code is governed by  a BSD-style license that can be<br>

14 # found in the LICENSE file.</tt></p>	14 # found in the LICENSE file.</tt></p>

15 <p>	15 <p>

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

17 <tr bgcolor="#aa55cc">	17 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	18 <td colspan=3 valign=bottom> <br>

19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

20	20

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

22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page _action</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page _action</a><br>

	23 </td><td width="25%" valign=top><a href="re.html">re</a><br>

23 </td><td width="25%" valign=top><a href="time.html">time</a><br>	24 </td><td width="25%" valign=top><a href="time.html">time</a><br>

24 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor e.util</a><br>	25 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor e.util</a><br>

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

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

27 <tr bgcolor="#ee77aa">	28 <tr bgcolor="#ee77aa">

28 <td colspan=3 valign=bottom> <br>	29 <td colspan=3 valign=bottom> <br>

29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>	30 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

30	31

31 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	32 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

32 <td width="100%"><dl>	33 <td width="100%"><dl>

33 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__buil tin__.html#object">__builtin__.object</a>)	34 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__buil tin__.html#object">__builtin__.object</a>)

34 </font></dt><dd>	35 </font></dt><dd>

35 <dl>	36 <dl>

36 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.wait.html#Wait Action">WaitAction</a>	37 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.wait.html#Wait Action">WaitAction</a>

37 </font></dt></dl>	38 </font></dt></dl>

38 </dd>	39 </dd>

39 </dl>	40 </dl>

40 <p>	41 <p>

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

42 <tr bgcolor="#ffc8d8">	43 <tr bgcolor="#ffc8d8">

43 <td colspan=3 valign=bottom> <br>	44 <td colspan=3 valign=bottom> <br>

44 <font color="#000000" face="helvetica, arial"><a name="WaitAction">class <strong >WaitAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAc tion">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>	45 <font color="#000000" face="helvetica, arial"><a name="WaitAction">class <strong >WaitAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAc tion">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>

45	46

46 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	47 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

48 <dd><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a></dd>	49 <dd><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a></dd>

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

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

51 </dl>	52 </dl>

52 <hr>	53 <hr>

53 Methods defined here:<br>	54 Methods defined here:<br>

54 <dl><dt><a name="WaitAction-RunAction"><strong>RunAction</strong></a>(self, page , tab, previous_action)</dt></dl>	55 <dl><dt><a name="WaitAction-RunAction"><strong>RunAction</strong></a>(self, page , tab)</dt></dl>

55

56 <dl><dt><a name="WaitAction-RunsPreviousAction"><strong>RunsPreviousAction</stro ng></a>(self)</dt></dl>

57	56

58 <dl><dt><a name="WaitAction-__init__"><strong>__init__</strong></a>(self, attrib utes<font color="#909090">=None</font>)</dt></dl>	57 <dl><dt><a name="WaitAction-__init__"><strong>__init__</strong></a>(self, attrib utes<font color="#909090">=None</font>)</dt></dl>

59	58

60 <hr>	59 <hr>

61 Data and other attributes defined here:<br>

62 <dl><dt><strong>DEFAULT_TIMEOUT</strong> = 60</dl>

63

64 <hr>

65 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>	60 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>

66 <dl><dt><a name="WaitAction-BindMeasurementJavaScript"><strong>BindMeasurementJa vaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this&nb sp;action determine when measurements should start&nbsp ;and stop.<br>	61 <dl><dt><a name="WaitAction-BindMeasurementJavaScript"><strong>BindMeasurementJa vaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this&nb sp;action determine when measurements should start&nbsp ;and stop.<br>

67  <br>	62  <br>

68 A measurement can call this method to provide  the action<br>	63 A measurement can call this method to provide  the action<br>

69 with JavaScript code that starts and stops me asurements. The action<br>	64 with JavaScript code that starts and stops me asurements. The action<br>

70 determines when to execute the provided JavaScript  code, for more accurate<br>	65 determines when to execute the provided JavaScript  code, for more accurate<br>

71 timings.<br>	66 timings.<br>

72  <br>	67  <br>

73 Args:<br>	68 Args:<br>

74   tab: The tab to do everything on.<br>	69   tab: The tab to do everything on.<br>

75   start_js: JavaScript code that starts measu rements.<br>	70   start_js: JavaScript code that starts measu rements.<br>

76   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>	71   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>

77	72

78 <dl><dt><a name="WaitAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</d t><dd><tt>If this class implements BindMeasurementJavaScript , override CanBeBound<br>	73 <dl><dt><a name="WaitAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</d t><dd><tt>If this class implements BindMeasurementJavaScript , override CanBeBound<br>

79 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>	74 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>

80	75

81 <dl><dt><a name="WaitAction-CleanUp"><strong>CleanUp</strong></a>(self, page, ta b)</dt></dl>	76 <dl><dt><a name="WaitAction-CleanUp"><strong>CleanUp</strong></a>(self, page, ta b)</dt></dl>

82	77

83 <dl><dt><a name="WaitAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOpt ions</strong></a>(self, options)</dt><dd><tt>Override to add acti on-specific options to the BrowserOptions<br>	78 <dl><dt><a name="WaitAction-CustomizeBrowserOptionsForPageSet"><strong>Customize BrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Override t o add action-specific options to the BrowserOption s<br>

84 object.</tt></dd></dl>	79 object. These options will be set for the&nbs p;whole page set.<br>

	80  <br>

	81 If the browser is not being restarted for&nbs p;every page in the page set then<br>

	82 all browser options required for the action m ust be set here. This, however,<br>

	83 requires that they do not conflict with optio ns require by other actions<br>

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

	85

	86 <dl><dt><a name="WaitAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOnTi meline</strong></a>(self, timeline)</dt></dl>

	87

	88 <dl><dt><a name="WaitAction-RunActionAndMaybeWait"><strong>RunActionAndMaybeWait </strong></a>(self, page, tab)</dt></dl>

85	89

86 <dl><dt><a name="WaitAction-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab)</dt><dd><tt>Override to do action-specific se tup before<br>	90 <dl><dt><a name="WaitAction-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab)</dt><dd><tt>Override to do action-specific se tup before<br>

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

88	92

	93 <dl><dt><a name="WaitAction-WillWaitAfterRun"><strong>WillWaitAfterRun</strong>< /a>(self)</dt></dl>

	94

	95 <hr>

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

	97 <dl><dt><a name="WaitAction-ResetNextTimelineMarkerId"><strong>ResetNextTimeline MarkerId</strong></a>()</dt></dl>

	98

89 <hr>	99 <hr>

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

91 <dl><dt><strong>__dict__</strong></dt>	101 <dl><dt><strong>__dict__</strong></dt>

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

93 </dl>	103 </dl>

94 <dl><dt><strong>__weakref__</strong></dt>	104 <dl><dt><strong>__weakref__</strong></dt>

95 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	105 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

96 </dl>	106 </dl>

97 </td></tr></table></td></tr></table>	107 </td></tr></table></td></tr></table>

98 </body></html>	108 </body></html>

OLD	NEW