AutoJs6 Documentation

https://github.com/supermonster003/autojs6-documentation
Admin
This project provides API documentation for AutoJs6, a JavaScript automation tool, detailing its...
Tokens:95,431
Snippets:875
Trust Score:8.4
License:Apache-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### dragStart()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Starts a drag operation on the UI object.

```APIDOC
## dragStart()

### Description
Starts a drag operation on the UI object.

### Method
dragStart

### Parameters
None

### Returns
None
```

--------------------------------

### dragStart()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Starts a drag operation on the selected UI element.

```APIDOC
## dragStart()

### Description
Starts a drag operation on the selected UI element.

### Method
dragStart

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### packageNameStartsWith(str)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Matches UI elements whose package name starts with the given string.

```APIDOC
## packageNameStartsWith(str)

### Description
Matches UI elements whose package name starts with the given string.

### Method
packageNameStartsWith

### Parameters
- **str** (string) - Required - The prefix to match.

### Returns
- UiSelector - The selector with the package name prefix filter applied.

```

--------------------------------

### auto.start()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Starts the automation service. This is typically required before using other automator functions.

```APIDOC
## auto.start()

### Description
Starts the automation service. This is typically required before using other automator functions.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### time(label?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/console.html

Starts a timer with an optional label.

```APIDOC
## time(label?)

### Description
Starts a timer with an optional label.

### Method
time

### Parameters
- **label** (string) - Optional - The label for the timer.

```

--------------------------------

### Use custom plugin with full selector

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/ai.html

Defines a custom plugin with component packageName, className, and providerId. Passes the plugin to ai.catalog() to get its default target, then sends a chat request using the plugin and that target. Logs the plugin, target id, and response text. Replace the package name, class name, and provider ID for third-party plugins.

```javascript
let plugin = {
    component: {
        packageName: 'io.github.example.ai',
        className: 'io.github.example.ai.provider.ExampleAiProviderService',
    },
    providerId: 'example.ai-provider',
};

ai.catalog({ plugin: plugin }).then((catalog) => {
    if (!catalog.defaultTarget) {
        throw new Error('The plugin has no default target');
    }
    return ai.chat('Reply with OK', {
        plugin: plugin,
        target: catalog.defaultTarget,
    });
}).then((response) => {
    console.log(response.plugin, response.target.id, response.text);
});
```

--------------------------------

### randInt(start, stop)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

生成一个在 start 和 stop 之间的随机整数（包含两端）。

```APIDOC
## randInt(start, stop)

### Description
生成一个在 start 和 stop 之间的随机整数（包含两端）。

### Method
randInt

### Parameters
- **start** (number) - 必需 - 起始值。
- **stop** (number) - 必需 - 结束值。

### Returns
- **number** - 生成的随机整数。
```

--------------------------------

### auto.getWindowRoot(window)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Gets the root node of a window.

```APIDOC
## auto.getWindowRoot(window)

### Description
Gets the root node of a window.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
- **window** (object) - Required - The window object.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### drawText(text, start, end, x, y, paint)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/canvas.html

Draws a substring of the specified text from start to end at the given coordinates.

```APIDOC
## drawText(text, start, end, x, y, paint)

### Description
Draws a substring of the specified text from start to end at the given coordinates.

### Method
Canvas method

### Parameters
- **text** (string) - Required - The full text string.
- **start** (number) - Required - The starting index of the substring (inclusive).
- **end** (number) - Required - The ending index of the substring (exclusive).
- **x** (number) - Required - The x-coordinate of the text origin.
- **y** (number) - Required - The y-coordinate of the text baseline.
- **paint** (Paint) - Required - The paint used for drawing.

### Returns
void
```

--------------------------------

### Shell#Home()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Home key.

```APIDOC
## Shell#Home()

### Description
Simulates pressing the Home key.

### Method
Home

### Parameters
None

### Returns
None
```

--------------------------------

### getScaleBaseY()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Gets the current scale base for the Y axis.

```APIDOC
## getScaleBaseY()

### Description
Gets the current scale base for the Y axis.

### Method
getScaleBaseY

### Parameters
None.

### Returns
- **number** - The scale base for Y.
```

--------------------------------

### auto.launchSettings()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Launches the accessibility settings screen.

```APIDOC
## auto.launchSettings()

### Description
Launches the accessibility settings screen.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Shell#OK()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the OK key.

```APIDOC
## Shell#OK()

### Description
Simulates pressing the OK key.

### Method
OK

### Parameters
None

### Returns
None
```

--------------------------------

### wakeUp()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/device.html

Wakes up the device screen.

```APIDOC
## wakeUp()

### Description
Wakes up the device screen.

### Method
N/A (SDK function)

### Endpoint
N/A

### Parameters
None

### Response
No return value.
```

--------------------------------

### getScaleBaseX()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Gets the current scale base for the X axis.

```APIDOC
## getScaleBaseX()

### Description
Gets the current scale base for the X axis.

### Method
getScaleBaseX

### Parameters
None.

### Returns
- **number** - The scale base for X.
```

--------------------------------

### getScaleBases()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Gets the current scale bases for coordinate conversion.

```APIDOC
## getScaleBases()

### Description
Gets the current scale bases for coordinate conversion.

### Method
getScaleBases

### Parameters
None.

### Returns
- **object** - An object containing baseX and baseY.
```

--------------------------------

### Database#onCreate

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Called when the database is created for the first time.

```APIDOC
## onCreate(database)

### Description
Called when the database is created for the first time. This is a callback method that should be overridden to create tables and initialize data.

### Method
onCreate

### Parameters
- **database** (Database) - Required - The database that was created.

### Returns
- (void) - No return value.
```

--------------------------------

### Cursor#get

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Retrieves the value at the specified index in the current row.

```APIDOC
## get(index)

### Description
Returns the value at the given column index in the current row of the cursor.

### Method
get

### Parameters
- **index** (number) - Required - The zero-based column index.

### Returns
- (any) - The value at the specified index.
```

--------------------------------

### Shell#VolumeUp()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Volume Up key.

```APIDOC
## Shell#VolumeUp()

### Description
Simulates pressing the Volume Up key.

### Method
VolumeUp

### Parameters
None

### Returns
None
```

--------------------------------

### setSelection(start, end)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectCollectionType.html

Sets the selection range of the UI object collection.

```APIDOC
## setSelection(start, end)

### Description
Sets the selection range of the UI object collection.

### Method
setSelection

### Parameters
- **start** (type) - Required - The start index of the selection.
- **end** (type) - Required - The end index of the selection.

### Returns
- (type) - The result of the action.
```

--------------------------------

### Shell#Menu()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Menu key.

```APIDOC
## Shell#Menu()

### Description
Simulates pressing the Menu key.

### Method
Menu

### Parameters
None

### Returns
None
```

--------------------------------

### Database#beginTransactionWithListener

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Begins a transaction with a listener for transaction events.

```APIDOC
## beginTransactionWithListener(listener)

### Description
Begins a transaction with a listener for transaction events.

### Method
beginTransactionWithListener

### Parameters
- **listener** (TransactionListener) - Required - The listener for transaction events.

### Returns
None
```

--------------------------------

### timeEnd(label?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/console.html

Stops a timer started with `time` and logs the elapsed time.

```APIDOC
## timeEnd(label?)

### Description
Stops a timer started with `time` and logs the elapsed time.

### Method
timeEnd

### Parameters
- **label** (string) - Optional - The label of the timer to stop.

```

--------------------------------

### launchAndWait(app, options?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Launches an app and waits for it to become idle. The app can be an app name or package name. Options may include timeout and interval.

```APIDOC
## launchAndWait(app, options?)

### Description
Launches an app and waits for it to become idle. The app can be an app name or package name. Options may include timeout and interval.

### Method
launchAndWait

### Parameters
- **app** (string) - Required - The app name or package name.
- **options** (Object) - Optional - Options for launching and waiting.

### Returns
- **Boolean** - Whether the app was launched and became idle.
```

--------------------------------

### util.morseCode.getCode(source, timeSpan?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/util.html

Gets the code of Morse code for the given source.

```APIDOC
## util.morseCode.getCode(source, timeSpan?)

### Description
Gets the code of Morse code for the given source.

### Method
Function call

### Parameters
- **source** (string) - Required - The source string.
- **timeSpan** (number) - Optional - Time span in milliseconds.

### Returns
- (string) - The Morse code.
```

--------------------------------

### Shell#Power()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Power key.

```APIDOC
## Shell#Power()

### Description
Simulates pressing the Power key.

### Method
Power

### Parameters
None

### Returns
None
```

--------------------------------

### Shell#Camera()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Camera key.

```APIDOC
## Shell#Camera()

### Description
Simulates pressing the Camera key.

### Method
Camera

### Parameters
None

### Returns
None
```

--------------------------------

### util.morseCode.getPattern(source, timeSpan?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/util.html

Gets the pattern of Morse code for the given source.

```APIDOC
## util.morseCode.getPattern(source, timeSpan?)

### Description
Gets the pattern of Morse code for the given source.

### Method
Function call

### Parameters
- **source** (string) - Required - The source string.
- **timeSpan** (number) - Optional - Time span in milliseconds.

### Returns
- (string) - The Morse code pattern.
```

--------------------------------

### setSelection(start, end)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectActionsType.html

Sets the selection range of the UI object's text.

```APIDOC
## setSelection(start, end)

### Description
Sets the selection range of the UI object's text.

### Method
setSelection

### Signature
setSelection(start, end)

### Parameters
- **start** (number) - Required - The start index of the selection.
- **end** (number) - Required - The end index of the selection.

### Returns
- **boolean** - Whether the action was performed successfully.

```

--------------------------------

### findOnce()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Finds and returns the first matching UI element, or null if none found.

```APIDOC
## findOnce()

### Description
Finds and returns the first matching UI element, or null if none found.

### Method
findOnce

### Returns
- **UiObject** - The first matching UI element, or null if none found.
```

--------------------------------

### show()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Shows the selected UI element.

```APIDOC
## show()

### Description
Shows the selected UI element.

### Method
show

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### show()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectCollectionType.html

Shows the UI object collection.

```APIDOC
## show()

### Description
Shows the UI object collection.

### Method
show

### Parameters
None

### Returns
- (type) - The result of the action.
```

--------------------------------

### Shell#Back()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Back key.

```APIDOC
## Shell#Back()

### Description
Simulates pressing the Back key.

### Method
Back

### Parameters
None

### Returns
None
```

--------------------------------

### explain(selector, root?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Explains a selector by returning a description of the matched nodes.

```APIDOC
## explain(selector, root?)

### Description
Explains a selector by returning a description of the matched nodes.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
- **selector** (object) - Required - The selector to explain.
- **root** (object) - Optional - The root node to search from.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### dump(options?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Dumps the UI hierarchy as a string.

```APIDOC
## dump(options?)

### Description
Dumps the UI hierarchy as a string.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
- **options** (object) - Optional - Options for dumping.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Shell#Up()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Up arrow key.

```APIDOC
## Shell#Up()

### Description
Simulates pressing the Up arrow key.

### Method
Up

### Parameters
None

### Returns
None
```

--------------------------------

### MatchingResult#best()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

返回最佳匹配项。

```APIDOC
## MatchingResult#best()

### Description
返回最佳匹配项。

### Method
MatchingResult#best

### Parameters
无

### Returns
- 匹配项。
```

--------------------------------

### ObjectFrame#summary()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

返回 ObjectFrame 的摘要信息。

```APIDOC
## ObjectFrame#summary()

### Description
返回 ObjectFrame 的摘要信息。

### Method
ObjectFrame#summary

### Parameters
无

### Returns
- 字符串，摘要信息。
```

--------------------------------

### select()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectCollectionType.html

Selects the UI object collection.

```APIDOC
## select()

### Description
Selects the UI object collection.

### Method
select

### Parameters
None

### Returns
- (type) - The result of the action.
```

--------------------------------

### MatchingResult#first()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

返回第一个匹配项。

```APIDOC
## MatchingResult#first()

### Description
返回第一个匹配项。

### Method
MatchingResult#first

### Parameters
无

### Returns
- 匹配项。
```

--------------------------------

### Shell#Input(text)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates text input.

```APIDOC
## Shell#Input(text)

### Description
Simulates text input.

### Method
Input

### Parameters
- **text** (string) - The text to input.

### Returns
None
```

--------------------------------

### launchAndWait(app, timeout)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Launches an app and waits for it to become idle within a specified timeout. The app can be an app name or package name.

```APIDOC
## launchAndWait(app, timeout)

### Description
Launches an app and waits for it to become idle within a specified timeout. The app can be an app name or package name.

### Method
launchAndWait

### Parameters
- **app** (string) - Required - The app name or package name.
- **timeout** (number) - Required - The timeout in milliseconds.

### Returns
- **Boolean** - Whether the app was launched and became idle.
```

--------------------------------

### pickup()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Picks up a UI element based on a selector.

```APIDOC
## pickup()

### Description
Picks up a UI element based on a selector.

### Method
pickup

### Parameters
None.

### Returns
- **UiObject** - The picked UI element.
```

--------------------------------

### untilFind()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Finds all matching UI elements, waiting until at least one is found.

```APIDOC
## untilFind()

### Description
Finds all matching UI elements, waiting until at least one is found.

### Method
untilFind

### Returns
- **Array<UiObject>** - An array of all matching UI elements.
```

--------------------------------

### select()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Selects all text in the UI object.

```APIDOC
## select()

### Description
Selects all text in the UI object.

### Method
select

### Parameters
None

### Returns
None
```

--------------------------------

### Shell#Right()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Right arrow key.

```APIDOC
## Shell#Right()

### Description
Simulates pressing the Right arrow key.

### Method
Right

### Parameters
None

### Returns
None
```

--------------------------------

### backToApp(app, options?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Presses the back button until the specified app is in the foreground. The app can be an app name or package name. Options may include maxTimes and interval.

```APIDOC
## backToApp(app, options?)

### Description
Presses the back button until the specified app is in the foreground. The app can be an app name or package name. Options may include maxTimes and interval.

### Method
backToApp

### Parameters
- **app** (string) - Required - The app name or package name.
- **options** (Object) - Optional - Options for back behavior.

### Returns
- **Boolean** - Whether the app was reached.
```

--------------------------------

### select(syntax)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Selects content in the selected UI element using the given syntax.

```APIDOC
## select(syntax)

### Description
Selects content in the selected UI element using the given syntax.

### Method
select

### Parameters
- **syntax** (string) - Required - The selection syntax.

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### select()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Selects the entire content of the selected UI element.

```APIDOC
## select()

### Description
Selects the entire content of the selected UI element.

### Method
select

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### auto.currentPackage()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Returns the current foreground package name.

```APIDOC
## auto.currentPackage()

### Description
Returns the current foreground package name.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Shell#TouchX(x)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates a touch at the specified x-coordinate.

```APIDOC
## Shell#TouchX(x)

### Description
Simulates a touch at the specified x-coordinate.

### Method
TouchX

### Parameters
- **x** (number) - The x-coordinate.

### Returns
None
```

--------------------------------

### floorLog(base, antilogarithm)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

计算以 base 为底 antilogarithm 的对数，并向下取整。

```APIDOC
## floorLog(base, antilogarithm)

### Description
计算以 base 为底 antilogarithm 的对数，并向下取整。

### Method
floorLog

### Parameters
- **base** (number) - 必需 - 底数。
- **antilogarithm** (number) - 必需 - 真数。

### Returns
- **number** - 向下取整后的对数值。
```

--------------------------------

### findOnce(index)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Finds and returns the UI element at the specified index among matches, or null if none found.

```APIDOC
## findOnce(index)

### Description
Finds and returns the UI element at the specified index among matches, or null if none found.

### Method
findOnce

### Parameters
- **index** (number) - Required - The index of the element to find.

### Returns
- **UiObject** - The UI element at the specified index, or null if none found.
```

--------------------------------

### show()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Shows the UI object if it is hidden.

```APIDOC
## show()

### Description
Shows the UI object if it is hidden.

### Method
show

### Parameters
None

### Returns
None
```

--------------------------------

### find()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Finds all matching UI elements and returns them as an array.

```APIDOC
## find()

### Description
Finds all matching UI elements and returns them as an array.

### Method
find

### Returns
- **Array<UiObject>** - An array of all matching UI elements.
```

--------------------------------

### Shell#Touch(x, y)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates a touch at the specified coordinates.

```APIDOC
## Shell#Touch(x, y)

### Description
Simulates a touch at the specified coordinates.

### Method
Touch

### Parameters
- **x** (number) - The x-coordinate.
- **y** (number) - The y-coordinate.

### Returns
None
```

--------------------------------

### auto.enable()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Enables the automation service.

```APIDOC
## auto.enable()

### Description
Enables the automation service.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### logMn(base, antilogarithm, fraction?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

计算以 base 为底 antilogarithm 的对数，并可指定小数位数。

```APIDOC
## logMn(base, antilogarithm, fraction?)

### Description
计算以 base 为底 antilogarithm 的对数，并可指定小数位数。

### Method
logMn

### Parameters
- **base** (number) - 必需 - 底数。
- **antilogarithm** (number) - 必需 - 真数。
- **fraction** (number) - 可选 - 小数位数。

### Returns
- **number** - 对数值。
```

--------------------------------

### util.versionCodes.summary(isInDetail?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/util.html

Returns a summary of Android version codes. Optionally includes details.

```APIDOC
## util.versionCodes.summary(isInDetail?)

### Description
Returns a summary of Android version codes. Optionally includes details.

### Method
Function call

### Parameters
- **isInDetail** (boolean) - Optional - If true, includes detailed information.

### Returns
- (string) - Summary string.
```

--------------------------------

### Shell#SetScreenMetrics(width, height)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Sets the screen metrics for the shell.

```APIDOC
## Shell#SetScreenMetrics(width, height)

### Description
Sets the screen metrics for the shell.

### Method
SetScreenMetrics

### Parameters
- **width** (number) - The screen width.
- **height** (number) - The screen height.

### Returns
None
```

--------------------------------

### auto.windowRoots

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Property representing the list of window roots.

```APIDOC
## auto.windowRoots

### Description
Property representing the list of window roots.

### Method
N/A (property)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### expand()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Expands the selected UI element.

```APIDOC
## expand()

### Description
Expands the selected UI element.

### Method
expand

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### showTooltip()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectCollectionType.html

Shows a tooltip for the UI object collection.

```APIDOC
## showTooltip()

### Description
Shows a tooltip for the UI object collection.

### Method
showTooltip

### Parameters
None

### Returns
- (type) - The result of the action.
```

--------------------------------

### expand()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectCollectionType.html

Expands the UI object collection.

```APIDOC
## expand()

### Description
Expands the UI object collection.

### Method
expand

### Parameters
None

### Returns
- (type) - The result of the action.
```

--------------------------------

### showTooltip()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Shows a tooltip for the UI object.

```APIDOC
## showTooltip()

### Description
Shows a tooltip for the UI object.

### Method
showTooltip

### Parameters
None

### Returns
None
```

--------------------------------

### auto.windows

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Property representing the list of windows.

```APIDOC
## auto.windows

### Description
Property representing the list of windows.

### Method
N/A (property)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### images.getSimilarity(imageA, imageB, options?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

获取两张图像的相似度，可指定选项。

```APIDOC
## images.getSimilarity(imageA, imageB, options?)

### Description
获取两张图像的相似度，可指定选项。

### Method
images.getSimilarity

### Parameters
- **imageA** (Image) - 第一张图像
- **imageB** (Image) - 第二张图像
- **options** (Object) - 可选，相似度计算选项。

### Returns
- 数值，表示相似度。
```

--------------------------------

### Shell#Swipe(x1, y1, x2, y2)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates a swipe from one point to another.

```APIDOC
## Shell#Swipe(x1, y1, x2, y2)

### Description
Simulates a swipe from one point to another.

### Method
Swipe

### Parameters
- **x1** (number) - The starting x-coordinate.
- **y1** (number) - The starting y-coordinate.
- **x2** (number) - The ending x-coordinate.
- **y2** (number) - The ending y-coordinate.

### Returns
None
```

--------------------------------

### 窗口过滤器对象 (WindowFilter)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Object used to filter windows.

```APIDOC
## 窗口过滤器对象 (WindowFilter)

### Description
Object used to filter windows.

### Method
N/A (type)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### argb

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/color.html

Creates an ARGB color from various input formats.

```APIDOC
## argb(colorHex)

### Description
Creates an ARGB color from a hexadecimal color string.

### Parameters
- **colorHex** (string) - Required - The hexadecimal color string (e.g., "#RRGGBB" or "#AARRGGBB").

### Returns
- (number) - The ARGB color value as a 32-bit integer.
```

```APIDOC
## argb(alpha, red, green, blue)

### Description
Creates an ARGB color from individual alpha, red, green, and blue components.

### Parameters
- **alpha** (number) - Required - The alpha component (0-255).
- **red** (number) - Required - The red component (0-255).
- **green** (number) - Required - The green component (0-255).
- **blue** (number) - Required - The blue component (0-255).

### Returns
- (number) - The ARGB color value as a 32-bit integer.
```

```APIDOC
## argb(components)

### Description
Creates an ARGB color from an array of components [alpha, red, green, blue].

### Parameters
- **components** (Array<number>) - Required - An array containing alpha, red, green, and blue components (0-255 each).

### Returns
- (number) - The ARGB color value as a 32-bit integer.
```

--------------------------------

### showTooltip()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Shows a tooltip for the selected UI element.

```APIDOC
## showTooltip()

### Description
Shows a tooltip for the selected UI element.

### Method
showTooltip

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### Database#getPath

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Returns the path of the database file.

```APIDOC
## getPath()

### Description
Returns the path of the database file.

### Method
getPath

### Parameters
None

### Returns
String - The database file path.
```

--------------------------------

### Shell.Callback#onInitialized()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Callback method invoked when the shell is initialized.

```APIDOC
## Shell.Callback#onInitialized()

### Description
Callback method invoked when the shell is initialized.

### Method
onInitialized

### Parameters
None

### Returns
None
```

--------------------------------

### util.java.instanceOf(obj, clazz)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/util.html

Alias for util.java.instanceof.

```APIDOC
## util.java.instanceOf(obj, clazz)

### Description
Alias for util.java.instanceof.

### Method
Function call

### Parameters
- **obj** (object) - Required - The object to check.
- **clazz** (JavaClass) - Required - The Java class to check against.

### Returns
- (boolean) - True if the object is an instance of the class.
```

--------------------------------

### selector()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Creates a selector object for UI automation.

```APIDOC
## selector()

### Description
Creates a selector object for UI automation.

### Method
selector

### Parameters
None.

### Returns
- **Selector** - A selector object.
```

--------------------------------

### packageName(app)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Matches UI elements whose package name equals the given app's package name.

```APIDOC
## packageName(app)

### Description
Matches UI elements whose package name equals the package name of the given app.

### Method
packageName

### Parameters
- **app** (App) - Required - The app object whose package name is used for matching.

### Returns
- UiSelector - The selector with the package name filter applied.

```

--------------------------------

### Shell#Tap(x, y)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates a tap at the specified coordinates.

```APIDOC
## Shell#Tap(x, y)

### Description
Simulates a tap at the specified coordinates.

### Method
Tap

### Parameters
- **x** (number) - The x-coordinate.
- **y** (number) - The y-coordinate.

### Returns
None
```

--------------------------------

### Shell.SimpleCallback constructor

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Constructor for the Shell.SimpleCallback class.

```APIDOC
## Shell.SimpleCallback()

### Description
Constructor for the Shell.SimpleCallback class.

### Method
constructor

### Parameters
None

### Returns
- **Shell.SimpleCallback** - A new instance of SimpleCallback.
```

--------------------------------

### imeEnter()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Performs an IME enter action on the selected UI element.

```APIDOC
## imeEnter()

### Description
Performs an IME enter action on the selected UI element.

### Method
imeEnter

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### packageNameMatch(regex)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Matches UI elements whose package name matches the given regular expression.

```APIDOC
## packageNameMatch(regex)

### Description
Matches UI elements whose package name matches the given regular expression.

### Method
packageNameMatch

### Parameters
- **regex** (RegExp) - Required - The regular expression to match.

### Returns
- UiSelector - The selector with the package name regex filter applied.

```

--------------------------------

### detect()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/global.html

Detects UI elements based on a selector.

```APIDOC
## detect()

### Description
Detects UI elements based on a selector.

### Method
detect

### Parameters
None.

### Returns
- **UiObject** - The detected UI element.
```

--------------------------------

### min(numbers, fraction?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

返回数字数组中的最小值，并可指定小数位数。

```APIDOC
## min(numbers, fraction?)

### Description
返回数字数组中的最小值，并可指定小数位数。

### Method
min

### Parameters
- **numbers** (number[]) - 必需 - 数字数组。
- **fraction** (number) - 可选 - 小数位数。

### Returns
- **number** - 最小值。
```

--------------------------------

### wait(cond, options, onOk?, onErr?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Waits until a condition is met, with options object.

```APIDOC
## wait(cond, options, onOk?, onErr?)

### Description
Waits until a condition is met, with options object.

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
- **cond** (function) - Required - Condition function that returns a boolean.
- **options** (object) - Required - Options object containing timeout, interval, etc.
- **onOk** (function) - Optional - Callback when condition is met.
- **onErr** (function) - Optional - Callback on timeout.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### ImageFeatures#oneShot()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

检查是否处于一次性模式。

```APIDOC
## ImageFeatures#oneShot()

### Description
检查是否处于一次性模式。

### Method
ImageFeatures#oneShot

### Parameters
无

### Returns
- 布尔值，表示是否处于一次性模式。
```

--------------------------------

### performAction(action, bundle)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Performs the specified action on the UI object with a bundle of arguments.

```APIDOC
## performAction(action, bundle)

### Description
Performs the specified action on the UI object with a bundle of arguments.

### Method
POST

### Endpoint
`performAction(action, bundle)`

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform.

#### Query Parameters
- **bundle** (object) - Required - A bundle of arguments for the action.

### Response
- **boolean** - True if the action was performed successfully, false otherwise.
```

--------------------------------

### Shell#Text(text)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates text input (alias for Input).

```APIDOC
## Shell#Text(text)

### Description
Simulates text input (alias for Input).

### Method
Text

### Parameters
- **text** (string) - The text to input.

### Returns
None
```

--------------------------------

### auto.currentComponent()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/automator.html

Returns the current foreground component (package and activity).

```APIDOC
## auto.currentComponent()

### Description
Returns the current foreground component (package and activity).

### Method
N/A (function call)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### untilFindOne()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Finds a matching UI element, waiting until one is found.

```APIDOC
## untilFindOne()

### Description
Finds a matching UI element, waiting until one is found.

### Method
untilFindOne

### Returns
- **UiObject** - The first matching UI element.
```

--------------------------------

### Shell#Left()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates pressing the Left arrow key.

```APIDOC
## Shell#Left()

### Description
Simulates pressing the Left arrow key.

### Method
Left

### Parameters
None

### Returns
None
```

--------------------------------

### Database#rawQueryWithFactory

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Runs a raw SQL query with a custom cursor factory. Two overloads are available, one with an optional cancellation signal.

```APIDOC
## rawQueryWithFactory(cursorFactory, sql, selectionArgs, editTable)

### Description
Runs a raw SQL query with a custom cursor factory.

### Method
rawQueryWithFactory

### Parameters
- **cursorFactory** (CursorFactory) - Required - The cursor factory to use.
- **sql** (String) - Required - The SQL query string.
- **selectionArgs** (String[]) - Required - Optional arguments for the query.
- **editTable** (String) - Required - The table to edit.

### Returns
Cursor - The result cursor.

---

## rawQueryWithFactory(cursorFactory, sql, selectionArgs, editTable, cancellationSignal)

### Description
Runs a raw SQL query with a custom cursor factory and a cancellation signal.

### Method
rawQueryWithFactory

### Parameters
- **cursorFactory** (CursorFactory) - Required - The cursor factory to use.
- **sql** (String) - Required - The SQL query string.
- **selectionArgs** (String[]) - Required - Optional arguments for the query.
- **editTable** (String) - Required - The table to edit.
- **cancellationSignal** (CancellationSignal) - Required - Signal to cancel the operation.

### Returns
Cursor - The result cursor.
```

--------------------------------

### packageNameMatches(regex)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Matches UI elements whose package name fully matches the given regular expression.

```APIDOC
## packageNameMatches(regex)

### Description
Matches UI elements whose package name fully matches the given regular expression.

### Method
packageNameMatches

### Parameters
- **regex** (RegExp) - Required - The regular expression to match.

### Returns
- UiSelector - The selector with the package name regex filter applied.

```

--------------------------------

### sum(numbers, fraction?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

计算数字数组的总和，并可指定小数位数。

```APIDOC
## sum(numbers, fraction?)

### Description
计算数字数组的总和，并可指定小数位数。

### Method
sum

### Parameters
- **numbers** (number[]) - 必需 - 数字数组。
- **fraction** (number) - 可选 - 小数位数。

### Returns
- **number** - 总和。
```

--------------------------------

### input(data?, ...args)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/console.html

Reads input from the user, optionally displaying a prompt.

```APIDOC
## input(data?, ...args)

### Description
Reads input from the user, optionally displaying a prompt.

### Method
input

### Parameters
- **data** (any) - Optional - The prompt message or data to display.
- **...args** (any) - Optional - Additional arguments for the prompt.

```

--------------------------------

### imeEnter()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Performs an IME enter action on the UI object.

```APIDOC
## imeEnter()

### Description
Performs an IME enter action on the UI object.

### Method
imeEnter

### Parameters
None

### Returns
None
```

--------------------------------

### mail.connect(options)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mail.html

使用指定选项建立邮件连接。options 对象应包含服务器、端口、认证等信息。

```APIDOC
## mail.connect(options)

### Description
使用指定选项建立邮件连接。

### Method
connect

### Endpoint
mail.connect(options)

### Parameters
#### options (Object) - Required
包含连接配置的选项对象。

### Request Example
```javascript
mail.connect({
  // 配置选项
});
```

### Response
返回一个邮件客户端对象。
```

--------------------------------

### Database#onOpen

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/sqlite.html

Called when the database has been opened.

```APIDOC
## onOpen(database)

### Description
Called when the database has been opened. This is a callback method that can be overridden to perform actions after the database is opened.

### Method
onOpen

### Parameters
- **database** (Database) - Required - The database that was opened.

### Returns
- (void) - No return value.
```

--------------------------------

### performAction(action, ...arguments)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Performs the specified action on the UI object with the given arguments.

```APIDOC
## performAction(action, ...arguments)

### Description
Performs the specified action on the UI object with the given arguments.

### Method
POST

### Endpoint
`performAction(action, ...arguments)`

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform.

#### Query Parameters
- **arguments** (any) - Optional - Additional arguments for the action.

### Response
- **boolean** - True if the action was performed successfully, false otherwise.
```

--------------------------------

### Shell#Screencap(path)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Takes a screenshot and saves it to the specified path.

```APIDOC
## Shell#Screencap(path)

### Description
Takes a screenshot and saves it to the specified path.

### Method
Screencap

### Parameters
- **path** (string) - The file path to save the screenshot.

### Returns
None
```

--------------------------------

### Shell#Swipe(x1, y1, x2, y2, duration)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/shell.html

Simulates a swipe from one point to another over a specified duration.

```APIDOC
## Shell#Swipe(x1, y1, x2, y2, duration)

### Description
Simulates a swipe from one point to another over a specified duration.

### Method
Swipe

### Parameters
- **x1** (number) - The starting x-coordinate.
- **y1** (number) - The starting y-coordinate.
- **x2** (number) - The ending x-coordinate.
- **y2** (number) - The ending y-coordinate.
- **duration** (number) - The duration of the swipe in milliseconds.

### Returns
None
```

--------------------------------

### util.versionCodes.toString(isInDetail?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/util.html

Returns a string representation of Android version codes. Optionally includes details.

```APIDOC
## util.versionCodes.toString(isInDetail?)

### Description
Returns a string representation of Android version codes. Optionally includes details.

### Method
Function call

### Parameters
- **isInDetail** (boolean) - Optional - If true, includes detailed information.

### Returns
- (string) - String representation.
```

--------------------------------

### exists()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Checks whether any matching UI element exists.

```APIDOC
## exists()

### Description
Checks whether any matching UI element exists.

### Method
exists

### Returns
- **boolean** - True if at least one matching element exists, false otherwise.
```

--------------------------------

### click()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Clicks the matched UI element.

```APIDOC
## click()

### Description
Clicks the matched UI element.

### Method
click

### Returns
- **boolean** - True if the click was successful, false otherwise.
```

--------------------------------

### focus()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Requests focus on the selected UI element.

```APIDOC
## focus()

### Description
Requests focus on the selected UI element.

### Method
focus

### Parameters
None

### Returns
- (boolean) - Whether the operation succeeded.
```

--------------------------------

### size()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Returns the size (width and height) of the UI object's bounds.

```APIDOC
## size()

### Description
Returns the size (width and height) of the UI object's bounds.

### Method
GET

### Endpoint
`size()`

### Parameters
None

### Response
- **Size** - The size of the UI object.
```

--------------------------------

### boundsTop(min, max)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiSelectorType.html

Matches UI elements whose top bound is between the given minimum and maximum values.

```APIDOC
## boundsTop(min, max)

### Description
Matches UI elements whose top bound is between the given minimum and maximum values.

### Method
boundsTop

### Parameters
- **min** (number) - Required - The minimum top bound value.
- **max** (number) - Required - The maximum top bound value.

### Returns
- UiSelector - The selector with the top bound range filter applied.

```

--------------------------------

### var(numbers, fraction?)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/mathx.html

计算数字数组的方差，并可指定小数位数。

```APIDOC
## var(numbers, fraction?)

### Description
计算数字数组的方差，并可指定小数位数。

### Method
var

### Parameters
- **numbers** (number[]) - 必需 - 数字数组。
- **fraction** (number) - 可选 - 小数位数。

### Returns
- **number** - 方差。
```

--------------------------------

### images.mssim(imageA, imageB)

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/image.html

计算两张图像的平均结构相似性指数（MSSIM），用于评估图像相似度。

```APIDOC
## images.mssim(imageA, imageB)

### Description
计算两张图像的平均结构相似性指数（MSSIM），用于评估图像相似度。

### Method
images.mssim

### Parameters
- **imageA** (Image) - 第一张图像
- **imageB** (Image) - 第二张图像

### Returns
- 数值，表示 MSSIM 值。
```

--------------------------------

### focus()

Source: https://github.com/supermonster003/autojs6-documentation/blob/master/docs/uiObjectType.html

Requests focus on the UI object.

```APIDOC
## focus()

### Description
Requests focus on the UI object.

### Method
focus

### Parameters
None

### Returns
None
```
Tokens:
Raw