Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Chain

Hierarchy

Index

Constructors

constructor

Properties

delayNextAction

delayNextAction: Initializer.ChainDelayNextAction

Delays the next action. For most cases manually managing the execution of actions in JavaScript should be sufficient - using this will block any new action that BTT will recieve

param

time in miliseconds during any action execution will be delayed

executeScript

executeScript: Initializer.ChainExecuteScript

Executes passed nodejs script. Requires manual specificying of node executable binary if used on frontend

param

a code to run

hapticFeedback

hapticFeedback: Initializer.ChainHapticFeedback

Triggers a haptic response. Takes a number as a param due to BTT lack of information which ID represents which mode, in order to know what value represents what open BTT and map the order of selects options in config of "Perform Haptic Feedback on Trackpad" action

param

a number representing each mode.

launchApplication

launchApplication: Initializer.ChainLaunchApplication

Open an application on the given path

lockScreen

lockScreen: Initializer.ChainLockScreen

Locks the screen

logout

logout: Initializer.ChainLogout

Logouts current user

moveMouse

moveMouse: Initializer.ChainMoveMouse

Moves mouse to specified position

mute

mute: Initializer.ChainMute

Toggles the mute state in the system

quit

quit: Initializer.ChainQuitBTT

Quits BetterTouchTool

restart

restart: Initializer.ChainRestartBTT

Restarts BetterTouchTool

saveSelectedText

saveSelectedText: Initializer.ChainSaveSelectedText

Saves selected text to variable selected_text This can be later retrieved via btt.state.get('selected_text')

sendShortcut

sendShortcut: Initializer.ChainSendShortcut

Sends shortcut to txhe application. Some apps need to have focus so they can recieve shortcuts.

param

key identifiers separated by space

param

absolute path pointing to the app which should recieve shortcut

param

required for BTT to recognize the app, whithin browser env must be provided manually

sendText

sendText: Initializer.ChainSendText

Sends / Types / Inserts / Pastes custom text

showHUD

showHUD: Initializer.ChainShowHUD

Shows HUD with given config

showNotification

showNotification: Initializer.ChainShowNotification

Shows system wide notification. Keep in mind that it's presence depends on the DnD state in the system.

showWebView

showWebView: Initializer.ChainShowWebView

Opens a web view

sleepComputer

sleepComputer: Initializer.ChainSleepComputer

Sleeps computer

sleepDisplay

sleepDisplay: Initializer.ChainSleepDisplay

Sleeps computer display

startSiri

startSiri: Initializer.ChainStartSiri

Starts Siri

toggle

toggle: Initializer.ChainToggleBTT

Toggles the BetterTouchTool gesture recognition

toggleApplication

toggleApplication: Initializer.ChainToggleApplication

Toggles the visibility of given application

toggleDarkMode

toggleDarkMode: Initializer.ChainToggleDarkMode

Toggles the system dark mode

toggleDnD

toggleDnD: Initializer.ChainToggleDnD

Toggles do not disturb mode

toggleMouseCursor

toggleMouseCursor: Initializer.ChainToggleMouseCursor

Toggles mouse cursor visibility

toggleMouseSize

toggleMouseSize: Initializer.ChainToggleMouseSize

Toggles between the big and regular mouse cursor size

toggleMouseSpeed

toggleMouseSpeed: Initializer.ChainToggleMouseSpeed

Toggles the mouse speed between a regular and speeded up one

toggleNightShift

toggleNightShift: Initializer.ChainToggleNightShift

Toggles night shift

toggleTrueTone

toggleTrueTone: Initializer.ChainToggleTrueTone

Toggles do not disturb mode

triggerShortcut

triggerShortcut: Initializer.ChainTriggerShortcut

Triggers system wide keyboard shortcut

param

key identifiers separated by space

Methods

call

clear

  • clear(): this

wait

  • wait(timeout: number): this
  • Allows to delay the action execution from JavaScript side. Time in ms

    Parameters

    • timeout: number

    Returns this