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

Side by Side Diff: tools/telemetry/docs/telemetry.core.web_contents.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.web_contents</title>	3 <html><head><title>Python: module telemetry.core.web_contents</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>.web_contents</strong></big></b ig></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>.web_contents</strong></big></b ig></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/web_contents.py">telemetry/core/web_contents.py</a></font></t d></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/web_contents.py">telemetry/core/web_contents.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">

	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="os.html">os</a><br>

	23 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor e.util</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.core.web_contents.html#WebC ontents">WebContents</a>	35 <dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebC ontents">WebContents</a>

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

28 </dd>	37 </dd>

29 </dl>	38 </dl>

30 <p>	39 <p>

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

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

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

34 <font color="#000000" face="helvetica, arial"><a name="WebContents">class <stron g>WebContents</strong></a>(<a href="__builtin__.html#object">__builtin__.object< /a>)</font></td></tr>	43 <font color="#000000" face="helvetica, arial"><a name="WebContents">class <stron g>WebContents</strong></a>(<a href="__builtin__.html#object">__builtin__.object< /a>)</font></td></tr>

35	44

36 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>	45 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

37 <td colspan=2><tt>Represents web contents in the browse r<br> </tt></td></tr>	46 <td colspan=2><tt>Represents web contents in the browse r<br> </tt></td></tr>

38 <tr><td> </td>	47 <tr><td> </td>

39 <td width="100%">Methods defined here:<br>	48 <td width="100%">Methods defined here:<br>

40 <dl><dt><a name="WebContents-Close"><strong>Close</strong></a>(self)</dt><dd><tt >Closes this page.<br>	49 <dl><dt><a name="WebContents-Close"><strong>Close</strong></a>(self)</dt><dd><tt >Closes this page.<br>

41  <br>	50  <br>

42 Not all browsers or browser versions support  this method.<br>	51 Not all browsers or browser versions support  this method.<br>

43 Be sure to check browser.supports_tab_control.</tt></dd></dl >	52 Be sure to check browser.supports_tab_control.</tt></dd></dl >

44	53

45 <dl><dt><a name="WebContents-Disconnect"><strong>Disconnect</strong></a>(self)</ dt></dl>	54 <dl><dt><a name="WebContents-EvaluateJavaScript"><strong>EvaluateJavaScript</str ong></a>(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Evalut es expr in JavaScript and returns the JSONize d result.<br>

46

47 <dl><dt><a name="WebContents-EvaluateJavaScript"><strong>EvaluateJavaScript</str ong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalut es expr in JavaScript and returns the JSONize d result.<br>

48  <br>	55  <br>

49 Consider using ExecuteJavaScript for cases where t he result of the<br>	56 Consider using ExecuteJavaScript for cases where t he result of the<br>

50 expression is not needed.<br>	57 expression is not needed.<br>

51  <br>	58  <br>

52 If evaluation throws in JavaScript, a Python  EvaluateException will<br>	59 If evaluation throws in JavaScript, a Python  EvaluateException will<br>

53 be raised.<br>	60 be raised.<br>

54  <br>	61  <br>

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

56 EvaluationException will be raised.</tt></dd></dl>	63 EvaluationException will be raised.</tt></dd></dl>

57	64

58 <dl><dt><a name="WebContents-ExecuteJavaScript"><strong>ExecuteJavaScript</stron g></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes  expr in JavaScript. Does not return the&nbsp ;result.<br>	65 <dl><dt><a name="WebContents-EvaluateJavaScriptInContext"><strong>EvaluateJavaSc riptInContext</strong></a>(self, expr, context_id, timeout<font color="#909090"> =90</font>)</dt><dd><tt>Similar to ExecuteJavaScript, except&nbsp ;context_id can refer to an iframe.<br>

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

	67

	68 <dl><dt><a name="WebContents-ExecuteJavaScript"><strong>ExecuteJavaScript</stron g></a>(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Executes  expr in JavaScript. Does not return the&nbsp ;result.<br>

59  <br>	69  <br>

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

61	71

62 <dl><dt><a name="WebContents-StartTimelineRecording"><strong>StartTimelineRecord ing</strong></a>(self)</dt></dl>	72 <dl><dt><a name="WebContents-ExecuteJavaScriptInContext"><strong>ExecuteJavaScri ptInContext</strong></a>(self, expr, context_id, timeout<font color="#909090">=9 0</font>)</dt><dd><tt>Similar to ExecuteJavaScript, except c ontext_id can refer to an iframe.<br>

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

	74

	75 <dl><dt><a name="WebContents-HasReachedQuiescence"><strong>HasReachedQuiescence< /strong></a>(self)</dt><dd><tt>Determine whether the page ha s reached quiescence after loading.<br>

	76  <br>

	77 Returns:<br>

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

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

	80

	81 <dl><dt><a name="WebContents-StartTimelineRecording"><strong>StartTimelineRecord ing</strong></a>(self, options<font color="#909090">=None</font>)</dt></dl>

63	82

64 <dl><dt><a name="WebContents-StopTimelineRecording"><strong>StopTimelineRecordin g</strong></a>(self)</dt></dl>	83 <dl><dt><a name="WebContents-StopTimelineRecording"><strong>StopTimelineRecordin g</strong></a>(self)</dt></dl>

65	84

66 <dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeComplete"><strong>Wait ForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090 ">=60</font>)</dt></dl>	85 <dl><dt><a name="WebContents-TakeJSHeapSnapshot"><strong>TakeJSHeapSnapshot</str ong></a>(self, timeout<font color="#909090">=120</font>)</dt></dl>

67	86

68 <dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeInteractiveOrBetter">< strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeo ut<font color="#909090">=60</font>)</dt></dl>	87 <dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeComplete"><strong>Wait ForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090 ">=90</font>)</dt></dl>

69	88

70 <dl><dt><a name="WebContents-__del__"><strong>__del__</strong></a>(self)</dt></d l>	89 <dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeInteractiveOrBetter">< strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeo ut<font color="#909090">=90</font>)</dt></dl>

	90

	91 <dl><dt><a name="WebContents-WaitForJavaScriptExpression"><strong>WaitForJavaScr iptExpression</strong></a>(self, expr, timeout)</dt><dd><tt>Waits for  the given JavaScript expression to be True.<br>

	92  <br>

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

71	94

72 <dl><dt><a name="WebContents-__init__"><strong>__init__</strong></a>(self, inspe ctor_backend)</dt></dl>	95 <dl><dt><a name="WebContents-__init__"><strong>__init__</strong></a>(self, inspe ctor_backend)</dt></dl>

73	96

74 <hr>	97 <hr>

75 Data descriptors defined here:<br>	98 Data descriptors defined here:<br>

76 <dl><dt><strong>__dict__</strong></dt>	99 <dl><dt><strong>__dict__</strong></dt>

77 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>	100 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

78 </dl>	101 </dl>

79 <dl><dt><strong>__weakref__</strong></dt>	102 <dl><dt><strong>__weakref__</strong></dt>

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

81 </dl>	104 </dl>

	105 <dl><dt><strong>is_timeline_recording_running</strong></dt>

	106 </dl>

82 <dl><dt><strong>message_output_stream</strong></dt>	107 <dl><dt><strong>message_output_stream</strong></dt>

83 </dl>	108 </dl>

84 <dl><dt><strong>timeline_model</strong></dt>	109 <dl><dt><strong>timeline_model</strong></dt>

85 </dl>	110 </dl>

86 </td></tr></table></td></tr></table><p>	111 </td></tr></table></td></tr></table><p>

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

88 <tr bgcolor="#55aa55">	113 <tr bgcolor="#55aa55">

89 <td colspan=3 valign=bottom> <br>	114 <td colspan=3 valign=bottom> <br>

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

91	116

92 <tr><td bgcolor="#55aa55"><tt>      </tt></td><td>  </td>	117 <tr><td bgcolor="#55aa55"><tt>      </tt></td><td>  </td>

93 <td width="100%"><strong>DEFAULT_WEB_CONTENTS_TIMEOUT</strong> = 60</td></tr></t able>	118 <td width="100%"><strong>DEFAULT_WEB_CONTENTS_TIMEOUT</strong> = 90</td></tr></t able>

94 </body></html>	119 </body></html>

OLD	NEW

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