MonkeyRunner
Stay organized with collections
Save and categorize content based on your preferences.
A monkeyrunner class that contains static utility methods.
Summary
| Methods |
|
void
|
alert
(string message,
string title,
string okTitle)
Displays an alert dialog to the process running the current
program.
|
|
integer
|
choice
(string message,
iterable choices,
string title)
Displays a dialog with a list of choices to the process running the current program.
|
|
void
|
help
(string format)
Displays the monkeyrunner API reference in a style similar to that of Python's
pydoc tool, using the specified format.
|
|
string
|
input
(string message,
string initialValue,
string title,
string okTitle,
string cancelTitle)
Displays a dialog that accepts input.
|
|
void
|
sleep
(float seconds)
Pauses the current program for the specified number of seconds.
|
MonkeyDevice
|
waitForConnection
(float timeout,
string deviceId)
Tries to make a connection between the monkeyrunner backend and the
specified device or emulator.
|
Public methods
string
alert
(
string message,
string title,
string okTitle)
Displays an alert dialog to the process running the current
program. The dialog is modal, so the program pauses until the user clicks the dialog's
button.
Arguments
| message |
The message to display in the dialog.
|
| title |
The dialog's title. The default value is "Alert".
|
| okTitle |
The text displayed in the dialog button. The default value is "OK".
|
integer
choice
(string message,
iterable choices,
string title)
Displays a dialog with a list of choices to the process running the current program. The
dialog is modal, so the program pauses until the user clicks one of the dialog's
buttons.
Arguments
| message |
The prompt message displayed in the dialog.
|
| choices |
A Python iterable containing one or more objects that are displayed as strings. The
recommended form is an array of strings.
|
|
title
|
The dialog's title. The default is "Input".
|
Returns
-
If the user makes a selection and clicks the "OK" button, the method returns
the 0-based index of the selection within the iterable.
If the user clicks the "Cancel" button, the method returns -1.
Displays the monkeyrunner API reference in a style similar to that of Python's
pydoc tool, using the specified format.
Arguments
| format |
The markup format to use in the output. The possible values are "text" for plain text
or "html" for HTML.
|
Displays a dialog that accepts input and returns it to the program. The dialog is
modal, so the program pauses until the user clicks one of the dialog's buttons.
The dialog contains two buttons, one of which displays the okTitle value
and the other the cancelTitle value. If the user clicks the okTitle button,
the current value of the input box is returned. If the user clicks the cancelTitle
button, an empty string is returned.
Arguments
| message |
The prompt message displayed in the dialog.
|
| initialValue |
The initial value to display in the dialog. The default is an empty string.
|
| title |
The dialog's title. The default is "Input".
|
| okTitle |
The text displayed in the okTitle button. The default is "OK".
|
| cancelTitle |
The text displayed in the cancelTitle button. The default is "Cancel".
|
Returns
-
If the user clicks the okTitle button, then the method returns the current value of
the dialog's input box. If the user clicks the cancelTitle button, the method returns
an empty string.
void
sleep
(
float seconds
)
Pauses the current program for the specified number of seconds.
Arguments
| seconds |
The number of seconds to pause.
|
MonkeyDevice
waitForConnection
(float timeout,
string deviceId)
Tries to make a connection between the monkeyrunner backend and the
specified device or emulator.
Arguments
| timeout |
The number of seconds to wait for a connection. The default is to wait forever.
|
|
deviceId
|
A regular expression that specifies the serial number of the device or emulator. See
the topic
Android Debug Bridge
for a description of device and emulator serial numbers.
|
Returns
-
A
MonkeyDevice
instance for the device or emulator. Use this object to control and communicate with the
device or emulator.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-04-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-04-12 UTC."],[],[],null,["# MonkeyRunner\n\nA monkeyrunner class that contains static utility methods.\n\nSummary\n-------\n\n| Methods ||||||||||||\n|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|\n| void | [alert](#alert) (*string* message, *string* title, *string* okTitle) Displays an alert dialog to the process running the current program. |\n| *integer* | [choice](#choice) (*string* message, *iterable* choices, *string* title) Displays a dialog with a list of choices to the process running the current program. |\n| void | [help](#help) (*string* format) Displays the monkeyrunner API reference in a style similar to that of Python's `pydoc` tool, using the specified format. |\n| *string* | [input](#input) (*string* message, *string* initialValue, *string* title, *string* okTitle, *string* cancelTitle) Displays a dialog that accepts input. |\n| void | [sleep](#sleep) (*float* seconds) Pauses the current program for the specified number of seconds. |\n| ` `[MonkeyDevice](/tools/help/MonkeyDevice)` ` | [waitForConnection](#waitForConnection) (*float* timeout, *string* deviceId) Tries to make a connection between the `monkeyrunner` backend and the specified device or emulator. |\n\nPublic methods\n--------------\n\n#### *string*\nalert\n( *string* message, *string* title, *string* okTitle)\n\n\nDisplays an alert dialog to the process running the current\nprogram. The dialog is modal, so the program pauses until the user clicks the dialog's\nbutton. \n\n##### Arguments\n\n| message | The message to display in the dialog. |\n| title | The dialog's title. The default value is \"Alert\". |\n| okTitle | The text displayed in the dialog button. The default value is \"OK\". |\n|---------|---------------------------------------------------------------------|\n\n#### *integer*\nchoice\n(*string* message, *iterable* choices, *string* title)\n\n\nDisplays a dialog with a list of choices to the process running the current program. The\ndialog is modal, so the program pauses until the user clicks one of the dialog's\nbuttons. \n\n##### Arguments\n\n| message | The prompt message displayed in the dialog. |\n| choices | A Python iterable containing one or more objects that are displayed as strings. The recommended form is an array of strings. |\n| title | The dialog's title. The default is \"Input\". |\n|---------|------------------------------------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- If the user makes a selection and clicks the \"OK\" button, the method returns the 0-based index of the selection within the iterable. If the user clicks the \"Cancel\" button, the method returns -1. \n\n#### void\nhelp\n(*string* format)\n\n\nDisplays the monkeyrunner API reference in a style similar to that of Python's\n`pydoc` tool, using the specified format. \n\n##### Arguments\n\n| format | The markup format to use in the output. The possible values are \"text\" for plain text or \"html\" for HTML. |\n|--------|-----------------------------------------------------------------------------------------------------------|\n\n#### *string*\ninput\n(*string* message *string* initialValue, *string* title, *string* okTitle, *string* cancelTitle)\n\n\nDisplays a dialog that accepts input and returns it to the program. The dialog is\nmodal, so the program pauses until the user clicks one of the dialog's buttons.\n\n\nThe dialog contains two buttons, one of which displays the okTitle value\nand the other the cancelTitle value. If the user clicks the okTitle button,\nthe current value of the input box is returned. If the user clicks the cancelTitle\nbutton, an empty string is returned. \n\n##### Arguments\n\n| message | The prompt message displayed in the dialog. |\n| initialValue | The initial value to display in the dialog. The default is an empty string. |\n| title | The dialog's title. The default is \"Input\". |\n| okTitle | The text displayed in the okTitle button. The default is \"OK\". |\n| cancelTitle | The text displayed in the cancelTitle button. The default is \"Cancel\". |\n|--------------|-----------------------------------------------------------------------------|\n\n##### Returns\n\n- If the user clicks the okTitle button, then the method returns the current value of the dialog's input box. If the user clicks the cancelTitle button, the method returns an empty string. \n\n#### void\nsleep\n( *float* seconds )\n\n\nPauses the current program for the specified number of seconds. \n\n##### Arguments\n\n| seconds | The number of seconds to pause. |\n|---------|---------------------------------|\n\n#### `\n`[MonkeyDevice](/tools/help/MonkeyDevice)`\n`\nwaitForConnection\n(*float* timeout, *string* deviceId)\n\n\nTries to make a connection between the `monkeyrunner` backend and the\nspecified device or emulator. \n\n##### Arguments\n\n| timeout | The number of seconds to wait for a connection. The default is to wait forever. |\n| deviceId | A regular expression that specifies the serial number of the device or emulator. See the topic [Android Debug Bridge](/tools/help/adb) for a description of device and emulator serial numbers. |\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- A [MonkeyDevice](/tools/help/MonkeyDevice) instance for the device or emulator. Use this object to control and communicate with the device or emulator."]]
