Update docs for new flags.

fake-name · Jun 23, 2020 · 0ce4401 · 0ce4401
1 parent 054c33a
commit 0ce4401
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/docs/ChromeController.ChromeRemoteDebugInterface.html b/docs/ChromeController.ChromeRemoteDebugInterface.html
@@ -42,7 +42,6 @@
 Roughly,&nbsp;this&nbsp;corresponds&nbsp;to&nbsp;the&nbsp;javascript&nbsp;`DOMContentLoaded`&nbsp;event,<br>
 meaning&nbsp;the&nbsp;dom&nbsp;for&nbsp;the&nbsp;page&nbsp;is&nbsp;ready.<br>
 &nbsp;<br>
-&nbsp;<br>
 Internals:<br>
 &nbsp;<br>
 A&nbsp;navigation&nbsp;command&nbsp;results&nbsp;in&nbsp;a&nbsp;sequence&nbsp;of&nbsp;events:<br>
@@ -128,7 +127,7 @@
 
 <dl><dt><a name="ChromeRemoteDebugInterface-click_link_containing_url"><strong>click_link_containing_url</strong></a>(self, url)</dt><dd><tt>TODO</tt></dd></dl>
 
-<dl><dt><a name="ChromeRemoteDebugInterface-execute_javascript_function"><strong>execute_javascript_function</strong></a>(self, script, *args)</dt><dd><tt>Execute&nbsp;a&nbsp;javascript&nbsp;function&nbsp;in&nbsp;the&nbsp;context&nbsp;of&nbsp;the&nbsp;browser&nbsp;tab.<br>
+<dl><dt><a name="ChromeRemoteDebugInterface-execute_javascript_function"><strong>execute_javascript_function</strong></a>(self, script, args=None)</dt><dd><tt>Execute&nbsp;a&nbsp;javascript&nbsp;function&nbsp;in&nbsp;the&nbsp;context&nbsp;of&nbsp;the&nbsp;browser&nbsp;tab.<br>
 &nbsp;<br>
 The&nbsp;passed&nbsp;script&nbsp;must&nbsp;be&nbsp;a&nbsp;single&nbsp;function&nbsp;definition,&nbsp;which&nbsp;will<br>
 be&nbsp;called&nbsp;via&nbsp;({script}).apply(null,&nbsp;{args}).</tt></dd></dl>
@@ -241,6 +240,14 @@
 If&nbsp;no&nbsp;'User-Agent'&nbsp;key&nbsp;is&nbsp;present&nbsp;in&nbsp;the&nbsp;new&nbsp;headers,<br>
 the&nbsp;first&nbsp;item&nbsp;in&nbsp;the&nbsp;tuple&nbsp;will&nbsp;be&nbsp;None</tt></dd></dl>
 
+<dl><dt><a name="ChromeRemoteDebugInterface-xhr_fetch"><strong>xhr_fetch</strong></a>(self, url, headers=None, post_data=None, post_type=None)</dt><dd><tt>Execute&nbsp;a&nbsp;XMLHttpRequest()&nbsp;for&nbsp;content&nbsp;at&nbsp;`url`.&nbsp;If<br>
+`headers`&nbsp;are&nbsp;specified,&nbsp;they&nbsp;must&nbsp;be&nbsp;a&nbsp;dict&nbsp;of&nbsp;string:string<br>
+keader:values.&nbsp;post_data&nbsp;must&nbsp;also&nbsp;be&nbsp;pre-encoded.<br>
+&nbsp;<br>
+Note&nbsp;that&nbsp;this&nbsp;will&nbsp;be&nbsp;affected&nbsp;by&nbsp;the&nbsp;same-origin&nbsp;policy&nbsp;of&nbsp;the&nbsp;current<br>
+page,&nbsp;so&nbsp;it&nbsp;can&nbsp;fail&nbsp;if&nbsp;you&nbsp;are&nbsp;requesting&nbsp;content&nbsp;from&nbsp;another&nbsp;domain&nbsp;and<br>
+the&nbsp;current&nbsp;site&nbsp;has&nbsp;restrictive&nbsp;same-origin&nbsp;policies&nbsp;(which&nbsp;is&nbsp;very&nbsp;common).</tt></dd></dl>
+
 <hr>
 Methods inherited from <a href="ChromeController.Generator.Generated.html#ChromeRemoteDebugInterface">ChromeController.Generator.Generated.ChromeRemoteDebugInterface</a>:<br>
 <dl><dt><a name="ChromeRemoteDebugInterface-Accessibility_getPartialAXTree"><strong>Accessibility_getPartialAXTree</strong></a>(self, nodeId, **kwargs)</dt><dd><tt>Function&nbsp;path:&nbsp;Accessibility.getPartialAXTree<br>

diff --git a/docs/ChromeController.manager.html b/docs/ChromeController.manager.html
@@ -85,7 +85,6 @@
 Roughly,&nbsp;this&nbsp;corresponds&nbsp;to&nbsp;the&nbsp;javascript&nbsp;`DOMContentLoaded`&nbsp;event,<br>
 meaning&nbsp;the&nbsp;dom&nbsp;for&nbsp;the&nbsp;page&nbsp;is&nbsp;ready.<br>
 &nbsp;<br>
-&nbsp;<br>
 Internals:<br>
 &nbsp;<br>
 A&nbsp;navigation&nbsp;command&nbsp;results&nbsp;in&nbsp;a&nbsp;sequence&nbsp;of&nbsp;events:<br>
@@ -171,7 +170,7 @@
 
 <dl><dt><a name="ChromeRemoteDebugInterface-click_link_containing_url"><strong>click_link_containing_url</strong></a>(self, url)</dt><dd><tt>TODO</tt></dd></dl>
 
-<dl><dt><a name="ChromeRemoteDebugInterface-execute_javascript_function"><strong>execute_javascript_function</strong></a>(self, script, *args)</dt><dd><tt>Execute&nbsp;a&nbsp;javascript&nbsp;function&nbsp;in&nbsp;the&nbsp;context&nbsp;of&nbsp;the&nbsp;browser&nbsp;tab.<br>
+<dl><dt><a name="ChromeRemoteDebugInterface-execute_javascript_function"><strong>execute_javascript_function</strong></a>(self, script, args=None)</dt><dd><tt>Execute&nbsp;a&nbsp;javascript&nbsp;function&nbsp;in&nbsp;the&nbsp;context&nbsp;of&nbsp;the&nbsp;browser&nbsp;tab.<br>
 &nbsp;<br>
 The&nbsp;passed&nbsp;script&nbsp;must&nbsp;be&nbsp;a&nbsp;single&nbsp;function&nbsp;definition,&nbsp;which&nbsp;will<br>
 be&nbsp;called&nbsp;via&nbsp;({script}).apply(null,&nbsp;{args}).</tt></dd></dl>
@@ -284,6 +283,14 @@
 If&nbsp;no&nbsp;'User-Agent'&nbsp;key&nbsp;is&nbsp;present&nbsp;in&nbsp;the&nbsp;new&nbsp;headers,<br>
 the&nbsp;first&nbsp;item&nbsp;in&nbsp;the&nbsp;tuple&nbsp;will&nbsp;be&nbsp;None</tt></dd></dl>
 
+<dl><dt><a name="ChromeRemoteDebugInterface-xhr_fetch"><strong>xhr_fetch</strong></a>(self, url, headers=None, post_data=None, post_type=None)</dt><dd><tt>Execute&nbsp;a&nbsp;XMLHttpRequest()&nbsp;for&nbsp;content&nbsp;at&nbsp;`url`.&nbsp;If<br>
+`headers`&nbsp;are&nbsp;specified,&nbsp;they&nbsp;must&nbsp;be&nbsp;a&nbsp;dict&nbsp;of&nbsp;string:string<br>
+keader:values.&nbsp;post_data&nbsp;must&nbsp;also&nbsp;be&nbsp;pre-encoded.<br>
+&nbsp;<br>
+Note&nbsp;that&nbsp;this&nbsp;will&nbsp;be&nbsp;affected&nbsp;by&nbsp;the&nbsp;same-origin&nbsp;policy&nbsp;of&nbsp;the&nbsp;current<br>
+page,&nbsp;so&nbsp;it&nbsp;can&nbsp;fail&nbsp;if&nbsp;you&nbsp;are&nbsp;requesting&nbsp;content&nbsp;from&nbsp;another&nbsp;domain&nbsp;and<br>
+the&nbsp;current&nbsp;site&nbsp;has&nbsp;restrictive&nbsp;same-origin&nbsp;policies&nbsp;(which&nbsp;is&nbsp;very&nbsp;common).</tt></dd></dl>
+
 <hr>
 Methods inherited from <a href="ChromeController.Generator.Generated.html#ChromeRemoteDebugInterface">ChromeController.Generator.Generated.ChromeRemoteDebugInterface</a>:<br>
 <dl><dt><a name="ChromeRemoteDebugInterface-Accessibility_getPartialAXTree"><strong>Accessibility_getPartialAXTree</strong></a>(self, nodeId, **kwargs)</dt><dd><tt>Function&nbsp;path:&nbsp;Accessibility.getPartialAXTree<br>

diff --git a/docs/ChromeController.transport.html b/docs/ChromeController.transport.html
@@ -61,7 +61,7 @@
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="ChromeExecutionManager-__del__"><strong>__del__</strong></a>(self)</dt></dl>
 
-<dl><dt><a name="ChromeExecutionManager-__init__"><strong>__init__</strong></a>(self, binary, base_tab_key, host='localhost', port=None, websocket_timeout=10, enable_gpu=False, additional_options=[])</dt><dd><tt>Start&nbsp;up&nbsp;a&nbsp;chromium&nbsp;instance&nbsp;binary&nbsp;`binary`,&nbsp;with&nbsp;the&nbsp;base&nbsp;debug&nbsp;port&nbsp;`port`,<br>
+<dl><dt><a name="ChromeExecutionManager-__init__"><strong>__init__</strong></a>(self, binary, base_tab_key, host='localhost', port=None, websocket_timeout=10, enable_gpu=False, headless=True, additional_options=[])</dt><dd><tt>Start&nbsp;up&nbsp;a&nbsp;chromium&nbsp;instance&nbsp;binary&nbsp;`binary`,&nbsp;with&nbsp;the&nbsp;base&nbsp;debug&nbsp;port&nbsp;`port`,<br>
 on&nbsp;host&nbsp;`localhost`.<br>
 &nbsp;<br>
 Note:&nbsp;If&nbsp;the&nbsp;port&nbsp;is&nbsp;set&nbsp;to&nbsp;None&nbsp;(the&nbsp;default),&nbsp;the&nbsp;port&nbsp;will&nbsp;be&nbsp;the&nbsp;next&nbsp;availble&nbsp;port&nbsp;accounting&nbsp;for&nbsp;other<br>