194 docs tagged with "Reference"

Add checkbox to dialog view

Will return the current checkbox view id

Will return the current checkbox text

Will return the current checkbox text size

Useful to parameterize click event

Will return the delay of click

This method return the number of click duration in milliseconds

Will return the offset of click representing in Point

You can set delay in milliseconds of click using this method

This method is used to set hold long the click lasts in miliseconds

When match or coordinate is set, the position of click will be offset based on x and y coordinate

Utility class to perform color similarity

Compare both color and get the similarity score

Will return hexadecimal string color

Check if both color is has similarity to 1

Add Column view to dialog

Will return the id of column view

Utility class to perform datetime calculations

Adds a specified amount of time to the DateTime object.

Returns the day of the month of the DateTime object.

Sets the day of the month of the DateTime object.

Returns the day of the week of the DateTime object. (Sunday is 0, Monday is 1, etc.).

Calculates the difference between the current DateTime object and another DateTime object.

Sets the DateTime object to the end of a specified unit of time (e.g., end of the day, end of the month).

Returns the formatted date as a string.

Returns the hour of the day of the DateTime object. (24-hour format, 0-23).

Sets the hour of the day of the DateTime object. (24-hour format, 0-23).

Checks if the current DateTime object is after another DateTime object.

Checks if the current DateTime object is before another DateTime object.

Checks if the current DateTime object is between two other DateTime objects (inclusive).

Checks if the current DateTime object is the same as another DateTime object.

Checks if the current DateTime object is the same as or after another DateTime object.

Checks if the current DateTime object is the same as or before another DateTime object.

Converts the DateTime object's timezone to the system's default local timezone.

Returns the millisecond of the second of the DateTime object.

Sets the millisecond of the second of the DateTime object.

Returns the minute of the hour of the DateTime object.

Sets the minute of the hour of the DateTime object.

Returns the month of the DateTime object. (1-based, January is 1).

Sets the month of the DateTime object. (1-based, January is 1).

Returns the second of the minute of the DateTime object.

Sets the second of the minute of the DateTime object.

Sets the DateTime object to the start of a specified unit of time (e.g., start of the day, start of the month).

Subtracts a specified amount of time from the DateTime object.

Returns the ISO 8601 formatted date string (e.g., "1970-01-01T0000.000Z").

Sets the DateTime object's timezone to a specified timezone ID.

Returns the Unix timestamp (seconds since Unix epoch) of the DateTime object.

Converts the DateTime object's timezone to UTC.

Returns the primitive value of the DateTime object, which is the number of milliseconds since the Unix epoch.

Sets the year of the DateTime object.

Returns the year of the DateTime object.

Utility class to show dialog popup into screen, useful to parameterize your macro

Add view to the dialog, currently you can only add view based on this parameter

This method is useful to get the value of EditText, CheckBox, RadioGroup based on id

This method is useful to get the value of EditText, CheckBox, RadioGroup

To start using and displaying the dialog, this method is required to initialize the dialog

Remove view from dialog view based on it's id

Add body content text to the dialog view

Add title to the dialog view

If you invoke this function the dialog will popup in the screen

Add EditText to dialog view

Will return the hint text of EditText

Will return the color text

Will return the text size of EditText

Useful to parameterize search detection

Will return the delay of detection

Will return the detection method

Will return the detection type which is IMAGE or TEXT in string

Will return the detection score threshold

This method return boolean indicating the image/text search will be performed in grayscale

Will return boolean whether detection will be highlighted or not

You can set image/text search delay in milliseconds using this method

Modify the detection algorithm

Modify the detection behaviour which is IMAGE or TEXT in string. By default IMAGE is used

This parameter will tell the macro to show the highlight of the detection in your device screen

Set the threshold score for image and text recognition

Useful module to type text into your device screen

This method will simulate keyboard typing to your screen, but only works on any text input not working in some apps

Get the list of your existing macro

An extension module for calling or executing your macro programatically at runtime

Execute your macro using block executor

Execute your macro using code executor

Get the xml block of the coresponding macro

Get the code of the coresponding macro

Get the id of the coresponding macro

Get the name of the coresponding macro

Coordinate of x and y in screen

Will return the x coordinate

Will return the y coordinate

Modify the x coordinate

Modify the y coordinate

Add Radio button to dialog view

Will return the button id

Will return the text of radio button

Add radio group to dialog view, each child view contains Radio Button

Add radio button to the group

Will return the list of radio buttons

Will return the view id

Useful module to replay your gestures/touches

Execute your pre-recorded touch

The core module for detecting and performing ui automation in a region of interest which is a part of screen device

To perform parameterize click behaviour using MatchResult

To perform image/text detection and click it's match coordinate in bulk manner

To check if match exist in the region, if match is found then this method returns true else false

To perform image/text detection and click it's match coordinate, if match is found then this method returns true

To perform image/text detection and click it's match coordinate, if match is found then this method returns true

To perform image or text search in the region, if the image or text is found return the MatchResult else return nil

To perform image or text search in bulk manner and return a list of MatchResult

To get color pixel in certain coordinate, later this color can be used to compare if color has similar score, this is useful to do color detection

To get color pixel in multiple coordinates at the same time, later these colors can be used to compare if color has similar score, this is useful to do color detection

This method performs OCR in region of interest and return the concatenated text

Get the x coordinate of region

Get the y coordinate of region

Get the height of region

Use for highlighting the region

Take a screenshot of region and save it to /data/data/com.androidmacro/images/$macroId/$fileName

Perform swipe behaviour to the specific region

Wait until template appear in the region, if timeout reached this method will throw an error

Wait until template disappear or vanish in the region, if timeout reached this method will throw an error

Get the width of region

Add Row view to dialog

Will return the id of row view

The module has similar functionality with Region module, except it uses full device width and height

To perform parameterize click behaviour using MatchResult

To perform image/text detection and click it's match coordinate in bulk manner

To check if match exist in device screen, if match is found then this method returns true else false

To perform image/text detection and click it's match coordinate, if match is found then this method returns true

To perform image/text detection and click it's match coordinate, if match is found then this method returns true

To perform image or text search in your device screen, if the image or text is found return the MatchResult else return nil

To perform image or text search in bulk manner and return a list of MatchResult

To get color pixel in certain coordinate, later this color can be used to compare if color has similar score, this is useful to do color detection

To get color pixel in multiple coordinates at the same time, later these colors can be used to compare if color has similar score, this is useful to do color detection

This method performs OCR in device screen and return the concatenated text

Get the x coordinate of screen

Get the y coordinate of screen

Get the height of screen

Use for highlighting the screen

Perform up to 10 fingers swipe simultaneously to the screen

Take a screenshot the entire device screen and save it to /data/data/com.androidmacro/images/$macroId/$fileName

Perform swipe behaviour to the screen

Wait until template appear in the screen, if timeout reached this method will throw an error

Wait until template disappear or vanish in the screen, if timeout reached this method will throw an error

Get the width of screen

Useful to modify macro settings & optimization

When this option is set to on, the macro will store a temporary cache to store last frame, normally your macro will capture the screen device every time frame is available, this is an intensive operation so in order to prevent that you can use this options

Will return delay of click in currently running macro

Will return the current path of macro image directory

Will return the minimum match score as threshold when you perform text or image detection

Will return the delay of text or image detection in currently running macro

Will return delay of swipe in currently running macro

When this option is set to off, the text or image detection will be processed in normal mode

When this option is set to on, the text or image detection will be processed in grayscale mode, this is useful to speed up the detection process

Check if text or image detection is processed in grayscale mode

Change the entire click delay in currently running macro

Change the comparison height, this comparison height is a variable or constant that the Android Macro used to calculate screen resolution between 2 devices with the same aspect ratio

Change the comparison width, this comparison width is a variable or constant that the Android Macro used to calculate screen resolution between 2 devices with the same aspect ratio

Change the minimum threshold score when performing text or image detection

Add delay when you perform text or image detection

Change the entire swipe delay in currently running macro

When this option is set to off, the macro will not use cache image frame

Useful to parameterize swipe events

Will return the delay of each swipe points

Return true if swipe points are continuous

You can set whether each swipe point is continuous, which means the swiping finger does not lift up.

You can set swipe delay in milliseconds using this method

A module used to modify swipe behaviour

Will return swipe point hold duration

Will return swipe point speed. This method won't work after version 1.0.0.16

Will return swipe point duration

Will return swipe point x coordinate

Will return swipe point y coordinate

Change the hold duration of swipe point

Change the speed of swipe point. This method won't work after version 1.0.0.16

Change the duration of swipe point

Change the x coordinate of swipe point

Change the y coordinate of swipe point

Utility class to press system button

Press back button

Press home button

Press recent button

Press recent button

Add TextView to the dialog view

Get text content

Interface for handling touch interactions on Android devices.

Dispatches all pending touch events to the system. This method is useful when you want to ensure all touch events are processed immediately.

Performs a touch down action at the specified coordinates or point.

Exits and cleans up the touch interface. This method should be called when you're done using the touch interface.

Initializes the touch interface. This method must be called before using any other touch methods.

Performs a touch move action to the specified coordinates or point.

Performs a touch up action, releasing the touch at the current position.

Utility class to show toast, alert, sleep and more

Show alert to the screen

Add sleep to the macro

Show toast to the screen