Class Plugin`Abstract`

Index

Constructors

Methods

destroy getBoardActions getBoardProperties getCardActions getCardProperties getSettingsSchema init onAfterDeleteTask onBeforeAddTask onBeforeBoardUpdate onBoardUpdate onTaskFound onTaskUpdate

Constructors

constructor

new Plugin(project: Project): Plugin
Parameters
- project: Project
Returns Plugin
- Defined in plugin.ts:46

Methods

destroy

destroy(): void
Destroys the plugin instance.

Returns void
- Defined in plugin.ts:58

getBoardActions

getBoardActions(): BoardAction[]
Gets the actions available for the board.

Returns BoardAction[]
- The board actions.
- Defined in plugin.ts:144

getBoardProperties

getBoardProperties(): Object
Gets the properties of the board.

Returns Object
- The board properties.
- Defined in plugin.ts:125

getCardActions

getCardActions(task: Task): CardAction[]
Gets the actions available for a card.
Parameters
- task: Task
  The task associated with the card.
Returns CardAction[]
- The card actions.
- Defined in plugin.ts:135

getCardProperties

getCardProperties(task: Task): Object
Gets the properties of a card.
Parameters
- task: Task
  The task associated with the card.
Returns Object
- The card properties.
- Defined in plugin.ts:116

getSettingsSchema

getSettingsSchema(): Settings
Gets the settings schema.

Returns Settings
- The settings schema.
- Defined in plugin.ts:153

init

init(): Promise<void>
Returns Promise<void>
- Defined in plugin.ts:51

onAfterDeleteTask

onAfterDeleteTask(task: Task): void
Hook that is called after a task is deleted.
Parameters
- task: Task
  The deleted task.
Returns void
- Defined in plugin.ts:107

onBeforeAddTask

onBeforeAddTask(
request: OnBeforeAddTaskRequest,
): Promise<OnBeforeAddTaskResponse>
Hook that is called before a task is added.
Parameters
- request: OnBeforeAddTaskRequest
  The request object containing task details.
Returns Promise<OnBeforeAddTaskResponse>
- The response object containing task details.
- Defined in plugin.ts:65

onBeforeBoardUpdate

onBeforeBoardUpdate(): Promise<void>
Hook that is called before the board is updated.

Returns Promise<void>
- Defined in plugin.ts:74

onBoardUpdate

onBoardUpdate(lists: List[]): Promise<void>
Hook that is called when the board is updated.
Parameters
- lists: List[]
  The updated lists.
Returns Promise<void>
- Defined in plugin.ts:82

onTaskFound

onTaskFound(task: Task): Promise<void>
Hook that is called when a task is found.
Parameters
- task: Task
  The found task.
Returns Promise<void>
- Defined in plugin.ts:99

onTaskUpdate

onTaskUpdate(task: Task): void
Hook that is called when a task is updated.
Parameters
- task: Task
  The updated task.
Returns void
- Defined in plugin.ts:90