From 2c7e57a3380d7f23e06c5aea8fe579dab307899a Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Sat, 29 Jun 2024 18:18:28 +0100 Subject: [PATCH] Document some possible metadata keys. --- docs/server/messages/metadata.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/server/messages/metadata.yml b/docs/server/messages/metadata.yml index 3d28b789..e3e9b2c9 100644 --- a/docs/server/messages/metadata.yml +++ b/docs/server/messages/metadata.yml @@ -14,6 +14,25 @@ syntax: - '{*} []' description: |- Changes the specified channel, user, or network metadata entry to the specified value. +extra: |- + Some possible values for the key field are: + + Name | Type | Description + ---------------- | ------- | ----------- + accountid | User | The account identifier of the target user. + accountname | User | The account name of the target user. + accountnicks | User | A space-delimited list of nicknames associated with the target user's account. + auspex | Channel | Enables services servers receiving messages for the target channel even when it has no users in it. + ctitle | User | The custom WHOIS title of the target user. + filter | Server | A filter entry which is set on the originating server. + gateway-realhost | User | The hostname of the WebIRC gateway the target user connected via. + gateway-realip | User | The IP address of the WebIRC gateway the target user connected via. + mlock | Channel | The modes which are locked on the target channel and can not be changed. + modules | Server | A module state change on the originating server. + operquit | User | The quit message to show to server operators when the tatget user quits. + swhois | User | The custom WHOIS message of the target user. + topiclock | Channel | Marks the target channel as having an immutable topic. + webirc-gateway | User | The name of the WebIRC gateway that the target user connected via. example: - description: |- Changes the mlock channel metadata for #chan to channel modes `n` (noextmsg) and `t` (topiclock)