Copyright	(c) pierre 2007
License	BSD3
Maintainer	Dmitry Astapov <dastapov@gmail.com>, pierre <k.pierre.k@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Network.XMPP.XEP.MUC

Description

XEP-0045, join/kick/ban/leave functionality

Synopsis

createRoomStanza :: UserJID -> UserJID -> UUID -> Stanza 'Presence 'Outgoing ()
leaveRoomStanza :: UserJID -> RoomMemberJID -> UUID -> Stanza 'Presence 'Outgoing ()
destroyRoomStanza :: UserJID -> RoomJID -> Text -> UUID -> Stanza 'IQ 'Outgoing ()
roomMessageStanza :: UserJID -> RoomJID -> Text -> UUID -> Stanza 'Message 'Outgoing ()
privateMessageStanza :: UserJID -> RoomMemberJID -> Text -> UUID -> Stanza 'Message 'Outgoing ()
queryInstantRoomConfigStanza :: UserJID -> RoomJID -> UUID -> Stanza 'IQ 'Outgoing ()
queryForAssociatedServicesStanza :: JID 'NodeResource -> Server -> UUID -> Stanza 'IQ 'Outgoing MUCPayload
submitInstantRoomConfigStanza :: UserJID -> RoomJID -> XmppForm -> UUID -> Stanza 'IQ 'Outgoing ()
setRoomMembersListStanza :: RoomJID -> UserJID -> RoomMembersList -> UUID -> Stanza 'IQ 'Outgoing ()
queryForRoomInfoStanza :: UserJID -> RoomJID -> UUID -> Stanza 'IQ 'Outgoing ()
type UserJID = JID 'NodeResource
type RoomJID = JID 'Node
type RoomMemberJID = JID 'NodeResource
class FromXML a where
- decodeXml :: Content Posn -> Maybe a
data MUCPayload
- = MUCRoomCreated Affiliation Role
- | MUCRoomQuery XmppForm
- | MUCRoomConfigRejected
- | MUCNotFound Text
- | MUCMembersPresences Affiliation Role
- | MUCMessageId Text
- | MUCArchivedMessage {
  - mamMessage :: Stanza 'Message 'Incoming ()
  - mamFrom :: JID 'Domain
  - mamWhen :: UTCTime
  - mamStoredId :: Text
  }
newtype RoomMembersList = RoomMembersList [(UserJID, Affiliation)]
data Affiliation
data Role
- = ModeratorRole
- | NoneRole
- | ParticipantRole
- | VisitorRole

Documentation

createRoomStanza :: UserJID -> UserJID -> UUID -> Stanza 'Presence 'Outgoing () Source #

leaveRoomStanza :: UserJID -> RoomMemberJID -> UUID -> Stanza 'Presence 'Outgoing () Source #

destroyRoomStanza :: UserJID -> RoomJID -> Text -> UUID -> Stanza 'IQ 'Outgoing () Source #

roomMessageStanza :: UserJID -> RoomJID -> Text -> UUID -> Stanza 'Message 'Outgoing () Source #

privateMessageStanza :: UserJID -> RoomMemberJID -> Text -> UUID -> Stanza 'Message 'Outgoing () Source #

queryInstantRoomConfigStanza :: UserJID -> RoomJID -> UUID -> Stanza 'IQ 'Outgoing () Source #

queryForAssociatedServicesStanza :: JID 'NodeResource -> Server -> UUID -> Stanza 'IQ 'Outgoing MUCPayload Source #

https://xmpp.org/extensions/xep-0045.html#disco-service

submitInstantRoomConfigStanza :: UserJID -> RoomJID -> XmppForm -> UUID -> Stanza 'IQ 'Outgoing () Source #

setRoomMembersListStanza :: RoomJID -> UserJID -> RoomMembersList -> UUID -> Stanza 'IQ 'Outgoing () Source #

queryForRoomInfoStanza :: UserJID -> RoomJID -> UUID -> Stanza 'IQ 'Outgoing () Source #

type UserJID = JID 'NodeResource Source #

type RoomJID = JID 'Node Source #

type RoomMemberJID = JID 'NodeResource Source #

class FromXML a where Source #

Methods

decodeXml :: Content Posn -> Maybe a Source #

Instances

Instances details

FromXML () Source #
Instance details Defined in Network.XMPP.XML Methods decodeXml :: Content Posn -> Maybe () Source #
FromXML XmppField Source #
Instance details Defined in Network.XMPP.XEP.Form Methods decodeXml :: Content Posn -> Maybe XmppField Source #
FromXML XmppForm Source #
Instance details Defined in Network.XMPP.XEP.Form Methods decodeXml :: Content Posn -> Maybe XmppForm Source #
FromXML MAMPayload Source #
Instance details Defined in Network.XMPP.XEP.MAM Methods decodeXml :: Content Posn -> Maybe MAMPayload Source #
FromXML MUCPayload Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods decodeXml :: Content Posn -> Maybe MUCPayload Source #
(FromXML a, FromXML b) => FromXML (Either a b) Source #
Instance details Defined in Network.XMPP.XML Methods decodeXml :: Content Posn -> Maybe (Either a b) Source #

data MUCPayload Source #

Constructors

MUCRoomCreated Affiliation Role
MUCRoomQuery XmppForm
MUCRoomConfigRejected
MUCNotFound Text
MUCMembersPresences Affiliation Role
MUCMessageId Text
MUCArchivedMessage
Fields mamMessage :: Stanza 'Message 'Incoming () mamFrom :: JID 'Domain mamWhen :: UTCTime mamStoredId :: Text

Instances

Instances details

Show MUCPayload Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods showsPrec :: Int -> MUCPayload -> ShowS # show :: MUCPayload -> String # showList :: [MUCPayload] -> ShowS #
FromXML MUCPayload Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods decodeXml :: Content Posn -> Maybe MUCPayload Source #

newtype RoomMembersList Source #

Constructors

RoomMembersList [(UserJID, Affiliation)]

Instances

Instances details

Eq RoomMembersList Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods (==) :: RoomMembersList -> RoomMembersList -> Bool # (/=) :: RoomMembersList -> RoomMembersList -> Bool #
Show RoomMembersList Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods showsPrec :: Int -> RoomMembersList -> ShowS # show :: RoomMembersList -> String # showList :: [RoomMembersList] -> ShowS #
ToXML RoomMembersList Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods encodeXml :: RoomMembersList -> [Node] Source #

data Affiliation Source #

Constructors

OwnerAffiliation
AdminAffiliation
MemberAffiliation
OutcastAffiliation
NoneAffiliation

Instances

Instances details

Eq Affiliation Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods (==) :: Affiliation -> Affiliation -> Bool # (/=) :: Affiliation -> Affiliation -> Bool #
Show Affiliation Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods showsPrec :: Int -> Affiliation -> ShowS # show :: Affiliation -> String # showList :: [Affiliation] -> ShowS #

data Role Source #

Constructors

ModeratorRole
NoneRole
ParticipantRole
VisitorRole

Instances

Instances details

Eq Role Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #
Show Role Source #
Instance details Defined in Network.XMPP.XEP.MUC Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #