plugins.core.touchbar.manager.widgets.md

docs » plugins.core.touchbar.manager.widgets

---

Touch Bar Widgets Manager

API Overview

• Variables - Configurable values
• widgets
• Functions - API calls offered directly by the extension
• allGroups
• Methods - API calls which can only be made on an object returned by a constructor
• get
• getAll
• id
• new
• params

API Documentation

Variables

widgets

Signature	plugins.core.touchbar.manager.widgets -> table
Type	Variable
Description	Widget Manager

Functions

allGroups

Signature	plugins.core.touchbar.manager.widgets.allGroups() -> table
Type	Function
Description	Returns a table containing all of the widget groups.
Parameters	None
Returns	Table

Methods

get

Signature	plugins.core.touchbar.manager.widgets:get(id) -> table
Type	Method
Description	Gets a Touch Bar widget
Parameters	id - The unique ID for the widget you want to return.
Returns	table containing the widget

getAll

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

id

Signature	plugins.core.touchbar.manager.widgets:id() -> string
Type	Method
Description	Returns the ID of the widget
Parameters	None
Returns	The ID of the widget as a string

new

Signature	plugins.core.touchbar.manager.widgets:new(id, params) -> table
Type	Method
Description	Creates a new Touch Bar Widget.
Parameters	id - The unique ID for this widget.
Returns	table that has been created

params

Signature	plugins.core.touchbar.manager.widgets:params() -> function
Type	Method
Description	Returns the paramaters of the widget
Parameters	None
Returns	The paramaters of the widget