mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-04 04:33:23 +00:00
sammyette
4150001d8b
* fix: make lua implemented hilbish interfaces documented * fix: signature link in table of contents * fix: reduce function list to match in go generated docs * fix: toc appending * docs: enable docs for hilbish.messages * feat: add description gen, and more spacing between param listing * docs: add more detailed documentation for lua modules * docs: update hilbish.messages docs * fix: add description for lua doc'd modules, remove duplicate docs * docs: add back hilbish.jobs doc * feat: generate toc for lua modules * fix: add table heading * ci: add lua docgen * docs: put dirs.old doc on 1 line
2.8 KiB
2.8 KiB
| title | description | layout | menu | ||||
|---|---|---|---|---|---|---|---|
| Module hilbish.messages | simplistic message passing | doc |
|
Introduction
The messages interface defines a way for Hilbish-integrated commands,
user config and other tasks to send notifications to alert the user.z
The hilbish.message type is a table with the following keys:
title (string): A title for the message notification.
text (string): The contents of the message.
channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks.
summary (string): A short summary of the text.
icon (string): Unicode (preferably standard emoji) icon for the message notification
read (boolean): Whether the full message has been read or not.
Functions
| unreadCount() | Returns the amount of unread messages. |
| readAll() | Marks all messages as read. |
| send(message) | Sends a message. |
| read(idx) | Marks a message at idx as read. |
| delete(idx) | Deletes the message at idx. |
| clear() | Deletes all messages. |
| all() | Returns all messages. |