plugins.core.watchfolders.manager.md

docs » plugins.core.watchfolders.manager

---

Manager for the CommandPost Watch Folders Panel.

Submodules

• plugins.core.watchfolders.manager.panel

API Overview

• Constants - Useful values which cannot be changed
• position
• Functions - API calls offered directly by the extension
• addPanel
• init
• showPreferences

API Documentation

Constants

position

Signature	plugins.core.watchfolders.manager.position <cp.prop: table>
Type	Constant
Description	Returns the last frame saved in settings.

Functions

addPanel

Signature	plugins.core.watchfolders.manager.addPanel(params) -> plugins.core.watchfolders.manager.panel
Type	Function
Description	Adds a new panel with the specified params to the preferences manager.
Parameters	params - The parameters table. Details below.
Returns	The new panel instance.
Notes	The params can have the following properties. The priority and id and properties are required. ** priority - An integer value specifying the priority of the panel compared to others. ** id - A string containing the unique ID of the panel. ** label - The human-readable label for the panel icon. ** image - The hs.image for the panel icon. ** tooltip - The human-readable details for the toolbar icon when the mouse is hovering over it.

init

Signature	plugins.core.watchfolders.manager.init() -> nothing
Type	Function
Description	Initialises the preferences panel.
Parameters	* None
Returns	* Nothing

showPreferences

Signature	plugins.core.watchfolders.manager.showPreferences() -> boolean
Type	Function
Description	Shows the Preferences Window
Parameters	None
Returns	True if successful or nil if an error occurred