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

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

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>)	32 <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>	33 </font></dt><dd>

33 <dl>	34 <dl>

34 <dt><font face="helvetica, arial"><a href="telemetry.core.extension_page.html#Ex tensionPage">ExtensionPage</a>	35 <dt><font face="helvetica, arial"><a href="telemetry.core.extension_page.html#Ex tensionPage">ExtensionPage</a>

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

36 </dd>	37 </dd>

37 </dl>	38 </dl>

38 <p>	39 <p>

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

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

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

42 <font color="#000000" face="helvetica, arial"><a name="ExtensionPage">class <str ong>ExtensionPage</strong></a>(<a href="telemetry.core.web_contents.html#WebCont ents">telemetry.core.web_contents.WebContents</a>)</font></td></tr>	43 <font color="#000000" face="helvetica, arial"><a name="ExtensionPage">class <str ong>ExtensionPage</strong></a>(<a href="telemetry.core.web_contents.html#WebCont ents">telemetry.core.web_contents.WebContents</a>)</font></td></tr>

43	44

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

45 <td colspan=2><tt>Represents a an extension page in&nbs p;the browser<br> </tt></td></tr>	46 <td colspan=2><tt>Represents an extension page in the&n bsp;browser<br> </tt></td></tr>

46 <tr><td> </td>	47 <tr><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.core.extension_page.html#ExtensionPage">ExtensionPage</a> </dd>	49 <dd><a href="telemetry.core.extension_page.html#ExtensionPage">ExtensionPage</a> </dd>

49 <dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_co ntents.WebContents</a></dd>	50 <dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_co ntents.WebContents</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="ExtensionPage-__del__"><strong>__del__</strong></a>(self)</dt>< /dl>	55 <dl><dt><a name="ExtensionPage-Reload"><strong>Reload</strong></a>(self)</dt><dd ><tt>Reloading an extension page is used as a  workaround for an extension<br>

	56 binding bug for old versions of Chrome (crbug .com/263162). After Navigate<br>

	57 returns, we are guaranteed that the inspected&nbsp ;page is in the correct state.</tt></dd></dl>

55	58

56 <dl><dt><a name="ExtensionPage-__init__"><strong>__init__</strong></a>(self, ins pector_backend)</dt></dl>	59 <dl><dt><a name="ExtensionPage-__init__"><strong>__init__</strong></a>(self, ins pector_backend)</dt></dl>

57	60

58 <hr>	61 <hr>

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

60 <dl><dt><a name="ExtensionPage-Close"><strong>Close</strong></a>(self)</dt><dd>< tt>Closes this page.<br>	63 <dl><dt><a name="ExtensionPage-Close"><strong>Close</strong></a>(self)</dt><dd>< tt>Closes this page.<br>

61  <br>	64  <br>

62 Not all browsers or browser versions support  this method.<br>	65 Not all browsers or browser versions support  this method.<br>

63 Be sure to check browser.supports_tab_control.</tt></dd></dl >	66 Be sure to check browser.supports_tab_control.</tt></dd></dl >

64	67

65 <dl><dt><a name="ExtensionPage-Disconnect"><strong>Disconnect</strong></a>(self) </dt></dl>	68 <dl><dt><a name="ExtensionPage-EvaluateJavaScript"><strong>EvaluateJavaScript</s trong></a>(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Eval utes expr in JavaScript and returns the JSONi zed result.<br>

66

67 <dl><dt><a name="ExtensionPage-EvaluateJavaScript"><strong>EvaluateJavaScript</s trong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Eval utes expr in JavaScript and returns the JSONi zed result.<br>

68  <br>	69  <br>

69 Consider using ExecuteJavaScript for cases where t he result of the<br>	70 Consider using ExecuteJavaScript for cases where t he result of the<br>

70 expression is not needed.<br>	71 expression is not needed.<br>

71  <br>	72  <br>

72 If evaluation throws in JavaScript, a Python  EvaluateException will<br>	73 If evaluation throws in JavaScript, a Python  EvaluateException will<br>

73 be raised.<br>	74 be raised.<br>

74  <br>	75  <br>

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

76 EvaluationException will be raised.</tt></dd></dl>	77 EvaluationException will be raised.</tt></dd></dl>

77	78

78 <dl><dt><a name="ExtensionPage-ExecuteJavaScript"><strong>ExecuteJavaScript</str ong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Execut es expr in JavaScript. Does not return the&nb sp;result.<br>	79 <dl><dt><a name="ExtensionPage-EvaluateJavaScriptInContext"><strong>EvaluateJava ScriptInContext</strong></a>(self, expr, context_id, timeout<font color="#909090 ">=90</font>)</dt><dd><tt>Similar to ExecuteJavaScript, except&nb sp;context_id can refer to an iframe.<br>

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

	81

	82 <dl><dt><a name="ExtensionPage-ExecuteJavaScript"><strong>ExecuteJavaScript</str ong></a>(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Execut es expr in JavaScript. Does not return the&nb sp;result.<br>

79  <br>	83  <br>

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

81	85

82 <dl><dt><a name="ExtensionPage-StartTimelineRecording"><strong>StartTimelineReco rding</strong></a>(self)</dt></dl>	86 <dl><dt><a name="ExtensionPage-ExecuteJavaScriptInContext"><strong>ExecuteJavaSc 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>

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

	88

	89 <dl><dt><a name="ExtensionPage-HasReachedQuiescence"><strong>HasReachedQuiescenc e</strong></a>(self)</dt><dd><tt>Determine whether the page  has reached quiescence after loading.<br>

	90  <br>

	91 Returns:<br>

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

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

	94

	95 <dl><dt><a name="ExtensionPage-StartTimelineRecording"><strong>StartTimelineReco rding</strong></a>(self, options<font color="#909090">=None</font>)</dt></dl>

83	96

84 <dl><dt><a name="ExtensionPage-StopTimelineRecording"><strong>StopTimelineRecord ing</strong></a>(self)</dt></dl>	97 <dl><dt><a name="ExtensionPage-StopTimelineRecording"><strong>StopTimelineRecord ing</strong></a>(self)</dt></dl>

85	98

86 <dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeComplete"><strong>Wa itForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#9090 90">=60</font>)</dt></dl>	99 <dl><dt><a name="ExtensionPage-TakeJSHeapSnapshot"><strong>TakeJSHeapSnapshot</s trong></a>(self, timeout<font color="#909090">=120</font>)</dt></dl>

87	100

88 <dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeInteractiveOrBetter" ><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, tim eout<font color="#909090">=60</font>)</dt></dl>	101 <dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeComplete"><strong>Wa itForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#9090 90">=90</font>)</dt></dl>

	102

	103 <dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeInteractiveOrBetter" ><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, tim eout<font color="#909090">=90</font>)</dt></dl>

	104

	105 <dl><dt><a name="ExtensionPage-WaitForJavaScriptExpression"><strong>WaitForJavaS criptExpression</strong></a>(self, expr, timeout)</dt><dd><tt>Waits for&nbs p;the given JavaScript expression to be True.<br>

	106  <br>

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

89	108

90 <hr>	109 <hr>

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

92 <dl><dt><strong>__dict__</strong></dt>	111 <dl><dt><strong>__dict__</strong></dt>

93 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>	112 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

94 </dl>	113 </dl>

95 <dl><dt><strong>__weakref__</strong></dt>	114 <dl><dt><strong>__weakref__</strong></dt>

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

97 </dl>	116 </dl>

	117 <dl><dt><strong>is_timeline_recording_running</strong></dt>

	118 </dl>

98 <dl><dt><strong>message_output_stream</strong></dt>	119 <dl><dt><strong>message_output_stream</strong></dt>

99 </dl>	120 </dl>

100 <dl><dt><strong>timeline_model</strong></dt>	121 <dl><dt><strong>timeline_model</strong></dt>

101 </dl>	122 </dl>

102 </td></tr></table></td></tr></table>	123 </td></tr></table></td></tr></table><p>

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

	125 <tr bgcolor="#eeaa77">

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

	127 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>

	128

	129 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>

	130 <td width="100%"><dl><dt><a name="-UrlToExtensionId"><strong>UrlToExtensionId</s trong></a>(url)</dt></dl>

	131 </td></tr></table>

103 </body></html>	132 </body></html>

OLD	NEW