plugins.core.touchbar.location.md

docs » plugins.core.touchbar.location

---

Virtual Touch Bar Update Location Callback

API Overview

• Methods - API calls which can only be made on an object returned by a constructor
• callbackFn
• delete
• get
• getAll
• id
• new

API Documentation

Methods

callbackFn

Signature	plugins.core.touchbar.location:callbackFn() -> function
Type	Method
Description	Returns the callbackFn of the current Update Location Callback
Parameters	None
Returns	The callbackFn of the current Shutdown Callback

delete

Signature	plugins.core.touchbar.location:delete() -> none
Type	Method
Description	Deletes a Update Location Callback based on an ID.
Parameters	None
Returns	None

get

Signature	plugins.core.touchbar.location:get(id) -> table
Type	Method
Description	Gets an Update Location Callback based on an ID.
Parameters	id - The unique ID for the callback you want to return.
Returns	table containing the callback

getAll

Signature	plugins.core.touchbar.location:getAll() -> table
Type	Method
Description	Returns all of the created Update Location Callbacks
Parameters	None
Returns	table containing all of the created callbacks

id

Signature	plugins.core.touchbar.location:id() -> string
Type	Method
Description	Returns the ID of the current Update Location Callback
Parameters	None
Returns	The ID of the current File Dropped to Dock Icon Callback as a string

new

Signature	plugins.core.touchbar.location:new(id, callbackFn) -> table
Type	Method
Description	Creates a new Update Location Callback
Parameters	id - The unique ID for this callback.
Returns	table that has been created