Safe Haskell	None
Language	Haskell2010

Network.Matrix.Client

Contents

Client
API
User data
Room participation
Room membership

Description

This module contains the client-server API https://matrix.org/docs/spec/client_server/r0.6.1

Synopsis

data ClientSession
newtype MatrixToken = MatrixToken Text
getTokenFromEnv :: Text -> IO MatrixToken
createSession :: Text -> MatrixToken -> IO ClientSession
type MatrixIO a = IO (Either MatrixError a)
data MatrixError = MatrixError {
- meErrcode :: Text
- meError :: Text
- meRetryAfterMS :: Maybe Int
}
retry :: MatrixIO a -> MatrixIO a
newtype UserID = UserID Text
getTokenOwner :: ClientSession -> MatrixIO UserID
newtype TxnID = TxnID Text
sendMessage :: ClientSession -> RoomID -> Event -> TxnID -> MatrixIO EventID
data MessageText = MessageText {
- mtBody :: Text
- mtFormat :: Maybe Text
- mtFormattedBody :: Maybe Text
}
data RoomMessage
- = RoomMessageText MessageText
- | RoomMessageEmote MessageText
- | RoomMessageNotice MessageText
newtype Event = EventRoomMessage RoomMessage
newtype EventID = EventID Text
eventType :: Event -> Text
newtype RoomID = RoomID Text
getJoinedRooms :: ClientSession -> MatrixIO [RoomID]
joinRoom :: ClientSession -> Text -> MatrixIO RoomID
joinRoomById :: ClientSession -> RoomID -> MatrixIO RoomID
leaveRoomById :: ClientSession -> RoomID -> MatrixIO ()

Client

data ClientSession Source #

The session record, use createSession to create it.

newtype MatrixToken Source #

Constructors

MatrixToken Text

getTokenFromEnv Source #

Arguments

:: Text	The envirnoment variable name
-> IO MatrixToken

createSession Source #

Arguments

:: Text	The matrix client-server base url, e.g. "https://matrix.org"
-> MatrixToken	The user token
-> IO ClientSession

createSession creates the session record.

API

type MatrixIO a = IO (Either MatrixError a) Source #

MatrixIO is a convenient type alias for server response

data MatrixError Source #

Constructors

MatrixError
Fields meErrcode :: Text meError :: Text meRetryAfterMS :: Maybe Int

Instances

Instances details

Eq MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods (==) :: MatrixError -> MatrixError -> Bool # (/=) :: MatrixError -> MatrixError -> Bool #
Show MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods showsPrec :: Int -> MatrixError -> ShowS # show :: MatrixError -> String # showList :: [MatrixError] -> ShowS #
FromJSON MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser MatrixError # parseJSONList :: Value -> Parser [MatrixError] #

retry :: MatrixIO a -> MatrixIO a Source #

User data

newtype UserID Source #

Constructors

UserID Text

Instances

Instances details

Eq UserID Source #
Instance details Defined in Network.Matrix.Internal Methods (==) :: UserID -> UserID -> Bool # (/=) :: UserID -> UserID -> Bool #
Show UserID Source #
Instance details Defined in Network.Matrix.Internal Methods showsPrec :: Int -> UserID -> ShowS # show :: UserID -> String # showList :: [UserID] -> ShowS #
FromJSON UserID Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser UserID # parseJSONList :: Value -> Parser [UserID] #

getTokenOwner :: ClientSession -> MatrixIO UserID Source #

getTokenOwner gets information about the owner of a given access token.

Room participation

newtype TxnID Source #

Constructors

TxnID Text

Instances

Instances details

Eq TxnID Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: TxnID -> TxnID -> Bool # (/=) :: TxnID -> TxnID -> Bool #
Show TxnID Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> TxnID -> ShowS # show :: TxnID -> String # showList :: [TxnID] -> ShowS #

sendMessage :: ClientSession -> RoomID -> Event -> TxnID -> MatrixIO EventID Source #

data MessageText Source #

Constructors

MessageText
Fields mtBody :: Text mtFormat :: Maybe Text mtFormattedBody :: Maybe Text

Instances

Instances details

Eq MessageText Source #
Instance details Defined in Network.Matrix.Events Methods (==) :: MessageText -> MessageText -> Bool # (/=) :: MessageText -> MessageText -> Bool #
Show MessageText Source #
Instance details Defined in Network.Matrix.Events Methods showsPrec :: Int -> MessageText -> ShowS # show :: MessageText -> String # showList :: [MessageText] -> ShowS #

data RoomMessage Source #

Constructors

RoomMessageText MessageText
RoomMessageEmote MessageText
RoomMessageNotice MessageText

Instances

Instances details

Eq RoomMessage Source #
Instance details Defined in Network.Matrix.Events Methods (==) :: RoomMessage -> RoomMessage -> Bool # (/=) :: RoomMessage -> RoomMessage -> Bool #
Show RoomMessage Source #
Instance details Defined in Network.Matrix.Events Methods showsPrec :: Int -> RoomMessage -> ShowS # show :: RoomMessage -> String # showList :: [RoomMessage] -> ShowS #
ToJSON RoomMessage Source #
Instance details Defined in Network.Matrix.Events Methods toJSON :: RoomMessage -> Value # toEncoding :: RoomMessage -> Encoding # toJSONList :: [RoomMessage] -> Value # toEncodingList :: [RoomMessage] -> Encoding #

newtype Event Source #

Constructors

EventRoomMessage RoomMessage

Instances

Instances details

ToJSON Event Source #
Instance details Defined in Network.Matrix.Events Methods toJSON :: Event -> Value # toEncoding :: Event -> Encoding # toJSONList :: [Event] -> Value # toEncodingList :: [Event] -> Encoding #

newtype EventID Source #

Constructors

EventID Text

Instances

Instances details

Show EventID Source #
Instance details Defined in Network.Matrix.Events Methods showsPrec :: Int -> EventID -> ShowS # show :: EventID -> String # showList :: [EventID] -> ShowS #
FromJSON EventID Source #
Instance details Defined in Network.Matrix.Events Methods parseJSON :: Value -> Parser EventID # parseJSONList :: Value -> Parser [EventID] #

eventType :: Event -> Text Source #

Room membership

newtype RoomID Source #

Constructors

RoomID Text

Instances

Instances details

Eq RoomID Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomID -> RoomID -> Bool # (/=) :: RoomID -> RoomID -> Bool #
Show RoomID Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomID -> ShowS # show :: RoomID -> String # showList :: [RoomID] -> ShowS #
Hashable RoomID Source #
Instance details Defined in Network.Matrix.Client Methods hashWithSalt :: Int -> RoomID -> Int # hash :: RoomID -> Int #
FromJSON RoomID Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser RoomID # parseJSONList :: Value -> Parser [RoomID] #

getJoinedRooms :: ClientSession -> MatrixIO [RoomID] Source #

joinRoom :: ClientSession -> Text -> MatrixIO RoomID Source #

Note that this API takes either a room ID or alias, unlike joinRoomById

joinRoomById :: ClientSession -> RoomID -> MatrixIO RoomID Source #

leaveRoomById :: ClientSession -> RoomID -> MatrixIO () Source #