A monkeyrunner class that represents a device or emulator accessible by the workstation running monkeyrunner.

monkeyrunner类代表了能被工作站运行monkeyrunner连接的设备或者模拟器

This class is used to control an Android device or emulator. The methods send UI events, retrieve information, install and remove applications, and run applications.

这个类通常用来控制安卓设备或者模拟器. 这个方法包括,发送UI事件,检索信息,安卓或者下载程序,和运行程序.

You normally do not have to create an instance of MonkeyDevice. Instead, you use MonkeyRunner.waitForConnection() to create a new object from a connection to a device or emulator. For example, instead of using:

通常你不需要单独去创建一个monkeydevice的实例, 你可以用MonkeyRunner.waitForConnection()创建一个对象连接设备和模拟器.例如,通常不用

newdevice = MonkeyDevice()

you would use:

而使用:

newdevice = MonkeyRunner.waitForConnection()

Constants

string DOWN

press() or touch() value. Specifies that a DOWN event type should be sent to the device, corresponding to pressing down on a key or touching the screen.

press() 或者touch()的值.指定一个DOWN事件类型发送给设备,相当于按下一个按键或者触摸屏幕.

string UP

press() or touch() value. Specifies that an UP event type should be sent to the device, corresponding to releasing a key or lifting up from the screen.

press() 或者touch()的值.指定一个UP事件类型发送给设备,相当于释放一个按键或者离开屏幕.

string DOWN_AND_UP

press(), touch() or type() value. Specifies that a DOWN event type followed by an UP event type should be sent to the device, corresponding to typing a key or clicking the screen.

press(),touch() 或者 type()的值. 指定一个down事件类型跟随一个UP事件类型发送给设备,相当于点击一个按键或者点击屏幕.

Public Methods

void broadcastIntent ( string uri, string action, string data, string mimetype, iterable categories dictionary extras, component component, iterable flags) ?

　　Broadcasts an Intent to this device, as if the Intent were coming from an application. See Intent for more information about the arguments.

　　对设备广播Intent, 就像这个Intent是从程序来的.

　　Arguments

　　　　uri  The URI for the Intent. (see Intent.setData()).

　　　　action  The action for this Intent (see Intent.setAction()).

　　　　data    The data URI for this Intent (see Intent.setData()).

　　　　mimetype  The MIME type for the Intent (see Intent.setType()).

　　　　categories An iterable data structure containing strings that define categories for this Intent (see 　　　　　　　　　　　　Intent.addCategory()).

　　　　extras  A dictionary of extra data for this Intent (see Intent.putExtra() for an example).The key for 　　　　　　　　　　each dictionary item should be a string. The item's value can be any simple or structured 　　　　　　　　　　data type.

　　　　component      The component for this Intent (see ComponentName). Using this argument will direct 　　　　　　　　　　　　the Intent to a specific class within a specific Android package.

　　　　flags    An iterable data structure containing flags that control how the Intent is handled (see 　　　　　　　　　　　　Intent.setFlags()).

void drag ( tuple start, tuple end, float duration, integer steps) ?

　　Simulates a drag gesture (touch, hold, and move) on this device's screen.

　　在屏幕上模拟一个drag的手势(触摸,保持并且移动)

Arguments

　　start         　The starting point of the drag gesture, in the form of a tuple (x,y) where x and y are integers.

　　　　　　　　　　drag手势开始的点,用元组(x,y)表示, x,y是整数.

　　end  　　　　The end point of the drag gesture, in the form of a tuple (x,y) where x and y are integers.

　　　　　　　　　　drag手势结束的点,用元组(x,y)表示, x,y是整数.

　　duration   　The duration of the drag gesture in seconds. The default is 1.0 seconds.

　　　　　　　　　　drag手势的时间,默认是1秒.

　　steps        　The number of steps to take when interpolating points. The default is 10.

　　　　　　　　　　　插值点时要采用的步骤.默认是10.

object getProperty (string key)

　　Given the name of a system environment variable, returns its value for this device.

　　给出系统环境变量,返回设备值.

　　Arguments

　　　　key   The name of the system environment variable. The available variable names are listed in "Table 1. Property variable names" at the end of this 　　　　　　　　　　topic.

　　　　　　　　系统环境变量的名字. 可用的变量名字在Topic最后的Table1列出.

　　　　Returns

　　　　　　The value of the variable. The data format varies according to the variable requested.

　　　　　　　　返回变量的值, 数据格式依据需求变化.

object getSystemProperty (string key)

　　Synonym for getProperty().

　　和getProperty()同义.

　　Arguments

　　　　key   The name of the system environment variable. The available variable names are listed in Table 1. Property Variable Names.

　　　　　　　　系统环境变量的名字. 可用的变量名字在Topic最后的Table1列出.

　　　　Returns

　　　　　　The value of the variable. The data format varies according to the variable requested.

　　　　　　返回变量的值, 数据格式依据需求变化.

void installPackage (string path)

　　Installs the Android application or test package contained in packageFile onto this device. If the application or test package is already installed, it is 　　　　　　replaced.

　　安装程序或者包含包文件的测试包到设备. 如果程序或者包已经安装过了.会覆盖它.

　　Arguments

　　　　path 　　The fully-qualified path and filename of the .apk file to install.

　　　　　　　　　　全路径.apk的包名.

dictionary instrument ( string className, dictionary args)

　　　　Runs the specified component with Android instrumentation, and returns the results in a dictionary 　　　　　　whose exact format is dictated by the component being run. The component must already be 　　　　　　　　present on this device.

　　　　Use this method to start a test case that uses one of Android's test case classes. See Testing 　　　　　　　　Fundamentals to learn more about unit testing with 　　　　　the Android testing framework.

　　Arguments

　　　　className      The name of an Android component that is already installed on this device, in the 　　　　　　　　　　　　　　　standard form packagename/classname, where packagename is the Android package 　　　　　　　　　　　　　name of a .apk file on this device, and classname is the class name of an Android 　　　　　　　　　　　　　　component (Activity, ContentProvider, Service, or BroadcastReceiver) in that file. 　　　　　　　　　　　　　　Both packagename and classname must be fully qualified. See ComponentName for 　　　　　　　　　　　　　more details.

　　　　args 　　　　　A dictionary containing flags and their values. These are passed to the component as 　　　　　　　　　　　　it is started. If the flag does not take a value, set its dictionary value to an empty 　　　　　　　　　　　　　　string.

　　　　Returns

　　　　　　A dictionary containing the component's output. The contents of the dictionary are defined by the 　　　　　　component itself.

　　　　　　If you use InstrumentationTestRunner as the class name in the componentName argument, then 　　　　　　the result dictionary contains the single key "stream". The value of "stream" is a string containing the test output, as if InstrumentationTestRunner was run from the command line. The format of this output is described in Testing in Other IDEs.

void press (string name, integer type)

　　Sends the key event specified by type to the key specified by keycode.

　　发送一个指定类型的key 事件

　　Arguments

　　　　name        The name of the keycode to send. See KeyEvent for a list of keycode names. Use the keycode name, not its integer value.

　　　　　　　　　　　　要发送的keycode的名字. 要使用keycode的名字,不用数值,(http://developer.android.com/reference/android/view/KeyEvent.html)

　　　　type 　　　The type of key event to send. The allowed values are DOWN, UP, and DOWN_AND_UP.

　　　　　　　　　　 要发送的KEY事件的类型. 允许的值为DOWN, UP 和 DOWN_AND_UP

void reboot (string bootloadType)

　　Reboots this device into the bootloader specified by bootloadType.

　　重启设备进入到bootloader

　　Arguments

　　　　into  The type of bootloader to reboot into. The allowed values are "bootloader", "recovery", or 　　　　　　　　　　"None".

　　　　　　　　重启后进入bootloader的类型, 允许的值为"bootloader", "recovery" 或者 "None".

void removePackage (string package)

　　Deletes the specified package from this device, including its data and cache.

　　从设备上删除指定的包,包括数据和缓存.

　　Arguments

　　　　package   The Android package name of an .apk file on this device.

　　　　　　　　　　一个.apk的包名.

object shell (string cmd)

　　Executes an adb shell command and returns the result, if any.

　　执行一个adb shell的命令并返回结果.

　　Arguments

　　　　cmd 　　The command to execute in the adb shell. The form of these commands is described in the topic Android Debug Bridge.

　　　　　　　　　　要再adb shell中执行的命令. (http://developer.android.com/tools/help/adb.html)

　　　　Returns　　The results of the command, if any. The format of the results is determined by the command.

　　　　　　　　　　　　命令执行的结果,如果存在的话. 结果的格式由命令决定.

void startActivity ( string uri, string action, string data, string mimetype, iterable categories dictionary extras, component component, iterable flags)

　　Starts an Activity on this device by sending an Intent constructed from the supplied arguments.

　　Arguments

　　　　uri    The URI for the Intent. (see Intent.setData()).

　　　　action       The action for the Intent (see Intent.setAction()).

　　　　data The data URI for the Intent (see Intent.setData()).

　　　　mimetype         The MIME type for the Intent (see Intent.setType()).

　　　　categories        An iterable data structure containing strings that define categories for the Intent 　　　　　　　　　　　　　　　　(see Intent.addCategory()).

　　　　extras       A dictionary of extra data for the Intent (see Intent.putExtra() for an example).The key for each dictionary item should be a string. The item's value can be any simple or structured data type.

　　　　component       The component for the Intent (see ComponentName). Using this argument will direct the Intent to a specific class within a specific Android package.

　　　　flags          An iterable data structure containing flags that control how the Intent is handled　(see Intent.setFlags()).

MonkeyImage takeSnapshot ()

　　Captures the entire screen buffer of this device, yielding a screen capture of the current display.

　　捕获这个设备整个屏幕的缓存,产生当前屏幕的截图.

　　Returns

　　　　A MonkeyImage object containing the image of the current display.

　　　　一个包含当前屏幕显示的MonkeyImage对象

void touch ( integer x, integer y, string type)

　　Sends a touch event specified by type to the screen location specified by x and y.

　　发送一个指定类型的touch事件到屏幕的(x,y).

　　Arguments

　　　　x       The horizontal position of the touch in actual device pixels, starting from the left of the screen in its current orientation.

　　　　　　　 从屏幕左边开始计算的水平像素.

　　　　y       The vertical position of the touch in actual device pixels, starting from the top of the screen in its current orientation.

　　　　　　　　从屏幕上边开始计算的垂直像素

　　　　type 　　The type of key event to send. The allowed values are DOWN, UP, and DOWN_AND_UP.

　　　　　　　　　　要发送的key事件类型.允许的值是,DOWN, UP 和 DOWN_AND_UP

void type (string message)

　　　　Sends the characters contained in message to this device, as if they had been typed on the device's keyboard. This is equivalent to calling press() for each keycode in message using the key event type DOWN_AND_UP.

　　　　给设备发送包含字母的信息,就像他们是再设备键盘上输入的. 这个等于调用press(keycode,DOWN_AND_UP)函数.

　　Arguments

　　　　message  A string containing the characters to send.

　　　　　　　　　　包含字母的字符串.

void wake ()

　　　Wakes the screen of this device.

　　　　唤醒设备屏幕.

Appendix

Table 1.Property variable names used with getProperty() and getSystemProperty().