Getting Started
Apps & Automation
User Interaction
Files & Documents
Intelligence
Security
System & Hardware
API Reference
open()
open_with()
notify()
say()
screenshot()
accent_color()
set_accent_color()
ACCENT_COLORS
set_auto_mode()
font_smoothing()
set_font_smoothing()
set_hide_menu_bar()
is_auto()
is_dark()
menu_bar_hidden()
mode()
set_mode()
scroll_bars()
set_scroll_bars()
wait_for_change()
add_login_item()
App
default_browser()
default_for()
set_default_for()
frontmost()
get()
installed()
InstalledApp
install_from_dmg()
is_quarantined()
LoginItem
login_items()
remove_login_item()
running()
uninstall()
unquarantine()
AudioInfo
classify()
concat()
convert()
default_input()
default_output()
Device
devices()
fade()
gain()
has_permission()
info()
set_input()
input_level()
input_muted()
inputs()
input_volume()
set_input_volume()
mute_input()
set_output()
outputs()
record()
record_until_silence()
request_permission()
reverse()
speed()
trim()
confirm()
is_available()
required()
connect()
disconnect()
power()
set_power()
BROWSERS
current_tab()
run_js()
Tab
tabs()
Camera
photo()
change_count()
clear()
copy()
copy_files()
copy_image()
has_image()
paste()
paste_files()
paste_image()
watch()
delete()
GLOBAL
keys()
read()
restored()
write()
alert()
choose()
choose_file()
choose_files()
choose_folder()
prompt()
add_app()
add_folder()
add_spacer()
apps()
autohide()
set_autohide()
autohide_delay()
set_autohide_delay()
autohide_duration()
set_autohide_duration()
auto_rearrange_spaces()
set_auto_rearrange_spaces()
dim_hidden_apps()
set_dim_hidden_apps()
DockApp
DockFolder
folders()
group_windows_by_app()
set_group_windows_by_app()
set_hot_corner()
HOT_CORNER_ACTIONS
hot_corner_modifiers()
hot_corners()
launch_animation()
set_launch_animation()
magnification()
set_magnification()
minimize_effect()
set_minimize_effect()
minimize_to_app()
set_minimize_to_app()
only_open_apps()
set_only_open_apps()
position()
set_position()
remove_app()
remove_folder()
remove_spacers()
restart()
separate_spaces_per_display()
set_separate_spaces_per_display()
show_indicators()
set_show_indicators()
show_recents()
set_show_recents()
size()
set_size()
switch_to_space_with_app()
set_switch_to_space_with_app()
text()
Event
Handler
NAMES
off()
on()
run()
stop()
wait()
add_tags()
compress()
current_folder()
default_view()
set_default_view()
desktop_view()
set_desktop_view()
drives_on_desktop()
extension_change_warning()
set_extension_change_warning()
extract()
folders_first()
set_folders_first()
has_custom_icon()
set_icon()
is_alias()
largest()
make_alias()
new_window_folder()
set_new_window_folder()
quick_look()
quit_menu()
set_quit_menu()
remove_icon()
remove_old_trash_items()
set_remove_old_trash_items()
remove_tags()
resolve_alias()
reveal()
search_scope()
set_search_scope()
selection()
show_desktop_icons()
set_show_desktop_icons()
set_show_drives_on_desktop()
show_extensions()
set_show_extensions()
show_full_path_in_title()
set_show_full_path_in_title()
show_hidden_files()
set_show_hidden_files()
show_library_folder()
set_show_library_folder()
show_path_bar()
set_show_path_bar()
show_status_bar()
set_show_status_bar()
tags()
set_tags()
thumbnail()
trash()
Hotkey
register()
unregister()
blur_background()
blur_faces()
contact_sheet()
crop()
dominant_colors()
effect()
enhance()
flip()
ImageInfo
location()
set_location()
metadata()
qr_code()
replace_background()
resize()
rotate()
straighten()
strip_metadata()
taken_at()
set_taken_at()
watermark()
set_app_shortcut()
app_shortcuts()
auto_brightness()
set_auto_brightness()
auto_capitalization()
set_auto_capitalization()
autocorrect()
set_autocorrect()
backlight_timeout()
set_backlight_timeout()
brightness()
set_brightness()
caps_lock()
clear_remappings()
double_space_period()
set_double_space_period()
fn_key_action()
set_fn_key_action()
full_keyboard_access()
set_full_keyboard_access()
hold()
inline_predictions()
set_inline_predictions()
KeyPress
key_repeat()
set_key_repeat()
layout()
set_layout()
layouts()
press()
press_and_hold()
set_press_and_hold()
remap()
remappings()
smart_dashes()
set_smart_dashes()
smart_quotes()
set_smart_quotes()
standard_function_keys()
set_standard_function_keys()
set_system_shortcut()
SYSTEM_SHORTCUTS
system_shortcuts()
type()
accounts()
set()
detect()
embedding()
entities()
Entity
guess()
keywords()
sentiment()
similarity()
directions()
geocode()
Place
reverse_geocode()
acceleration()
set_acceleration()
Click
click()
click_text()
double_click_speed()
set_double_click_speed()
drag()
move()
scroll()
scroll_speed()
set_scroll_speed()
tracking_speed()
set_tracking_speed()
next()
now_playing()
pause()
play()
play_pause()
previous()
seek()
Track
volume()
set_volume()
Bandwidth
bandwidth()
connect_vpn()
disconnect_vpn()
dns_servers()
interface()
interfaces()
ip()
is_online()
NetworkInterface
Proxies
proxies()
SpeedTest
speed_test()
VPN
vpns()
wifi_power()
set_wifi_power()
WiFiSignal
wifi_signal()
is_allowed()
add_text()
Bookmark
bookmarks()
set_bookmarks()
encrypt()
fill_form()
FormField
form_fields()
from_images()
grayscale()
images()
merge()
Metadata
ocr()
page_count()
redact()
Redaction
render()
sign()
Adapter
adapter()
Battery
battery()
keep_awake()
low_power_mode()
sleep()
SleepBlocker
sleep_blockers()
sleep_display()
cancel()
default()
set_default()
jobs()
Printer
printers()
print_file()
PrintJob
add()
Job
remove()
resume()
run_now()
color_at()
Display
DisplayMode
display_mode()
set_display_mode()
display_modes()
displays()
find_text()
is_asleep()
is_locked()
lock()
set_main_display()
mirror()
mirrored()
night_shift()
set_night_shift()
night_shift_schedule()
set_night_shift_schedule()
night_shift_strength()
set_night_shift_strength()
screensaver_delay()
set_screensaver_delay()
screenshot_folder()
set_screenshot_folder()
screenshot_format()
set_screenshot_format()
screenshot_name()
set_screenshot_name()
screenshot_shadow()
set_screenshot_shadow()
screenshot_target()
set_screenshot_target()
screenshot_thumbnail()
set_screenshot_thumbnail()
start_screensaver()
stop_mirroring()
TextMatch
true_tone()
set_true_tone()
wait_for_text()
wallpaper()
set_wallpaper()
apply()
export()
names()
list()
alert_sound()
set_alert_sound()
alert_volume()
set_alert_volume()
beep()
ui_sounds()
set_ui_sounds()
Voice
voices()
search()
search_name()
available_updates()
battery_percentage_shown()
build()
camera_in_use()
clock_format()
set_clock_format()
computer_name()
Connection
connections()
cpu_usage()
CrashReport
crash_reports()
DiskHealth
disk_health()
ds_store_on_network()
set_ds_store_on_network()
ds_store_on_usb()
set_ds_store_on_usb()
eject()
EnergyUsage
energy_usage()
expanded_save_dialog()
set_expanded_save_dialog()
fonts()
GPUUsage
gpu_usage()
idle_time()
keep_windows_on_quit()
set_keep_windows_on_quit()
kill()
lid_closed()
LogEntry
logs()
measurement_units()
set_measurement_units()
memory()
MemoryUsage
memory_usage()
MENU_BAR_ITEMS
menu_bar_items()
set_menu_bar_items()
menu_bar_spacing()
set_menu_bar_spacing()
microphone_in_use()
model()
model_identifier()
mount_image()
NetworkUsage
network_usage()
open_files()
open_photos_on_device_connect()
set_open_photos_on_device_connect()
Port
port_owner()
ports()
Process
process()
processes()
processor()
save_to_icloud_by_default()
set_save_to_icloud_by_default()
SecurityStatus
security_status()
set_show_battery_percentage()
StartupItem
startup_items()
temperature_unit()
set_temperature_unit()
thermal_state()
unmount_image()
Update
uptime()
USBDevice
usb_devices()
version()
Volume
volumes()
wait_for_activity()
wait_for_idle()
who_uses()
backup_now()
destinations()
exclude()
include()
is_backing_up()
is_excluded()
last_backup()
progress()
stop_backup()
click_pressure()
set_click_pressure()
set_gesture()
GESTURES
gestures()
natural_scrolling()
set_natural_scrolling()
secondary_click()
set_secondary_click()
tap_to_click()
set_tap_to_click()
three_finger_drag()
set_three_finger_drag()
add_audio()
add_language_track()
frame()
frames()
mute()
to_gif()
VideoInfo
Aesthetics
aesthetics()
Animal
animals()
Barcode
barcodes()
best_shot()
body_pose()
duplicates()
faces()
Hand
hand_pose()
horizon()
image_distance()
languages()
lines()
Pose
remove_background()
scan_document()
smart_crop()
TextLine
is_muted()
unmute()
animations()
set_animations()
click_wallpaper_to_show_desktop()
set_click_wallpaper_to_show_desktop()
double_click_title_bar()
set_double_click_title_bar()
focused()
LAYOUTS
tile()
tile_all()
tiling()
set_tiling()
wait_for()
Window
MacOSError
NotSupportedError
PermissionDeniedError
AppNotFoundError
ShortcutNotFoundError
KeychainError
CommandError
Project