Comparison

plugins/muc/mod_muc.lua @ 8572:ce1737520943

MUC: Write down which functions are exposed and thus available to other modules
author Kim Alvefur <zash@zash.se>
date Fri, 09 Mar 2018 19:16:18 +0100
parent 8387:7d61431e1aa6
child 8656:0e84814a7ece
comparison
equal deleted inserted replaced
8571:44217f40ff4a 8572:ce1737520943
3 -- Copyright (C) 2008-2010 Waqas Hussain 3 -- Copyright (C) 2008-2010 Waqas Hussain
4 -- 4 --
5 -- This project is MIT/X11 licensed. Please see the 5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information. 6 -- COPYING file in the source package for more information.
7 -- 7 --
8
9 -- Exposed functions:
10 --
11 -- create_room(jid) -> room
12 -- track_room(room)
13 -- delete_room(room)
14 -- forget_room(room)
15 -- get_room_from_jid(jid) -> room
16 -- each_room(local_only) -> () -> room
17 -- shutdown_component()
8 18
9 if module:get_host_type() ~= "component" then 19 if module:get_host_type() ~= "component" then
10 error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0); 20 error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0);
11 end 21 end
12 22