docs: improve doucmentation
improve doucmentation and fix small store changes
This commit is contained in:
@@ -6,6 +6,22 @@ sidebar_position: 4
|
||||
|
||||
`TojuClientPluginApi` is the object passed to a plugin activation context. The runtime freezes the API object before passing it to plugin code.
|
||||
|
||||
This page is the compact map. Use the focused API pages for concrete copy-paste examples with literal input data.
|
||||
|
||||
## Focused API Pages
|
||||
|
||||
- [Context and Logging](./api/context-and-logging.md)
|
||||
- [Profile API](./api/profile.md)
|
||||
- [Users and Roles API](./api/users-and-roles.md)
|
||||
- [Server API](./api/server.md)
|
||||
- [Channels API](./api/channels.md)
|
||||
- [Messages and Typing API](./api/messages-and-typing.md)
|
||||
- [Events API](./api/events.md)
|
||||
- [Message Bus API](./api/message-bus.md)
|
||||
- [P2P and Media API](./api/p2p-and-media.md)
|
||||
- [Storage API](./api/storage.md)
|
||||
- [UI API](./api/ui.md)
|
||||
|
||||
## Activation Types
|
||||
|
||||
```ts
|
||||
@@ -123,6 +139,8 @@ interface PluginApiMessageAsPluginUserRequest {
|
||||
| `messages.readCurrent()` | `messages.read` | Returns current visible messages. |
|
||||
| `messages.send(content, channelId?)` | `messages.send` | Sends a message and returns the created `Message`. |
|
||||
| `messages.sendAsPluginUser(request)` | `messages.send` | Emits a message from a registered plugin user. |
|
||||
| `messages.setTyping(isTyping, channelId?)` | `messages.send` | Broadcasts current typing state for a channel. |
|
||||
| `messages.subscribeTyping(handler)` | `messages.read` | Subscribes to peer typing state. |
|
||||
| `messages.edit(messageId, content)` | `messages.editOwn` | Edits a plugin message. |
|
||||
| `messages.delete(messageId)` | `messages.deleteOwn` | Deletes a plugin message. |
|
||||
| `messages.moderateDelete(messageId)` | `messages.moderate` | Performs a moderation delete. |
|
||||
@@ -299,3 +317,13 @@ interface PluginApiDomMountRequest {
|
||||
| `ui.registerToolbarAction(id, contribution)` | `ui.pages` | Adds a toolbar action. |
|
||||
| `ui.registerEmbedRenderer(id, contribution)` | `ui.embeds` | Adds an embed renderer. |
|
||||
| `ui.mountElement(id, request)` | `ui.dom` | Mounts plugin-owned DOM into a target element or selector. |
|
||||
|
||||
## Context and Logger
|
||||
|
||||
| Method | Capability | Description |
|
||||
| --- | --- | --- |
|
||||
| `context.getCurrent()` | None | Reads current user, server, active text channel, and active voice channel. |
|
||||
| `logger.debug(message, data?)` | None | Writes a debug plugin log entry. |
|
||||
| `logger.info(message, data?)` | None | Writes an info plugin log entry. |
|
||||
| `logger.warn(message, data?)` | None | Writes a warning plugin log entry. |
|
||||
| `logger.error(message, data?)` | None | Writes an error plugin log entry. |
|
||||
|
||||
Reference in New Issue
Block a user