dockIconClickCallback

​
Callback which triggers when the CommandPost Dock Icon is clicked
API Overview
Methods - API calls which can only be made on an object returned by a constructor
​callbackFn​
​get​
​getAll​
​id​
​new​
API Documentation
Methods
​callbackFn​
Signature
cp.config.dockIconClickCallback:callbackFn() -> function
Type
Method
Description
Returns the callbackFn of the current Dock Icon Click Callback
Parameters
None
Returns
The callbackFn of the current Shutdown Callback
​get​
Signature
cp.config.dockIconClickCallback:get(id) -> table
Type
Method
Description
Creates a new Dock Icon Click Callback.
Parameters
id - The unique ID for the callback you want to return.
Returns
table containing the callback
​getAll​
Signature
cp.config.dockIconClickCallback:getAll() -> table
Type
Method
Description
Returns all of the created Dock Icon Click Callbacks
Parameters
None
Returns
table containing all of the created callbacks
​id​
Signature
cp.config.dockIconClickCallback:id() -> string
Type
Method
Description
Returns the ID of the current Dock Icon Click Callback
Parameters
None
Returns
The ID of the current File Dropped to Dock Icon Callback as a string
​new​
Signature
cp.config.dockIconClickCallback:new(id, callbackFn) -> table
Type
Method
Description
Creates a new File Dropped to Dock Icon Callback.
Parameters
id - The unique ID for this callback.
Returns
table that has been created

Last modified 1yr ago

Signature	`cp.config.dockIconClickCallback:callbackFn() -> function`
Type	Method
Description	Returns the callbackFn of the current Dock Icon Click Callback
Parameters	None
Returns	The callbackFn of the current Shutdown Callback

Signature	`cp.config.dockIconClickCallback:get(id) -> table`
Type	Method
Description	Creates a new Dock Icon Click Callback.
Parameters	`id` - The unique ID for the callback you want to return.
Returns	table containing the callback

Signature	`cp.config.dockIconClickCallback:getAll() -> table`
Type	Method
Description	Returns all of the created Dock Icon Click Callbacks
Parameters	None
Returns	table containing all of the created callbacks

Signature	`cp.config.dockIconClickCallback:id() -> string`
Type	Method
Description	Returns the ID of the current Dock Icon Click Callback
Parameters	None
Returns	The ID of the current File Dropped to Dock Icon Callback as a `string`

Signature	`cp.config.dockIconClickCallback:new(id, callbackFn) -> table`
Type	Method
Description	Creates a new File Dropped to Dock Icon Callback.
Parameters	`id` - The unique ID for this callback.
Returns	table that has been created

dockIconClickCallback

API Overview

API Documentation

Methods

​callbackFn​

​get​

​getAll​

​id​

​new​

callbackFn

get

getAll

id

new