Network.Xmpp.IM

RFC 6121: Instant Messaging and Presence

Instant Messages

data InstantMessage

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

Constructors

InstantMessage

Fields

• imThread :: Maybe MessageThread
• imSubject :: [MessageSubject]
• imBody :: [MessageBody]

Instances

Default InstantMessage

Methods

def :: InstantMessage

data MessageBody

Constructors

MessageBody

Fields

• bodyLang :: Maybe LangTag
• bodyContent :: Text

data MessageThread

Constructors

MessageThread

Fields

• threadID :: Text
• threadParent :: Maybe Text

data MessageSubject

Constructors

MessageSubject

Fields

• subjectLang :: Maybe LangTag
• subjectContent :: Text

data Subscription

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

Methods

(==) :: Subscription -> Subscription -> Bool

(/=) :: Subscription -> Subscription -> Bool

Read Subscription

Methods

readsPrec :: Int -> ReadS Subscription

readList :: ReadS [Subscription]

readPrec :: ReadPrec Subscription

readListPrec :: ReadPrec [Subscription]

Show Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

instantMessage :: InstantMessage

Empty instant message.

simpleIM

Arguments

:: Jid

recipient

-> Text

body

-> Message

Generate a simple message

getIM :: Message -> Maybe InstantMessage

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

withIM :: Message -> InstantMessage -> Message

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

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

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

Constructors

StatusAway

StatusChat

StatusDnd

StatusXa

Instances

Eq ShowStatus

Methods

(==) :: ShowStatus -> ShowStatus -> Bool

(/=) :: ShowStatus -> ShowStatus -> Bool

Read ShowStatus

Methods

readsPrec :: Int -> ReadS ShowStatus

readList :: ReadS [ShowStatus]

readPrec :: ReadPrec ShowStatus

readListPrec :: ReadPrec [ShowStatus]

Show ShowStatus

Methods

showsPrec :: Int -> ShowStatus -> ShowS

show :: ShowStatus -> String

showList :: [ShowStatus] -> ShowS

data IMPresence

Constructors

IMP

Fields

• showStatus :: Maybe ShowStatus
• status :: Maybe Text
• priority :: Maybe Int

Instances

Eq IMPresence

Methods

(==) :: IMPresence -> IMPresence -> Bool

(/=) :: IMPresence -> IMPresence -> Bool

Show IMPresence

Methods

showsPrec :: Int -> IMPresence -> ShowS

show :: IMPresence -> String

showList :: [IMPresence] -> ShowS

Default IMPresence

Methods

def :: IMPresence

imPresence :: IMPresence

getIMPresence :: Presence -> Maybe IMPresence

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

withIMPresence :: IMPresence -> Presence -> Presence

Roster

data Roster

Constructors

Roster

Fields

• ver :: Maybe Text
• items :: Map Jid Item

Instances

Show Roster

Methods

showsPrec :: Int -> Roster -> ShowS

show :: Roster -> String

showList :: [Roster] -> ShowS

data Item

Roster Items

Constructors

Item

Fields

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

Instances

Show Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

getRoster :: Session -> IO Roster

Retrieve the current Roster state

getRosterSTM :: Session -> STM Roster

Retrieve the current Roster state (STM version)

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

Synonym to rosterSet

rosterRemove :: Jid -> Session -> IO Bool

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

Constructors

PeerAvailable (Maybe IMPresence)

PeerUnavailable

Instances

Eq PeerStatus

Methods

(==) :: PeerStatus -> PeerStatus -> Bool

(/=) :: PeerStatus -> PeerStatus -> Bool

Show PeerStatus

Methods

showsPrec :: Int -> PeerStatus -> ShowS

show :: PeerStatus -> String

showList :: [PeerStatus] -> ShowS

isPeerAvailable :: Jid -> Session -> STM Bool

Check whether a given jid is available

getEntityStatus :: Jid -> Session -> STM PeerStatus

Get status of given full JID

getAvailablePeers :: Session -> STM [Jid]

Get list of (bare) Jids with available entities

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

Get all available full JIDs to the given JID