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

Side by Side Diff: tools/telemetry/docs/telemetry.page.actions.reload.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

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.reload</title>	3 <html><head><title>Python: module telemetry.page.actions.reload</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>.reload</strong></big></big></fo nt></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>.reload</strong></big></big></fo nt></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/reload.py">telemetry/page/actions/reload.py</a></font ></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/actions/reload.py">telemetry/page/actions/reload.py</a></font ></td></tr></table>

12 <p><tt># Copyright (c) 2013 The Chromium Autho rs. All rights reserved.<br>	12 <p><tt># Copyright (c) 2013 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="telemetry.page.page.html">telemetry.pag e.page</a><br>	23 </td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width=" 25%" valign=top></td></tr></table></td></tr></table><p>

24 </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></tabl e></td></tr></table><p>

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

26 <tr bgcolor="#ee77aa">	25 <tr bgcolor="#ee77aa">

27 <td colspan=3 valign=bottom> <br>	26 <td colspan=3 valign=bottom> <br>

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

29	28

30 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	29 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

31 <td width="100%"><dl>	30 <td width="100%"><dl>

32 <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>)	31 <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>)

33 </font></dt><dd>	32 </font></dt><dd>

34 <dl>	33 <dl>

35 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.reload.html#Re loadAction">ReloadAction</a>	34 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.reload.html#Re loadAction">ReloadAction</a>

36 </font></dt></dl>	35 </font></dt></dl>

37 </dd>	36 </dd>

38 </dl>	37 </dl>

39 <p>	38 <p>

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

41 <tr bgcolor="#ffc8d8">	40 <tr bgcolor="#ffc8d8">

42 <td colspan=3 valign=bottom> <br>	41 <td colspan=3 valign=bottom> <br>

43 <font color="#000000" face="helvetica, arial"><a name="ReloadAction">class <stro ng>ReloadAction</strong></a>(<a href="telemetry.page.actions.page_action.html#Pa geAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>	42 <font color="#000000" face="helvetica, arial"><a name="ReloadAction">class <stro ng>ReloadAction</strong></a>(<a href="telemetry.page.actions.page_action.html#Pa geAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>

44	43

45 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	44 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

47 <dd><a href="telemetry.page.actions.reload.html#ReloadAction">ReloadAction</a></ dd>	46 <dd><a href="telemetry.page.actions.reload.html#ReloadAction">ReloadAction</a></ dd>

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

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

50 </dl>	49 </dl>

51 <hr>	50 <hr>

52 Methods defined here:<br>	51 Methods defined here:<br>

53 <dl><dt><a name="ReloadAction-RunAction"><strong>RunAction</strong></a>(self, pa ge, tab, previous_action)</dt></dl>	52 <dl><dt><a name="ReloadAction-RunAction"><strong>RunAction</strong></a>(self, pa ge, tab)</dt></dl>

54	53

55 <dl><dt><a name="ReloadAction-__init__"><strong>__init__</strong></a>(self, attr ibutes<font color="#909090">=None</font>)</dt></dl>	54 <dl><dt><a name="ReloadAction-__init__"><strong>__init__</strong></a>(self, attr ibutes<font color="#909090">=None</font>)</dt></dl>

56	55

57 <hr>	56 <hr>

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

59 <dl><dt><a name="ReloadAction-BindMeasurementJavaScript"><strong>BindMeasurement JavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this& nbsp;action determine when measurements should start&nb sp;and stop.<br>	58 <dl><dt><a name="ReloadAction-BindMeasurementJavaScript"><strong>BindMeasurement JavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this& nbsp;action determine when measurements should start&nb sp;and stop.<br>

60  <br>	59  <br>

61 A measurement can call this method to provide  the action<br>	60 A measurement can call this method to provide  the action<br>

62 with JavaScript code that starts and stops me asurements. The action<br>	61 with JavaScript code that starts and stops me asurements. The action<br>

63 determines when to execute the provided JavaScript  code, for more accurate<br>	62 determines when to execute the provided JavaScript  code, for more accurate<br>

64 timings.<br>	63 timings.<br>

65  <br>	64  <br>

66 Args:<br>	65 Args:<br>

67   tab: The tab to do everything on.<br>	66   tab: The tab to do everything on.<br>

68   start_js: JavaScript code that starts measu rements.<br>	67   start_js: JavaScript code that starts measu rements.<br>

69   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>	68   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>

70	69

71 <dl><dt><a name="ReloadAction-CanBeBound"><strong>CanBeBound</strong></a>(self)< /dt><dd><tt>If this class implements BindMeasurementJavaScri pt, override CanBeBound<br>	70 <dl><dt><a name="ReloadAction-CanBeBound"><strong>CanBeBound</strong></a>(self)< /dt><dd><tt>If this class implements BindMeasurementJavaScri pt, override CanBeBound<br>

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

73	72

74 <dl><dt><a name="ReloadAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>	73 <dl><dt><a name="ReloadAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>

75	74

76 <dl><dt><a name="ReloadAction-CustomizeBrowserOptions"><strong>CustomizeBrowserO ptions</strong></a>(self, options)</dt><dd><tt>Override to add ac tion-specific options to the BrowserOptions<br>	75 <dl><dt><a name="ReloadAction-CustomizeBrowserOptionsForPageSet"><strong>Customi zeBrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Override&nbsp ;to add action-specific options to the BrowserOpti ons<br>

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

	77  <br>

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

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

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

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

78	82

79 <dl><dt><a name="ReloadAction-RunsPreviousAction"><strong>RunsPreviousAction</st rong></a>(self)</dt><dd><tt>Some actions require some initia lization to be performed before the<br>	83 <dl><dt><a name="ReloadAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOn Timeline</strong></a>(self, timeline)</dt></dl>

80 previous action. For example, wait for href c hange needs to record the old<br>	84

81 href before the previous action changes it. T herefore, we allow actions to<br>	85 <dl><dt><a name="ReloadAction-RunActionAndMaybeWait"><strong>RunActionAndMaybeWa it</strong></a>(self, page, tab)</dt></dl>

82 run the previous action. An action that does& nbsp;this should override this to<br>

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

84	86

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

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

87	89

	90 <dl><dt><a name="ReloadAction-WillWaitAfterRun"><strong>WillWaitAfterRun</strong ></a>(self)</dt></dl>

	91

	92 <hr>

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

	94 <dl><dt><a name="ReloadAction-ResetNextTimelineMarkerId"><strong>ResetNextTimeli neMarkerId</strong></a>()</dt></dl>

	95

88 <hr>	96 <hr>

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

90 <dl><dt><strong>__dict__</strong></dt>	98 <dl><dt><strong>__dict__</strong></dt>

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

92 </dl>	100 </dl>

93 <dl><dt><strong>__weakref__</strong></dt>	101 <dl><dt><strong>__weakref__</strong></dt>

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

95 </dl>	103 </dl>

96 </td></tr></table></td></tr></table>	104 </td></tr></table></td></tr></table>

97 </body></html>	105 </body></html>

OLD	NEW

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.play.html ('k') | tools/telemetry/docs/telemetry.page.actions.scroll.html » ('j') | no next file with comments »