| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
- <html><head><title>Python: module telemetry.internal.backends.chrome.oobe</title>
- <meta charset="utf-8">
- </head><body bgcolor="#f0f0f8">
- <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
- <tr bgcolor="#7799ee">
- <td valign=bottom> <br>
- <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.backends.html"><font color="#ffffff">backends</font></a>.<a href="telemetry.internal.backends.chrome.html"><font color="#ffffff">chrome</font></a>.oobe</strong></big></big></font></td
- ><td align=right valign=bottom
- ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/backends/chrome/oobe.py">telemetry/internal/backends/chrome/oobe.py</a></font></td></tr></table>
- <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br>
- # Use of this source code is governed by a BSD-style license that can be<br>
- # found in the LICENSE file.</tt></p>
- <p>
- <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
- <tr bgcolor="#aa55cc">
- <td colspan=3 valign=bottom> <br>
- <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
-
- <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
- <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
- </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
- </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br>
- </td><td width="25%" valign=top><a href="telemetry.internal.browser.web_contents.html">telemetry.internal.browser.web_contents</a><br>
- </td></tr></table></td></tr></table><p>
- <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
- <tr bgcolor="#ee77aa">
- <td colspan=3 valign=bottom> <br>
- <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
-
- <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
- <td width="100%"><dl>
- <dt><font face="helvetica, arial"><a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
- </font></dt><dd>
- <dl>
- <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome.oobe.html#Oobe">Oobe</a>
- </font></dt></dl>
- </dd>
- </dl>
- <p>
- <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
- <tr bgcolor="#ffc8d8">
- <td colspan=3 valign=bottom> <br>
- <font color="#000000" face="helvetica, arial"><a name="Oobe">class <strong>Oobe</strong></a>(<a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>)</font></td></tr>
-
- <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
- <td width="100%"><dl><dt>Method resolution order:</dt>
- <dd><a href="telemetry.internal.backends.chrome.oobe.html#Oobe">Oobe</a></dd>
- <dd><a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a></dd>
- <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
- </dl>
- <hr>
- Methods defined here:<br>
- <dl><dt><a name="Oobe-NavigateFakeLogin"><strong>NavigateFakeLogin</strong></a>(self, username, password, gaia_id)</dt><dd><tt>Fake user login.</tt></dd></dl>
- <dl><dt><a name="Oobe-NavigateGaiaLogin"><strong>NavigateGaiaLogin</strong></a>(self, username, password, enterprise_enroll<font color="#909090">=False</font>, for_user_triggered_enrollment<font color="#909090">=False</font>)</dt><dd><tt>Logs in using the GAIA webview or IFrame, whichever is<br>
- present. |enterprise_enroll| allows for enterprise enrollment.<br>
- |for_user_triggered_enrollment| should be False for remora enrollment.</tt></dd></dl>
- <dl><dt><a name="Oobe-NavigateGuestLogin"><strong>NavigateGuestLogin</strong></a>(self)</dt><dd><tt>Logs in as guest.</tt></dd></dl>
- <dl><dt><a name="Oobe-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl>
- <hr>
- Methods inherited from <a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>:<br>
- <dl><dt><a name="Oobe-CloseConnections"><strong>CloseConnections</strong></a>(self)</dt><dd><tt>Closes all TCP sockets held open by the browser.<br>
- <br>
- Raises:<br>
- exceptions.DevtoolsTargetCrashException if the tab is not alive.</tt></dd></dl>
- <dl><dt><a name="Oobe-EnableAllContexts"><strong>EnableAllContexts</strong></a>(self)</dt><dd><tt>Enable all contexts in a page. Returns the number of available contexts.<br>
- <br>
- Raises:<br>
- exceptions.WebSocketDisconnected<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.<br>
- <br>
- Consider using ExecuteJavaScript for cases where the result of the<br>
- expression is not needed.<br>
- <br>
- If evaluation throws in JavaScript, a Python EvaluateException will<br>
- be raised.<br>
- <br>
- If the result of the evaluation cannot be JSONized, then an<br>
- EvaluationException will be raised.<br>
- <br>
- Raises:<br>
- exceptions.Error: See <a href="#Oobe-EvaluateJavaScriptInContext">EvaluateJavaScriptInContext</a>() for a detailed list<br>
- of possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-EvaluateJavaScriptInContext"><strong>EvaluateJavaScriptInContext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</font>)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.<br>
- The main page has context_id=1, the first iframe context_id=2, etc.<br>
- <br>
- Raises:<br>
- exceptions.EvaluateException<br>
- exceptions.WebSocketDisconnected<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, statement, timeout<font color="#909090">=90</font>)</dt><dd><tt>Executes statement in JavaScript. Does not return the result.<br>
- <br>
- If the statement failed to evaluate, EvaluateException will be raised.<br>
- <br>
- Raises:<br>
- exceptions.Error: See <a href="#Oobe-ExecuteJavaScriptInContext">ExecuteJavaScriptInContext</a>() for a detailed list of<br>
- possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-ExecuteJavaScriptInContext"><strong>ExecuteJavaScriptInContext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</font>)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.<br>
- The main page has context_id=1, the first iframe context_id=2, etc.<br>
- <br>
- Raises:<br>
- exceptions.EvaluateException<br>
- exceptions.WebSocketDisconnected<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-GetUrl"><strong>GetUrl</strong></a>(self)</dt><dd><tt>Returns the URL to which the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is connected.<br>
- <br>
- Raises:<br>
- exceptions.Error: If there is an error in inspector backend connection.</tt></dd></dl>
- <dl><dt><a name="Oobe-GetWebviewContexts"><strong>GetWebviewContexts</strong></a>(self)</dt><dd><tt>Returns a list of webview contexts within the current inspector backend.<br>
- <br>
- Returns:<br>
- A list of <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> objects representing the webview contexts.<br>
- <br>
- Raises:<br>
- exceptions.Error: If there is an error in inspector backend connection.</tt></dd></dl>
- <dl><dt><a name="Oobe-HasReachedQuiescence"><strong>HasReachedQuiescence</strong></a>(self)</dt><dd><tt>Determine whether the page has reached quiescence after loading.<br>
- <br>
- Returns:<br>
- True if 2 seconds have passed since last resource received, false<br>
- otherwise.<br>
- Raises:<br>
- exceptions.Error: See <a href="#Oobe-EvaluateJavaScript">EvaluateJavaScript</a>() for a detailed list of<br>
- possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-IsAlive"><strong>IsAlive</strong></a>(self)</dt><dd><tt>Whether the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is still operating normally.<br>
- <br>
- Since <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> function asynchronously, this method does not guarantee<br>
- that the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> will still be alive at any point in the future.<br>
- <br>
- Returns:<br>
- A boolean indicating whether the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is opearting normally.</tt></dd></dl>
- <dl><dt><a name="Oobe-Navigate"><strong>Navigate</strong></a>(self, url, script_to_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909090">=90</font>)</dt><dd><tt>Navigates to url.<br>
- <br>
- If |script_to_evaluate_on_commit| is given, the script source string will be<br>
- evaluated when the navigation is committed. This is after the context of<br>
- the page exists, but before any script on the page itself has executed.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt><dd><tt>Starts timeline recording.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt><dd><tt>Stops timeline recording.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-SynthesizeScrollGesture"><strong>SynthesizeScrollGesture</strong></a>(self, x<font color="#909090">=100</font>, y<font color="#909090">=800</font>, xDistance<font color="#909090">=0</font>, yDistance<font color="#909090">=-500</font>, xOverscroll<font color="#909090">=None</font>, yOverscroll<font color="#909090">=None</font>, preventFling<font color="#909090">=True</font>, speed<font color="#909090">=None</font>, gestureSourceType<font color="#909090">=None</font>, repeatCount<font color="#909090">=None</font>, repeatDelayMs<font color="#909090">=None</font>, interactionMarkerName<font color="#909090">=None</font>)</dt><dd><tt>Runs an inspector command that causes a repeatable browser driven scroll.<br>
- <br>
- Args:<br>
- x: X coordinate of the start of the gesture in CSS pixels.<br>
- y: Y coordinate of the start of the gesture in CSS pixels.<br>
- xDistance: Distance to scroll along the X axis (positive to scroll left).<br>
- yDistance: Ddistance to scroll along the Y axis (positive to scroll up).<br>
- xOverscroll: Number of additional pixels to scroll back along the X axis.<br>
- xOverscroll: Number of additional pixels to scroll back along the Y axis.<br>
- preventFling: Prevents a fling gesture.<br>
- speed: Swipe speed in pixels per second.<br>
- gestureSourceType: Which type of input events to be generated.<br>
- repeatCount: Number of additional repeats beyond the first scroll.<br>
- repeatDelayMs: Number of milliseconds delay between each repeat.<br>
- interactionMarkerName: The name of the interaction markers to generate.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <dl><dt><a name="Oobe-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=90</font>)</dt><dd><tt>Waits for the document to finish loading.<br>
- <br>
- Raises:<br>
- exceptions.Error: See <a href="#Oobe-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>() for a detailed list<br>
- of possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=90</font>)</dt><dd><tt>Waits for the document to be interactive.<br>
- <br>
- Raises:<br>
- exceptions.Error: See <a href="#Oobe-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>() for a detailed list<br>
- of possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-WaitForJavaScriptExpression"><strong>WaitForJavaScriptExpression</strong></a>(self, expr, timeout, dump_page_state_on_timeout<font color="#909090">=True</font>)</dt><dd><tt>Waits for the given JavaScript expression to be True.<br>
- <br>
- This method is robust against any given Evaluation timing out.<br>
- <br>
- Args:<br>
- expr: The expression to evaluate.<br>
- timeout: The number of seconds to wait for the expression to be True.<br>
- dump_page_state_on_timeout: Whether to provide additional information on<br>
- the page state if a TimeoutException is thrown.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException: On a timeout.<br>
- exceptions.Error: See <a href="#Oobe-EvaluateJavaScript">EvaluateJavaScript</a>() for a detailed list of<br>
- possible exceptions.</tt></dd></dl>
- <dl><dt><a name="Oobe-WaitForNavigate"><strong>WaitForNavigate</strong></a>(self, timeout<font color="#909090">=90</font>)</dt><dd><tt>Waits for the navigation to complete.<br>
- <br>
- The current page is expect to be in a navigation.<br>
- This function returns when the navigation is complete or when<br>
- the timeout has been exceeded.<br>
- <br>
- Raises:<br>
- exceptions.TimeoutException<br>
- exceptions.DevtoolsTargetCrashException</tt></dd></dl>
- <hr>
- Data descriptors inherited from <a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>:<br>
- <dl><dt><strong>__dict__</strong></dt>
- <dd><tt>dictionary for instance variables (if defined)</tt></dd>
- </dl>
- <dl><dt><strong>__weakref__</strong></dt>
- <dd><tt>list of weak references to the object (if defined)</tt></dd>
- </dl>
- <dl><dt><strong>id</strong></dt>
- <dd><tt>Return the unique id string for this tab object.</tt></dd>
- </dl>
- <dl><dt><strong>message_output_stream</strong></dt>
- </dl>
- <dl><dt><strong>timeline_model</strong></dt>
- </dl>
- </td></tr></table></td></tr></table>
- </body></html>
|
