Module exmpp_client_muc

Helper functions for generating MUC related stanzas.

Authors: Pablo Polvorin (pablo.polvorin@process-one.net).

Description

Helper functions for generating MUC related stanzas. Very incomplete, now it only generates kick and ban stanzas.

Data Types

ban_item()

ban_item() = {exmpp_jid:jid(), outcast | none | binary()} | {exmpp_jid:jid(), outcast | none | binary(), binary() | string()}

xmlattr()

xmlattr() = #xmlattr{ns = xmlname() | undefined, name = undefined | xmlname(), value = undefined | binary()}

xmlcdata()

xmlcdata() = #xmlcdata{cdata = binary()}

xmlname()

xmlname() = atom() | string()

Function Index

ban/2
ban/3
ban/4
get_banlist/1
get_banlist/2
kick/2
kick/3
kick/4
update_banlist/2
update_banlist/3

Function Details

ban/2

ban(Room::exmpp_jid:jid(), JID::exmpp_jid:jid()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

ban/3

ban(NS::atom() | string(), Room::exmpp_jid:jid(), JID::exmpp_jid:jid()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

ban/4

ban(NS::atom() | string(), Room::exmpp_jid:jid(), JID::exmpp_jid:jid(), Reason::string() | binary()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

get_banlist/1

get_banlist(Room::exmpp_jid:jid()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

get_banlist/2

get_banlist(NS::atom() | string(), Room::exmpp_jid:jid()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

kick/2

kick(Room::exmpp_jid:jid(), Nick::string() | binary()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

kick/3

kick(NS::atom() | string(), Room::exmpp_jid:jid(), Nick::string() | binary()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

kick/4

kick(NS::atom() | string(), Room::exmpp_jid:jid(), Nick::string() | binary(), Reason::string() | binary()) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

update_banlist/2

update_banlist(Room::exmpp_jid:jid(), BanList::[ban_item()]) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}

update_banlist/3

update_banlist(NS::atom() | string(), Room::exmpp_jid:jid(), BanList::[ban_item()]) -> #xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{ns = xmlname() | undefined, declared_ns = [{xmlname(), string() | none}], name = undefined | xmlname(), attrs = [xmlattr()], children = [#xmlel{} | xmlcdata()] | undefined} | xmlcdata()] | undefined}


Generated by EDoc, Nov 13 2012, 00:05:41.