tools/telemetry/docs/telemetry.core.tab.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Side by Side Diff: tools/telemetry/docs/telemetry.core.tab.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.core.tab</title>	3 <html><head><title>Python: module telemetry.core.tab</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 .core.html"><font color="#ffffff">core</font></a>.tab</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 .core.html"><font color="#ffffff">core</font></a>.tab</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/core/tab.py">telemetry/core/tab.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/tab.py">telemetry/core/tab.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">	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.core.web_contents.html">telemetry.core.web_contents</a><br >	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.bitmap.html">telemetry.core.bitmap</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>	23 </td><td width="25%" valign=top><a href="telemetry.core.web_contents.html">telem etry.core.web_contents</a><br>

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

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

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

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

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

28	29

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

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

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

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

	34 <dl>

	35 <dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#BoundingBoxNo tFoundException">BoundingBoxNotFoundException</a>

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

	37 </dd>

31 <dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebC ontents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#o bject">__builtin__.object</a>)	38 <dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebC ontents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#o bject">__builtin__.object</a>)

32 </font></dt><dd>	39 </font></dt><dd>

33 <dl>	40 <dl>

34 <dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">Tab</a>	41 <dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">Tab</a>

35 </font></dt></dl>	42 </font></dt></dl>

36 </dd>	43 </dd>

37 </dl>	44 </dl>

38 <p>	45 <p>

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

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

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

	49 <font color="#000000" face="helvetica, arial"><a name="BoundingBoxNotFoundExcept ion">class <strong>BoundingBoxNotFoundException</strong></a>(<a href="exceptions .html#Exception">exceptions.Exception</a>)</font></td></tr>

	50

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

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

	53 <dd><a href="telemetry.core.tab.html#BoundingBoxNotFoundException">BoundingBoxNo tFoundException</a></dd>

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

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

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

	57 </dl>

	58 <hr>

	59 Data descriptors defined here:<br>

	60 <dl><dt><strong>__weakref__</strong></dt>

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

	62 </dl>

	63 <hr>

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

	65 <dl><dt><a name="BoundingBoxNotFoundException-__init__"><strong>__init__</strong ></a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__init__">__init __</a>(...) initializes x; see help(type(x)) for s ignature</tt></dd></dl>

	66

	67 <hr>

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

	69 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#BoundingBoxNotFoundException-__new__">__new__</a>(S, . ..) -> a new object with type S, a&nb sp;subtype of T</tt></dl>

	70

	71 <hr>

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

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

	74

	75 <dl><dt><a name="BoundingBoxNotFoundException-__getattribute__"><strong>__getatt ribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException- __getattribute__">__getattribute__</a>('name') <==> x.name</tt>< /dd></dl>

	76

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

	78

	79 <dl><dt><a name="BoundingBoxNotFoundException-__getslice__"><strong>__getslice__ </strong></a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__getsli ce__">__getslice__</a>(i, j) <==> x[i:j]<br>

	80  <br>

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

	82

	83 <dl><dt><a name="BoundingBoxNotFoundException-__reduce__"><strong>__reduce__</st rong></a>(...)</dt></dl>

	84

	85 <dl><dt><a name="BoundingBoxNotFoundException-__repr__"><strong>__repr__</strong ></a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__repr__">__repr __</a>() <==> repr(x)</tt></dd></dl>

	86

	87 <dl><dt><a name="BoundingBoxNotFoundException-__setattr__"><strong>__setattr__</ strong></a>(...)</dt><dd><tt>x.<a href="#BoundingBoxNotFoundException-__setattr_ _">__setattr__</a>('name', value) <==> x.name = v alue</tt></dd></dl>

	88

	89 <dl><dt><a name="BoundingBoxNotFoundException-__setstate__"><strong>__setstate__ </strong></a>(...)</dt></dl>

	90

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

	92

	93 <dl><dt><a name="BoundingBoxNotFoundException-__unicode__"><strong>__unicode__</ strong></a>(...)</dt></dl>

	94

	95 <hr>

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

	97 <dl><dt><strong>__dict__</strong></dt>

	98 </dl>

	99 <dl><dt><strong>args</strong></dt>

	100 </dl>

	101 <dl><dt><strong>message</strong></dt>

	102 </dl>

	103 </td></tr></table> <p>

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

	105 <tr bgcolor="#ffc8d8">

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

42 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core .web_contents.WebContents</a>)</font></td></tr>	107 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core .web_contents.WebContents</a>)</font></td></tr>

43	108

44 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>	109 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

45 <td colspan=2><tt>Represents a tab in the browser<br>	110 <td colspan=2><tt>Represents a tab in the browser<br>

46  <br>	111  <br>

47 The important parts of the <a href="#Tab">Tab</a>  object are in the runtime and page objects.<b r>	112 The important parts of the <a href="#Tab">Tab</a>  object are in the runtime and page objects.<b r>

48 E.g.:<br>	113 E.g.:<br>

49     # Navigates the tab to a g iven url.<br>	114     # Navigates the tab to a g iven url.<br>

50     tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http: //www.google.com/">http://www.google.com/</a>')<br>	115     tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http: //www.google.com/">http://www.google.com/</a>')<br>

51  <br>	116  <br>

(...skipping 10 matching lines...) Expand all Loading...
62 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings this tab to the foreground asynchronously.<b r>	127 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings this tab to the foreground asynchronously.<b r>

63  <br>	128  <br>

64 Not all browsers or browser versions support  this method.<br>	129 Not all browsers or browser versions support  this method.<br>

65 Be sure to check browser.supports_tab_control.<br>	130 Be sure to check browser.supports_tab_control.<br>

66  <br>	131  <br>

67 Please note: this is asynchronous. There is a  delay between this call<br>	132 Please note: this is asynchronous. There is a  delay between this call<br>

68 and the page's documentVisibilityState becoming 'visibl e', and yet more<br>	133 and the page's documentVisibilityState becoming 'visibl e', and yet more<br>

69 delay until the actual tab is visible to&nbsp ;the user. None of these delays<br>	134 delay until the actual tab is visible to&nbsp ;the user. None of these delays<br>

70 are included in this call.</tt></dd></dl>	135 are included in this call.</tt></dd></dl>

71	136

72 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self)</dt><dd>< tt>Clears the browser's HTTP disk cache and t he tab's HTTP memory cache.</tt></dd></dl>	137 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self, force)</d t><dd><tt>Clears the browser's networking related disk,  memory and other caches.<br>

	138  <br>

	139 Args:<br>

	140   force: Iff true, navigates to about:blank&n bsp;which destroys the previous<br>

	141       renderer, ensuring that even& nbsp;"live" resources in the memory cache are<br>

	142       cleared.</tt></dd></dl>

	143

	144 <dl><dt><a name="Tab-ClearHighlight"><strong>ClearHighlight</strong></a>(self, c olor)</dt><dd><tt>Clears a highlight of the given  bitmap.RgbaColor.</tt></dd></dl>

73	145

74 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</ dt></dl>	146 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</ dt></dl>

75	147

76 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the&nbs p;value of the cookie by the given \|name\|.</t t></dd></dl>	148 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the&nbs p;value of the cookie by the given \|name\|.</t t></dd></dl>

77	149

	150 <dl><dt><a name="Tab-Highlight"><strong>Highlight</strong></a>(self, color)</dt> <dd><tt>Synchronously highlights entire tab contents wi th the given RgbaColor.<br>

	151  <br>

	152 TODO(tonyg): It is possible that the z-index  hack here might not work for<br>

	153 all pages. If this happens, DevTools also pro vides a method for this.</tt></dd></dl>

	154

78 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909 090">=60</font>)</dt><dd><tt>Navigates to url.<br>	155 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909 090">=60</font>)</dt><dd><tt>Navigates to url.<br>

79  <br>	156  <br>

80 If \|script_to_evaluate_on_commit\| is given, the script& nbsp;source string will be<br>	157 If \|script_to_evaluate_on_commit\| is given, the script& nbsp;source string will be<br>

81 evaluated when the navigation is committed. This&n bsp;is after the context of<br>	158 evaluated when the navigation is committed. This&n bsp;is after the context of<br>

82 the page exists, but before any script on&nbs p;the page itself has executed.</tt></dd></dl>	159 the page exists, but before any script on&nbs p;the page itself has executed.</tt></dd></dl>

83	160

84 <dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWa itForNavigate</strong></a>(self, action_function, timeout<font color="#909090">= 60</font>)</dt><dd><tt>Executes action_function, and waits f or the navigation to complete.<br>	161 <dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWa itForNavigate</strong></a>(self, action_function, timeout<font color="#909090">= 60</font>)</dt><dd><tt>Executes action_function, and waits f or the navigation to complete.<br>

85  <br>	162  <br>

86 action_function must be a Python function that&nbs p;results in a navigation.<br>	163 action_function must be a Python function that&nbs p;results in a navigation.<br>

87 This function returns when the navigation is  complete or when<br>	164 This function returns when the navigation is  complete or when<br>

88 the timeout has been exceeded.</tt></dd></dl>	165 the timeout has been exceeded.</tt></dd></dl>

89	166

90 <dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<f ont color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot  of the window for rendering validation</tt></dd></dl>	167 <dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<f ont color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot  of the tab's contents.<br>

	168  <br>

	169 Returns:<br>

	170   A telemetry.core.Bitmap.</tt></dd></dl>

91	171

92 <dl><dt><a name="Tab-__del__"><strong>__del__</strong></a>(self)</dt></dl>	172 <dl><dt><a name="Tab-StartVideoCapture"><strong>StartVideoCapture</strong></a>(s elf, min_bitrate_mbps)</dt><dd><tt>Starts capturing video of&nbsp ;the tab's contents.<br>

	173  <br>

	174 This works by flashing the entire tab content s to a arbitrary color and then<br>

	175 starting video recording. When the frames are&nbsp ;processed, we can look for<br>

	176 that flash as the content bounds.<br>

	177  <br>

	178 Args:<br>

	179   min_bitrate_mbps: The minimum caputre bitrate&nb sp;in MegaBits Per Second.<br>

	180       The platform is free to& nbsp;deliver a higher bitrate if it can do&nb sp;so<br>

	181       without increasing overhead.</tt>< /dd></dl>

	182

	183 <dl><dt><a name="Tab-StopVideoCapture"><strong>StopVideoCapture</strong></a>(sel f)</dt><dd><tt>Stops recording video of the tab's  contents.<br>

	184  <br>

	185 This looks for the initial color flash in&nbs p;the first frame to establish the<br>

	186 tab content boundaries and then omits all fra mes displaying the flash.<br>

	187  <br>

	188 Yields:<br>

	189   (time_ms, bitmap) tuples representing each  video keyframe. Only the first<br>

	190   frame in a run of sequential duplicate  bitmaps is typically included.<br>

	191     time_ms is milliseconds since naviga tionStart.<br>

	192     bitmap is a telemetry.core.Bitmap.</tt></ dd></dl>

93	193

94 <dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_bac kend)</dt></dl>	194 <dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_bac kend)</dt></dl>

95	195

96 <hr>	196 <hr>

97 Data descriptors defined here:<br>	197 Data descriptors defined here:<br>

98 <dl><dt><strong>browser</strong></dt>	198 <dl><dt><strong>browser</strong></dt>

99 <dd><tt>The browser in which this tab resides.</tt ></dd>	199 <dd><tt>The browser in which this tab resides.</tt ></dd>

100 </dl>	200 </dl>

101 <dl><dt><strong>dom_stats</strong></dt>	201 <dl><dt><strong>dom_stats</strong></dt>

102 <dd><tt>A dictionary populated with measured DOM s tatistics.<br>	202 <dd><tt>A dictionary populated with measured DOM s tatistics.<br>

103  <br>	203  <br>

104 Currently this dictionary contains:<br>	204 Currently this dictionary contains:<br>

105 {<br>	205 {<br>

106   'document_count': integer,<br>	206   'document_count': integer,<br>

107   'node_count': integer,<br>	207   'node_count': integer,<br>

108   'event_listener_count': integer<br>	208   'event_listener_count': integer<br>

109 }</tt></dd>	209 }</tt></dd>

110 </dl>	210 </dl>

	211 <dl><dt><strong>is_video_capture_running</strong></dt>

	212 </dl>

111 <dl><dt><strong>screenshot_supported</strong></dt>	213 <dl><dt><strong>screenshot_supported</strong></dt>

112 <dd><tt>True if the browser instance is capable&nb sp;of capturing screenshots</tt></dd>	214 <dd><tt>True if the browser instance is capable&nb sp;of capturing screenshots.</tt></dd>

113 </dl>	215 </dl>

114 <dl><dt><strong>url</strong></dt>	216 <dl><dt><strong>url</strong></dt>

115 </dl>	217 </dl>

	218 <dl><dt><strong>video_capture_supported</strong></dt>

	219 <dd><tt>True if the browser instance is capable&nb sp;of capturing video.</tt></dd>

	220 </dl>

116 <hr>	221 <hr>

117 Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te lemetry.core.web_contents.WebContents</a>:<br>	222 Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te lemetry.core.web_contents.WebContents</a>:<br>

118 <dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes& nbsp;this page.<br>	223 <dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes& nbsp;this page.<br>

119  <br>	224  <br>

120 Not all browsers or browser versions support  this method.<br>	225 Not all browsers or browser versions support  this method.<br>

121 Be sure to check browser.supports_tab_control.</tt></dd></dl >	226 Be sure to check browser.supports_tab_control.</tt></dd></dl >

122	227

123 <dl><dt><a name="Tab-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl>	228 <dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a> (self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Evalutes  expr in JavaScript and returns the JSONized r esult.<br>

124

125 <dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a> (self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes  expr in JavaScript and returns the JSONized r esult.<br>

126  <br>	229  <br>

127 Consider using ExecuteJavaScript for cases where t he result of the<br>	230 Consider using ExecuteJavaScript for cases where t he result of the<br>

128 expression is not needed.<br>	231 expression is not needed.<br>

129  <br>	232  <br>

130 If evaluation throws in JavaScript, a Python  EvaluateException will<br>	233 If evaluation throws in JavaScript, a Python  EvaluateException will<br>

131 be raised.<br>	234 be raised.<br>

132  <br>	235  <br>

133 If the result of the evaluation cannot be&nbs p;JSONized, then an<br>	236 If the result of the evaluation cannot be&nbs p;JSONized, then an<br>

134 EvaluationException will be raised.</tt></dd></dl>	237 EvaluationException will be raised.</tt></dd></dl>

135	238

136 <dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(s elf, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes ex pr in JavaScript. Does not return the result. <br>	239 <dl><dt><a name="Tab-EvaluateJavaScriptInContext"><strong>EvaluateJavaScriptInCo ntext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</fon t>)</dt><dd><tt>Similar to ExecuteJavaScript, except context _id can refer to an iframe.<br>

	240 The main page has context_id=1, the first ifr ame context_id=2, etc.</tt></dd></dl>

	241

	242 <dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(s elf, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Executes ex pr in JavaScript. Does not return the result. <br>

137  <br>	243  <br>

138 If the expression failed to evaluate, EvaluateExce ption will be raised.</tt></dd></dl>	244 If the expression failed to evaluate, EvaluateExce ption will be raised.</tt></dd></dl>

139	245

140 <dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</str ong></a>(self)</dt></dl>	246 <dl><dt><a name="Tab-ExecuteJavaScriptInContext"><strong>ExecuteJavaScriptInCont ext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</font> )</dt><dd><tt>Similar to ExecuteJavaScript, except context_i d can refer to an iframe.<br>

	247 The main page has context_id=1, the first ifr ame context_id=2, etc.</tt></dd></dl>

	248

	249 <dl><dt><a name="Tab-HasReachedQuiescence"><strong>HasReachedQuiescence</strong> </a>(self)</dt><dd><tt>Determine whether the page has r eached quiescence after loading.<br>

	250  <br>

	251 Returns:<br>

	252   True if 2 seconds have passed since&nb sp;last resource received, false<br>

	253   otherwise.</tt></dd></dl>

	254

	255 <dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</str ong></a>(self, options<font color="#909090">=None</font>)</dt></dl>

141	256

142 <dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</stron g></a>(self)</dt></dl>	257 <dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</stron g></a>(self)</dt></dl>

143	258

144 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocum entReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</f ont>)</dt></dl>	259 <dl><dt><a name="Tab-TakeJSHeapSnapshot"><strong>TakeJSHeapSnapshot</strong></a> (self, timeout<font color="#909090">=120</font>)</dt></dl>

145	260

146 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>W aitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl>	261 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocum entReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=90</f ont>)</dt></dl>

	262

	263 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>W aitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=90</font>)</dt></dl>

	264

	265 <dl><dt><a name="Tab-WaitForJavaScriptExpression"><strong>WaitForJavaScriptExpre ssion</strong></a>(self, expr, timeout)</dt><dd><tt>Waits for the&nbsp ;given JavaScript expression to be True.<br>

	266  <br>

	267 This method is robust against any given Evalu ation timing out.</tt></dd></dl>

147	268

148 <hr>	269 <hr>

149 Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon tents">telemetry.core.web_contents.WebContents</a>:<br>	270 Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon tents">telemetry.core.web_contents.WebContents</a>:<br>

150 <dl><dt><strong>__dict__</strong></dt>	271 <dl><dt><strong>__dict__</strong></dt>

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

152 </dl>	273 </dl>

153 <dl><dt><strong>__weakref__</strong></dt>	274 <dl><dt><strong>__weakref__</strong></dt>

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

155 </dl>	276 </dl>

	277 <dl><dt><strong>is_timeline_recording_running</strong></dt>

	278 </dl>

156 <dl><dt><strong>message_output_stream</strong></dt>	279 <dl><dt><strong>message_output_stream</strong></dt>

157 </dl>	280 </dl>

158 <dl><dt><strong>timeline_model</strong></dt>	281 <dl><dt><strong>timeline_model</strong></dt>

159 </dl>	282 </dl>

160 </td></tr></table></td></tr></table><p>	283 </td></tr></table></td></tr></table><p>

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

162 <tr bgcolor="#55aa55">	285 <tr bgcolor="#55aa55">

163 <td colspan=3 valign=bottom> <br>	286 <td colspan=3 valign=bottom> <br>

164 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></ font></td></tr>	287 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></ font></td></tr>

165	288

166 <tr><td bgcolor="#55aa55"><tt>      </tt></td><td>  </td>	289 <tr><td bgcolor="#55aa55"><tt>      </tt></td><td>  </td>

167 <td width="100%"><strong>DEFAULT_TAB_TIMEOUT</strong> = 60</td></tr></table>	290 <td width="100%"><strong>DEFAULT_TAB_TIMEOUT</strong> = 60</td></tr></table>

168 </body></html>	291 </body></html>

OLD	NEW

« no previous file with comments | « tools/telemetry/docs/telemetry.core.profile_types.html ('k') | tools/telemetry/docs/telemetry.core.timeline.html » ('j') | no next file with comments »