deblan-mirror/mautrix-go
1
0
Fork 0
mirror of https://mau.dev/mautrix/go.git synced 2026-03-14 14:25:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

event/capabilities: add docstrings for state and member_actions

Browse source
This commit is contained in:
Tulir Asokan 2025-11-13 01:29:45 +02:00
commit 151d945685
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
event/capabilities.d.ts vendored
View file

@ -16,7 +16,22 @@ export interface RoomFeatures {
* If a message type isn't listed here, it should be treated as support level -2 (will be rejected).
*/
file?: Record<CapabilityMsgType, FileFeatures>
/**
* Supported state event types and their parameters. Currently, there are no parameters,
* but it is likely there will be some in the future (like max name/topic length, avatar mime types, etc.).
*
* Events that are not listed or have a support level of zero or below should be treated as unsupported.
*
* Clients should at least check `m.room.name`, `m.room.topic`, and `m.room.avatar` here.
* `m.room.member` will not be listed here, as it's controlled by the member_actions field.
* `com.beeper.disappearing_timer` should be listed here, but the parameters are in the disappearing_timer field for now.
*/
state?: Record<EventType, StateFeatures>
/**
* Supported member actions and their support levels.
*
* Actions that are not listed or have a support level of zero or below should be treated as unsupported.
*/
member_actions?: Record<MemberAction, CapabilitySupportLevel>
/** Maximum length of normal text messages. */