2.5 KiB
2.5 KiB
Plugin API
NOTE: This file is generated automatically.
Scroll down to PluginAPI for a list of properties available to plugins.
Typedefs
- PluginAPI :
object - PluginCommandsAPI :
object - PluginAttachmentsAPI :
object - PluginLogsAPI :
object - PluginHooksAPI :
object
PluginAPI : object
Kind: global typedef
Properties
| Name | Type |
|---|---|
| bot | Client |
| knex | Knex |
| config | ModmailConfig |
| commands | PluginCommandsAPI |
| attachments | PluginAttachmentsAPI |
| logs | PluginLogsAPI |
| hooks | PluginHooksAPI |
| formats | FormattersExport |
PluginCommandsAPI : object
Kind: global typedef
Properties
| Name | Type |
|---|---|
| manager | CommandManager |
| addGlobalCommand | AddGlobalCommandFn |
| addInboxServerCommand | AddInboxServerCommandFn |
| addInboxThreadCommand | AddInboxThreadCommandFn |
| addAlias | AddAliasFn |
PluginAttachmentsAPI : object
Kind: global typedef
Properties
| Name | Type |
|---|---|
| addStorageType | AddAttachmentStorageTypeFn |
| downloadAttachment | DownloadAttachmentFn |
PluginLogsAPI : object
Kind: global typedef
Properties
| Name | Type |
|---|---|
| addStorageType | AddLogStorageTypeFn |
| saveLogToStorage | SaveLogToStorageFn |
| getLogUrl | GetLogUrlFn |
| getLogFile | GetLogFileFn |
| getLogCustomResponse | GetLogCustomResponseFn |
PluginHooksAPI : object
Kind: global typedef
Properties
| Name | Type |
|---|---|
| beforeNewThread | AddBeforeNewThreadHookFn |
| afterThreadClose | AddAfterThreadCloseHookFn |