diff options
| author | Joas Schilling <coding@schilljs.com> | 2023-10-19 16:36:14 +0200 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2023-10-20 14:44:21 +0200 |
| commit | 831e859cbcbf0c6efbe98a1452a581c0661c462d (patch) | |
| tree | 63fdfe0e8304115c4beb4a0b90bca3f46fb28d2a /docs | |
| parent | beec053e3d7dce3ea5f8fe3ac5140043c613f71c (diff) | |
feat(events): Migrate chat related events to typed events
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/events.md | 35 |
1 files changed, 31 insertions, 4 deletions
diff --git a/docs/events.md b/docs/events.md index 4d76e4ca0..7c74c22b9 100644 --- a/docs/events.md +++ b/docs/events.md @@ -276,6 +276,30 @@ These events were not using the typed-event mechanism and are therefore deprecat ## Chat related events +### Parse chat message + +Used to parse mentions, replace parameters in messages with rich objects, transform system messages into readable and translated chat messages etc. + +* Event: `OCA\Talk\Events\MessageParseEvent` +* Since: 18.0.0 + +### Chat message sent + +* Before event: `OCA\Talk\Events\BeforeChatMessageSentEvent` +* After event: `OCA\Talk\Events\ChatMessageSentEvent` +* Since: 18.0.0 + +### System message sent + +`shouldSkipLastActivityUpdate` indicates whether multiple system messages are being sent. +In case you only need to be notified after the last system message was posted, +listen to the `OCA\Talk\Events\SystemMessagesMultipleSentEvent` event instead. + +* Before event: `OCA\Talk\Events\BeforeSystemMessageSentEvent` +* After event: `OCA\Talk\Events\SystemMessageSentEvent` +* Final event: `OCA\Talk\Events\SystemMessagesMultipleSentEvent` - Only sent once as per above explanation +* Since: 18.0.0 + ### Deprecated events These events were not using the typed-event mechanism and are therefore deprecated and will be removed in a future version. @@ -286,7 +310,8 @@ These events were not using the typed-event mechanism and are therefore deprecat * Before event name: `OCA\Talk\Chat\ChatManager::EVENT_BEFORE_SYSTEM_MESSAGE_SEND` * After event name: `OCA\Talk\Chat\ChatManager::EVENT_AFTER_SYSTEM_MESSAGE_SEND` * Since: 8.0.0 -* Deprecated: 18.0.0 +* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeSystemMessageSentEvent` and `OCA\Talk\Events\SystemMessageSentEvent` instead +* Removed: 19.0.0 #### Post chat message @@ -294,21 +319,23 @@ These events were not using the typed-event mechanism and are therefore deprecat * Before event name: `OCA\Talk\Chat\ChatManager::EVENT_BEFORE_MESSAGE_SEND` * After event name: `OCA\Talk\Chat\ChatManager::EVENT_AFTER_MESSAGE_SEND` * Since: 8.0.0 -* Deprecated: 18.0.0 +* Deprecated: 18.0.0 - Use `OCA\Talk\Events\BeforeChatMessageSentEvent` and `OCA\Talk\Events\ChatMessageSentEvent` instead +* Removed: 19.0.0 #### Parse chat message * Event class: `OCA\Talk\Events\ChatMessageEvent` * Event name: `OCA\Talk\Chat\MessageParser::EVENT_MESSAGE_PARSE` * Since: 8.0.0 -* Deprecated: 18.0.0 +* Deprecated: 18.0.0 - Use `OCA\Talk\Events\MessageParseEvent` instead +* Removed: 19.0.0 #### Command execution for apps * Event class: `OCA\Talk\Events\CommandEvent` * Event name: `OCA\Talk\Chat\Command\Executor::EVENT_APP_EXECUTE` * Since: 8.0.0 -* Deprecated: 18.0.0 +* Deprecated: 17.0.0 - Commands are deprecated, please migrate to bots instead ## Other events |