Class AShowHUD

This action is responsible for showing a BetterTouchTool HUD. The HUD cannot be blocked by do-not-disturb mode or anything and it cannot be closed - it'll fade out on its own

Hierarchy

BaseAction
- AShowHUD

Index

Constructors

constructor

Accessors

Methods

invoke

Constructors

constructor

new AShowHUD(config: AppConfig, ...args: any[]): AShowHUD

Inherited from BaseAction.constructor
- Defined in abstract/base-action.ts:13
A constructor for the Action

Parameters
- config: AppConfig
- Rest ...args: any[]
Returns AShowHUD

Accessors

data

get data(): object

- Defined in common/actions/showHUD.ts:13
Returns object
- HUDActionConfiguration: string

json

get json(): Types.BttPayload

Inherited from BaseAction.json
- Defined in abstract/base-action.ts:28
Returns JSON structure for the current action. Must be overriden by instances

Returns Types.BttPayload

url

get url(): string

Inherited from BaseAction.url
- Defined in abstract/base-action.ts:59
Returns the url of the given action, that this library generates Visiting the returned value in browser (or calling it from backend) will invoke this particular action on the mac specified in initial configuration

Returns string

Methods

invoke

invoke(): Promise<CallResult | any>

Inherited from BaseAction.invoke
- Defined in abstract/base-action.ts:75
Calls the prepared action

Returns Promise<CallResult | any>