Network.Matrix.Client

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

Client

data ClientSession

The session record, use createSession to create it.

newtype MatrixToken

Constructors

MatrixToken Text

getTokenFromEnv

Arguments

:: Text

The envirnoment variable name

-> IO MatrixToken

createSession

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 MatrixM m a = m (Either MatrixError a)

type MatrixIO a = MatrixM IO a

MatrixIO is a convenient type alias for server response

data MatrixError

Constructors

MatrixError

Fields

• meErrcode :: Text
• meError :: Text
• meRetryAfterMS :: Maybe Int

Instances

Eq MatrixError

Defined in Network.Matrix.Internal

Methods

(==) :: MatrixError -> MatrixError -> Bool

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

Show MatrixError

Defined in Network.Matrix.Internal

Methods

showsPrec :: Int -> MatrixError -> ShowS

show :: MatrixError -> String

showList :: [MatrixError] -> ShowS

FromJSON MatrixError

Defined in Network.Matrix.Internal

Methods

parseJSON :: Value -> Parser MatrixError

parseJSONList :: Value -> Parser [MatrixError]

retry :: MatrixIO a -> MatrixIO a

retryWithLog

Arguments

:: (MonadMask m, MonadIO m)

=> Int

Maximum number of retry

-> (Text -> m ())

A log function, can be used to measure errors

-> MatrixM m a

The action to retry

-> MatrixM m a

Retry a network action

User data

newtype UserID

Constructors

UserID Text

Instances

Eq UserID

Defined in Network.Matrix.Internal

Methods

(==) :: UserID -> UserID -> Bool

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

Ord UserID

Defined in Network.Matrix.Internal

Methods

compare :: UserID -> UserID -> Ordering

(<) :: UserID -> UserID -> Bool

(<=) :: UserID -> UserID -> Bool

(>) :: UserID -> UserID -> Bool

(>=) :: UserID -> UserID -> Bool

max :: UserID -> UserID -> UserID

min :: UserID -> UserID -> UserID

Show UserID

Defined in Network.Matrix.Internal

Methods

showsPrec :: Int -> UserID -> ShowS

show :: UserID -> String

showList :: [UserID] -> ShowS

Hashable UserID

Defined in Network.Matrix.Internal

Methods

hashWithSalt :: Int -> UserID -> Int

hash :: UserID -> Int

FromJSON UserID

Defined in Network.Matrix.Internal

Methods

parseJSON :: Value -> Parser UserID

parseJSONList :: Value -> Parser [UserID]

getTokenOwner :: ClientSession -> MatrixIO UserID

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

Room management

data RoomCreatePreset

https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-createroom

Constructors

PrivateChat

TrustedPrivateChat

PublicChat

Instances

Eq RoomCreatePreset

Defined in Network.Matrix.Room

Methods

(==) :: RoomCreatePreset -> RoomCreatePreset -> Bool

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

Show RoomCreatePreset

Defined in Network.Matrix.Room

Methods

showsPrec :: Int -> RoomCreatePreset -> ShowS

show :: RoomCreatePreset -> String

showList :: [RoomCreatePreset] -> ShowS

ToJSON RoomCreatePreset

Defined in Network.Matrix.Room

Methods

toJSON :: RoomCreatePreset -> Value

toEncoding :: RoomCreatePreset -> Encoding

toJSONList :: [RoomCreatePreset] -> Value

toEncodingList :: [RoomCreatePreset] -> Encoding

data RoomCreateRequest

Constructors

RoomCreateRequest

Fields

• rcrPreset :: RoomCreatePreset
• rcrRoomAliasName :: Text
• rcrName :: Text
• rcrTopic :: Text

Instances

Eq RoomCreateRequest

Defined in Network.Matrix.Room

Methods

(==) :: RoomCreateRequest -> RoomCreateRequest -> Bool

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

Show RoomCreateRequest

Defined in Network.Matrix.Room

Methods

showsPrec :: Int -> RoomCreateRequest -> ShowS

show :: RoomCreateRequest -> String

showList :: [RoomCreateRequest] -> ShowS

Generic RoomCreateRequest

Defined in Network.Matrix.Room

Associated Types

type Rep RoomCreateRequest :: Type -> Type

Methods

from :: RoomCreateRequest -> Rep RoomCreateRequest x

to :: Rep RoomCreateRequest x -> RoomCreateRequest

ToJSON RoomCreateRequest

Defined in Network.Matrix.Room

Methods

toJSON :: RoomCreateRequest -> Value

toEncoding :: RoomCreateRequest -> Encoding

toJSONList :: [RoomCreateRequest] -> Value

toEncodingList :: [RoomCreateRequest] -> Encoding

type Rep RoomCreateRequest

Defined in Network.Matrix.Room

type Rep RoomCreateRequest = D1 ('MetaData "RoomCreateRequest" "Network.Matrix.Room" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "RoomCreateRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rcrPreset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RoomCreatePreset) :*: S1 ('MetaSel ('Just "rcrRoomAliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "rcrName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rcrTopic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

createRoom :: ClientSession -> RoomCreateRequest -> MatrixIO RoomID

Room participation

newtype TxnID

Constructors

TxnID Text

Instances

Eq TxnID

Defined in Network.Matrix.Client

Methods

(==) :: TxnID -> TxnID -> Bool

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

Show TxnID

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> TxnID -> ShowS

show :: TxnID -> String

showList :: [TxnID] -> ShowS

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

mkReply

Arguments

:: RoomID

The destination room, must match the original event

-> RoomEvent

The original event

-> MessageText

The reply message

-> Event

The event to send

Prepare a reply event

data MessageTextType

Constructors

TextType

EmoteType

NoticeType

Instances

Eq MessageTextType

Defined in Network.Matrix.Events

Methods

(==) :: MessageTextType -> MessageTextType -> Bool

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

Show MessageTextType

Defined in Network.Matrix.Events

Methods

showsPrec :: Int -> MessageTextType -> ShowS

show :: MessageTextType -> String

showList :: [MessageTextType] -> ShowS

ToJSON MessageTextType

Defined in Network.Matrix.Events

Methods

toJSON :: MessageTextType -> Value

toEncoding :: MessageTextType -> Encoding

toJSONList :: [MessageTextType] -> Value

toEncodingList :: [MessageTextType] -> Encoding

FromJSON MessageTextType

Defined in Network.Matrix.Events

Methods

parseJSON :: Value -> Parser MessageTextType

parseJSONList :: Value -> Parser [MessageTextType]

data MessageText

Constructors

MessageText

Fields

• mtBody :: Text
• mtType :: MessageTextType
• mtFormat :: Maybe Text
• mtFormattedBody :: Maybe Text

Instances

Eq MessageText

Defined in Network.Matrix.Events

Methods

(==) :: MessageText -> MessageText -> Bool

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

Show MessageText

Defined in Network.Matrix.Events

Methods

showsPrec :: Int -> MessageText -> ShowS

show :: MessageText -> String

showList :: [MessageText] -> ShowS

ToJSON MessageText

Defined in Network.Matrix.Events

Methods

toJSON :: MessageText -> Value

toEncoding :: MessageText -> Encoding

toJSONList :: [MessageText] -> Value

toEncodingList :: [MessageText] -> Encoding

FromJSON MessageText

Defined in Network.Matrix.Events

Methods

parseJSON :: Value -> Parser MessageText

parseJSONList :: Value -> Parser [MessageText]

newtype RoomMessage

Constructors

RoomMessageText MessageText

Instances

Eq RoomMessage

Defined in Network.Matrix.Events

Methods

(==) :: RoomMessage -> RoomMessage -> Bool

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

Show RoomMessage

Defined in Network.Matrix.Events

Methods

showsPrec :: Int -> RoomMessage -> ShowS

show :: RoomMessage -> String

showList :: [RoomMessage] -> ShowS

ToJSON RoomMessage

Defined in Network.Matrix.Events

Methods

toJSON :: RoomMessage -> Value

toEncoding :: RoomMessage -> Encoding

toJSONList :: [RoomMessage] -> Value

toEncodingList :: [RoomMessage] -> Encoding

FromJSON RoomMessage

Defined in Network.Matrix.Events

Methods

parseJSON :: Value -> Parser RoomMessage

parseJSONList :: Value -> Parser [RoomMessage]

data Event

Constructors

EventRoomMessage RoomMessage

EventRoomReply EventID RoomMessage

A reply defined by the parent event id and the reply message

EventRoomEdit (EventID, RoomMessage) RoomMessage

An edit defined by the original message and the new message

EventUnknown Object

Instances

Eq Event

Defined in Network.Matrix.Events

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Defined in Network.Matrix.Events

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

ToJSON Event

Defined in Network.Matrix.Events

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

FromJSON Event

Defined in Network.Matrix.Events

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

newtype EventID

Constructors

EventID

Fields

• unEventID :: Text

Instances

Eq EventID

Defined in Network.Matrix.Events

Methods

(==) :: EventID -> EventID -> Bool

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

Ord EventID

Defined in Network.Matrix.Events

Methods

compare :: EventID -> EventID -> Ordering

(<) :: EventID -> EventID -> Bool

(<=) :: EventID -> EventID -> Bool

(>) :: EventID -> EventID -> Bool

(>=) :: EventID -> EventID -> Bool

max :: EventID -> EventID -> EventID

min :: EventID -> EventID -> EventID

Show EventID

Defined in Network.Matrix.Events

Methods

showsPrec :: Int -> EventID -> ShowS

show :: EventID -> String

showList :: [EventID] -> ShowS

ToJSON EventID

Defined in Network.Matrix.Events

Methods

toJSON :: EventID -> Value

toEncoding :: EventID -> Encoding

toJSONList :: [EventID] -> Value

toEncodingList :: [EventID] -> Encoding

FromJSON EventID

Defined in Network.Matrix.Events

Methods

parseJSON :: Value -> Parser EventID

parseJSONList :: Value -> Parser [EventID]

eventType :: Event -> Text

Room membership

newtype RoomID

Constructors

RoomID Text

Instances

Eq RoomID

Defined in Network.Matrix.Client

Methods

(==) :: RoomID -> RoomID -> Bool

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

Ord RoomID

Defined in Network.Matrix.Client

Methods

compare :: RoomID -> RoomID -> Ordering

(<) :: RoomID -> RoomID -> Bool

(<=) :: RoomID -> RoomID -> Bool

(>) :: RoomID -> RoomID -> Bool

(>=) :: RoomID -> RoomID -> Bool

max :: RoomID -> RoomID -> RoomID

min :: RoomID -> RoomID -> RoomID

Show RoomID

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> RoomID -> ShowS

show :: RoomID -> String

showList :: [RoomID] -> ShowS

Hashable RoomID

Defined in Network.Matrix.Client

Methods

hashWithSalt :: Int -> RoomID -> Int

hash :: RoomID -> Int

FromJSON RoomID

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser RoomID

parseJSONList :: Value -> Parser [RoomID]

getJoinedRooms :: ClientSession -> MatrixIO [RoomID]

joinRoom :: ClientSession -> Text -> MatrixIO RoomID

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

joinRoomById :: ClientSession -> RoomID -> MatrixIO RoomID

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

Filter

data EventFormat

Constructors

Client

Federation

Instances

Eq EventFormat

Defined in Network.Matrix.Client

Methods

(==) :: EventFormat -> EventFormat -> Bool

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

Show EventFormat

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> EventFormat -> ShowS

show :: EventFormat -> String

showList :: [EventFormat] -> ShowS

ToJSON EventFormat

Defined in Network.Matrix.Client

Methods

toJSON :: EventFormat -> Value

toEncoding :: EventFormat -> Encoding

toJSONList :: [EventFormat] -> Value

toEncodingList :: [EventFormat] -> Encoding

FromJSON EventFormat

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser EventFormat

parseJSONList :: Value -> Parser [EventFormat]

data EventFilter

Constructors

EventFilter

Fields

• efLimit :: Maybe Int
• efNotSenders :: Maybe [Text]
• efNotTypes :: Maybe [Text]
• efSenders :: Maybe [Text]
• efTypes :: Maybe [Text]

Instances

Eq EventFilter

Defined in Network.Matrix.Client

Methods

(==) :: EventFilter -> EventFilter -> Bool

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

Show EventFilter

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> EventFilter -> ShowS

show :: EventFilter -> String

showList :: [EventFilter] -> ShowS

Generic EventFilter

Defined in Network.Matrix.Client

Associated Types

type Rep EventFilter :: Type -> Type

Methods

from :: EventFilter -> Rep EventFilter x

to :: Rep EventFilter x -> EventFilter

ToJSON EventFilter

Defined in Network.Matrix.Client

Methods

toJSON :: EventFilter -> Value

toEncoding :: EventFilter -> Encoding

toJSONList :: [EventFilter] -> Value

toEncodingList :: [EventFilter] -> Encoding

FromJSON EventFilter

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser EventFilter

parseJSONList :: Value -> Parser [EventFilter]

type Rep EventFilter

Defined in Network.Matrix.Client

type Rep EventFilter = D1 ('MetaData "EventFilter" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "EventFilter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "efLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "efNotSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "efNotTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "efSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "efTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))))))

defaultEventFilter :: EventFilter

eventFilterAll :: EventFilter

A filter that should match nothing

data RoomEventFilter

Constructors

RoomEventFilter

Fields

• refLimit :: Maybe Int
• refNotSenders :: Maybe [Text]
• refNotTypes :: Maybe [Text]
• refSenders :: Maybe [Text]
• refTypes :: Maybe [Text]
• refLazyLoadMembers :: Maybe Bool
• refIncludeRedundantMembers :: Maybe Bool
• refNotRooms :: Maybe [Text]
• refRooms :: Maybe [Text]
• refContainsUrl :: Maybe Bool

Instances

Eq RoomEventFilter

Defined in Network.Matrix.Client

Methods

(==) :: RoomEventFilter -> RoomEventFilter -> Bool

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

Show RoomEventFilter

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> RoomEventFilter -> ShowS

show :: RoomEventFilter -> String

showList :: [RoomEventFilter] -> ShowS

Generic RoomEventFilter

Defined in Network.Matrix.Client

Associated Types

type Rep RoomEventFilter :: Type -> Type

Methods

from :: RoomEventFilter -> Rep RoomEventFilter x

to :: Rep RoomEventFilter x -> RoomEventFilter

ToJSON RoomEventFilter

Defined in Network.Matrix.Client

Methods

toJSON :: RoomEventFilter -> Value

toEncoding :: RoomEventFilter -> Encoding

toJSONList :: [RoomEventFilter] -> Value

toEncodingList :: [RoomEventFilter] -> Encoding

FromJSON RoomEventFilter

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser RoomEventFilter

parseJSONList :: Value -> Parser [RoomEventFilter]

type Rep RoomEventFilter

Defined in Network.Matrix.Client

type Rep RoomEventFilter = D1 ('MetaData "RoomEventFilter" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "RoomEventFilter" 'PrefixI 'True) (((S1 ('MetaSel ('Just "refLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "refNotSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "refNotTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "refSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "refTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "refLazyLoadMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "refIncludeRedundantMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "refNotRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "refRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "refContainsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))

defaultRoomEventFilter :: RoomEventFilter

roomEventFilterAll :: RoomEventFilter

A filter that should match nothing

data StateFilter

Constructors

StateFilter

Fields

• sfLimit :: Maybe Int
• sfNotSenders :: Maybe [Text]
• sfNotTypes :: Maybe [Text]
• sfSenders :: Maybe [Text]
• sfTypes :: Maybe [Text]
• sfLazyLoadMembers :: Maybe Bool
• sfIncludeRedundantMembers :: Maybe Bool
• sfNotRooms :: Maybe [Text]
• sfRooms :: Maybe [Text]
• sfContains_url :: Maybe Bool

Instances

Eq StateFilter

Defined in Network.Matrix.Client

Methods

(==) :: StateFilter -> StateFilter -> Bool

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

Show StateFilter

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> StateFilter -> ShowS

show :: StateFilter -> String

showList :: [StateFilter] -> ShowS

Generic StateFilter

Defined in Network.Matrix.Client

Associated Types

type Rep StateFilter :: Type -> Type

Methods

from :: StateFilter -> Rep StateFilter x

to :: Rep StateFilter x -> StateFilter

ToJSON StateFilter

Defined in Network.Matrix.Client

Methods

toJSON :: StateFilter -> Value

toEncoding :: StateFilter -> Encoding

toJSONList :: [StateFilter] -> Value

toEncodingList :: [StateFilter] -> Encoding

FromJSON StateFilter

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser StateFilter

parseJSONList :: Value -> Parser [StateFilter]

type Rep StateFilter

Defined in Network.Matrix.Client

type Rep StateFilter = D1 ('MetaData "StateFilter" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "StateFilter" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sfLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sfNotSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "sfNotTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "sfSenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sfTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "sfLazyLoadMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sfIncludeRedundantMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sfNotRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "sfRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sfContains_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))

defaultStateFilter :: StateFilter

stateFilterAll :: StateFilter

data RoomFilter

Constructors

RoomFilter

Fields

• rfNotRooms :: Maybe [Text]
• rfRooms :: Maybe [Text]
• rfEphemeral :: Maybe RoomEventFilter
• rfIncludeLeave :: Maybe Bool
• rfState :: Maybe StateFilter
• rfTimeline :: Maybe RoomEventFilter
• rfAccountData :: Maybe RoomEventFilter

Instances

Eq RoomFilter

Defined in Network.Matrix.Client

Methods

(==) :: RoomFilter -> RoomFilter -> Bool

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

Show RoomFilter

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> RoomFilter -> ShowS

show :: RoomFilter -> String

showList :: [RoomFilter] -> ShowS

Generic RoomFilter

Defined in Network.Matrix.Client

Associated Types

type Rep RoomFilter :: Type -> Type

Methods

from :: RoomFilter -> Rep RoomFilter x

to :: Rep RoomFilter x -> RoomFilter

ToJSON RoomFilter

Defined in Network.Matrix.Client

Methods

toJSON :: RoomFilter -> Value

toEncoding :: RoomFilter -> Encoding

toJSONList :: [RoomFilter] -> Value

toEncodingList :: [RoomFilter] -> Encoding

FromJSON RoomFilter

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser RoomFilter

parseJSONList :: Value -> Parser [RoomFilter]

type Rep RoomFilter

Defined in Network.Matrix.Client

type Rep RoomFilter = D1 ('MetaData "RoomFilter" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "RoomFilter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rfNotRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "rfRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "rfEphemeral") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RoomEventFilter)))) :*: ((S1 ('MetaSel ('Just "rfIncludeLeave") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "rfState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StateFilter))) :*: (S1 ('MetaSel ('Just "rfTimeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RoomEventFilter)) :*: S1 ('MetaSel ('Just "rfAccountData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RoomEventFilter))))))

defaultRoomFilter :: RoomFilter

data Filter

Constructors

Filter

Fields

• filterEventFields :: Maybe [Text]
• filterEventFormat :: Maybe EventFormat
• filterPresence :: Maybe EventFilter
• filterAccountData :: Maybe EventFilter
• filterRoom :: Maybe RoomFilter

Instances

Eq Filter

Defined in Network.Matrix.Client

Methods

(==) :: Filter -> Filter -> Bool

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

Show Filter

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

Generic Filter

Defined in Network.Matrix.Client

Associated Types

type Rep Filter :: Type -> Type

Methods

from :: Filter -> Rep Filter x

to :: Rep Filter x -> Filter

ToJSON Filter

Defined in Network.Matrix.Client

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

FromJSON Filter

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser Filter

parseJSONList :: Value -> Parser [Filter]

type Rep Filter

Defined in Network.Matrix.Client

type Rep Filter = D1 ('MetaData "Filter" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "Filter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterEventFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "filterEventFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EventFormat))) :*: (S1 ('MetaSel ('Just "filterPresence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EventFilter)) :*: (S1 ('MetaSel ('Just "filterAccountData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EventFilter)) :*: S1 ('MetaSel ('Just "filterRoom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RoomFilter))))))

defaultFilter :: Filter

newtype FilterID

Constructors

FilterID Text

Instances

Eq FilterID

Defined in Network.Matrix.Client

Methods

(==) :: FilterID -> FilterID -> Bool

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

Show FilterID

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> FilterID -> ShowS

show :: FilterID -> String

showList :: [FilterID] -> ShowS

Hashable FilterID

Defined in Network.Matrix.Client

Methods

hashWithSalt :: Int -> FilterID -> Int

hash :: FilterID -> Int

FromJSON FilterID

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser FilterID

parseJSONList :: Value -> Parser [FilterID]

messageFilter :: Filter

A filter to keep all the messages

createFilter

Arguments

:: ClientSession

The client session, use createSession to get one.

-> UserID

The userID, use getTokenOwner to get it.

-> Filter

The filter definition, use defaultFilter to create one or use the messageFilter example.

-> MatrixIO FilterID

The function returns a FilterID suitable for the sync function.

Upload a new filter definition to the homeserver https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-user-userid-filter

getFilter :: ClientSession -> UserID -> FilterID -> MatrixIO Filter

Events

sync :: ClientSession -> Maybe FilterID -> Maybe Text -> Maybe Presence -> Maybe Int -> MatrixIO SyncResult

getTimelines :: SyncResult -> [(RoomID, NonEmpty RoomEvent)]

Extract room events from a sync result

syncPoll

Arguments

:: MonadIO m

=> ClientSession

The client session, use createSession to get one.

-> Maybe FilterID

A sync filter, use createFilter to get one.

-> Maybe Text

A since value, get it from a previous sync result using the srNextBatch field.

-> Maybe Presence

Set the session presence.

-> (SyncResult -> m ())

Your callback to handle sync result.

-> MatrixM m ()

This function does not return unless there is an error.

newtype Author

Constructors

Author

Fields

• unAuthor :: Text

Instances

Eq Author

Defined in Network.Matrix.Client

Methods

(==) :: Author -> Author -> Bool

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

Show Author

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> Author -> ShowS

show :: Author -> String

showList :: [Author] -> ShowS

ToJSON Author

Defined in Network.Matrix.Client

Methods

toJSON :: Author -> Value

toEncoding :: Author -> Encoding

toJSONList :: [Author] -> Value

toEncodingList :: [Author] -> Encoding

FromJSON Author

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser Author

parseJSONList :: Value -> Parser [Author]

data Presence

Constructors

Offline

Online

Unavailable

Instances

Eq Presence

Defined in Network.Matrix.Client

Methods

(==) :: Presence -> Presence -> Bool

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

Show Presence

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> Presence -> ShowS

show :: Presence -> String

showList :: [Presence] -> ShowS

ToJSON Presence

Defined in Network.Matrix.Client

Methods

toJSON :: Presence -> Value

toEncoding :: Presence -> Encoding

toJSONList :: [Presence] -> Value

toEncodingList :: [Presence] -> Encoding

FromJSON Presence

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser Presence

parseJSONList :: Value -> Parser [Presence]

data RoomEvent

Constructors

RoomEvent

Fields

• reContent :: Event
• reType :: Text
• reEventId :: EventID
• reSender :: Author

Instances

Eq RoomEvent

Defined in Network.Matrix.Client

Methods

(==) :: RoomEvent -> RoomEvent -> Bool

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

Show RoomEvent

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> RoomEvent -> ShowS

show :: RoomEvent -> String

showList :: [RoomEvent] -> ShowS

Generic RoomEvent

Defined in Network.Matrix.Client

Associated Types

type Rep RoomEvent :: Type -> Type

Methods

from :: RoomEvent -> Rep RoomEvent x

to :: Rep RoomEvent x -> RoomEvent

ToJSON RoomEvent

Defined in Network.Matrix.Client

Methods

toJSON :: RoomEvent -> Value

toEncoding :: RoomEvent -> Encoding

toJSONList :: [RoomEvent] -> Value

toEncodingList :: [RoomEvent] -> Encoding

FromJSON RoomEvent

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser RoomEvent

parseJSONList :: Value -> Parser [RoomEvent]

type Rep RoomEvent

Defined in Network.Matrix.Client

type Rep RoomEvent = D1 ('MetaData "RoomEvent" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "RoomEvent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Event) :*: S1 ('MetaSel ('Just "reType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "reEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EventID) :*: S1 ('MetaSel ('Just "reSender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Author))))

data RoomSummary

Constructors

RoomSummary

Fields

• rsJoinedMemberCount :: Maybe Int
• rsInvitedMemberCount :: Maybe Int

Instances

Eq RoomSummary

Defined in Network.Matrix.Client

Methods

(==) :: RoomSummary -> RoomSummary -> Bool

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

Show RoomSummary

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> RoomSummary -> ShowS

show :: RoomSummary -> String

showList :: [RoomSummary] -> ShowS

Generic RoomSummary

Defined in Network.Matrix.Client

Associated Types

type Rep RoomSummary :: Type -> Type

Methods

from :: RoomSummary -> Rep RoomSummary x

to :: Rep RoomSummary x -> RoomSummary

ToJSON RoomSummary

Defined in Network.Matrix.Client

Methods

toJSON :: RoomSummary -> Value

toEncoding :: RoomSummary -> Encoding

toJSONList :: [RoomSummary] -> Value

toEncodingList :: [RoomSummary] -> Encoding

FromJSON RoomSummary

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser RoomSummary

parseJSONList :: Value -> Parser [RoomSummary]

type Rep RoomSummary

Defined in Network.Matrix.Client

type Rep RoomSummary = D1 ('MetaData "RoomSummary" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "RoomSummary" 'PrefixI 'True) (S1 ('MetaSel ('Just "rsJoinedMemberCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "rsInvitedMemberCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))

data TimelineSync

Constructors

TimelineSync

Fields

• tsEvents :: Maybe [RoomEvent]
• tsLimited :: Maybe Bool
• tsPrevBatch :: Maybe Text

Instances

Eq TimelineSync

Defined in Network.Matrix.Client

Methods

(==) :: TimelineSync -> TimelineSync -> Bool

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

Show TimelineSync

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> TimelineSync -> ShowS

show :: TimelineSync -> String

showList :: [TimelineSync] -> ShowS

Generic TimelineSync

Defined in Network.Matrix.Client

Associated Types

type Rep TimelineSync :: Type -> Type

Methods

from :: TimelineSync -> Rep TimelineSync x

to :: Rep TimelineSync x -> TimelineSync

ToJSON TimelineSync

Defined in Network.Matrix.Client

Methods

toJSON :: TimelineSync -> Value

toEncoding :: TimelineSync -> Encoding

toJSONList :: [TimelineSync] -> Value

toEncodingList :: [TimelineSync] -> Encoding

FromJSON TimelineSync

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser TimelineSync

parseJSONList :: Value -> Parser [TimelineSync]

type Rep TimelineSync

Defined in Network.Matrix.Client

type Rep TimelineSync = D1 ('MetaData "TimelineSync" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "TimelineSync" 'PrefixI 'True) (S1 ('MetaSel ('Just "tsEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [RoomEvent])) :*: (S1 ('MetaSel ('Just "tsLimited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tsPrevBatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data InvitedRoomSync

Constructors

InvitedRoomSync

Instances

Eq InvitedRoomSync

Defined in Network.Matrix.Client

Methods

(==) :: InvitedRoomSync -> InvitedRoomSync -> Bool

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

Show InvitedRoomSync

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> InvitedRoomSync -> ShowS

show :: InvitedRoomSync -> String

showList :: [InvitedRoomSync] -> ShowS

Generic InvitedRoomSync

Defined in Network.Matrix.Client

Associated Types

type Rep InvitedRoomSync :: Type -> Type

Methods

from :: InvitedRoomSync -> Rep InvitedRoomSync x

to :: Rep InvitedRoomSync x -> InvitedRoomSync

ToJSON InvitedRoomSync

Defined in Network.Matrix.Client

Methods

toJSON :: InvitedRoomSync -> Value

toEncoding :: InvitedRoomSync -> Encoding

toJSONList :: [InvitedRoomSync] -> Value

toEncodingList :: [InvitedRoomSync] -> Encoding

FromJSON InvitedRoomSync

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser InvitedRoomSync

parseJSONList :: Value -> Parser [InvitedRoomSync]

type Rep InvitedRoomSync

Defined in Network.Matrix.Client

type Rep InvitedRoomSync = D1 ('MetaData "InvitedRoomSync" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "InvitedRoomSync" 'PrefixI 'False) (U1 :: Type -> Type))

data JoinedRoomSync

Constructors

JoinedRoomSync

Fields

• jrsSummary :: Maybe RoomSummary
• jrsTimeline :: TimelineSync

Instances

Eq JoinedRoomSync

Defined in Network.Matrix.Client

Methods

(==) :: JoinedRoomSync -> JoinedRoomSync -> Bool

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

Show JoinedRoomSync

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> JoinedRoomSync -> ShowS

show :: JoinedRoomSync -> String

showList :: [JoinedRoomSync] -> ShowS

Generic JoinedRoomSync

Defined in Network.Matrix.Client

Associated Types

type Rep JoinedRoomSync :: Type -> Type

Methods

from :: JoinedRoomSync -> Rep JoinedRoomSync x

to :: Rep JoinedRoomSync x -> JoinedRoomSync

ToJSON JoinedRoomSync

Defined in Network.Matrix.Client

Methods

toJSON :: JoinedRoomSync -> Value

toEncoding :: JoinedRoomSync -> Encoding

toJSONList :: [JoinedRoomSync] -> Value

toEncodingList :: [JoinedRoomSync] -> Encoding

FromJSON JoinedRoomSync

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser JoinedRoomSync

parseJSONList :: Value -> Parser [JoinedRoomSync]

type Rep JoinedRoomSync

Defined in Network.Matrix.Client

type Rep JoinedRoomSync = D1 ('MetaData "JoinedRoomSync" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "JoinedRoomSync" 'PrefixI 'True) (S1 ('MetaSel ('Just "jrsSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RoomSummary)) :*: S1 ('MetaSel ('Just "jrsTimeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimelineSync)))

data SyncResult

Constructors

SyncResult

Fields

• srNextBatch :: Text
• srRooms :: Maybe SyncResultRoom

Instances

Eq SyncResult

Defined in Network.Matrix.Client

Methods

(==) :: SyncResult -> SyncResult -> Bool

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

Show SyncResult

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> SyncResult -> ShowS

show :: SyncResult -> String

showList :: [SyncResult] -> ShowS

Generic SyncResult

Defined in Network.Matrix.Client

Associated Types

type Rep SyncResult :: Type -> Type

Methods

from :: SyncResult -> Rep SyncResult x

to :: Rep SyncResult x -> SyncResult

ToJSON SyncResult

Defined in Network.Matrix.Client

Methods

toJSON :: SyncResult -> Value

toEncoding :: SyncResult -> Encoding

toJSONList :: [SyncResult] -> Value

toEncodingList :: [SyncResult] -> Encoding

FromJSON SyncResult

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser SyncResult

parseJSONList :: Value -> Parser [SyncResult]

type Rep SyncResult

Defined in Network.Matrix.Client

type Rep SyncResult = D1 ('MetaData "SyncResult" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "SyncResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "srNextBatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "srRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SyncResultRoom))))

data SyncResultRoom

Constructors

SyncResultRoom

Fields

• srrJoin :: Maybe (Map Text JoinedRoomSync)
• srrInvite :: Maybe (Map Text InvitedRoomSync)

Instances

Eq SyncResultRoom

Defined in Network.Matrix.Client

Methods

(==) :: SyncResultRoom -> SyncResultRoom -> Bool

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

Show SyncResultRoom

Defined in Network.Matrix.Client

Methods

showsPrec :: Int -> SyncResultRoom -> ShowS

show :: SyncResultRoom -> String

showList :: [SyncResultRoom] -> ShowS

Generic SyncResultRoom

Defined in Network.Matrix.Client

Associated Types

type Rep SyncResultRoom :: Type -> Type

Methods

from :: SyncResultRoom -> Rep SyncResultRoom x

to :: Rep SyncResultRoom x -> SyncResultRoom

ToJSON SyncResultRoom

Defined in Network.Matrix.Client

Methods

toJSON :: SyncResultRoom -> Value

toEncoding :: SyncResultRoom -> Encoding

toJSONList :: [SyncResultRoom] -> Value

toEncodingList :: [SyncResultRoom] -> Encoding

FromJSON SyncResultRoom

Defined in Network.Matrix.Client

Methods

parseJSON :: Value -> Parser SyncResultRoom

parseJSONList :: Value -> Parser [SyncResultRoom]

type Rep SyncResultRoom

Defined in Network.Matrix.Client

type Rep SyncResultRoom = D1 ('MetaData "SyncResultRoom" "Network.Matrix.Client" "matrix-client-0.1.2.0-IBEy2HWO5KfIiyHvD7KcGH" 'False) (C1 ('MetaCons "SyncResultRoom" 'PrefixI 'True) (S1 ('MetaSel ('Just "srrJoin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text JoinedRoomSync))) :*: S1 ('MetaSel ('Just "srrInvite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text InvitedRoomSync)))))