| OLD | NEW |
| (Empty) |
| 1 | |
| 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> | |
| 3 <html><head><title>Python: module telemetry.core.android_action_runner</title> | |
| 4 <meta charset="utf-8"> | |
| 5 </head><body bgcolor="#f0f0f8"> | |
| 6 | |
| 7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> | |
| 8 <tr bgcolor="#7799ee"> | |
| 9 <td valign=bottom> <br> | |
| 10 <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>.android_action_runner</strong>
</big></big></font></td | |
| 11 ><td align=right valign=bottom | |
| 12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href=
"../telemetry/core/android_action_runner.py">telemetry/core/android_action_runne
r.py</a></font></td></tr></table> | |
| 13 <p><tt># Copyright 2015 The Chromium Authors.
All rights reserved.<br> | |
| 14 # Use of this source code is governed by
a BSD-style license that can be<br> | |
| 15 # found in the LICENSE file.</tt></p> | |
| 16 <p> | |
| 17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| 18 <tr bgcolor="#aa55cc"> | |
| 19 <td colspan=3 valign=bottom> <br> | |
| 20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big
></font></td></tr> | |
| 21 | |
| 22 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td>
</td> | |
| 23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t
op><a href="logging.html">logging</a><br> | |
| 24 </td><td width="25%" valign=top><a href="time.html">time</a><br> | |
| 25 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor
e.util</a><br> | |
| 26 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> | |
| 27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| 28 <tr bgcolor="#ee77aa"> | |
| 29 <td colspan=3 valign=bottom> <br> | |
| 30 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big
></font></td></tr> | |
| 31 | |
| 32 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td>
</td> | |
| 33 <td width="100%"><dl> | |
| 34 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.
object</a> | |
| 35 </font></dt><dd> | |
| 36 <dl> | |
| 37 <dt><font face="helvetica, arial"><a href="telemetry.core.android_action_runner.
html#AndroidActionRunner">AndroidActionRunner</a> | |
| 38 </font></dt></dl> | |
| 39 </dd> | |
| 40 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions
.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException<
/a>) | |
| 41 </font></dt><dd> | |
| 42 <dl> | |
| 43 <dt><font face="helvetica, arial"><a href="telemetry.core.android_action_runner.
html#ActionNotSupported">ActionNotSupported</a> | |
| 44 </font></dt></dl> | |
| 45 </dd> | |
| 46 </dl> | |
| 47 <p> | |
| 48 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| 49 <tr bgcolor="#ffc8d8"> | |
| 50 <td colspan=3 valign=bottom> <br> | |
| 51 <font color="#000000" face="helvetica, arial"><a name="ActionNotSupported">class
<strong>ActionNotSupported</strong></a>(<a href="exceptions.html#Exception">exc
eptions.Exception</a>)</font></td></tr> | |
| 52 | |
| 53 <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> | |
| 54 <td width="100%"><dl><dt>Method resolution order:</dt> | |
| 55 <dd><a href="telemetry.core.android_action_runner.html#ActionNotSupported">Actio
nNotSupported</a></dd> | |
| 56 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> | |
| 57 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> | |
| 58 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> | |
| 59 </dl> | |
| 60 <hr> | |
| 61 Data descriptors defined here:<br> | |
| 62 <dl><dt><strong>__weakref__</strong></dt> | |
| 63 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> | |
| 64 </dl> | |
| 65 <hr> | |
| 66 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception<
/a>:<br> | |
| 67 <dl><dt><a name="ActionNotSupported-__init__"><strong>__init__</strong></a>(...)
</dt><dd><tt>x.<a href="#ActionNotSupported-__init__">__init__</a>(...) ini
tializes x; see help(type(x)) for signature</tt></dd></
dl> | |
| 68 | |
| 69 <hr> | |
| 70 Data and other attributes inherited from <a href="exceptions.html#Exception">exc
eptions.Exception</a>:<br> | |
| 71 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object>
;<dd><tt>T.<a href="#ActionNotSupported-__new__">__new__</a>(S, ...) -
> a new <a href="__builtin__.html#object">object</a> with
type S, a subtype of T</tt></dl> | |
| 72 | |
| 73 <hr> | |
| 74 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx
ception</a>:<br> | |
| 75 <dl><dt><a name="ActionNotSupported-__delattr__"><strong>__delattr__</strong></a
>(...)</dt><dd><tt>x.<a href="#ActionNotSupported-__delattr__">__delattr__</a>('
name') <==> del x.name</tt></dd></dl> | |
| 76 | |
| 77 <dl><dt><a name="ActionNotSupported-__getattribute__"><strong>__getattribute__</
strong></a>(...)</dt><dd><tt>x.<a href="#ActionNotSupported-__getattribute__">__
getattribute__</a>('name') <==> x.name</tt></dd></dl> | |
| 78 | |
| 79 <dl><dt><a name="ActionNotSupported-__getitem__"><strong>__getitem__</strong></a
>(...)</dt><dd><tt>x.<a href="#ActionNotSupported-__getitem__">__getitem__</a>(y
) <==> x[y]</tt></dd></dl> | |
| 80 | |
| 81 <dl><dt><a name="ActionNotSupported-__getslice__"><strong>__getslice__</strong><
/a>(...)</dt><dd><tt>x.<a href="#ActionNotSupported-__getslice__">__getslice__</
a>(i, j) <==> x[i:j]<br> | |
| 82 <br> | |
| 83 Use of negative indices is not supported.</tt></dd
></dl> | |
| 84 | |
| 85 <dl><dt><a name="ActionNotSupported-__reduce__"><strong>__reduce__</strong></a>(
...)</dt></dl> | |
| 86 | |
| 87 <dl><dt><a name="ActionNotSupported-__repr__"><strong>__repr__</strong></a>(...)
</dt><dd><tt>x.<a href="#ActionNotSupported-__repr__">__repr__</a>() <==
> repr(x)</tt></dd></dl> | |
| 88 | |
| 89 <dl><dt><a name="ActionNotSupported-__setattr__"><strong>__setattr__</strong></a
>(...)</dt><dd><tt>x.<a href="#ActionNotSupported-__setattr__">__setattr__</a>('
name', value) <==> x.name = value</tt></dd></dl> | |
| 90 | |
| 91 <dl><dt><a name="ActionNotSupported-__setstate__"><strong>__setstate__</strong><
/a>(...)</dt></dl> | |
| 92 | |
| 93 <dl><dt><a name="ActionNotSupported-__str__"><strong>__str__</strong></a>(...)</
dt><dd><tt>x.<a href="#ActionNotSupported-__str__">__str__</a>() <==>
str(x)</tt></dd></dl> | |
| 94 | |
| 95 <dl><dt><a name="ActionNotSupported-__unicode__"><strong>__unicode__</strong></a
>(...)</dt></dl> | |
| 96 | |
| 97 <hr> | |
| 98 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
ns.BaseException</a>:<br> | |
| 99 <dl><dt><strong>__dict__</strong></dt> | |
| 100 </dl> | |
| 101 <dl><dt><strong>args</strong></dt> | |
| 102 </dl> | |
| 103 <dl><dt><strong>message</strong></dt> | |
| 104 </dl> | |
| 105 </td></tr></table> <p> | |
| 106 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| 107 <tr bgcolor="#ffc8d8"> | |
| 108 <td colspan=3 valign=bottom> <br> | |
| 109 <font color="#000000" face="helvetica, arial"><a name="AndroidActionRunner">clas
s <strong>AndroidActionRunner</strong></a>(<a href="__builtin__.html#object">__b
uiltin__.object</a>)</font></td></tr> | |
| 110 | |
| 111 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> | |
| 112 <td colspan=2><tt>Provides an API for interacting with&
nbsp;an android device.<br> | |
| 113 <br> | |
| 114 This makes use of functionality provided by t
he android input command. None<br> | |
| 115 of the gestures here are guaranteed to be&nbs
p;performant for telemetry tests and<br> | |
| 116 there is no official support for this API.<br
> | |
| 117 <br> | |
| 118 TODO(ariblue): Replace this API with a better 
;implementation for interacting<br> | |
| 119 with native components.<br> </tt></td></tr> | |
| 120 <tr><td> </td> | |
| 121 <td width="100%">Methods defined here:<br> | |
| 122 <dl><dt><a name="AndroidActionRunner-InputKeyEvent"><strong>InputKeyEvent</stron
g></a>(self, key)</dt><dd><tt>Send a single key input t
o the device.<br> | |
| 123 <br> | |
| 124 Args:<br> | |
| 125 key: A key code number or name th
at will be sent to the device</tt></dd></dl> | |
| 126 | |
| 127 <dl><dt><a name="AndroidActionRunner-InputPress"><strong>InputPress</strong></a>
(self)</dt><dd><tt>Perform a press input.</tt></dd></dl> | |
| 128 | |
| 129 <dl><dt><a name="AndroidActionRunner-InputRoll"><strong>InputRoll</strong></a>(s
elf, dx, dy)</dt><dd><tt>Perform a roll input. This sen
ds a simple zero-pressure move event.<br> | |
| 130 <br> | |
| 131 Args:<br> | |
| 132 dx: Change in the x coordinate due&nbs
p;to move.<br> | |
| 133 dy: Change in the y coordinate due&nbs
p;to move.</tt></dd></dl> | |
| 134 | |
| 135 <dl><dt><a name="AndroidActionRunner-InputSwipe"><strong>InputSwipe</strong></a>
(self, left_start_coord, top_start_coord, left_end_coord, top_end_coord, duratio
n)</dt><dd><tt>Perform a swipe input.<br> | |
| 136 <br> | |
| 137 Args:<br> | |
| 138 left_start_coord: The horizontal starting coordi
nate of the gesture<br> | |
| 139 top_start_coord: The vertical starting coordinat
e of the gesture<br> | |
| 140 left_end_coord: The horizontal ending coordinate
of the gesture<br> | |
| 141 top_end_coord: The vertical ending coordinate&nb
sp;of the gesture<br> | |
| 142 duration: The length of time of the&nb
sp;swipe in milliseconds</tt></dd></dl> | |
| 143 | |
| 144 <dl><dt><a name="AndroidActionRunner-InputTap"><strong>InputTap</strong></a>(sel
f, x_coord, y_coord)</dt><dd><tt>Perform a tap input at 
;the given coordinates.<br> | |
| 145 <br> | |
| 146 Args:<br> | |
| 147 x_coord: The x coordinate of the tap&n
bsp;event.<br> | |
| 148 y_coord: The y coordinate of the tap&n
bsp;event.</tt></dd></dl> | |
| 149 | |
| 150 <dl><dt><a name="AndroidActionRunner-InputText"><strong>InputText</strong></a>(s
elf, string)</dt><dd><tt>Convert the characters of the
string into key events and send to device.<br
> | |
| 151 <br> | |
| 152 Args:<br> | |
| 153 string: The string to send to the 
;device.</tt></dd></dl> | |
| 154 | |
| 155 <dl><dt><a name="AndroidActionRunner-SmoothScrollBy"><strong>SmoothScrollBy</str
ong></a>(self, left_start_coord, top_start_coord, direction, scroll_distance)</d
t><dd><tt>Perfrom gesture to scroll down on the&nb
sp;android device.</tt></dd></dl> | |
| 156 | |
| 157 <dl><dt><a name="AndroidActionRunner-TurnScreenOff"><strong>TurnScreenOff</stron
g></a>(self)</dt><dd><tt>If device screen is on, turn&n
bsp;screen off.<br> | |
| 158 If the screen is already off, log a warn
ing and return immediately.<br> | |
| 159 <br> | |
| 160 Raises:<br> | |
| 161 Timeout: If the screen is on and
device fails to turn screen off.</tt></dd></dl> | |
| 162 | |
| 163 <dl><dt><a name="AndroidActionRunner-TurnScreenOn"><strong>TurnScreenOn</strong>
</a>(self)</dt><dd><tt>If device screen is off, turn&nb
sp;screen on.<br> | |
| 164 If the screen is already on, log a warni
ng and return immediately.<br> | |
| 165 <br> | |
| 166 Raises:<br> | |
| 167 Timeout: If the screen is off and 
;device fails to turn screen on.</tt></dd></dl> | |
| 168 | |
| 169 <dl><dt><a name="AndroidActionRunner-UnlockScreen"><strong>UnlockScreen</strong>
</a>(self)</dt><dd><tt>If device screen is locked, unlo
cks it.<br> | |
| 170 If the device is not locked, log a warni
ng and return immediately.<br> | |
| 171 <br> | |
| 172 Raises:<br> | |
| 173 Timeout: If device fails to unlock scr
een.</tt></dd></dl> | |
| 174 | |
| 175 <dl><dt><a name="AndroidActionRunner-Wait"><strong>Wait</strong></a>(self, secon
ds)</dt><dd><tt>Wait for the number of seconds spe
cified.<br> | |
| 176 <br> | |
| 177 Args:<br> | |
| 178 seconds: The number of seconds to wait
.</tt></dd></dl> | |
| 179 | |
| 180 <dl><dt><a name="AndroidActionRunner-__init__"><strong>__init__</strong></a>(sel
f, platform_backend)</dt></dl> | |
| 181 | |
| 182 <hr> | |
| 183 Data descriptors defined here:<br> | |
| 184 <dl><dt><strong>__dict__</strong></dt> | |
| 185 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> | |
| 186 </dl> | |
| 187 <dl><dt><strong>__weakref__</strong></dt> | |
| 188 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> | |
| 189 </dl> | |
| 190 </td></tr></table></td></tr></table> | |
| 191 </body></html> | |
| OLD | NEW |