Actions

The action Add WiFi Access Point adds a new WiFi configuration and optionally connects to the new WiFi network.

 

Examples:

• Scan a barcode with WiFi connection information and directly connect to the new WiFi

The action Answer Ringing Call answers the currently-ringing call.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Automatically answer a call when you are prepared to answer calls but don't have your hands free.

The action Call Number calls a number by opening the telephone application and directly calling the supplied number.

 

Example:

• Automatically call a contact at 6pm.

The action Clear Automagic Log clears the internal log of Automagic (not the log on the SD-card when enabled in the preferences).

The action Close System Dialogs closes system dialogs like the expanded notification area, the expanded quick settings or the power-menu.
Whether dialog is classified as a system dialog or not is controlled by the dialog itself. Regular dialogs and windows can not be closed using this action.

The action Combine Images allows to superimpose two images on top of each other. The images have to be loaded with action Init Variable Image File.

Note: The action has to create a copy of the image in memory so please ensure to scale down the images first when memory becomes an issue.

 

Examples:

• Superimpose a logo on an image as a watermark.

The action Connect/Disconnect Bluetooth Device tries to connect/disconnect to/from a paired bluetooth device (Android 3+ required).

Warning: This function is not officially supported by Android and might not work on all devices.

 

Examples:

• Connect to the bluetooth headset when a shortcut is pressed.

The action Control Audio Player can launch and control the default audio player of Android. Note that device and manufacturer specific audio players will probably not work.

Warning: This function is not officially supported by Android and might not work on all devices.

 

Examples:

• Pause the audio player when the headphones are disconnected.

The action Control UI uses the accessibility features of the device to control the user interface and allows to automatically press buttons, long-click elements, scroll lists and change the values of checkboxes and radio buttons.

Note: This action controls the user interface by simulating user input, therefore the screen has to be active, unlocked and the user interface must be showing on screen.
The accessibility service of Automagic needs to be enabled in the preferences for this action to work. At least Android 4.1 (Jelly Bean) is required.

Note: Turning on the accessibility service is not possible on some devices when a screen brightness or screen filter app displays an overlay over other controls. Please disable such apps temporarily when pressing the OK button in system settings is not possible.

 

Examples:

• Start the location settings page and enable/disable GPS.
• Start the device update check by pressing the "Check now" button.

notifications();//to expand the notifications
sleep(1000);//wait one second for animations to complete
clicked = click("Clear all notifications");//click the button
if(not clicked) //check whether the button has been successfully clicked
{
    back();//hide the notification when the clear button was not available
}
        

sleep(1000);//wait for settings page to show
click("GPS satellites");//toggle setting on/off
sleep(500);
back();//go back to the previous screen
        

home();//ensure the main home screen is showing
sleep(1000);//wait one second for animations to complete
click("Apps");//open the apps drawer
        

The action Copy File locally copies a file.

 

Examples:

• Create a weekly backup of the Automagic flows to a file containing the timestamp

The action Copy Files locally copies one or a list of files to the specified target directory or file.

 

Examples:

• Backup all files in directory /mnt/sdcard/xyz/ to the folder /mnt/sdcard/xyz_backup/

The action Copy Text from Clipboard copies the text on the clipboard to the specified variable.

 

Examples:

• Send the text on the clipboard directly by sms or text.

The action Copy Text to Clipboard copies the specified text to the clipboard.

 

Examples:

• Copy the scanned barcode value to the clipboard to paste it in the browser.
• Copy the text of an incoming SMS to the clipboard to paste it in a mail.

The action Create Calendar Event creates an event on the specified calendar of the device (Android 4+ required)

 

Examples:

• create a calendar event based on the text of a received SMS
• create a calendar event for every received call

The action Create Directories locally creates one or multiple directories.

 

Examples:

• Create a target directory /mnt/sdcard/backup/ before copying files into this directory

The action Delete App Cache deletes the cache files of the specified app. Android ignores this function for system apps.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Delete the browser cache every evening for security purposes

The action Delete Files locally deletes one or multiple files or folders including contained files.

 

Examples:

• Monthly delete all files in the /mnt/sdcard/download/ folder

The action Delete Flows deletes the specified flows.

 

Examples:

• Delete a flow before the flow is imported again with action Import Flows/Widgets

The action Dismiss Slide to Unlock Keyguard unlocks the device when the slid-to-unlock keyguard is used. This action can not unlock a secure keyguard that requires to enter a password, PIN or pattern.

Warning: This function is not officially supported by Android and might not work on all devices.
Some devices require that the screen is off to dismiss the keyguard.
Some devices turn off the screen when the keyguard is dismissed. You can mitigate the problem by adding an action Turn Screen On to the flow after dismissing the keyguard.

The action Download URL directly downloads a file in the background to the defined directory.

 

Examples:

• Download a PDF newspaper every morning

The action Dropbox Create Directories creates one or multiple directories on Dropbox.

 

Examples:

• create a directory before files are uploaded.

The action Dropbox Delete Files deletes the defined files on Dropbox.

 

Examples:

• Delete all files in a folder before uploading new files to this folder to get rid of files you don't need anymore.

The action Dropbox Download Files downloads multiple files and directories recursively to your device.

Warning: This action downloads all specified files and overwrites already existing target files. The files will be downloaded even when the same file already exists on the device.

Warning: Dropbox limits the amount of data each user can transfer.

 

Examples:

• Download each morning the newest file of keypass containing your passwords to ensure you have the newest offline copy available.

The action Dropbox Init Variable File List lists the files of a directory that match the specified name pattern.

 

Examples:

• Get a list of files and download only the ones smaller than 1MB.

The action Dropbox Upload File uploads one file to your Dropbox.

 

Examples:

• Upload a backup of all data in Gleeo Time Tracker to the your Dropbox

The action Dropbox Upload Files uploads one or multiple files and directories recursively to your Dropbox.

Warning: This action uploads all specified files and overwrites already existing target files. The files will be uploaded even when the same file already exists on Dropbox.

Warning: Dropbox limits the amount of data each user can transfer.

 

Examples:

• Upload a backup of all data in Gleeo Time Tracker to the your Dropbox

The action Enable WiFi Access Point enables one of the access point configurations and optionally prevents to connect to other access points by disabling them.

 

Examples:

• Enable a free access point at home and disable a paid access point.

The action End Call hangs up the current call.

Warning: This function is not officially supported by Android and might not work on all devices.
Warning: This function requires root access on some devices.

Example:

• Let the phone call home for 15 seconds and automatically terminate the call to notify something.

The action Execute Command executes a shell command and stores the output in variables.

 

Examples:

• ls -l to list all files in the working directory
• ps to store the running processes in the defined variable
• ps > file.txt to store the running processes in a file
• cat file1.txt > file2.txt to copy a file
• cat /proc/wakelocks to show the wake locks preventing your device from sleeping

String variables are replaced before the command is passed to the interpreter.
You can use this for example to create a filename based on the current date: ps > file-{triggertime,datetime,yyyyMMdd}.txt.

Special characters in the command have to be escaped using backslash or placed in quotes as appropriate:
cat 'Test File1.txt' > 'Test File2.txt'
cat Test\ File1.txt > Test\ File2.txt

The action Execute Flows executes one or multiple flows specified in the field Flow pattern list.

Tip: It's also possible to execute utility flows that don't have their own trigger. Simply don't add a trigger to such a flow but ensure that the flow is enabled.

The executed flow will inherit the execution context with all variables of the parent flow.
The variables usually supplied by the trigger of the target flow will not be available since the trigger of the target flow is bypassed when using this action.

 

Examples:

• Execute all flows with the words battery save in the name when the battery reaches a critical level

The action Execute Root Command executes a shell command as root by passing the command to su and stores the output in variables.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• reboot to reboot the device
• reboot -p to shutdown

String variables are replaced before the command is passed to the interpreter.
You can use this for example to create a filename based on the current date: ps > file-{triggertime,datetime,yyyyMMdd}.txt.

Special characters in the command have to be escaped using backslash or placed in quotes as appropriate:
cat 'Test File1.txt' > 'Test File2.txt'
cat Test\ File1.txt > Test\ File2.txt

The action Execute SSH Command connects to an SSH server and executes a command.

Note: It can not be guaranteed that this action is compatible with all SSH servers.

 

Examples:

• execute a command on a NAS every evening
• show the free memory of the server on a widget

The action Exit Device Idle/Doze Mode exits the device idle/doze mode.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Exit the device idle/doze mode every morning at 6am to make the device work reliable again.

The action Export Flows exports the selected flows to the specified file.

 

Examples:

• Export all flows to a file and upload the file to Dropbox as a backup

The action Flashlight enables or disables the flashlight of the device.

 

Examples:

• Turn on or off the flashlight using a toggle widget.

The action FTP Create Directories creates one or multiple directories on an FTP server.

 

Examples:

• create a directory before files are uploaded.

The action FTP Delete Files deletes the files specified on the FTP server.

 

Examples:

• Recursively delete all files in a directory on the server before uploading new files

The action FTP Download Files downloads files and folders stored on an FTP server.

 

Examples:

• Recursively download a directory with music every morning

The action FTP Init Variable File List lists the files of a directory that match the specified name pattern.

 

Examples:

• Get a list of files and download only the ones smaller than 1MB.

The action FTP Upload File uploads one file to an FTP server.

 

Examples:

• Upload a backup of all data in Gleeo Time Tracker to the your company server

The action FTP Upload Files uploads files and folders to an FTP server.

 

Examples:

• Recursively upload a directory with photos every morning to an FTP server

The action Gleeo Create Entry creates an entry of the specified project and task in Gleeo Time Tracker.

 

Examples:

• Track the amount of time spent in the Twitter app and create an entry in Gleeo Time Tracker at the end of the day.

The action Gleeo Filesystem Export creates a CSV export of the defined projects and time range.

 

Examples:

• Backup all data in Gleeo Time Tracker to the SD card
• Export the current month by pressing a shortcut on the launcher and attach the created file to a Google Mail message draft
• Each month export all recorded entries of the month to the SD card and send the file by mail to your employer

The action Gleeo Start Recording starts recording the defined project and task in Gleeo Time Tracker when this task is not already recording.

 

Examples:

• Start tracking the time when you arrive at your office.
• Start tracking the time when your employer calls.
• Start tracking the time when you press a shortcut on the launcher.

The action Gleeo Stop Recording stops recording the currently recording task in Gleeo Time Tracker.

 

Examples:

• Stop tracking the time when you leave your office.
• Stop tracking the time every evening at 6pm and show an alert when you forgot to stop recording.

The action Google Drive Create Directories (Experimental) creates one or multiple directories on Google Drive.

 

Examples:

• create a directory before files are uploaded.

The action Google Drive Delete Files (Experimental) deletes the defined files on Dropbox.

 

Examples:

• Delete all files in a folder before uploading new files to this folder to get rid of files you don't need anymore.

The action Google Drive Download Files (Experimental) downloads multiple files and directories recursively to your device.

Warning: This action downloads all specified files and overwrites already existing target files. The files will be downloaded even when the same file already exists on the device.

Note: Google Drive allows to create duplicate files which is not possible on a regular filesystem. Automagic only considers the newest file in such a case and ignores duplicates.
Note: Google Documents are not downloaded.

 

Examples:

• Download each morning the newest file of keypass containing your passwords to ensure you have the newest offline copy available.

The action Google Drive Init Variable File List lists the files of a directory that match the specified name pattern.

 

Examples:

• Get a list of files and download only the ones smaller than 1MB.

The action Google Drive Upload Files (Experimental) uploads one or multiple files and directories recursively to your Google Drive.

Warning: This action uploads all specified files and overwrites already existing target files.

 

Examples:

• Upload a backup of all data in Gleeo Time Tracker to the Google Drive

The action Hide Custom Widget Overlay hides a previously shown overlay.

The action Hide Custom Widget Overlay (Android Wear) hides a previously shown overlay.

The action HTTP Request requests a resource from a server using the specified HTTP request method.

Note: This action is meant to be used for technical requests (REST and the like) and to process the response using scripts. If you simply want to download a file please use the action Download URL.
The action terminates with a status code of -1 for general errors. It will terminate with an error when not even a connection to the server can be established (network not available, IP can not be resolved etc.). Use an Exception-connection to handle such errors.

 

Examples:

• Fetch a web page of a weather service and test if it contains the word rain
• Get the price of a product from an online retailers REST service

The action Import Flows imports all flows of the specified file. The imported flows are disabled. Already existing flows are not imported.
Flows can be enabled after importing when desired using action Set Flow State and the variable {imported_flow_names,listformat,comma}.

 

Examples:

• Import a flow to lock the device on the stolen device.

The action Init Variable Contact List stores the list of contacts in the specified variable.

 

Examples:

• Show the starred contacts in a selection list before calling the selected contact.

The action Init Variable File List lists all files or only the newly added files in a directory and stores the list in a variable.

 

Examples:

• Send all files of a directory by mail to your mail account.
• Send all new backup files of Gleeo Time Tracker to your inbox.

The action Init Variable Image File loads the pixel data of an image into the specified local variable to modify the image with action Modify Image or to read color values of pixels with script function getPixelColor.

Warning: Loading large images uses a lot of internal memory which could cause Automagic to crash in the worst case. It's recommended to read only one image into memory and not to load very large images.

 

Examples:

• Load an image, shrink the size and send the smaller file by mail.

The action Init Variable Image Metadata extracts the metadata (e.g. Exif tags) from an image and stores the values in a map (key=label/name of the tag, value=description or raw value of the tag).

Example to read the GPS location in an action Script:
location = getMapValue(image_metadata, "gps_location");

Tip: Condition Debug Dialog can be used to display the keys and values stored in the map.

 

Examples:

• Extract the GPS location and the thumbnail from a JPEG image.

The action Init Variable Location acquires one location from the defined provider and stores the location in the variable.

Note: Getting one location can take several seconds to complete. The passive provider might not return a location until another app is activating one of the location providers.

 

Examples:

• Send the location in response to an SMS containing the text Where are you? to the sender.
• Store the location coordinates in a file when the employer calls.
• Send the location and phone number by mail whenever you call someone.

The action Init Variable Next Alarm fills the time of the next currently known alarm into the specified variable.

Warning: This function is not officially supported by Android < 5.0 and might not work on all devices.

 

Examples:

• Get the time of the next alarm to show a reminder one hour before the alarm is reached.

The action Init Variable Notifications on Statusbar stores all currently shown notifications as a list in a variable.

 

Examples:

• Send the texts of all shown notifications by mail to your account when you receive an SMS with the text get notifications.

The action Init Variable Package Info loads information of the specified apps/packages and stores the information in a map.

Tip: Condition Debug Dialog can be used to display the keys and values stored in the map.

 

Examples:

• Load the list of permissions used by an app and check which permissions have been granted.

The map contains the package name as the key and a map with the queried information as value. Example shown as JSON:

        {
          "package1": {"version_name": xyz, "version_code": 123},
          "package2": {"version_name": xyz, "version_code": 123}
        }
    

Example JSON queried for one app:

        {
          "com.android.vending": {
            "version_name": "6.4.12.C-all [0] 2744941", // the version name
            "version_code": 80641200, // the version number
            "first_install_time": 1230796800000, // the time at which the app was first installed (millis since 1970)
            "last_update_time": 1461091018180, // the time at which the app was last updated (millis since 1970)
            "install_location": -1, // -1=auto?, 0=auto, 1=internal only, 2=prefer external
            "application_info": {
              "data_dir": "/data/user/0/com.android.vending", // full path to a directory assigned to the package for its persistent data
              "class_name": "com.google.android.finsky.FinskyApp", // class implementing the Application object
              "source_dir": "/data/app/com.android.vending-2/base.apk", // full path to the base APK for this application
              "label": "Google Play Store", // the label of the app (current locale)
              "uid": 10024, // the kernel user-ID that has been assigned to this application
              "icon_uri": "android.resource://com.android.vending/2130903045", // URI to load the icon of the app
              "target_sdk_version": 23, // the API level that the application targets
              "enabled": true // whether or not the Android system can instantiate components of the application
            },
            "requested_permissions": [
              {
                "permission": "android.permission.WRITE_EXTERNAL_STORAGE", // the name of the permission
                "requested_permission_flag": 3, // 1=requested, 3=requested & granted
                "label": "modify or delete the contents of your USB storage", // the label of the permission
                "description": "Allows the app to write to the USB storage.", // the description of the permission
                "protection_level": 1, // protection level as number
                "protection_level_text": "dangerous", // protection level expressed as text
                "group": "android.permission-group.STORAGE", // the group name of the permission
                "group_label": "Storage", // the permission group label
                "group_description": "access photos, media, and files on your device" // the permission group description
              }, ...
            ],
            "activity_info": [
              {
                "name": "com.android.vending.AssetBrowserActivity",
                "label": "Play Store",
                "icon_uri": "android.resource://com.android.vending/2130903045",
                "enabled": true, // whether the activity is enabled
                "exported": true // whether the activity can be used by other apps
                "permission": "com.google.android..." // permission required to access this activity (when defined)
              },
            ],
            "receiver_info": [
              {
                "name": "com.google.android.gcm.GCMBroadcastReceiver",
                "label": "Google Play Store",
                "enabled": true,
                "exported": true,
                "permission": "com.google.android.c2dm.permission.SEND"
              }, ...
            ],
            "provider_info": [
              {
                "name": "com.google.android.finsky.providers.RecentSuggestionsProvider",
                "label": "Google Play Store",
                "authority": "com.google.android.finsky.RecentSuggestionsProvider",
                "enabled": true,
                "exported": false
              }, ...
            ],
            "service_info": [
              {
                "name": "com.google.android.finsky.services.ReviewsService",
                "label": "Google Play Store",
                "enabled": true,
                "exported": true
              }, ...
            ]
          }, ...
        }
    

Please note that additional key value pairs might be added in future versions of Automagic.

The action Init Variable Random Number generates a random number in a defined interval.

 

Examples:

• Simulate to throw a dice.
• Play a random sound for every received SMS.

The action Init Variable System Setting reads a value from the system setting database and stores the value in a variable.

The action Init Variable System Setting (Android Wear) reads a value from the system setting database and stores the value in a variable.

The action Init Variable Text File reads the contents of a text file into the specified variable. Files up to 1MB are supported. Binary files are not supported.

 

Examples:

• Read a text file containing a mail template and send the text by mail.

The action Init Variable WiFi Access Point List lists all configured or only enabled/disabled wifi networks into a variable.

 

Examples:

• show a list of WiFI networks and allow to connect to the selected one

The action Init Variables Bluetooth Device List lists all paired, connected or not connected bluetooth devices in a variable.

 

Examples:

• show a dialog of all not connected bluetooth devices and attempt to connect to a selected device

The action Init Variables Call Log initializes variables with the values of the last entry of the call log.

 

Examples:

• Update a widget with the values of the last call

The action Init Variables Contact Info loads information of the specified contact and stores the information in a map.

Tip: Condition Debug Dialog can be used to display the keys and values stored in the map.

 

Examples:

• Show all phone numbers of a contact

Example JSON of a contact:

        {
          "display_name": "Contact XYZ", // name of the contact
          "photo_thumb_uri": "content://com.android.contacts/contacts/124/photo", // URI of the small image
          "photo_uri": "content://com.android.contacts/display_photo/3", // URI of the larger image
          "last_time_contacted": 1479667934531, // point in time of the last contact, 0 when not known
          "starred": true, // whether the contact is in the favorites or not
          "times_contacted": 1, // count of contacts (according to contact app)
          "phone_list": [{ // list of phone numbers
            "number": "+41987654321",
            "type": 2,
            "type_label": "Mobile"
          }, ... ],
          "organization_list": [{ // list of organizations
            "company": "Company X",
            "type": 2,
            "type_label": "Other",
            "title": "Company"
          }, ... ],
          "note_list": [{ // list of notes
              "note": "Note 1"
            }, ... ],
          "nickname_list": [{ // list of nicknames
            "nickname": "MR. incredible",
            "type": 0,
            "type_label": "Other"
          }, ... ],
          "email_list": [{ // list of email addresses
            "email": "
 This email address is being protected from spambots. You need JavaScript enabled to view it.
 ",
            "type": 1,
            "type_label": "Home"
          }, ... ],
          "relation_list": [{ // list of relations
            "relation": "Person 123",
            "type": 1,
            "type_label": "Assistant
          }, ... ],
          "structured_postal_list": [{ // list of addresses
            "formatted_address": "Mainstreet X\n1234 City",
            "type": 1,
            "type_label": "Home",
            "street": "Mainstreet X",
            "city": "City",
            "postcode": "1234"
          }, ... ],
          "structured_name_list": [{ // list of the names
            "display_name": "Contact XYZ",
            "given_name": "Contact",
            "family_name": "XYZ"
          }, ... ],
          "website_list": [{ // list of websites
            "url": "www.automagic4android.com",
            "type": 7,
            "type_label": "Other"
          }, ... ],
          "sip_address_list": [{ // list of the SIP addresses
            "number": "+41987654321",
            "type": 2,
            "type_label": "Mobile"
          }, ... ],
          "event_list": [{ // list of events
            "start_date": "1978-07-04",
            "type": 3,
            "type_label": "Birthday"
          }, ...],
          "group_list": [ // list of the groups
            "Group1",
            "Group2",
            "Group3"
          ]
        }
    

Please note that additional key value pairs might be added in future versions of Automagic.

Examples of access to values in action Script:

        name = contact_info["display_name"];
        photo_uri = contact_info["photo_uri"];
        phone1 = contact_info["phone_list"][0]["number"];
        phone2 = contact_info["phone_list"][1]["number"];
        phone2type = contact_info["phone_list"][1]["type_label"];
        nickname1 = contact_info["nickname_list"][0]["nickname"];
    

The action Init Variables Device Orientation measures the device orientation using the accelerometer and magnetometer sensors of the device.

Warning: This action uses the device hardware sensors and might increase battery usage (depending on device model). Some devices turn off the sensors when the screen is off.

 

Examples:

• Show your current orientation value in a popup.
• Select the task to record by changing the device orientation.

The action Init Variables File Info provides information about a file as variables to the flow.

 

Examples:

• Check if a file is older than one week and delete the file.

The action Init Variables Gleeo Project Structure initializes a variable with the domains, projects or tasks from Gleeo Time Tracker.

 

Examples:

• Load all Tasks of a project to show a selection list in Automagic.

The action Init Variables Gleeo Recording checks if a task is recording in Gleeo Time Tracker and stores the recording project and task in variables.

 

Examples:

• Store the recording task when someone calls and start recording the same task again when the call ends.
• Don't use a funny alert sound when you are working for a special project.

The action Init Variables Media Metadata loads the metadata of a media file into local variables (see variables section below).

 

Examples:

• Load the title of an mp3 and show the title in a notification

The action Init Variables Media Session (Experimental) fills the information of the media session of the specified media player into variables.

 

Examples:

• Check if Google Play Music is playing a track.

The action Init Variables Network Statistics queries the transferred amount of data of the specified network interfaces.
The network statistics are recorded by the operating system itself and is stored in blocks of two hours (device dependent). Queries that don't fall on such a two hour limit, will be interpolated (device dependent) so results might not be accurate especially for short time intervals.
The data of the network statistics is stored for each UID (user identification) of the executed process. Many apps/packages of the system are aggregated under UID 1000 and can not be differentiated further. The package selection shows the UID in brackets.
Data not available to the network statistics of the device can not be considered by this action (e.g. when a device is factory reset).

 

Examples:

• Periodically check the amount of data transferred by a specific app and show a warning when 100 MB are exceeded.

The action Init Variables Network Traffic initializes variables with the transmitted and received bytes since device boot of the system or a specific user ID that runs a given app.

Note: Some devices do not collect user/app specific values. This is also a known problem of Android 4.3.

 

Examples:

• Store the number of transferred data for each day in a log file

The action Init Variables Phone Info initializes the desired variables (not all values are available on all devices).

 

Examples:

• Check the network operator once an hour

The action Input Dialog shows an input dialog with an input text field, password field, single- or multi-selection list.

 

Examples:

• Ask the user whether he wants to turn WiFi off or not
• Ask for the password to use for an FTP upload
• Ask whether airplane mode should be activated in the evening. Activate airplane mode when the user does not respond within 30 seconds.

The action Input Speech (Android Wear) starts the speech recognition of the device and provides the recognized text to the flow in variable value. The speech recognition engine usually requires network access.

 

Examples:

• Control Automagic using spoken commands.

The action Input Speech (Experimental) starts the speech recognition of the device and provides the recognized text to the flow in variable value. The speech recognition engine usually requires network access.

 

Examples:

• Control Automagic using spoken commands.

The action Kill App kills the processes of an app running in the background.

Warning: The operating system does not allow to kill an app currently running in the foreground.

 

Examples:

• Kill the browser app when another app is started to reclaim memory.

The action Kill App Process sends the defined signal to the process using the kill command.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Kill the browser app when another app is started to reclaim memory.

The action Launch App starts an app or a specific activity of an app.

Tip: Some activities require special permissions to be launched. Check the log after testing the action when an activity fails to start.

 

Examples:

• Start the development settings directly using a shortcut.
• Start the shopping list app when you are near the shopping mall

The action Launch Shortcut starts a previously defined shortcut.

A new shortcut can either be built with button Build Shortcut or you can let Automagic capture the shortcut by leaving the action configuration open and by creating the shortcut in the other app. Automagic will show a notification on screen Shortcut captured by Automagic when the shortcut was properly detected by Automagic. Note that not all apps support both ways to create a shortcut.

 

Examples:

• Open a specific settings page
• Play an audio playlist
• Directly display a contact

The action Lock Device immediately locks the device.

Note: The device admin functions have to be enabled in the preferences to use this action.

 

Examples:

• Lock the device when an SMS contains device lost!

The action Mail with Gmail sends a mail using your Gmail account.

Note: If you have enabled 2-step verification in your Google account then you need to create an application specific password for login in the settings of your google account: https://www.google.com/settings/security

 

Examples:

• Forward every SMS as a mail to your inbox.
• Send your location every 30 minutes to your girlfriend.
• Send the new Gleeo Time Tracker backups to your inbox.

The action Map Values takes an input value (the key) and maps it to an output value.

 

Examples:

• Scan the barcode on the laboratory door and map the value to a project/task to start the time tracker.

The action Message Dialog shows a dialog with a message and an optional title.

 

Examples:

• Show the text of an incoming SMS directly in a dialog.

The action Modify Automagic Notification on Statusbar modifies the permanent notification usually shown by Automagic for technical reasons. The appearance of a modified notification is reset to the default when one of the settings in Automagic pertaining to the notification is changed.

 

Examples:

• Show a different icon when a particular flow is running.

The action Modify Call Log marks the entries of the call log as acknowledged or clears the call log.

 

Examples:

• Delete the call log every Monday morning.

The action Modify Image can be used to modify an image that was previously loaded with an action Init Variable Image File.

 

Examples:

• Load an image, shrink the size and send the smaller file by mail.

The action Move Files locally moves one or a list of files to the specified target directory or file.
A move is implemented to use a rename operation when possible. If a rename is not possible, the file/folder is copied to the target directory and afterwards the source is deleted.

 

Examples:

• Move all files in directory /mnt/sdcard/xyz/ to the folder /mnt/sdcard/xyz_backup/
• Rename directory /mnt/sdcard/xyz to /mnt/sdcard/xyz_backup

The action Notification on Screen shows a notification on the screen for a short period of time.

 

Examples:

• Show a notification when a background flow sends your location by mail.
• Show a notification with the text of a received SMS.

The action Notification on Screen (Android Wear) shows a notification on the screen for a short period of time.

 

Examples:

• Show a notification when a background flow sends your location by mail.
• Show a notification with the text of a received SMS.

The action Notification on Statusbar shows a notification on the status bar. The notification is displayed until the notification is clicked or clear is pressed.

 

Examples:

• Show a notification when a background flow sends your location by mail.

The action Open URL in Browser opens the browser with the specified URL.

Tip: The browser can also be used to download a file by using a URL pointing to a PDF or other downloadable file.

 

Examples:

• Open a news page every morning.
• Download a PDF every morning at 5am.

The action Perform Action on Notification on Statusbar clicks the notification or one of the action buttons which are usually available in the big, expanded notification on Android 4.1+.
The flow must be executed by a trigger Notification on Statusbar Displayed or the action after a condition Notification on Statusbar Displayed otherwise Automagic has no possibility to access the notification.

Warning: Android 4.1+ is required. This function is not officially supported by Android and might not work on all devices.

 

Examples:

• Automatically archive a mail when the mail contains a specific text.

The action Plugin (Experimental) executes the action defined in a plugin. Most plugins don't offer a way to let Automagic wait for the plugin to finish. You can use an action Sleep to wait a short amount of time.

Warning: This function is experimental and might not work with all existing plugins available in Google Play. We can not provide support for plugins.

Note: Plugins can be defined using the interface description available from the app Locale: Locale developer documentation and Tasker: Tasker plugin extensions.

The action Post Tweet posts a regular Twitter message.

 

Examples:

• Tweet your location every hour.

The action Post Twitter Direct Message posts a Twitter direct message to one recipient.

 

Examples:

• Tweet your location every hour to your wife.

The action Query Content Provider allows to load data from a content provider of another app. A content provider presents data to Automagic as one or more tables that are similar to the tables found in a relational database.

Warning: This function allows to access data that's not officially made available by Android which might not be available on all device models and Android Version.

 

The action Reboot restarts the device.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Restart the device every morning at 6am.

The action Remove Notification Missed Calls removes the missed calls notification in the statusbar.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Remove the missed calls notification when a number on a blocking list called in your absence.

The action Remove Notification on Statusbar removes the specified or all notifications on the statusbar added by the action Notification on Statusbar.

 

Example:

• Show a notification when a sound profile is active and remove the notification when the sound profile is deactivated.

The action Remove WiFi Access Point removes a WiFi configuration.

Warning: This function can only remove access points that have been added by Automagic on Android 6+.

 

Examples:

• Remove a previously added public access point to clean up the list.

The action Request Sync starts the synchronisation process of one or multiple accounts or some parts of the accounts. The order and the exact timing of the synchronisation is controlled by Android.
The action does not wait for the synchronisation to finish.

 

Examples:

• Disable the automatic synchronisation to save battery but execute the synchronisation manually every hour between 8am and 8pm.

The action Reregister Media Button Receiver registers Automagic as a receiver of media button events again.
This is useful in conjunction with trigger Media Button Receiver when another app requested to receive the media button events and Automagic thus does not receive the events anymore.

The action Restore Audio Volumes restores the audio volumes previously stored in global variables by action Store Audio Volumes.

 

Examples:

• Store the audio volumes when a meeting begins, set all volumes to zero and restore the previously volumes when the meeting ends

The action Save Variable in Image File saves the pixel data that was previously loaded with an action Init Variable Image File into a file.

 

Examples:

• Load an image, shrink the size and send the smaller file by mail.

The action Save Widget to Image File saves the current image of a widget to a file.

 

Examples:

• Add a text over an image and send the resulting image as an email attachment.

The action Scan Barcode opens an activity to scan a barcode using the camera of the device.

Tip: You can use an action Map Values to map known barcode values like a QR code on a laboratory door to a project/task.

 

Examples:

• Start recording the time in Gleeo Time Tracker based on a barcode on a laboratory door.
• Scan a barcode on a book and open the browser to search the book on Amazon.

The action Script executes a script doing some simple calculations and can be used to modify variables.

Following list of keywords are reserved and are therefore not allowed to be used as a variable name:

abstract alias and AND assert boolean break byte case catch char class const continue def default do double else elsif ensure enum extends false final finally float for goto if implements import in instanceof int interface long mod native new next not NOT null or OR package private protected public redo repeat rescue retry return self short static strictfp super switch synchronized then this throw throws to transient true try undef unless until void volatile when while xor XOR yield

Only a few of the reserved keywords are currently used but are reserved for future extensions of the scripting language.

Scripts can contain comments that are not executed when the script is interpreted.

• text after // to the end of the line
• text between /* and */. Such a comment can also span multiple lines.

Examples:

    a=1+2;//this is a comment
    b=a+3;
    c=b+a;
    /* this is a
        multiline comment */
    d=c*2;

A value like a number or a string can be stored in a variable using the assignment operator =
Variable names are case sensitive. A variable name has to start with a letter, a currency symbol (such as "$") or a connecting punctuation character (such as "_"). The rest of the variable name can also contain digits. Unicode characters are supported, but it is highly recommended to use US-ASCII characters.

Examples:

    a = 3;//assign the number three to the variable a
    b = a;//assign the value stored in variable a to the variable b

There exist two types of variable scopes:

Every variable declared in a script, expression or inline script is by default flow local as long as the name of the variable does not start with global_.

Examples of flow local variables with a value assigned:

• a = 1;   number one stored in a variable called 'a'
• var1 = 1.234;   decimal number 1.234 stored in a variable called 'var1'
• var_123 = "Hello World";   string "Hello World" stored in a variable called 'var_123'
• _m = true;   boolean value 'true' stored in a variable called '_m'
• var2 = a;   stores the value stored in variable 'a' in a variable called 'var2'

Every variable that starts with global_ is global and therefore accessible by other flows and will also be persisted to the external memory and reloaded when you stop/restart the Automagic service.

Examples of global variables with a value assigned:

• global_a = 1;   number one stored in a variable called 'global_a'
• global_var1 = 1.234;   decimal number 1.234 stored in a variable called 'global_var1'
• global_var_123 = "Hello World";   string "Hello World" stored in a variable called 'global_var_123'
• global_m = true;   boolean value 'true' stored in a variable called 'global_m'

Variables are references to values (like a pointer). Assigning the value stored in a variable to another variable does not copy the value but both variables point to the exact same value.
This is especially important when modifiable values like lists are used.
Example:

    a = newList(1, 2, 3);
    b = a;
    //at this point both variables a and b point to the exact
    // same list (the list only exists once)
    addElement(a, 4);
    //the list now contains 1, 2, 3, 4
    //both variables a and b still point to the same list

    //both loops therefore print the values 1, 2, 3 and 4 in the log:
    for (x in a)
    {
        log("{x}");
    }

    for (x in b)
    {
        log("{x}");
    }

Following operators are supported in expressions:

• +    addition and string concatenation
• -    subtraction
• *    multiplication
• /    division
• %    modulo division
• <    less than
• <=    less than or equal
• >    greater than
• >=    greater than or equal
• ==    equal
• !=    not equal
• AND, &&    and
• OR, ||    or
• XOR, ^    exclusive or
• NOT, !    not (unary)

An expression is a construct made up of variables, operators and function calls, that evaluates to a single value.

Examples:

• 42
• 1+2
• a=1
• b=a+1
• c=(a+1)*(b-3)
• global_a=1
• a=sqrt(9)
• b=addDays(triggertime, 3)
• c=replace("hello automagic", "automagic", "world")
• b=addDays(triggertime, sqrt(9))
• b="Hello " + "World"
• a=true
• b=false
• c=a AND b OR c>=5
• c=NOT a AND NOT b

Inline expressions in strings can be used to replace a part of the string by a variable or expression. The rules described here also apply to the text fields of triggers, conditions and actions documented in the help page with Variables are supported.
An inline expression is enclosed in curly braces: {expression}

Example simple inline expressions:

• var1="Test";
var2="This is a {var1}";
  'var2' will contain the string "This is a Test" after the script is evaluated
• var="one plus two is {1 + 2}";
  'var' is evaluated to "one plus two is 3"

Inline expressions can be formatted by defining a format type and depending on the format type a pattern to use: {var,formattype,pattern}

Example inline expressions with formatting:

• var="Today is {getDate(),dateformat,dd.MM.yyyy}";
  'var' will contain the string "Today is 21.07.2012"
• var="It's {getDate(),dateformat,HH:mm}";
  'var' will contain the string "It's 12:32"
• var="It's {getDate(),dateformat,timezone,UTC,HH:mm}";
  'var' will contain the string "It's 10:32"
• var="Value: {1.456789,numberformat,0.00}";
  'var' is evaluated to "Value: 1.46"
• var="I'm here: {location,locationformat,decimal}";
  'var' is evaluated to "I'm here: 46.76817,7.603751"
• var="{files,listformat,comma}";
  'var' is evaluated to "/mnt/sdcard/file1,/mnt/sdcard/file2"

Supported format types:

• dateformat: Formats the date using the specified date pattern. See pattern characters for a description of the supported patterns.
  The optional sub-format timezone along with the name of the timezone can be used to define the timezone used to format the date/time. Accepted timezone names are either UTC, GMT or the Olson name of a timezone name of the form Area/Location, such as America/Los_Angeles (device dependent). GMT is used for unknown timezone names.
  Examples:
  • {triggertime,dateformat,timezone,UTC,HH:mm}
  • {triggertime,dateformat,timezone,America/Los_Angeles,HH:mm}
  • {triggertime,dateformat,timezone,Europe/London,HH:mm}
  • {triggertime,dateformat,timezone,Europe/Paris,HH:mm}
  • {triggertime,dateformat,timezone,Africa/Harare,HH:mm}
• numberformat: Formats the number using the specified decimal format. See pattern characters for a description of the supported patterns.
• locationformat: Formats the address of the location when available in a single line of text when no format is specified. (Data connection is required)
  Following locationformat patterns are supported:
  • multiline: Formats the address as a multiline text. (Data connection is required)
  • decimal: Formats latitude,longitude as decimal numbers (+/-DDD.DDDDD). Example: 46.76817,7.603751.
  • microdegrees: Formats latitude,longitude multiplied by 1'000'000 as integers. Example: 46768355,7604022. This format can be useful in a call to a REST service.
  • swiss: Formats latitude,longitude converted to the Swiss coordinate system.
• listformat: Formats the list of values as a multiline text with one item per line when no pattern is specified.
  Following listformat patterns are supported:
  • comma: Formats the list of values as a comma separated list.
  • semicolon: Formats the list of values as a semicolon separated list.
• jsonformat: Formats the value as JSON fragment.

Inline expressions in strings with single quotes are not interpreted. This can be helpful for regular expressions, where a quantifier like {2} in the pattern ([0-9]){2}.* should not be replaced with 2.

Example:

• var='Today is {getDate(),dateformat,dd.MM.yyyy}';
  'var' is evaluated to 'Today is {getDate(),dateformat,dd.MM.yyyy}'

An if statement can be used to evaluate a block of code when a condition is true.
Example:

    if (a<3)
    {
        b = 0;
    }
    else
    {
        b = 1;
    }

In this example variable b is assigned the value zero when the variable a contains a value less than 3, b is assigned the value one when the variable a contains a value greater or equal to 3. A for loop evaluates a block of code for every value in a list of values.
Example:

    list=newList(1, 2, 3);

    for (a in list)
    {
        log("a contains {a}");
    }

This example would print the following output in the log:

    a contains 1
    a contains 2
    a contains 3

Since it is very common to create a list containing a sequence of numeric values there is a shorthand to create such a list using [<number> to <number>, <step size>]:
Examples:

    list = [1 to 10];//without the optional step size

    for (a in list)
    {
        log(a);
    }
    //logs 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

    //inlined
    for (a in [1 to 10])
    {
        log(a);
    }
    //logs 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

    //inlined with step size of 2
    for (a in [1 to 10, 2])
    {
        log(a);
    }
    //logs 1, 3, 5, 7, 9

    //inlined with negative step size of -3
    for (a in [10 to 1, -3])
    {
        log(a);
    }
    //logs 10, 7, 4, 1

Single values of lists and maps can be accessed with brackets.
Examples:

    list = [1 to 10];
    a = list[0];//get first element of the list: 1
    a = list[1];//get second element of the list: 2

    list[2] = 999;//assigns 999 to the third element of the list

    map = newMap();
    map["key1"] = 1;//creates a map entry key1-->1
    map["key2"] = 2;//creates a map entry key2-->2

    a = map["key1"];//gets the value of entry with key1: 1
    a = map["key2"];//gets the value of entry with key2: 2

A while-loop evaluates a block of code as long as a condition is true.
Example:

    a = 0;

    while (a < 10)
    {
        log(a);
        a = a + 1;
    }
    //logs 0, 1, 2, 3, 4, 5, 6, 7, 8, 9

The return statement can be used to terminate a script early and optionally to return a given value.
Example:

    a = null;
    if (a == null)
    {
        return;
    }

    log("X");//not reached since return terminates the script

The break statement can be used to terminate a loop and to continue the script after the loop body.
Example:

    for (a in [1 to 10])
    {
        if (a == 4)
        {
            break;
        }
        log(a);
    }

    log("X");
    //logs 1, 2, 3, X

The continue statement can be used to immediately continue with the next iteration of the loop.
Example:

    for (a in [1 to 10])
    {
        if (a == 4)
        {
            continue;
        }
        log(a);
    }

    log("X");
    //logs 1, 2, 3, 5, 6, 7, 8, 9, 10, X

Built in functions can be called to calculate trigonometric values, create lists, extract values from an XML and much more.
Examples:

    a = sin(1.2);//evaluates to 0.932039...
    a = max(1, 2, 3, 4, 5);//evaluates to 5
    a = isEmpty([1 to 10]);//evaluates to false
    a = containsElement([1 to 10, 2], 3);//evaluates to true

Tip: Please also see the Script examples page that shows some commonly used script snippets.

• Object convertNull(Object value, Object defaultValue)
  Returns the value of the first argument or returns default when the value is null.
• Number abs(Number value)
  Returns the absolute value of value.
• Number pow(Number base, Number exponent)
  Returns the value of the first argument raised to the power of the second argument.
• Number sqrt(Number a)
  Returns the square root of the number.
• Number sin(Number a)
  Returns the sine of the angle in radians.
• Number cos(Number a)
  Returns the cosine of the angle in radians.
• Number tan(Number a)
  Returns the tangent of the angle in radians.
• Number asin(Number a)
  Returns the sine of the angle in radians.
• Number acos(Number a)
  Returns the arc cosine of the angle in radians.
• Number atan(Number a)
  Returns the arc tangent of the angle in radians.
• Number atan2(Number y, Number x)
  Returns the angle of the polar representation of the rectangular coordinate (x, y).
• Number sinh(Number a)
  Returns the hyperbolic sine of the value.
• Number cosh(Number a)
  Returns the hyperbolic cosine of the value.
• Number tanh(Number a)
  Returns the hyperbolic tangent of the value.
• Number log10(Number a)
  Returns the base 10 logarithm of the value.
• Number ln(Number a)
  Returns the natural logarithm (base e) of the value.
• Number toRadians(Number a)
  Converts the Number from degrees to radians.
• Number toDegrees(Number a)
  Converts the Number from radians to degrees.
• Number round(Number a)
  Rounds the number to the nearest integer.
• Number ceil(Number a)
  Returns the next highest integer value by rounding up value if necessary.
• Number floor(Number a)
  Returns the next lowest integer value by rounding down value if necessary.
• Date addDays(Date d, Number a)
  Returns a new date by adding a number of days to the date d.
• Date addHours(Date d, Number a)
  Returns a new date by adding a number of hours to the date d.
• Date addMinutes(Date d, Number a)
  Returns a new Date by adding a number of minutes to the date d.
• Date addSeconds(Date d, Number a)
  Returns a new date by adding a number of seconds to the date d.
• Date getDate()
  Returns the current date and time.
• Date getDate(String date, String pattern)
  Converts the string to a date using the specified pattern. (see pattern characters)
• Date getDate(Number year, Number month, Number day)
  Returns the Date specified by the arguments.
• Date getDate(Number year, Number month, Number day, Number hours, Number minutes, Number seconds)
  Returns the date specified by the arguments.
• Date getDate(Date date, Number hours, Number minutes, Number seconds)
  Returns the date specified by the arguments.
• Date getDate(Date date, Number hours, Number minutes, Number seconds, String timezone)
  Returns the date specified by the arguments in the defined timezone.
• Number getUptimeMillis()
  Returns milliseconds since boot, not counting time spent in deep sleep.
• Number getElapsedRealtimeMillis()
  Returns milliseconds since boot, including time spent in sleep.
• Number getDurationMillis(String duration)
  Returns the duration in milliseconds specified by the duration string (e.g. "2m 15s" returns 135000).
• String getDurationString(Number duration)
  Returns the duration string representing the specified milliseconds (e.g. 135000 returns "2m 15s").
• Number getByteSize(String byteSize)
  Returns the number of bytes specified by the string (e.g. "10kb 15b" returns 10255).
• String getByteSizeString(Number byteSize)
  Returns the formatted byte string representing the specified bytes (e.g. 10255 returns "10kb 15b").
• Number toNumber(String number)
  Converts the specified parameter to a number.
• Number min(Number n1, Number n2, ...)
  Returns the smallest number of the arguments.
• Number max(Number n1, Number n2, ...)
  Returns the largest number of the arguments.
• Boolean isEmpty(String s)
  Returns whether the string is empty or not.
• Number length(String s)
  Returns the number of characters in string s.
• String substring(String s, Number start, Number end)
  Returns the substring of the specified string.
• String substring(String s, Number start)
  Returns the substring starting at the specified index.
• String left(String s, Number length)
  Returns the first length characters of the specified string.
• String right(String s, Number length)
  Returns the last length characters of the specified string.
• Number indexOf(String s, String search)
  Returns the first index of search in s.
• Number indexOf(String s, String search, Number start)
  Returns the first index of search after start in s.
• Number lastIndexOf(String s, String search)
  Returns the last index of search in s.
• Number lastIndexOf(String s, String search, Number start)
  Returns the last index of search before start in s.
• Boolean startsWith(String s, String prefix)
  Checks whether the string s starts with prefix.
• Boolean endsWith(String s, String suffix)
  Checks whether the string s ends with suffix.
• Boolean contains(String s, String search)
  Checks whether the string s contains the substring search.
• List split(String s, String pattern)
  Splits the string s into a list of strings by using the regular expression pattern as the delimiter. (see Regular expressions)
• List splitCSVRecord(String s)
  Splits the comma delimited string s into a list of tokens. Takes double quotes for escaped fields into consideration.
• String join(List list, String delimiter)
  Joins the elements of the list into a string by separating the elements with the specified delimiter.
• Boolean matches(String s, String pattern)
  Returns whether the string s matches the regular expression pattern. (see Regular expressions)
• Boolean matches(String s, String pattern, List groups)
  Returns whether the string s matches the regular expression pattern and fills the captured groups into the existing list groups. (see Regular expressions)
• List findAll(String s, String pattern)
  Returns a list of all matched values in s of regex pattern. (see Regular expressions)
• List findAll(String s, String pattern, boolean returnGroups)
  Returns a list of all matched values in s of regex pattern. Optionally item consists of a list of the matched groups. (see Regular expressions)
• String replace(String s, String search, String replace)
  Returns a modified string by replacing all occurrences of search with replace in string s.
• String replaceAll(String s, String regex, String replacement)
  Returns a modified string by replacing all substrings matching regex with replacement in string s. (see Regular expressions)
• String trim(String s)
  Returns a modified string by removing all leading and trailing whitespace from string s.
• String concat(Object o1, ...)
  Returns the string concatenation of the specified objects.
• String toUpperCase(String s)
  Converts the string to upper case using the rules of the default locale.
• String toLowerCase(String s)
  Converts the string to lower case using the rules of the default locale.
• String encodeURLForm(String urlPart)
  URL-encodes the specified urlPart (for application/x-www-form-urlencoded, spaces are encoded as +).
• String encodeURL(String urlPart)
  URL-encodes the specified urlPart (spaces are encoded as %20).
• String encodeHTML(String text)
  HTML-encodes the specified text.
• List newList(Object o1, ...)
  Returns a new list containing the specified objects.
• List copyList(List list)
  Returns a copy of specified list (flat copy).
• Number length(List list)
  Returns the number of elements in list.
• Boolean isEmpty(List list)
  Returns whether the list contains any elements or not.
• List addElement(List list, Object o1)
  Returns the same list after adding the object at the end of the list. Returns a new list when the list should not exist yet.
• List addElement(List list, Number index, Object o1)
  Returns the same list after adding the object at the specified index (zero based).
• List addAllElements(List list, List elementsToAdd)
  Returns the same list after adding all elements specified in list elementsToAdd.
• List removeDuplicateElements(List list)
  Returns the same list after removing all duplicates.
• List removeElementValue(List list, Object o1)
  Returns the same list after removing all elements with the specified value.
• List removeAllElementValues(List list, List elementsToRemove)
  Returns the same list after removing all elements contained in the second list.
• Boolean containsElement(List list, Object o1)
  Returns true when the list contains the specified element.
• Object removeElement(List list, Number index)
  Removes the object at the specified index (zero based) and returns the removed object.
• List removeElements(List list, Number fromIndex, Number toIndex)
  Removes the objects at the specified index range (zero based, [fromIndex,toIndex[) and returns the removed objects in a list.
• Object getElement(List list, Number index)
  Returns the object at the specified index (zero based).
• List setElement(List list, Number index, Object value)
  Sets the object at the specified index (zero based).
• Object getRandomElement(List list)
  Returns a random element of the list.
• List shuffleList(List list)
  Randomly shuffles the elements of the list.
• Number indexOfElement(List list, Object value)
  Returns the first index of the element in the list or -1 when the element is not contained in the list.
• Number indexOfElement(List list, Object value, Number start)
  Returns the first index of the element in the list that is bigger or equal to start or -1 when the element is not contained in the list.
• List sort(List list, Boolean casesensitive, Boolean natural)
  Modifies the list by sorting the values.
• List reverse(List list)
  Modifies the list by reversing the order of the contained values.
• Map newMap()
  Returns a new empty map
• Map newMapFromValues(String key1, Object value1, ...)
  Returns a new map initialized to contain the specified keys and values.
• Boolean isEmpty(Map map)
  Returns whether the map contains any elements or not.
• Number length(Map map)
  Returns the number of elements in map.
• Map copyMap(Map map)
  Returns a copy of specified map (flat copy).
• Map addMapEntry(Map map, String key, Object value)
  Adds a new entry key->value to the map and returns the map. Returns a new map when the map should not exist yet.",
• Map addAllMapEntries(Map map, Map entriesToAdd)
  Adds all entries of the second map to the first map and returns the first map.
• Object getMapValue(Map map, String key)
  Returns the object for key or null when no mapping for key exists.
• Object getMapValue(Map map, String key, Object default)
  Returns the object for key or default when no mapping for key exists or map is null.
• Object removeMapEntry(Map map, String key)
  Removes the entry for the given key and returns the value.
• List getMapKeys(Map map)
  Returns a list of the keys of map.
• List getMapValues(Map map)
  Returns a list of the values of map.
• String evaluateXPathAsString(String xml, String xpath)
  Evaluates the XPath expression on the given XML and returns the result as a string. (see XPath Specification)
• String hash(String value, String encoding, String algorithm)
  Calculates the hash of value using the specified encoding (like UTF-8 or UTF-16LE) and hashing algorithm (like MD5 or SHA1).
• String toJSON(Object value)
  Converts the specified object to a JSON string.
• String toJSON(Object value, Boolean indent)
  Converts the specified object to a JSON string, indented or not.
• Object fromJSON(String value)
  Converts the specified JSON string into an object.
• Object log(Object value)
  Logs the specified object in the Automagic log and returns the unmodified object.
• Object eval(String script)
  Evaluates the string as a script and returns the value of the last expression.
• Number random()
  Returns a random number between 0.0 and 1.0 (exclusive).
• Number random(Number low, Number high)
  Returns a random number between low and high (inclusive).
• Boolean sleep(Number milliseconds)
  Waits for the specified amount of milliseconds.
• Boolean sleep(String duration)
  Waits for the specified duration like "2m 30s".
• Boolean existsFile(String path)
  Checks whether the file denoted by path exists or not.
• Boolean isDirectory(String path)
  Checks whether the file denoted by path is a directory.
• String getExternalStorageDir()
  Returns the path to the primary external storage directory.
• Number getPixelColor(Bitmap image_data, Number x, Number y)
  Returns the color (argb) of the pixel of the image at location x, y.
• Number getRed(Number color)
  Returns the red component of the specified color.
• Number getGreen(Number color)
  Returns the green component of the specified color.
• Number getBlue(Number color)
  Returns the blue component of the specified color.
• Number getAlpha(Number color)
  Returns the alpha component of the specified color.
• Number newColor(Number a, Number r, Number g, Number b)
  Returns a new color from the specified ARGB components.
• Number distance(Location loc1, Location loc2)
  Calculates the distance between locations loc1 and loc2 in meters.
• Location newLocation(Number latitude, Number longitude)
  Creates a new Location for the specified latitude and longitude.
• String setHTTPResponseHeader(String header, String value)
  Sets the HTTP response header to the specified value and returns the value.
• Number setHTTPResponseStatus(Number status)
  Sets the HTTP response status to the specified value and returns the value.
• Boolean isList(Object value)
  Returns whether the specified value is a List or not.
• Boolean isMap(Object value)
  Returns whether the specified value is a Map or not.
• Boolean isString(Object value)
  Returns whether the specified value is a String or not.
• Boolean isNumber(Object value)
  Returns whether the specified value is a Number or not.
• Boolean isBoolean(Object value)
  Returns whether the specified value is a Boolean or not.
• Boolean isLocation(Object value)
  Returns whether the specified value is a Location or not.
• Object getWidgetElementProperty(String widgetName, String elementName, String property)
  Gets the current value of the property of the specified widget element.
• Object setWidgetElementProperty(String widgetName, String elementName, String property, Object value)
  Sets the given property of the specified widget element to value.
• Boolean refreshWidget(String widgetName, Boolean reloadImages)
  Refreshes the widget and optionally also reloads images.
• String getAppName(String packageName)
  Returns the display name of the app from the specified package or null when not available.
• String getActivityName(String packageName, String className)
  Returns the display name of the activity from the specified package and class or null when not available.
• String getServiceName(String packageName, String className)
  Returns the display name of the service from the specified package and class or null when not available.
• List getFlowNames()
  Returns a list containing the names of all flows.
• List getFlowNamesByGroup(String group)
  Returns a list containing the names of the flows of the specified group.
• List getFlowGroupNames()
  Returns a list containing the names of the flow groups.
• List getWidgetNames()
  Returns a list containing the names of all widgets.
• Map getFlowStatisticsDuration()
  Returns a map of the executed flows. Key=Flow name, Value=total execution duration in milliseconds, sorted by value descending.
• Map getFlowStatisticsCount()
  Returns a map of the executed flows. Key=Flow name, Value=total execution count, sorted by value descending.
• Boolean resetFlowStatistics()
  Resets the flow statistics.
• Object getValue(String name, Object default)
  Returns the value of the variable named name or returns default when the variable is undefined or null.
• Object setValue(String name, Object value)
  Sets the variable named name to value and returns value
• Object removeVariable(String name)
  Removes the variable named name.
• List getVariableNames()
  Returns a list of all variables currently available (local and global).
• Number getAndroidSDKVersion()
  Returns the SDK version number of the Android framework. (see Android API versions)
• Object getContext()
  Returns the context of the application.
• Object callJavaStaticMethod(String className, String methodSignature, Object params, ...)
  Calls the defined public static method of the defined class.
• Object callJavaConstructor(String className, String constructorSignature, Object params, ...)
  Calls the public constructor of the defined class.
• Object callJavaMethod(Object obj, String className, String methodSignature, Object params, ...)
  Calls the specified instance method on the defined object.
• Object getJavaStaticField(String className, String fieldName)
  Returns the value of the specified public static field.
• Object setJavaStaticField(String className, String fieldName, Object value)
  Sets the value of the specified public static field.
• Object getJavaField(Object obj, String className, String fieldName)
  Returns the value of the specified public instance field.
• Object setJavaField(Object obj, String className, String fieldName, Object value)
  Sets the value of the specified public instance field.

Note: Are you missing a function? Please let us know in the forum. Every executable expression in a script evaluates to a value. A block of code evaluates to the value produced by the last expression in the block and allows to create inline scripts with multiple expressions:

    s = "{a=1;b=2}";
    log(s);//logs 2

    a = true;
    b = if (a) 1 else 2;
    log(b);//logs 1

    for (a in [0 to 10])
    {
        log(if(a<5) "X" else "-");
    }
    //logs X, X, X, X, X, -, -, -, -, -, -

    b=0;
    log(for(a in [1 to 10]) {b=b+a});
    //logs 55

The action Seek Action Sound seeks in the currently executing action Sound.

 

Examples:

• Seek to the beginning of a song.

The action Send Broadcast send a broadcast using the specified intent. Please also see the documentation of the Android Intent class.
Tip: Some broadcast receivers require special permissions to be launched. Check the log after testing the action when the broadcast receiver fails.

 

Examples:

• Control an app that exposes its actions using a broadcast receiver.

putString("key1", "Hello");
putBoolean("key2", true);
putDouble("key3", 1.23);
putInt("key4", 42);
putInt("key5", a+4*b);

The action Send SMS sends an SMS to the specified phone number.

 

Examples:

• Send an SMS with your location as a response to an SMS containing the text Where are you?
• Send an SMS to your partner when you are on your way home.

The action Send USSD Request sends a USSD request to the provider.

Warning: Some versions of Android don't properly handle USSD request failures so a dialog of the system might be shown when a USSD request fails which causes the action to timeout after 30 seconds.

 

Examples:

• Query the prepaid balance.

The action Send Wake on LAN Packet sends a Wake On LAN packet using UDP to the specified IP address and port.

 

Examples:

• Start your NAS daily at 6am

The action Set Airplane Mode sets the airplane mode of the phone on or off.

Warning: This function requires root access starting with Android 4.2 and is not officially supported by Android.

 

Examples:

• Reduce radiation at night by turning on the airplane mode.
• Turn on airplane mode to reduce battery usage when battery level is below 20%.

The action Set Alarm creates an alarm in the alarm app available on the device.

Warning: Not all alarm apps support all options.

The action Set App Notification Peekable changes the setting whether app notifications of an app can be emphasized by sliding briefly into view.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Turn the peekable setting off for some apps when watching a movie.

The action Set App Notification Priority changes the setting whether app notifications are important or not for a particular app.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Change the priority of mail notifications to unimportant at night.

The action Set App Notification State enables or disables the capability of an app to post notifications.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Prevent that an incoming call displays a notification when the device is surveyed in the background.

The action Set Audio Manager Mode changes the mode of the audio manager to either Normal, Ringtone or In call. The audio mode encompasses audio routing AND the behavior of the telephony layer.

The action Set Audio Stream Volume changes the volume of a audio stream of a specific type.

 

Examples:

• Reduce ringer volume when you are in your office.
• Increase music volume when you plug in the earphones.

The action Set Auto Sync State turns the automatic synchronisation on or off.

 

Examples:

• Turn the automatic synchronisation off at night.
• Turn off the automatic synchronisation of the company account on weekends.

The action Set Accelerometer Rotation turns on or off the Auto-rotate screen setting.

Note: An application can request to use the accelerometer for screen orientation changes, even when this setting is turned off.

The action Set Battery Saver Mode turns on the battery saver mode of the device (Android 5+). Battery saver mode can not be enabled when the device is charging.

Warning: This function does not work for manufacturer specific battery saving modes like Samsungs (Ultra-)energy saving mode or Sony and HTC specific modes. Please use action Set System Setting on such devices.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Turn on the battery saver at night when no charging adapter is available.

The action Set Bluetooth SCO State turns Bluetooth SCO for communications on or off.

 

Examples:

• Turn Bluetooth SCO off even when a headset is connected.

The action Set Bluetooth State turns Bluetooth globally on or off.

 

Examples:

• Turn Bluetooth on when the phone is connected to a power source.
• Turn Bluetooth off when the battery level is below 30%.

The action Set Bluetooth Tethering State turns Bluetooth tethering setting on or off.

Note: This action does not supply the Bluetooth tethering feature by itself, it only turns on the setting. Some providers remove the Bluetooth tethering feature. This action can not turn on tethering on such a phone.

Warning: This function is not officially supported by Android and might not work on all devices.
Warning: This function requires Android 3+.

 

The action Set Camera Usage State allows or denies the camera usage for apps.

 

Examples:

• Avoid that an app can use the camera for privacy reasons.

The action Set Car UI Mode puts the device into car UI mode.

Note: Not supported by all devices.

 

Examples:

• Launch the car dock UI mode of an app when you don't actually own the car dock.

The action Set Cyanogen/LineageOS Profile changes the currently set Cyanogen/LineageOS profile.

Warning: This function is not officially supported by Android and might not work on all devices.

 

Examples:

• Change the profile to 'at home' when the WiFi is connected.

The action Set Data Roaming State turns the global data roaming setting on or off.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

Example:

• Activate data roaming abroad every morning for 10 minutes to synchronize the mails and deactivate data roaming again for the rest of the day.

The action Set Default Input Method changes the current input method/keyboard.

Warning: This function requires root access, is not officially supported by Android and might not work on all devices.

 

Examples:

• Use Hacker's Keyboard in landscape mode and otherwise the default keyboard

The action Set Ringtone sets the default ringtone of the specified type (ringtone, alarm or notification).

 

Examples:

• Use a different ringtone at home.