XMPP-0.0.1: XMPP library Contents Index

MUC

Description

Implementation of Multi-User Chat, according to XEP-0045. This API needs more thought and will change.

Synopsis

matchesBare :: String -> StanzaPredicate joinGroupchat :: String -> String -> XMPP (Maybe (IO [String])) mucPresenceHandler :: HashTable String () -> StanzaHandler isGroupchatMessage :: StanzaPredicate isGroupchatPrivmsg :: String -> StanzaPredicate sendGroupchatMessage :: String -> String -> XMPP () sendGroupchatPrivateMessage :: String -> String -> String -> XMPP ()

Documentation

matchesBare :: String -> StanzaPredicate

Return true if the stanza is from a JID whose "username@server" part matches the given string.

joinGroupchat

:: String Nickname to use -> String JID of room -> XMPP (Maybe (IO [String])) If Nothing, joining room failed. If Just, a function that returns a list of room participants. Join groupchat. If successful, return function for participant list. Currently there is no way to install an event handler for join and leave events.

mucPresenceHandler :: HashTable String () -> StanzaHandler

isGroupchatMessage :: StanzaPredicate

Return true if the stanza is a message of type "groupchat".

isGroupchatPrivmsg :: String -> StanzaPredicate

Return true if the stanza is a private message in the named room.

sendGroupchatMessage

:: String JID of chat room -> String Text of message -> XMPP () Send a groupchat message.

sendGroupchatPrivateMessage

:: String Nick of recipient -> String JID of chat room -> String Text of message -> XMPP () Send a private message in a chat room.

Produced by Haddock version 0.7