aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/muc/mod_muc.lua
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2018-03-09 19:16:18 +0100
committerKim Alvefur <zash@zash.se>2018-03-09 19:16:18 +0100
commit34f56dc375a9171d6ba0c6b2a9702316136468cc (patch)
tree55d70e0103896922b8f39045e0344ab874976a10 /plugins/muc/mod_muc.lua
parent58b678bdd6294a9be25bb2003ac591274d3846e1 (diff)
downloadprosody-34f56dc375a9171d6ba0c6b2a9702316136468cc.tar.gz
prosody-34f56dc375a9171d6ba0c6b2a9702316136468cc.zip
MUC: Write down which functions are exposed and thus available to other modules
Diffstat (limited to 'plugins/muc/mod_muc.lua')
-rw-r--r--plugins/muc/mod_muc.lua10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/muc/mod_muc.lua b/plugins/muc/mod_muc.lua
index 3b25f997..83ed4900 100644
--- a/plugins/muc/mod_muc.lua
+++ b/plugins/muc/mod_muc.lua
@@ -6,6 +6,16 @@
-- COPYING file in the source package for more information.
--
+-- Exposed functions:
+--
+-- create_room(jid) -> room
+-- track_room(room)
+-- delete_room(room)
+-- forget_room(room)
+-- get_room_from_jid(jid) -> room
+-- each_room(local_only) -> () -> room
+-- shutdown_component()
+
if module:get_host_type() ~= "component" then
error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0);
end