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

Side by Side 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 unified diff | Download patch | Annotate | Revision Log

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

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

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

	20

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

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

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

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

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

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

20	29

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

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

23 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>	32 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>

24 </font></dt><dd>	33 </font></dt><dd>

25 <dl>	34 <dl>

26 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">PageAction</a>	35 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">PageAction</a>

27 </font></dt></dl>	36 </font></dt></dl>

28 </dd>	37 </dd>

29 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)	38 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)

30 </font></dt><dd>	39 </font></dt><dd>

31 <dl>	40 <dl>

32 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageActionFailed">PageActionFailed</a>	41 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageActionFailed">PageActionFailed</a>

	42 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.actions.pa ge_action.html#PageActionInvalidTimelineMarker">PageActionInvalidTimelineMarker< /a>

33 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.actions.pa ge_action.html#PageActionNotSupported">PageActionNotSupported</a>	43 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.actions.pa ge_action.html#PageActionNotSupported">PageActionNotSupported</a>

34 </font></dt></dl>	44 </font></dt></dl>

35 </dd>	45 </dd>

36 </dl>	46 </dl>

37 <p>	47 <p>

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

39 <tr bgcolor="#ffc8d8">	49 <tr bgcolor="#ffc8d8">

40 <td colspan=3 valign=bottom> <br>	50 <td colspan=3 valign=bottom> <br>

41 <font color="#000000" face="helvetica, arial"><a name="PageAction">class <strong >PageAction</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a >)</font></td></tr>	51 <font color="#000000" face="helvetica, arial"><a name="PageAction">class <strong >PageAction</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a >)</font></td></tr>

42	52

(...skipping 11 matching lines...) Expand all Loading...
54 Args:<br>	64 Args:<br>

55   tab: The tab to do everything on.<br>	65   tab: The tab to do everything on.<br>

56   start_js: JavaScript code that starts measu rements.<br>	66   start_js: JavaScript code that starts measu rements.<br>

57   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>	67   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>

58	68

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

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

61	71

62 <dl><dt><a name="PageAction-CleanUp"><strong>CleanUp</strong></a>(self, page, ta b)</dt></dl>	72 <dl><dt><a name="PageAction-CleanUp"><strong>CleanUp</strong></a>(self, page, ta b)</dt></dl>

63	73

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

65 <a href="__builtin__.html#object">object</a>.</tt></dd></dl>	75 <a href="__builtin__.html#object">object</a>. These options will& nbsp;be set for the whole page set.<br>

	76  <br>

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

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

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

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

66	81

67 <dl><dt><a name="PageAction-RunAction"><strong>RunAction</strong></a>(self, page , tab, previous_action)</dt></dl>	82 <dl><dt><a name="PageAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOnTi meline</strong></a>(self, timeline)</dt></dl>

68	83

69 <dl><dt><a name="PageAction-RunsPreviousAction"><strong>RunsPreviousAction</stro ng></a>(self)</dt><dd><tt>Some actions require some initiali zation to be performed before the<br>	84 <dl><dt><a name="PageAction-RunAction"><strong>RunAction</strong></a>(self, page , tab)</dt></dl>

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

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

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

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

74	87

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

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

77	90

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

	92

78 <dl><dt><a name="PageAction-__init__"><strong>__init__</strong></a>(self, attrib utes<font color="#909090">=None</font>)</dt></dl>	93 <dl><dt><a name="PageAction-__init__"><strong>__init__</strong></a>(self, attrib utes<font color="#909090">=None</font>)</dt></dl>

79	94

80 <hr>	95 <hr>

	96 Static methods defined here:<br>

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

	98

	99 <hr>

81 Data descriptors defined here:<br>	100 Data descriptors defined here:<br>

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

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

84 </dl>	103 </dl>

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

86 <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>

87 </dl>	106 </dl>

88 </td></tr></table> <p>	107 </td></tr></table> <p>

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

90 <tr bgcolor="#ffc8d8">	109 <tr bgcolor="#ffc8d8">

(...skipping 49 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
140 <dl><dt><strong>__dict__</strong></dt>	159 <dl><dt><strong>__dict__</strong></dt>

141 </dl>	160 </dl>

142 <dl><dt><strong>args</strong></dt>	161 <dl><dt><strong>args</strong></dt>

143 </dl>	162 </dl>

144 <dl><dt><strong>message</strong></dt>	163 <dl><dt><strong>message</strong></dt>

145 </dl>	164 </dl>

146 </td></tr></table> <p>	165 </td></tr></table> <p>

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

148 <tr bgcolor="#ffc8d8">	167 <tr bgcolor="#ffc8d8">

149 <td colspan=3 valign=bottom> <br>	168 <td colspan=3 valign=bottom> <br>

	169 <font color="#000000" face="helvetica, arial"><a name="PageActionInvalidTimeline Marker">class <strong>PageActionInvalidTimelineMarker</strong></a>(<a href="exce ptions.html#Exception">exceptions.Exception</a>)</font></td></tr>

	170

	171 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

	173 <dd><a href="telemetry.page.actions.page_action.html#PageActionInvalidTimelineMa rker">PageActionInvalidTimelineMarker</a></dd>

	174 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

	175 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

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

	177 </dl>

	178 <hr>

	179 Data descriptors defined here:<br>

	180 <dl><dt><strong>__weakref__</strong></dt>

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

	182 </dl>

	183 <hr>

	184 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>

	185 <dl><dt><a name="PageActionInvalidTimelineMarker-__init__"><strong>__init__</str ong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__init__"> __init__</a>(...) initializes x; see help(type(x)) for& nbsp;signature</tt></dd></dl>

	186

	187 <hr>

	188 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>

	189 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#PageActionInvalidTimelineMarker-__new__">__new__</a>(S,&nbs p;...) -> a new <a href="__builtin__.html#object">object< /a> with type S, a subtype of T</tt></dl>

	190

	191 <hr>

	192 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>

	193 <dl><dt><a name="PageActionInvalidTimelineMarker-__delattr__"><strong>__delattr_ _</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__de lattr__">__delattr__</a>('name') <==> del x.name</tt></dd>< /dl>

	194

	195 <dl><dt><a name="PageActionInvalidTimelineMarker-__getattribute__"><strong>__get attribute__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineM arker-__getattribute__">__getattribute__</a>('name') <==> x.name </tt></dd></dl>

	196

	197 <dl><dt><a name="PageActionInvalidTimelineMarker-__getitem__"><strong>__getitem_ _</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__ge titem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

	198

	199 <dl><dt><a name="PageActionInvalidTimelineMarker-__getslice__"><strong>__getslic e__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__ getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>

	200  <br>

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

	202

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

	204

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

	206

	207 <dl><dt><a name="PageActionInvalidTimelineMarker-__setattr__"><strong>__setattr_ _</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__se tattr__">__setattr__</a>('name', value) <==> x.name =& nbsp;value</tt></dd></dl>

	208

	209 <dl><dt><a name="PageActionInvalidTimelineMarker-__setstate__"><strong>__setstat e__</strong></a>(...)</dt></dl>

	210

	211 <dl><dt><a name="PageActionInvalidTimelineMarker-__str__"><strong>__str__</stron g></a>(...)</dt><dd><tt>x.<a href="#PageActionInvalidTimelineMarker-__str__">__s tr__</a>() <==> str(x)</tt></dd></dl>

	212

	213 <dl><dt><a name="PageActionInvalidTimelineMarker-__unicode__"><strong>__unicode_ _</strong></a>(...)</dt></dl>

	214

	215 <hr>

	216 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>

	217 <dl><dt><strong>__dict__</strong></dt>

	218 </dl>

	219 <dl><dt><strong>args</strong></dt>

	220 </dl>

	221 <dl><dt><strong>message</strong></dt>

	222 </dl>

	223 </td></tr></table> <p>

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

	225 <tr bgcolor="#ffc8d8">

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

150 <font color="#000000" face="helvetica, arial"><a name="PageActionNotSupported">c lass <strong>PageActionNotSupported</strong></a>(<a href="exceptions.html#Except ion">exceptions.Exception</a>)</font></td></tr>	227 <font color="#000000" face="helvetica, arial"><a name="PageActionNotSupported">c lass <strong>PageActionNotSupported</strong></a>(<a href="exceptions.html#Except ion">exceptions.Exception</a>)</font></td></tr>

151	228

152 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	229 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

154 <dd><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">Pag eActionNotSupported</a></dd>	231 <dd><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">Pag eActionNotSupported</a></dd>

155 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>	232 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

156 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>	233 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

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

158 </dl>	235 </dl>

159 <hr>	236 <hr>

(...skipping 36 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
196 <hr>	273 <hr>

197 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>	274 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>

198 <dl><dt><strong>__dict__</strong></dt>	275 <dl><dt><strong>__dict__</strong></dt>

199 </dl>	276 </dl>

200 <dl><dt><strong>args</strong></dt>	277 <dl><dt><strong>args</strong></dt>

201 </dl>	278 </dl>

202 <dl><dt><strong>message</strong></dt>	279 <dl><dt><strong>message</strong></dt>

203 </dl>	280 </dl>

204 </td></tr></table></td></tr></table>	281 </td></tr></table></td></tr></table>

205 </body></html>	282 </body></html>

OLD	NEW