Difference between revisions of "Actions"

Latest revision as of 12:26, 15 August 2024

An action is something your device can do when a macro runs.
A macro must have at least one action to be valid.

Synchronous vs asynchronous

MacroDroid actions typically execute quickly, but certain actions like HTTP requests or shell scripts may take longer. To ensure that subsequent actions wait for these longer actions to complete before continuing, enable the 'Block next action until complete' option in the action's configuration GUI. Otherwise, the action will run asynchronously while other actions continue.

In traditional programming languages, you could pass a callback function to execute after the asynchronous action is complete. This allows you to perform additional actions or work with the data returned by the asynchronous action. However, MacroDroid's inner workings are arbitrary, so there is no systematic option for this. Instead, you must rely on different workarounds.

Control flow

If clause

If confirmed then

Repeat actions

Iterate Dictionary/Array

Break from loop

Continue loop

List of Actions

Accessibility Service

Camera Enable/Disable

Cancel Macro Actions

Car Mode

Check pixel colour

Check Text In Screenshot

Check Text On Screen

Clear App Data

Clear Call Log

Clear Dictionary/Array Entry

Clear MacroDroid Dialog

Configure App Notifications

Daydream/Screensaver On

Display Bubble Notification

Display Dialog

Display Notification

Empty Action

Enable/Disable Category

Enable/Disable Macro

Enable/Disable Trigger

Exit Action Block

Expand/Collapse Status Bar

Floating Button Configure

Floating text

Font Scale

Force Location Update

Force Screen Rotation

Get Light Level

Get Text From View Id

GPS Enable/Disable

Heads-up Enable/Disable

Keyboard - Set Default

Keyboard Prompt

Kill Application

Kill Background Processes

Notification Interaction

Notification LED Enable/Disable

Open Website / HTTP GET

Priority Mode / Do Not Disturb

Read Screen Contents

Read Screenshot Contents

Reboot/Power Off

Record Microphone

Restore Hidden Notifications

Set Location Update Rate

Set Digital Assistant

Set MacroDroid Icon

Set MacroDroid Mode

Set MacroDroid Notification Text

Set Notification Sound

Text from Image (OCR)

Vibrate Enable/Disable

Wait Before Next Action

@@ Line 1: / Line 1: @@
-An action is something your device can do when a macro runs. A macro must have at least one action to be valid.
+<pre style="background-color: #FFFF99; color: #112A46; border-radius: 10px; padding: 10px;">
+An action is something your device can do when a macro runs.
+A macro must have at least one action to be valid.
+</pre>
+=== Synchronous vs asynchronous ===
+<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
+MacroDroid actions typically execute quickly, but certain actions like HTTP requests or shell scripts may take longer. To ensure that subsequent actions wait for these longer actions to complete before continuing, enable the 'Block next action until complete' option in the action's configuration GUI. Otherwise, the action will run asynchronously while other actions continue.
+In traditional programming languages, you could pass a callback function to execute after the asynchronous action is complete. This allows you to perform additional actions or work with the data returned by the asynchronous action. However, MacroDroid's inner workings are arbitrary, so there is no systematic option for this. Instead, you must rely on different workarounds.
+</pre>
+== Control flow ==
+[[Control flow: If clause|If clause]]
+[[Control flow: If confirmed then|If confirmed then]]
+[[Control flow: Repeat actions|Repeat actions]]
+[[Control flow:  Iterate Dictionary/Array| Iterate Dictionary/Array]]
+[[Control flow: Break from loop|Break from loop]]
+[[Control flow: Continue loop|Continue loop]]
 == List of Actions ==
+[[Action: Accessibility Service|Accessibility Service]]
+[[Action: Action Block|Action Block]]
 [[Action: Airplane Mode On/Off|Airplane Mode On/Off]]
@@ Line 8: / Line 36: @@
 [[Action: Ambient Display|Ambient Display]]
+[[Action: Animation Overlay|Animation Overlay]]
 [[Action: Android Shortcut|Android Shortcut]]
@@ Line 14: / Line 44: @@
 [[Action: Answer Call|Answer Call]]
+[[Action: App Enable/Disable|App Enable/Disable]]
+[[Action: Authenticate User|Authenticate User]]
+[[Action: Array Manipulation|Array Manipulation]]
 [[Action: Autosync On/Off|Autosync On/Off]]
 [[Action: Battery Saver|Battery Saver]]
+[[Action: Block Screen Touch|Screen Block Touch]]
 [[Action: Bluetooth Configure|Bluetooth Configure]]
-[[Action: Bluetooth Tethering|Bluetooth Tethering]]
 [[Action: Brightness|Brightness]]
@@ Line 34: / Line 70: @@
 [[Action: Car Mode|Car Mode]]
+[[Action: Check Pixel Colour|Check pixel colour]]
+[[Action: Check Text In Screenshot|Check Text In Screenshot]]
+[[Action: Check Text On Screen|Check Text On Screen]]
 [[Action: Clear App Data|Clear App Data]]
 [[Action: Clear Call Log|Clear Call Log]]
+[[Action: Clear Dictionary/Array Entry|Clear Dictionary/Array Entry]]
+[[Action: Clear MacroDroid Dialog|Clear MacroDroid Dialog]]
 [[Action: Clear Log|Clear Log]]
 [[Action: Clear Notifications|Clear Notifications]]
+[[Action: Clear Variables|Clear Variables]]
+[[Action: Clipboard Refresh|Clipboard Refresh]]
 [[Action: Configure App Notifications|Configure App Notifications]]
+[[Action: Configure Quick Tile|Configure Quick Tile]]
 [[Action: Confirm Next|Confirm Next]]
@@ Line 58: / Line 110: @@
 [[Action: Delete Macro|Delete Macro]]
+[[Action: Delete Variable|Delete Variable]]
 [[Action: Demo Mode|Demo Mode]]
@@ Line 64: / Line 118: @@
 [[Action: Disable MacroDroid|Disable MacroDroid]]
+[[Action: Display Bubble Notification|Display Bubble Notification]]
 [[Action: Display Dialog|Display Dialog]]
@@ Line 74: / Line 130: @@
 [[Action: Enable/Disable Macro|Enable/Disable Macro]]
+[[Action: Enable/Disable Trigger|Enable/Disable Trigger]]
+[[Action: Exit Action Block|Exit Action Block]]
 [[Action: Expand/Collapse Status Bar|Expand/Collapse Status Bar]]
+[[Action: Export Log|Export Log]]
 [[Action: Export Macros|Export Macros]]
-[[Action: File Operations V2|File Operations V2]]
+[[Action: File Operation| File Operation]]
 [[Action: Fill Clipboard|Fill Clipboard]]
+[[Action: Floating Button Configure|Floating Button Configure]]
+[[Action: Floating text|Floating text]]
 [[Action: Font Scale|Font Scale]]
@@ Line 88: / Line 154: @@
 [[Action: Force Screen Rotation|Force Screen Rotation]]
+[[Action: Get Light Level|Get Light Level]]
+[[Action: Get Text From View Id|Get Text From View Id]]
 [[Action: GPS Enable/Disable|GPS Enable/Disable]]
@@ Line 94: / Line 164: @@
 [[Action: HotSpot On/Off|HotSpot On/Off]]
+[[Action: HTTP Request|HTTP Request]]
+[[Action: HTTP Server|HTTP Server]]
 [[Action: Immersive Mode|Immersive Mode]]
+[[Action: JavaScript Code|JavaScript Code]]
 [[Action: Invert Colours|Invert Colours]]
+[[Action: JSON Parse|JSON Parse]]
 [[Action: Keep Device Awake|Keep Device Awake]]
@@ Line 126: / Line 204: @@
 [[Action: MacroDroid Settings|MacroDroid Settings]]
+[[Action: Macro run|Macro run]]
 [[Action: Make Call|Make Call]]
@@ Line 136: / Line 216: @@
 [[Action: Notification LED Enable/Disable|Notification LED Enable/Disable]]
+[[Action: Notification Reply|Notification Reply]]
 [[Action: Open Call Log|Open Call Log]]
@@ Line 143: / Line 225: @@
 [[Action: Open Last Photo|Open Last Photo]]
-[[Action: Open MacroDroid Log]]
+[[Action: Open MacroDroid Log|Open MacroDroid Log]]
+[[Action: Open Website / HTTP GET|Open Website / HTTP GET]]
+[[Action: Option Dialog|Option Dialog]]
+[[Action: Play/Stop Sound|Play/Stop Sound]]
+[[Action: Popup Message|Popup Message]]
+[[Action: Press Back Button|Press Back Button]]
+[[Action: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]
+[[Action: Read Screen Contents|Read Screen Contents]]
+[[Action: Read Screenshot Contents|Read Screenshot Contents]]
+[[Action: Reboot/Power Off|Reboot/Power Off]]
+[[Action: Record Microphone|Record Microphone]]
-[[Action: Open Website / HTTP GET]]
+[[Action: Restore Hidden Notifications|Restore Hidden Notifications]]
-[[Action: Option Dialog]]
+[[Action: Ringtone Configure|Ringtone Configure]]
-[[Action: Play/Stop Sound]]
+[[Action: Say Current Time|Say Current Time]]
-[[Action: Popup Message]]
+[[Action: Screen On/Off|Screen On/Off]]
-[[Action: Press Back Button]]
+[[Action: Secure Settings|Secure Settings]]
-[[Action: Priority Mode / Do Not Disturb]]
+[[Action: Selecttion Dialog|Selection Dialog]]
-[[Action: Reboot/Power Off]]
+[[Action: Send Email|Send Email]]
-[[Action: Record Microphone]]
+[[Action: Send Intent|Send Intent]]
-[[Action: Ringtone Configure]]
+[[Action: Send SMS|Send SMS]]
-[[Action: Say Current Time]]
+[[Action: Set Button Bar Image|Set Button Bar Image]]
-[[Action: Screen On/Off]]
+[[Action: Set Location Update Rate|Set Location Update Rate]]
-[[Action: Secure Settings]]
+[[Action: Set Digital Assistant|Set Digital Assistant]]
-[[Action: Send Email]]
+[[Action: Set MacroDroid Icon|Set MacroDroid Icon]]
-[[Action: Send Intent]]
+[[Action: Set MacroDroid Mode|Set MacroDroid Mode]]
-[[Action: Send SMS]]
+[[Action: Set MacroDroid Notification Text|Set MacroDroid Notification Text]]
-[[Action: Set Location Update Rate]]
+[[Action: Set Notification Sound|Set Notification Sound]]
-[[Action: Set MacroDroid Icon]]
+[[Action: Set Screen Lock|Set Screen Lock]]
-[[Action: Set MacroDroid Mode]]
+[[Action: Set Screen Timeout|Set Screen Timeout]]
-[[Action: Set MacroDroid Notification Text]]
+[[Action: Set Variable|Set Variable]]
-[[Action: Set Notification Sound]]
+[[Action: Set Wallpaper|Set Wallpaper]]
-[[Action: Set Quick Settings Tile State]]
+[[Action: Share Last Photo|Share Last Photo]]
-[[Action: Set Screen Lock]]
+[[Action: Share Text|Share Text]]
-[[Action: Set Screen Timeout]]
+[[Action: Share Location|Share Location]]
-[[Action: Set Variable]]
+[[Action: Shell Script|Shell Script]]
-[[Action: Set Wallpaper]]
+[[Action: Silent - Vibrate Off|Silent - Vibrate Off]]
-[[Action: Share Last Photo]]
+[[Action: Silent - Show Volume Popup|Show Volume Popup]]
-[[Action: Share Location]]
+[[Action: Speak Text|Speak Text]]
-[[Action: Shell Script]]
+[[Action: Speakerphone On/Off|Speakerphone On/Off]]
-[[Action: Silent - Vibrate Off]]
+[[Action: Stopwatch|Stopwatch]]
-[[Action: Speak Text]]
+[[Action: Sync Account|Sync Account]]
-[[Action: Speakerphone On/Off]]
+[[Action: System Setting|System Setting]]
-[[Action: Stopwatch]]
+[[Action: Take Picture|Take Picture]]
-[[Action: Sync Account]]
+[[Action: Take Screenshot|Take Screenshot]]
-[[Action: System Setting]]
+[[Action: Text_from_Image_(OCR)|Text from Image (OCR)]]
-[[Action: Take Picture]]
+[[Action: Text Manipulation|Text Manipulation]]
-[[Action: Take Screenshot]]
+[[Action: Torch On/Off|Torch On/Off]]
-[[Action: Text Manipulation]]
+[[Action: Translate Text|Translate Text]]
-[[Action: Torch On/Off]]
+[[Action: Touch Screen|Touch Screen]]
-[[Action: Touch Screen]]
+[[Action: UDP Command|UDP Command]]
-[[Action: Tweet]]
+[[Action: UI Interaction|UI Interaction]]
-[[Action: UDB Command]]
+[[Action: USB Tethering|USB Tethering]]
-[[Action: UI Interaction]]
+[[Action: Vibrate|Vibrate]]
-[[Action: USB Tethering]]
+[[Action: Vibrate Enable/Disable|Vibrate Enable/Disable]]
-[[Action: Vibrate]]
+[[Action: Voice Input|Voice Input]]
-[[Action: Vibrate Enable/Disable]]
+[[Action: Voice Search|Voice Search]]
-[[Action: Voice Search]]
+[[Action: Volume Change|Volume Change]]
-[[Action: Volume Change]]
+[[Action: Volume Up/Down|Volume Up/Down]]
-[[Action: Volume Up/Down]]
+[[Action: Wait Before Next Action|Wait Before Next Action]]
-[[Action: Wait Before Next Action]]
+[[Action: Wait Until Trigger|Wait Until Trigger]]
-[[Action: Wait Until Trigger]]
+[[Action: WhatsApp Send|WhatsApp Send]]
-[[Action: Widget Button Modify]]
+[[Action: Widget Button Modify|Widget Button Modify]]
-[[Action: Wifi Configure]]
+[[Action: Wifi Configure|Wifi Configure]]
-[[Action: Write to File]]
+[[Action: Write to File|Write to File]]