Skip to content

plugin

Implemented by every plugin.

info() → plugin-info

Describe the plugin. Called once when the plugin is loaded, before start.

start()

Called when the plugin is enabled.

stop()

Called when the plugin is disabled. Timers are cancelled automatically.

on-event(event: event)

Receive an event. See event-kind for which events need a subscription.

pre-send(message: outgoing-message) → send-decision

Inspect or change a message before it is sent.

pre-edit(edit: outgoing-edit) → send-decision

Inspect or change an edit before it is saved.

message-accessories(message: message) → list<element>

Elements shown below a message’s content.

message-decorations(message: message) → list<element>

Elements shown next to a message author’s name.

message-popover-buttons(message: message) → list<popover-button>

Buttons added to a message’s hover toolbar.

chat-bar-buttons(context: chat-bar-context) → list<chat-bar-button>

Buttons added next to the message input.

context-menu(target: menu-target) → list<menu-item>

Items added to a context menu.

profile-sections(context: profile-context) → list<element>

Sections added to a user profile.

user-badges(context: profile-context) → list<badge>

Badges added to a user profile.

member-decorations(context: member-context) → list<element>

Elements shown next to a user in the member list and DM list.

server-list-elements() → list<element>

Elements added to the server list.

settings-panel() → option<element>

Custom settings UI shown below the plugin’s declared settings.