plugins.core.action.manager.md

docs » plugins.core.action.manager

---

Action Manager Module.

API Overview

• Constants - Useful values which cannot be changed
• handlerIds
• handlers
• Functions - API calls offered directly by the extension
• addHandler
• getActivator
• getHandler
• getURL
• init

API Documentation

Constants

handlerIds

Signature	plugins.core.action.manager.handlerIds <cp.prop: table of strings; read-only>
Type	Constant
Description	Returns a list of registered handler IDs.

handlers

Signature	plugins.core.action.manager.handlers <cp.prop: table of handlers; read-only>
Type	Constant
Description	Provides access to the set of handlers registered with the manager. It

Functions

addHandler

Signature	plugins.core.action.manager.addHandler(id) -> handler
Type	Function
Description	Adds a new action handler with the specified unique ID and returns it for further configuration.
Parameters	id - The unique ID group - The group the handler belongs to. label - An optional label for the handler (over-riding a supplied i18n value)
Returns	The handler instance.

getActivator

Signature	plugins.core.action.manager.getActivator(id) -> activator
Type	Function
Description	Returns an activator with the specified ID. If it doesn't exist, it will be created.
Parameters	activatorId - The unique ID of the activator.
Returns	The activator with the specified ID.

getHandler

Signature	plugins.core.action.manager.getHandler(id) -> handler
Type	Function
Description	Returns an existing handler with the specified ID.
Parameters	id - The unique ID of the action handler.
Returns	The action handler, or nil

getURL

Signature	plugins.core.action.manager.getURL(handlerId, action) -> string
Type	Function
Description	Gets a URL based on the Handler ID & Action Table.
Parameters	handlerId - The Handler ID action The action table
Returns	A string

init

Signature	plugins.core.action.manager.init() -> none
Type	Function
Description	Initialises the module.
Parameters	None
Returns	None