config

Last updated 9 months ago

Manage CommandPost's constants and settings.
Submodules
​cp.config.dockIconClickCallback​
​cp.config.fileDroppedToDockIconCallback​
​cp.config.shutdownCallback​
​cp.config.textDroppedToDockIconCallback​
API Overview
Constants - Useful values which cannot be changed
​appName​
​appVersion​
​assetsPath​
​basePath​
​bundledPluginsPath​
​bundleID​
​cachePath​
​configPrefix​
​developerMode​
​iconPath​
​languagePath​
​menubarIconPath​
​pluginPaths​
​privacyPolicyURL​
​processID​
​scriptPath​
​sourceExtensions​
​sourceWatcher​
​translationURL​
​userConfigRootPath​
​userPluginsPath​
Variables - Configurable values
​automaticScriptReloading​
Functions - API calls offered directly by the extension
​application​
​get​
​prop​
​reset​
​set​
​unwatch​
​watch​
Fields - Variables which can only be accessed from an object returned by a constructor
​frontmost​
API Documentation
Constants
​appName​
Signature
cp.config.appName -> string
Type
Constant
Description
The name of the Application
​appVersion​
Signature
cp.config.appVersion -> string
Type
Constant
Description
Prefix used for Configuration Settings
​assetsPath​
Signature
cp.config.assetsPath -> string
Type
Constant
Description
Path to where Application Assets are stored
​basePath​
Signature
cp.config.basePath -> string
Type
Constant
Description
Path to where the Extensions & Plugins folders are stored.
​bundledPluginsPath​
Signature
cp.config.bundledPluginsPath -> string
Type
Constant
Description
The path to bundled plugins
​bundleID​
Signature
cp.config.bundleID -> string
Type
Constant
Description
Application's Bundle ID
​cachePath​
Signature
cp.config.cachePath -> string
Type
Constant
Description
The path to the CommandPost Cache folder.
​configPrefix​
Signature
cp.config.configPrefix -> string
Type
Constant
Description
Prefix used for Configuration Settings
​developerMode​
Signature
cp.config.developerMode <cp.prop: boolean>
Type
Constant
Description
When true, the app is in developer mode.
​iconPath​
Signature
cp.config.iconPath -> string
Type
Constant
Description
Path to the Application Icon
​languagePath​
Signature
cp.config.languagePath -> string
Type
Constant
Description
Path to the Languages Folder
​menubarIconPath​
Signature
cp.config.menubarIconPath -> string
Type
Constant
Description
Path to the Menubar Application Icon
​pluginPaths​
Signature
cp.config.pluginPaths -> table
Type
Constant
Description
Table of Plugins Paths. Earlier entries take precedence.
​privacyPolicyURL​
Signature
cp.config.privacyPolicyURL -> string
Type
Constant
Description
URL for Privacy Policy
​processID​
Signature
cp.config.processID -> number
Type
Constant
Description
Application's Process ID
​scriptPath​
Signature
cp.config.scriptPath -> string
Type
Constant
Description
Path to where Application Scripts are stored
​sourceExtensions​
Signature
cp.config.sourceExtensions -> table
Type
Constant
Description
Extensions for files which will trigger a reload when modified.
​sourceWatcher​
Signature
cp.config.sourceWatcher -> SourceWatcher
Type
Constant
Description
A cp.sourcewatcher that will watch for source files and reload CommandPost if any change.
​translationURL​
Signature
cp.config.translationURL -> string
Type
Constant
Description
URL for Translations
​userConfigRootPath​
Signature
cp.config.userConfigRootPath -> string
Type
Constant
Description
The path to user configuration folders
​userPluginsPath​
Signature
cp.config.userPluginsPath -> string
Type
Constant
Description
The path to user plugins
Variables
​automaticScriptReloading​
Signature
cp.config.automaticScriptReloading <cp.prop: boolean>
Type
Variable
Description
Automatic Script Reloading.
Functions
​application​
Signature
cp.config.application() -> hs.application object
Type
Function
Description
Returns the Application as a hs.application object
Parameters
​
Returns
​
​get​
Signature
cp.config.get(key[, defaultValue]) -> string or boolean or number or nil or table or binary data
Type
Function
Description
Loads a setting
Parameters
​
Returns
​
​prop​
Signature
cp.config.prop(key[, defaultValue]) -> cp.prop
Type
Function
Description
Returns a cp.prop instance connected to the value of the specified key. When the value is modified, it will be notified.
Parameters
​
Returns
​
​reset​
Signature
cp.config.reset()
Type
Function
Description
Resets all the settings for the Application
Parameters
​
Returns
​
​set​
Signature
cp.config.set(key, value)
Type
Function
Description
Saves a setting with common datatypes
Parameters
​
Returns
​
Notes
​
​unwatch​
Signature
cp.config.unwatch(id)
Type
Function
Description
Unregisters the watcher with the specified ID.
Parameters
​
Returns
​
​watch​
Signature
cp.config.watch(events) -> id
Type
Function
Description
Watches for config events.
Parameters
​
Returns
​
Notes
​
Fields
​frontmost​
Signature
cp.config.frontmost <cp.prop: boolean; read-only>
Type
Field
Description
Returns whether or not the Application is frontmost.

builder

dockIconClickCallback

Signature	`cp.config.appName -> string`
Type	Constant
Description	The name of the Application

Signature	`cp.config.appVersion -> string`
Type	Constant
Description	Prefix used for Configuration Settings

Signature	`cp.config.assetsPath -> string`
Type	Constant
Description	Path to where Application Assets are stored

Signature	`cp.config.basePath -> string`
Type	Constant
Description	Path to where the Extensions & Plugins folders are stored.

Signature	`cp.config.bundledPluginsPath -> string`
Type	Constant
Description	The path to bundled plugins

Signature	`cp.config.bundleID -> string`
Type	Constant
Description	Application's Bundle ID

Signature	`cp.config.cachePath -> string`
Type	Constant
Description	The path to the CommandPost Cache folder.

Signature	`cp.config.configPrefix -> string`
Type	Constant
Description	Prefix used for Configuration Settings

Signature	`cp.config.developerMode <cp.prop: boolean>`
Type	Constant
Description	When `true`, the app is in developer mode.

Signature	`cp.config.iconPath -> string`
Type	Constant
Description	Path to the Application Icon

Signature	`cp.config.languagePath -> string`
Type	Constant
Description	Path to the Languages Folder

Signature	`cp.config.menubarIconPath -> string`
Type	Constant
Description	Path to the Menubar Application Icon

Signature	`cp.config.pluginPaths -> table`
Type	Constant
Description	Table of Plugins Paths. Earlier entries take precedence.

Signature	`cp.config.privacyPolicyURL -> string`
Type	Constant
Description	URL for Privacy Policy

Signature	`cp.config.processID -> number`
Type	Constant
Description	Application's Process ID

Signature	`cp.config.scriptPath -> string`
Type	Constant
Description	Path to where Application Scripts are stored

Signature	`cp.config.sourceExtensions -> table`
Type	Constant
Description	Extensions for files which will trigger a reload when modified.

Signature	`cp.config.sourceWatcher -> SourceWatcher`
Type	Constant
Description	A `cp.sourcewatcher` that will watch for source files and reload CommandPost if any change.

Signature	`cp.config.translationURL -> string`
Type	Constant
Description	URL for Translations

Signature	`cp.config.userConfigRootPath -> string`
Type	Constant
Description	The path to user configuration folders

Signature	`cp.config.userPluginsPath -> string`
Type	Constant
Description	The path to user plugins

Signature	`cp.config.automaticScriptReloading <cp.prop: boolean>`
Type	Variable
Description	Automatic Script Reloading.

Signature	`cp.config.application() -> hs.application object`
Type	Function
Description	Returns the Application as a hs.application object
Parameters
Returns

Signature	`cp.config.get(key[, defaultValue]) -> string or boolean or number or nil or table or binary data`
Type	Function
Description	Loads a setting
Parameters
Returns

Signature	`cp.config.prop(key[, defaultValue]) -> cp.prop`
Type	Function
Description	Returns a `cp.prop` instance connected to the value of the specified key. When the value is modified, it will be notified.
Parameters
Returns

config

Submodules

API Overview

API Documentation

Constants

​appName​

​appVersion​

​assetsPath​

​basePath​

​bundledPluginsPath​

​bundleID​

​cachePath​

​configPrefix​

​developerMode​

​iconPath​

​languagePath​

​menubarIconPath​

​pluginPaths​

​privacyPolicyURL​

​processID​

​scriptPath​

​sourceExtensions​

​sourceWatcher​

​translationURL​

​userConfigRootPath​

​userPluginsPath​

Variables

​automaticScriptReloading​

Functions

​application​

​get​

​prop​

​reset​

​set​

​unwatch​

​watch​

Fields

​frontmost​

appName

appVersion

assetsPath

basePath

bundledPluginsPath

bundleID

cachePath

configPrefix

developerMode

iconPath

languagePath

menubarIconPath

pluginPaths

privacyPolicyURL

processID

scriptPath

sourceExtensions

sourceWatcher

translationURL

userConfigRootPath

userPluginsPath

automaticScriptReloading

application

get

prop

reset

set

unwatch

watch

frontmost

Signature	`cp.config.reset()`
Type	Function
Description	Resets all the settings for the Application
Parameters
Returns

Signature	`cp.config.set(key, value)`
Type	Function
Description	Saves a setting with common datatypes
Parameters
Returns
Notes

Signature	`cp.config.unwatch(id)`
Type	Function
Description	Unregisters the watcher with the specified ID.
Parameters
Returns

Signature	`cp.config.watch(events) -> id`
Type	Function
Description	Watches for config events.
Parameters
Returns
Notes

Signature	`cp.config.frontmost <cp.prop: boolean; read-only>`
Type	Field
Description	Returns whether or not the Application is frontmost.