Safe Haskell	None
Language	Haskell98

Network.Xmpp.IM

Contents

Instant Messages
Presence
Roster
presenceTracker

Description

RFC 6121: Instant Messaging and Presence

Synopsis

data InstantMessage = InstantMessage {
- imThread :: Maybe MessageThread
- imSubject :: [MessageSubject]
- imBody :: [MessageBody]
}
data MessageBody = MessageBody {
- bodyLang :: Maybe LangTag
- bodyContent :: Text
}
data MessageThread = MessageThread {
- threadID :: Text
- threadParent :: Maybe Text
}
data MessageSubject = MessageSubject {
- subjectLang :: Maybe LangTag
- subjectContent :: Text
}
data Subscription
- = None
- | To
- | From
- | Both
instantMessage :: InstantMessage
simpleIM :: Jid -> Text -> Message
getIM :: Message -> Maybe InstantMessage
withIM :: Message -> InstantMessage -> Message
answerIM :: [MessageBody] -> Message -> Maybe Message
data ShowStatus
- = StatusAway
- | StatusChat
- | StatusDnd
- | StatusXa
data IMPresence = IMP {
- showStatus :: Maybe ShowStatus
- status :: Maybe Text
- priority :: Maybe Int
}
imPresence :: IMPresence
getIMPresence :: Presence -> Maybe IMPresence
withIMPresence :: IMPresence -> Presence -> Presence
data Roster = Roster {
- ver :: Maybe Text
- items :: Map Jid Item
}
data Item = Item {
- riApproved :: Bool
- riAsk :: Bool
- riJid :: Jid
- riName :: Maybe Text
- riSubscription :: Subscription
- riGroups :: [Text]
}
data RosterUpdate
- = RosterUpdateRemove Jid
- | RosterUpdateAdd Item
getRoster :: Session -> IO Roster
getRosterSTM :: Session -> STM Roster
rosterAdd :: Jid -> Maybe Text -> [Text] -> Session -> IO (Either IQSendError (Annotated IQResponse))
rosterRemove :: Jid -> Session -> IO Bool
data PeerStatus
- = PeerAvailable (Maybe IMPresence)
- | PeerUnavailable
isPeerAvailable :: Jid -> Session -> STM Bool
getEntityStatus :: Jid -> Session -> STM PeerStatus
getAvailablePeers :: Session -> STM [Jid]
getPeerEntities :: Jid -> Session -> STM (Map Jid (Maybe IMPresence))

Instant Messages

data InstantMessage Source #

The instant message (IM) specific part of a message.

Constructors

InstantMessage
Fields imThread :: Maybe MessageThread imSubject :: [MessageSubject] imBody :: [MessageBody]

Instances

Default InstantMessage Source #
Instance details Defined in Network.Xmpp.IM.Message Methods def :: InstantMessage #

data MessageBody Source #

Constructors

MessageBody
Fields bodyLang :: Maybe LangTag bodyContent :: Text

data MessageThread Source #

Constructors

MessageThread
Fields threadID :: Text threadParent :: Maybe Text

data MessageSubject Source #

Constructors

MessageSubject
Fields subjectLang :: Maybe LangTag subjectContent :: Text

data Subscription Source #

Constructors

None	the user does not have a subscription to the contact's presence information, and the contact does not have a subscription to the user's presence information
To	the user has a subscription to the contact's presence information, but the contact does not have a subscription to the user's presence information
From	the contact has a subscription to the user's presence information, but the user does not have a subscription to the contact's presence information
Both	both the user and the contact have subscriptions to each other's presence information

Instances

Eq Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods (==) :: Subscription -> Subscription -> Bool # (/=) :: Subscription -> Subscription -> Bool #
Read Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods readsPrec :: Int -> ReadS Subscription # readList :: ReadS [Subscription] # readPrec :: ReadPrec Subscription # readListPrec :: ReadPrec [Subscription] #
Show Subscription Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #

instantMessage :: InstantMessage Source #

Empty instant message.

simpleIM Source #

Arguments

:: Jid	recipient
-> Text	body
-> Message

Generate a simple message

getIM :: Message -> Maybe InstantMessage Source #

Get the IM specific parts of a message. Returns Nothing when the received payload is not valid IM data.

withIM :: Message -> InstantMessage -> Message Source #

Append IM data to a message. Additional IM bodies with the same Langtag are discarded.

answerIM :: [MessageBody] -> Message -> Maybe Message Source #

Generate an answer from a received message. The recepient is taken from the original sender, the sender is set to Nothing, message ID, language tag, message type as well as subject and thread are inherited.

Additional IM bodies with the same Langtag are discarded.

Presence

data ShowStatus Source #

Constructors

StatusAway
StatusChat
StatusDnd
StatusXa

Instances

Eq ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods (==) :: ShowStatus -> ShowStatus -> Bool # (/=) :: ShowStatus -> ShowStatus -> Bool #
Read ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods readsPrec :: Int -> ReadS ShowStatus # readList :: ReadS [ShowStatus] # readPrec :: ReadPrec ShowStatus # readListPrec :: ReadPrec [ShowStatus] #
Show ShowStatus Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods showsPrec :: Int -> ShowStatus -> ShowS # show :: ShowStatus -> String # showList :: [ShowStatus] -> ShowS #

data IMPresence Source #

Constructors

IMP
Fields showStatus :: Maybe ShowStatus status :: Maybe Text priority :: Maybe Int

Instances

Eq IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods (==) :: IMPresence -> IMPresence -> Bool # (/=) :: IMPresence -> IMPresence -> Bool #
Show IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods showsPrec :: Int -> IMPresence -> ShowS # show :: IMPresence -> String # showList :: [IMPresence] -> ShowS #
Default IMPresence Source #
Instance details Defined in Network.Xmpp.IM.Presence Methods def :: IMPresence #

imPresence :: IMPresence Source #

getIMPresence :: Presence -> Maybe IMPresence Source #

Try to extract RFC6121 IM presence information from presence stanza. Returns Nothing when the data is malformed, (Just IMPresence) otherwise.

withIMPresence :: IMPresence -> Presence -> Presence Source #

Roster

data Roster Source #

Constructors

Roster
Fields ver :: Maybe Text items :: Map Jid Item

Instances

Show Roster Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Roster -> ShowS # show :: Roster -> String # showList :: [Roster] -> ShowS #

data Item Source #

Roster Items

Constructors

Item
Fields riApproved :: Bool riAsk :: Bool riJid :: Jid riName :: Maybe Text riSubscription :: Subscription riGroups :: [Text]

Instances

Show Item Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #

data RosterUpdate Source #

Constructors

RosterUpdateRemove Jid
RosterUpdateAdd Item	New or updated item

Instances

Show RosterUpdate Source #
Instance details Defined in Network.Xmpp.IM.Roster.Types Methods showsPrec :: Int -> RosterUpdate -> ShowS # show :: RosterUpdate -> String # showList :: [RosterUpdate] -> ShowS #

getRoster :: Session -> IO Roster Source #

Retrieve the current Roster state

getRosterSTM :: Session -> STM Roster Source #

Retrieve the current Roster state (STM version)

rosterAdd :: Jid -> Maybe Text -> [Text] -> Session -> IO (Either IQSendError (Annotated IQResponse)) Source #

Synonym to rosterSet

rosterRemove :: Jid -> Session -> IO Bool Source #

Remove an item from the roster. Return True when the item is sucessfully removed or if it wasn't in the roster to begin with.

presenceTracker

data PeerStatus Source #

Constructors

PeerAvailable (Maybe IMPresence)
PeerUnavailable

Instances

Eq PeerStatus Source #
Instance details Defined in Network.Xmpp.IM.PresenceTracker.Types Methods (==) :: PeerStatus -> PeerStatus -> Bool # (/=) :: PeerStatus -> PeerStatus -> Bool #
Show PeerStatus Source #
Instance details Defined in Network.Xmpp.IM.PresenceTracker.Types Methods showsPrec :: Int -> PeerStatus -> ShowS # show :: PeerStatus -> String # showList :: [PeerStatus] -> ShowS #

isPeerAvailable :: Jid -> Session -> STM Bool Source #

Check whether a given jid is available

getEntityStatus :: Jid -> Session -> STM PeerStatus Source #

Get status of given full JID

getAvailablePeers :: Session -> STM [Jid] Source #

Get list of (bare) Jids with available entities

getPeerEntities :: Jid -> Session -> STM (Map Jid (Maybe IMPresence)) Source #

Get all available full JIDs to the given JID