Browse code

[mod] doc:api

Christian FraƟ authored on20/11/2021 16:05:32
Showing1 changed files
... ...
@@ -52,6 +52,13 @@ Example: `curl 'http://localhost:7979' -d '{"id":"foo1bar2",action":"send","data
52 52
 
53 53
 - description: gets the current user list and all new (since the last call) events
54 54
 - input type: `void`
55
-- output type: `record<users:list<record<name:string,role:string>>,events:list<record<timestamp:integer,kind:string,data:map<string,any>>>>`
56
-
55
+- output type: `list<record<timestamp:integer,kind:string,data:any>>`
56
+- output details:
57
+	- kind `user_list`: `data` type: `record<channel:string,users:list<record<name:string,role:string>>>`
58
+	- kind `user_joined`: `data` type: `record<channel:string,user_name:string>`
59
+	- kind `user_parted`: `data` type: `record<channel:string,user_name:string>`
60
+	- kind `user_kicked`: `data` type: `record<channel:string,user_name:string,op_name:string,reason:string>`
61
+	- kind `user_quit`: `data` type: `record<name:string,channels:list<string>>`
62
+	- kind `message_channel`: `data` type: `record<channel:string,sender:string,content:string>`
63
+	- kind `message_query`: `data` type: `record<user_name:string,sender:string,content:string>`
57 64