Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Matrix.Client

Contents

Client
API
User data
Room Events
Room management
Room participation
Room membership
Filter
Account data
Events

Description

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

Synopsis

data ClientSession
data LoginCredentials = LoginCredentials {
- lUsername :: Username
- lLoginSecret :: LoginSecret
- lBaseUrl :: Text
- lDeviceId :: Maybe DeviceId
- lInitialDeviceDisplayName :: Maybe InitialDeviceDisplayName
}
newtype MatrixToken = MatrixToken Text
newtype Username = Username {
- username :: Text
}
newtype DeviceId = DeviceId {
- deviceId :: Text
}
newtype InitialDeviceDisplayName = InitialDeviceDisplayName {
- initialDeviceDisplayName :: Text
}
data LoginSecret
- = Password Text
- | Token Text
data LoginResponse = LoginResponse {
- lrUserId :: Text
- lrAccessToken :: Text
- lrHomeServer :: Text
- lrDeviceId :: Text
}
getTokenFromEnv :: Text -> IO MatrixToken
createSession :: Text -> MatrixToken -> IO ClientSession
login :: LoginCredentials -> IO ClientSession
loginToken :: LoginCredentials -> IO (ClientSession, MatrixToken)
logout :: ClientSession -> MatrixIO ()
type MatrixM m a = m (Either MatrixError a)
type MatrixIO a = MatrixM IO a
data MatrixError = MatrixError {
- meErrcode :: Text
- meError :: Text
- meRetryAfterMS :: Maybe Int
}
retry :: (MonadIO m, MonadMask m) => MatrixM m a -> MatrixM m a
retryWithLog :: (MonadMask m, MonadIO m) => Int -> (Text -> m ()) -> MatrixM m a -> MatrixM m a
newtype UserID = UserID Text
getTokenOwner :: ClientSession -> MatrixIO UserID
data Dir
- = F
- | B
newtype EventType = EventType Text
data MRCreate = MRCreate {
- mrcCreator :: UserID
- mrcRoomVersion :: Integer
}
newtype MRCanonicalAlias = MRCanonicalAlias {
- mrcAlias :: Text
}
newtype MRGuestAccess = MRGuestAccess {
- mrGuestAccess :: Text
}
newtype MRHistoryVisibility = MRHistoryVisibility {
- mrHistoryVisibility :: Text
}
newtype MRName = MRName {
- mrnName :: Text
}
newtype MRTopic = MRTopic {
- mrTopic :: Text
}
data PaginatedRoomMessages = PaginatedRoomMessages {
- chunk :: [RoomEvent]
- end :: Maybe Text
- start :: Text
- state :: [StateEvent]
}
newtype StateKey = StateKey Text
data StateEvent = StateEvent {
- seContent :: StateContent
- seEventId :: EventID
- seOriginServerTimestamp :: Integer
- sePreviousContent :: Maybe Value
- seRoomId :: RoomID
- seSender :: UserID
- seStateKey :: StateKey
- seEventType :: EventType
- seUnsigned :: Maybe Value
}
data StateContent
- = StRoomCreate MRCreate
- | StRoomCanonicalAlias MRCanonicalAlias
- | StRoomGuestAccess MRGuestAccess
- | StRoomHistoryVisibility MRHistoryVisibility
- | StRoomName MRName
- | StRoomTopic MRTopic
- | StOther Value
getRoomEvent :: ClientSession -> RoomID -> EventID -> MatrixIO RoomEvent
getRoomMembers :: ClientSession -> RoomID -> MatrixIO (Map UserID User)
getRoomState :: ClientSession -> RoomID -> MatrixIO [StateEvent]
getRoomStateEvent :: ClientSession -> RoomID -> EventType -> StateKey -> MatrixIO StateEvent
getRoomMessages :: ClientSession -> RoomID -> Dir -> Maybe RoomEventFilter -> Text -> Maybe Int -> Maybe Int -> MatrixIO PaginatedRoomMessages
redact :: ClientSession -> RoomID -> EventID -> TxnID -> Text -> MatrixIO EventID
sendRoomStateEvent :: ClientSession -> RoomID -> EventType -> StateKey -> Value -> MatrixIO EventID
data RoomCreatePreset
- = PrivateChat
- | TrustedPrivateChat
- | PublicChat
data RoomCreateRequest = RoomCreateRequest {
- rcrPreset :: RoomCreatePreset
- rcrRoomAliasName :: Text
- rcrName :: Text
- rcrTopic :: Text
}
createRoom :: ClientSession -> RoomCreateRequest -> MatrixIO RoomID
data ResolvedRoomAlias = ResolvedRoomAlias {
- roomAlias :: RoomAlias
- roomID :: RoomID
- servers :: [Text]
}
newtype TxnID = TxnID Text
sendMessage :: ClientSession -> RoomID -> Event -> TxnID -> MatrixIO EventID
mkReply :: RoomID -> RoomEvent -> MessageText -> Event
data MessageTextType
- = TextType
- | EmoteType
- | NoticeType
data MessageText = MessageText {
- mtBody :: Text
- mtType :: MessageTextType
- mtFormat :: Maybe Text
- mtFormattedBody :: Maybe Text
}
newtype RoomMessage = RoomMessageText MessageText
data Event
- = EventRoomMessage RoomMessage
- | EventRoomReply EventID RoomMessage
- | EventRoomEdit (EventID, RoomMessage) RoomMessage
- | EventUnknown Object
newtype EventID = EventID {
- unEventID :: Text
}
eventType :: Event -> Text
setRoomAlias :: ClientSession -> RoomAlias -> RoomID -> MatrixIO ()
setRoomVisibility :: ClientSession -> RoomID -> Visibility -> MatrixIO ()
resolveRoomAlias :: ClientSession -> RoomAlias -> MatrixIO ResolvedRoomAlias
deleteRoomAlias :: ClientSession -> RoomAlias -> MatrixIO ()
getRoomAliases :: ClientSession -> RoomID -> MatrixIO [RoomAlias]
newtype RoomID = RoomID Text
newtype RoomAlias = RoomAlias Text
banUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO ()
checkRoomVisibility :: ClientSession -> RoomID -> MatrixIO Visibility
forgetRoom :: ClientSession -> RoomID -> MatrixIO ()
getJoinedRooms :: ClientSession -> MatrixIO [RoomID]
getPublicRooms :: ClientSession -> Maybe Int -> Maybe PaginationChunk -> MatrixIO PublicRooms
getPublicRooms' :: ClientSession -> Maybe Int -> Maybe PaginationChunk -> Maybe Text -> Maybe Bool -> Maybe ThirdPartyInstanceId -> MatrixIO PublicRooms
inviteToRoom :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO ()
joinRoom :: ClientSession -> Text -> MatrixIO RoomID
joinRoomById :: ClientSession -> RoomID -> MatrixIO RoomID
leaveRoomById :: ClientSession -> RoomID -> MatrixIO ()
kickUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO ()
knockOnRoom :: ClientSession -> Either RoomID RoomAlias -> [Text] -> Maybe Text -> MatrixIO RoomID
unbanUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO ()
data EventFormat
- = Client
- | Federation
data EventFilter = EventFilter {
- efLimit :: Maybe Int
- efNotSenders :: Maybe [Text]
- efNotTypes :: Maybe [Text]
- efSenders :: Maybe [Text]
- efTypes :: Maybe [Text]
}
defaultEventFilter :: EventFilter
eventFilterAll :: EventFilter
data RoomEventFilter = RoomEventFilter {
- 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
}
defaultRoomEventFilter :: RoomEventFilter
roomEventFilterAll :: RoomEventFilter
data StateFilter = StateFilter {
- 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
}
defaultStateFilter :: StateFilter
stateFilterAll :: StateFilter
data RoomFilter = RoomFilter {
- rfNotRooms :: Maybe [Text]
- rfRooms :: Maybe [Text]
- rfEphemeral :: Maybe RoomEventFilter
- rfIncludeLeave :: Maybe Bool
- rfState :: Maybe StateFilter
- rfTimeline :: Maybe RoomEventFilter
- rfAccountData :: Maybe RoomEventFilter
}
defaultRoomFilter :: RoomFilter
data Filter = Filter {
- filterEventFields :: Maybe [Text]
- filterEventFormat :: Maybe EventFormat
- filterPresence :: Maybe EventFilter
- filterAccountData :: Maybe EventFilter
- filterRoom :: Maybe RoomFilter
}
defaultFilter :: Filter
newtype FilterID = FilterID Text
messageFilter :: Filter
createFilter :: ClientSession -> UserID -> Filter -> MatrixIO FilterID
getFilter :: ClientSession -> UserID -> FilterID -> MatrixIO Filter
class (FromJSON a, ToJSON a) => AccountData a where
- accountDataType :: proxy a -> Text
getAccountData :: forall a. AccountData a => ClientSession -> UserID -> MatrixIO a
getAccountData' :: FromJSON a => ClientSession -> UserID -> Text -> MatrixIO a
setAccountData :: forall a. AccountData a => ClientSession -> UserID -> a -> MatrixIO ()
setAccountData' :: ToJSON a => ClientSession -> UserID -> Text -> a -> MatrixIO ()
sync :: ClientSession -> Maybe FilterID -> Maybe Text -> Maybe Presence -> Maybe Int -> MatrixIO SyncResult
getTimelines :: SyncResult -> [(RoomID, NonEmpty RoomEvent)]
syncPoll :: MonadIO m => ClientSession -> Maybe FilterID -> Maybe Text -> Maybe Presence -> (SyncResult -> m ()) -> MatrixM m ()
newtype Author = Author {
- unAuthor :: Text
}
data Presence
- = Offline
- | Online
- | Unavailable
data RoomEvent = RoomEvent {
- reContent :: Event
- reType :: Text
- reEventId :: EventID
- reSender :: Author
}
data RoomSummary = RoomSummary {
- rsJoinedMemberCount :: Maybe Int
- rsInvitedMemberCount :: Maybe Int
}
data TimelineSync = TimelineSync {
- tsEvents :: Maybe [RoomEvent]
- tsLimited :: Maybe Bool
- tsPrevBatch :: Maybe Text
}
data InvitedRoomSync = InvitedRoomSync
data JoinedRoomSync = JoinedRoomSync {
- jrsSummary :: Maybe RoomSummary
- jrsTimeline :: TimelineSync
}
data SyncResult = SyncResult {
- srNextBatch :: Text
- srRooms :: Maybe SyncResultRoom
}
data SyncResultRoom = SyncResultRoom {
- srrJoin :: Maybe (Map Text JoinedRoomSync)
- srrInvite :: Maybe (Map Text InvitedRoomSync)
}

Client

data ClientSession Source #

The session record, use createSession to create it.

data LoginCredentials Source #

Constructors

LoginCredentials
Fields lUsername :: Username lLoginSecret :: LoginSecret lBaseUrl :: Text lDeviceId :: Maybe DeviceId lInitialDeviceDisplayName :: Maybe InitialDeviceDisplayName

newtype MatrixToken Source #

Constructors

MatrixToken Text

newtype Username Source #

Constructors

Username
Fields username :: Text

newtype DeviceId Source #

Constructors

DeviceId
Fields deviceId :: Text

newtype InitialDeviceDisplayName Source #

Constructors

InitialDeviceDisplayName
Fields initialDeviceDisplayName :: Text

data LoginSecret Source #

Constructors

Password Text
Token Text

data LoginResponse Source #

Constructors

LoginResponse
Fields lrUserId :: Text lrAccessToken :: Text lrHomeServer :: Text lrDeviceId :: Text

Instances

Instances details

FromJSON LoginResponse Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser LoginResponse # parseJSONList :: Value -> Parser [LoginResponse] #

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.

login :: LoginCredentials -> IO ClientSession Source #

login allows you to generate a session token.

loginToken :: LoginCredentials -> IO (ClientSession, MatrixToken) Source #

loginToken allows you to generate a session token and recover the Matrix auth token.

logout :: ClientSession -> MatrixIO () Source #

logout allows you to destroy a session token.

API

type MatrixM m a = m (Either MatrixError a) Source #

type MatrixIO a = MatrixM IO 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

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

retry :: (MonadIO m, MonadMask m) => MatrixM m a -> MatrixM m a Source #

retryWithLog Source #

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 Source #

Constructors

UserID Text

Instances

Instances details

FromJSON UserID Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser UserID # parseJSONList :: Value -> Parser [UserID] #
FromJSONKey UserID Source #
Instance details Defined in Network.Matrix.Internal Methods fromJSONKey :: FromJSONKeyFunction UserID # fromJSONKeyList :: FromJSONKeyFunction [UserID] #
Show UserID Source #
Instance details Defined in Network.Matrix.Internal Methods showsPrec :: Int -> UserID -> ShowS # show :: UserID -> String # showList :: [UserID] -> ShowS #
Eq UserID Source #
Instance details Defined in Network.Matrix.Internal Methods (==) :: UserID -> UserID -> Bool # (/=) :: UserID -> UserID -> Bool #
Ord UserID Source #
Instance details 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 #
Hashable UserID Source #
Instance details Defined in Network.Matrix.Internal Methods hashWithSalt :: Int -> UserID -> Int # hash :: UserID -> Int #

getTokenOwner :: ClientSession -> MatrixIO UserID Source #

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

Room Events

data Dir Source #

Constructors

F	Forward
B	Backward

newtype EventType Source #

Constructors

EventType Text

Instances

Instances details

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

data MRCreate Source #

Constructors

MRCreate
Fields mrcCreator :: UserID mrcRoomVersion :: Integer

Instances

Instances details

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

newtype MRCanonicalAlias Source #

Constructors

MRCanonicalAlias
Fields mrcAlias :: Text

Instances

Instances details

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

newtype MRGuestAccess Source #

Constructors

MRGuestAccess
Fields mrGuestAccess :: Text

Instances

Instances details

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

newtype MRHistoryVisibility Source #

Constructors

MRHistoryVisibility
Fields mrHistoryVisibility :: Text

Instances

Instances details

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

newtype MRName Source #

Constructors

MRName
Fields mrnName :: Text

Instances

Instances details

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

newtype MRTopic Source #

Constructors

MRTopic
Fields mrTopic :: Text

Instances

Instances details

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

data PaginatedRoomMessages Source #

Constructors

PaginatedRoomMessages
Fields chunk :: [RoomEvent] end :: Maybe Text A token corresponding to the end of chunk. start :: Text A token corresponding to the start of chunk. state :: [StateEvent] A list of state events relevant to showing the chunk.

Instances

Instances details

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

newtype StateKey Source #

Constructors

StateKey Text

Instances

Instances details

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

data StateEvent Source #

Constructors

StateEvent
Fields seContent :: StateContent seEventId :: EventID seOriginServerTimestamp :: Integer sePreviousContent :: Maybe Value seRoomId :: RoomID seSender :: UserID seStateKey :: StateKey seEventType :: EventType seUnsigned :: Maybe Value

Instances

Instances details

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

data StateContent Source #

Constructors

StRoomCreate MRCreate
StRoomCanonicalAlias MRCanonicalAlias	StRoomMember MRMember \| StRoomPowerLevels MRPowerLevels \| StRoomJoinRules MRJoinRules
StRoomGuestAccess MRGuestAccess
StRoomHistoryVisibility MRHistoryVisibility
StRoomName MRName
StRoomTopic MRTopic
StOther Value

Instances

Instances details

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

getRoomEvent :: ClientSession -> RoomID -> EventID -> MatrixIO RoomEvent Source #

getRoomMembers :: ClientSession -> RoomID -> MatrixIO (Map UserID User) Source #

This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidjoined_members

getRoomState :: ClientSession -> RoomID -> MatrixIO [StateEvent] Source #

Get the state events for the current state of a room. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidstate

getRoomStateEvent :: ClientSession -> RoomID -> EventType -> StateKey -> MatrixIO StateEvent Source #

Looks up the contents of a state event in a room. If the user is joined to the room then the state is taken from the current state of the room. If the user has left the room then the state is taken from the state of the room when they left. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidstateeventtypestatekey

getRoomMessages Source #

Arguments

:: ClientSession
-> RoomID	The room to get events from.
-> Dir	The direction to return events from.
-> Maybe RoomEventFilter	A `RoomEventFilter` to filter returned events with.
-> Text	The Since value to start returning events from.
-> Maybe Int	The maximum number of events to return. Default: 10.
-> Maybe Int	The token to stop returning events at.
-> MatrixIO PaginatedRoomMessages

redact :: ClientSession -> RoomID -> EventID -> TxnID -> Text -> MatrixIO EventID Source #

sendRoomStateEvent :: ClientSession -> RoomID -> EventType -> StateKey -> Value -> MatrixIO EventID Source #

Send arbitrary state events to a room. These events will be overwritten if id, type and key all match. https://spec.matrix.org/v1.1/client-server-api/#put_matrixclientv3roomsroomidstateeventtypestatekey

Room management

data RoomCreatePreset Source #

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

Constructors

PrivateChat
TrustedPrivateChat
PublicChat

Instances

Instances details

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

data RoomCreateRequest Source #

Constructors

RoomCreateRequest
Fields rcrPreset :: RoomCreatePreset rcrRoomAliasName :: Text rcrName :: Text rcrTopic :: Text

Instances

Instances details

ToJSON RoomCreateRequest Source #
Instance details Defined in Network.Matrix.Room Methods toJSON :: RoomCreateRequest -> Value # toEncoding :: RoomCreateRequest -> Encoding # toJSONList :: [RoomCreateRequest] -> Value # toEncodingList :: [RoomCreateRequest] -> Encoding #
Generic RoomCreateRequest Source #
Instance details Defined in Network.Matrix.Room Associated Types type Rep RoomCreateRequest :: Type -> Type # Methods from :: RoomCreateRequest -> Rep RoomCreateRequest x # to :: Rep RoomCreateRequest x -> RoomCreateRequest #
Show RoomCreateRequest Source #
Instance details Defined in Network.Matrix.Room Methods showsPrec :: Int -> RoomCreateRequest -> ShowS # show :: RoomCreateRequest -> String # showList :: [RoomCreateRequest] -> ShowS #
Eq RoomCreateRequest Source #
Instance details Defined in Network.Matrix.Room Methods (==) :: RoomCreateRequest -> RoomCreateRequest -> Bool # (/=) :: RoomCreateRequest -> RoomCreateRequest -> Bool #
type Rep RoomCreateRequest Source #
Instance details Defined in Network.Matrix.Room type Rep RoomCreateRequest = D1 ('MetaData "RoomCreateRequest" "Network.Matrix.Room" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Create a new room with various configuration options. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3createroom

Room participation

data ResolvedRoomAlias Source #

Constructors

ResolvedRoomAlias
Fields roomAlias :: RoomAlias roomID :: RoomID The room ID for this room alias. servers :: [Text] A list of servers that are aware of this room alias.

Instances

Instances details

Show ResolvedRoomAlias Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> ResolvedRoomAlias -> ShowS # show :: ResolvedRoomAlias -> String # showList :: [ResolvedRoomAlias] -> ShowS #

newtype TxnID Source #

Constructors

TxnID Text

Instances

Instances details

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

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

This endpoint is used to send a message event to a room. https://spec.matrix.org/v1.1/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid

mkReply Source #

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 Source #

Constructors

TextType
EmoteType
NoticeType

Instances

Instances details

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

data MessageText Source #

Constructors

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

Instances

Instances details

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

newtype RoomMessage Source #

Constructors

RoomMessageText MessageText

Instances

Instances details

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

data Event Source #

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

Instances details

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

newtype EventID Source #

Constructors

EventID
Fields unEventID :: Text

Instances

Instances details

FromJSON EventID Source #
Instance details Defined in Network.Matrix.Events Methods parseJSON :: Value -> Parser EventID # parseJSONList :: Value -> Parser [EventID] #
ToJSON EventID Source #
Instance details Defined in Network.Matrix.Events Methods toJSON :: EventID -> Value # toEncoding :: EventID -> Encoding # toJSONList :: [EventID] -> Value # toEncodingList :: [EventID] -> Encoding #
Show EventID Source #
Instance details Defined in Network.Matrix.Events Methods showsPrec :: Int -> EventID -> ShowS # show :: EventID -> String # showList :: [EventID] -> ShowS #
Eq EventID Source #
Instance details Defined in Network.Matrix.Events Methods (==) :: EventID -> EventID -> Bool # (/=) :: EventID -> EventID -> Bool #
Ord EventID Source #
Instance details 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 #

eventType :: Event -> Text Source #

setRoomAlias :: ClientSession -> RoomAlias -> RoomID -> MatrixIO () Source #

Create a mapping of room alias to room ID. https://spec.matrix.org/v1.1/client-server-api/#put_matrixclientv3directoryroomroomalias

setRoomVisibility :: ClientSession -> RoomID -> Visibility -> MatrixIO () Source #

Sets the visibility of a given room in the server’s public room directory. https://spec.matrix.org/v1.1/client-server-api/#put_matrixclientv3directorylistroomroomid

resolveRoomAlias :: ClientSession -> RoomAlias -> MatrixIO ResolvedRoomAlias Source #

Requests that the server resolve a room alias to a room ID. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3directoryroomroomalias

deleteRoomAlias :: ClientSession -> RoomAlias -> MatrixIO () Source #

Delete a mapping of room alias to room ID. https://spec.matrix.org/v1.1/client-server-api/#delete_matrixclientv3directoryroomroomalias

getRoomAliases :: ClientSession -> RoomID -> MatrixIO [RoomAlias] Source #

Get a list of aliases maintained by the local server for the given room. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidaliases

Room membership

newtype RoomID Source #

Constructors

RoomID Text

Instances

Instances details

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

newtype RoomAlias Source #

Constructors

RoomAlias Text

Instances

Instances details

Show RoomAlias Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomAlias -> ShowS # show :: RoomAlias -> String # showList :: [RoomAlias] -> ShowS #
Eq RoomAlias Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomAlias -> RoomAlias -> Bool # (/=) :: RoomAlias -> RoomAlias -> Bool #
Ord RoomAlias Source #
Instance details Defined in Network.Matrix.Client Methods compare :: RoomAlias -> RoomAlias -> Ordering # (<) :: RoomAlias -> RoomAlias -> Bool # (<=) :: RoomAlias -> RoomAlias -> Bool # (>) :: RoomAlias -> RoomAlias -> Bool # (>=) :: RoomAlias -> RoomAlias -> Bool # max :: RoomAlias -> RoomAlias -> RoomAlias # min :: RoomAlias -> RoomAlias -> RoomAlias #
Hashable RoomAlias Source #
Instance details Defined in Network.Matrix.Client Methods hashWithSalt :: Int -> RoomAlias -> Int # hash :: RoomAlias -> Int #

banUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO () Source #

Ban a user in the room. If the user is currently in the room, also kick them. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidban

checkRoomVisibility :: ClientSession -> RoomID -> MatrixIO Visibility Source #

Gets the visibility of a given room on the server’s public room directory. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3directorylistroomroomid

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

Stops remembering a particular room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidforget

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

Returns a list of the user’s current rooms. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3joined_rooms

getPublicRooms :: ClientSession -> Maybe Int -> Maybe PaginationChunk -> MatrixIO PublicRooms Source #

Lists the public rooms on the server. https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3publicrooms

getPublicRooms' :: ClientSession -> Maybe Int -> Maybe PaginationChunk -> Maybe Text -> Maybe Bool -> Maybe ThirdPartyInstanceId -> MatrixIO PublicRooms Source #

Lists the public rooms on the server, with optional filter. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3publicrooms

inviteToRoom :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO () Source #

Invites a user to participate in a particular room. They do not start participating in the room until they actually join the room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidinvite

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

Note that this API takes either a room ID or alias, unlike joinRoomById https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3joinroomidoralias

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

Starts a user participating in a particular room, if that user is allowed to participate in that room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidjoin

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

Stop participating in a particular room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidleave

kickUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO () Source #

Kick a user from the room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidkick

knockOnRoom :: ClientSession -> Either RoomID RoomAlias -> [Text] -> Maybe Text -> MatrixIO RoomID Source #

This API “knocks” on the room to ask for permission to join, if the user is allowed to knock on the room. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3knockroomidoralias

unbanUser :: ClientSession -> RoomID -> UserID -> Maybe Text -> MatrixIO () Source #

Unban a user from the room. This allows them to be invited to the room, and join if they would otherwise be allowed to join according to its join rules. https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3roomsroomidunban

Filter

data EventFormat Source #

Constructors

Client
Federation

Instances

Instances details

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

data EventFilter Source #

Constructors

EventFilter
Fields efLimit :: Maybe Int efNotSenders :: Maybe [Text] efNotTypes :: Maybe [Text] efSenders :: Maybe [Text] efTypes :: Maybe [Text]

Instances

Instances details

FromJSON EventFilter Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser EventFilter # parseJSONList :: Value -> Parser [EventFilter] #
ToJSON EventFilter Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: EventFilter -> Value # toEncoding :: EventFilter -> Encoding # toJSONList :: [EventFilter] -> Value # toEncodingList :: [EventFilter] -> Encoding #
Generic EventFilter Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep EventFilter :: Type -> Type # Methods from :: EventFilter -> Rep EventFilter x # to :: Rep EventFilter x -> EventFilter #
Show EventFilter Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> EventFilter -> ShowS # show :: EventFilter -> String # showList :: [EventFilter] -> ShowS #
Eq EventFilter Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: EventFilter -> EventFilter -> Bool # (/=) :: EventFilter -> EventFilter -> Bool #
type Rep EventFilter Source #
Instance details Defined in Network.Matrix.Client type Rep EventFilter = D1 ('MetaData "EventFilter" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

eventFilterAll :: EventFilter Source #

A filter that should match nothing

data RoomEventFilter Source #

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

Instances details

FromJSON RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser RoomEventFilter # parseJSONList :: Value -> Parser [RoomEventFilter] #
ToJSON RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: RoomEventFilter -> Value # toEncoding :: RoomEventFilter -> Encoding # toJSONList :: [RoomEventFilter] -> Value # toEncodingList :: [RoomEventFilter] -> Encoding #
Generic RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep RoomEventFilter :: Type -> Type # Methods from :: RoomEventFilter -> Rep RoomEventFilter x # to :: Rep RoomEventFilter x -> RoomEventFilter #
Show RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomEventFilter -> ShowS # show :: RoomEventFilter -> String # showList :: [RoomEventFilter] -> ShowS #
Eq RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomEventFilter -> RoomEventFilter -> Bool # (/=) :: RoomEventFilter -> RoomEventFilter -> Bool #
type Rep RoomEventFilter Source #
Instance details Defined in Network.Matrix.Client type Rep RoomEventFilter = D1 ('MetaData "RoomEventFilter" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

roomEventFilterAll :: RoomEventFilter Source #

A filter that should match nothing

data StateFilter Source #

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

Instances details

FromJSON StateFilter Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser StateFilter # parseJSONList :: Value -> Parser [StateFilter] #
ToJSON StateFilter Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: StateFilter -> Value # toEncoding :: StateFilter -> Encoding # toJSONList :: [StateFilter] -> Value # toEncodingList :: [StateFilter] -> Encoding #
Generic StateFilter Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep StateFilter :: Type -> Type # Methods from :: StateFilter -> Rep StateFilter x # to :: Rep StateFilter x -> StateFilter #
Show StateFilter Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> StateFilter -> ShowS # show :: StateFilter -> String # showList :: [StateFilter] -> ShowS #
Eq StateFilter Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: StateFilter -> StateFilter -> Bool # (/=) :: StateFilter -> StateFilter -> Bool #
type Rep StateFilter Source #
Instance details Defined in Network.Matrix.Client type Rep StateFilter = D1 ('MetaData "StateFilter" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

stateFilterAll :: StateFilter Source #

data RoomFilter Source #

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

Instances details

FromJSON RoomFilter Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser RoomFilter # parseJSONList :: Value -> Parser [RoomFilter] #
ToJSON RoomFilter Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: RoomFilter -> Value # toEncoding :: RoomFilter -> Encoding # toJSONList :: [RoomFilter] -> Value # toEncodingList :: [RoomFilter] -> Encoding #
Generic RoomFilter Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep RoomFilter :: Type -> Type # Methods from :: RoomFilter -> Rep RoomFilter x # to :: Rep RoomFilter x -> RoomFilter #
Show RoomFilter Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomFilter -> ShowS # show :: RoomFilter -> String # showList :: [RoomFilter] -> ShowS #
Eq RoomFilter Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomFilter -> RoomFilter -> Bool # (/=) :: RoomFilter -> RoomFilter -> Bool #
type Rep RoomFilter Source #
Instance details Defined in Network.Matrix.Client type Rep RoomFilter = D1 ('MetaData "RoomFilter" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

data Filter Source #

Constructors

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

Instances

Instances details

FromJSON Filter Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser Filter # parseJSONList :: Value -> Parser [Filter] #
ToJSON Filter Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
Generic Filter Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
Show Filter Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Eq Filter Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
type Rep Filter Source #
Instance details Defined in Network.Matrix.Client type Rep Filter = D1 ('MetaData "Filter" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

newtype FilterID Source #

Constructors

FilterID Text

Instances

Instances details

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

messageFilter :: Filter Source #

A filter to keep all the messages

createFilter Source #

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 Source #

Account data

class (FromJSON a, ToJSON a) => AccountData a where Source #

Methods

accountDataType :: proxy a -> Text Source #

getAccountData :: forall a. AccountData a => ClientSession -> UserID -> MatrixIO a Source #

getAccountData' :: FromJSON a => ClientSession -> UserID -> Text -> MatrixIO a Source #

setAccountData :: forall a. AccountData a => ClientSession -> UserID -> a -> MatrixIO () Source #

setAccountData' :: ToJSON a => ClientSession -> UserID -> Text -> a -> MatrixIO () Source #

Events

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

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

Extract room events from a sync result

syncPoll Source #

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 Source #

Constructors

Author
Fields unAuthor :: Text

Instances

Instances details

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

data Presence Source #

Constructors

Offline
Online
Unavailable

Instances

Instances details

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

data RoomEvent Source #

Constructors

RoomEvent
Fields reContent :: Event reType :: Text reEventId :: EventID reSender :: Author

Instances

Instances details

FromJSON RoomEvent Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser RoomEvent # parseJSONList :: Value -> Parser [RoomEvent] #
ToJSON RoomEvent Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: RoomEvent -> Value # toEncoding :: RoomEvent -> Encoding # toJSONList :: [RoomEvent] -> Value # toEncodingList :: [RoomEvent] -> Encoding #
Generic RoomEvent Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep RoomEvent :: Type -> Type # Methods from :: RoomEvent -> Rep RoomEvent x # to :: Rep RoomEvent x -> RoomEvent #
Show RoomEvent Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomEvent -> ShowS # show :: RoomEvent -> String # showList :: [RoomEvent] -> ShowS #
Eq RoomEvent Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomEvent -> RoomEvent -> Bool # (/=) :: RoomEvent -> RoomEvent -> Bool #
type Rep RoomEvent Source #
Instance details Defined in Network.Matrix.Client type Rep RoomEvent = D1 ('MetaData "RoomEvent" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Constructors

RoomSummary
Fields rsJoinedMemberCount :: Maybe Int rsInvitedMemberCount :: Maybe Int

Instances

Instances details

FromJSON RoomSummary Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser RoomSummary # parseJSONList :: Value -> Parser [RoomSummary] #
ToJSON RoomSummary Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: RoomSummary -> Value # toEncoding :: RoomSummary -> Encoding # toJSONList :: [RoomSummary] -> Value # toEncodingList :: [RoomSummary] -> Encoding #
Generic RoomSummary Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep RoomSummary :: Type -> Type # Methods from :: RoomSummary -> Rep RoomSummary x # to :: Rep RoomSummary x -> RoomSummary #
Show RoomSummary Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> RoomSummary -> ShowS # show :: RoomSummary -> String # showList :: [RoomSummary] -> ShowS #
Eq RoomSummary Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: RoomSummary -> RoomSummary -> Bool # (/=) :: RoomSummary -> RoomSummary -> Bool #
type Rep RoomSummary Source #
Instance details Defined in Network.Matrix.Client type Rep RoomSummary = D1 ('MetaData "RoomSummary" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Constructors

TimelineSync
Fields tsEvents :: Maybe [RoomEvent] tsLimited :: Maybe Bool tsPrevBatch :: Maybe Text

Instances

Instances details

FromJSON TimelineSync Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser TimelineSync # parseJSONList :: Value -> Parser [TimelineSync] #
ToJSON TimelineSync Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: TimelineSync -> Value # toEncoding :: TimelineSync -> Encoding # toJSONList :: [TimelineSync] -> Value # toEncodingList :: [TimelineSync] -> Encoding #
Generic TimelineSync Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep TimelineSync :: Type -> Type # Methods from :: TimelineSync -> Rep TimelineSync x # to :: Rep TimelineSync x -> TimelineSync #
Show TimelineSync Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> TimelineSync -> ShowS # show :: TimelineSync -> String # showList :: [TimelineSync] -> ShowS #
Eq TimelineSync Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: TimelineSync -> TimelineSync -> Bool # (/=) :: TimelineSync -> TimelineSync -> Bool #
type Rep TimelineSync Source #
Instance details Defined in Network.Matrix.Client type Rep TimelineSync = D1 ('MetaData "TimelineSync" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Constructors

InvitedRoomSync

Instances

Instances details

FromJSON InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser InvitedRoomSync # parseJSONList :: Value -> Parser [InvitedRoomSync] #
ToJSON InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: InvitedRoomSync -> Value # toEncoding :: InvitedRoomSync -> Encoding # toJSONList :: [InvitedRoomSync] -> Value # toEncodingList :: [InvitedRoomSync] -> Encoding #
Generic InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep InvitedRoomSync :: Type -> Type # Methods from :: InvitedRoomSync -> Rep InvitedRoomSync x # to :: Rep InvitedRoomSync x -> InvitedRoomSync #
Show InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> InvitedRoomSync -> ShowS # show :: InvitedRoomSync -> String # showList :: [InvitedRoomSync] -> ShowS #
Eq InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: InvitedRoomSync -> InvitedRoomSync -> Bool # (/=) :: InvitedRoomSync -> InvitedRoomSync -> Bool #
type Rep InvitedRoomSync Source #
Instance details Defined in Network.Matrix.Client type Rep InvitedRoomSync = D1 ('MetaData "InvitedRoomSync" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" 'False) (C1 ('MetaCons "InvitedRoomSync" 'PrefixI 'False) (U1 :: Type -> Type))

data JoinedRoomSync Source #

Constructors

JoinedRoomSync
Fields jrsSummary :: Maybe RoomSummary jrsTimeline :: TimelineSync

Instances

Instances details

FromJSON JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser JoinedRoomSync # parseJSONList :: Value -> Parser [JoinedRoomSync] #
ToJSON JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: JoinedRoomSync -> Value # toEncoding :: JoinedRoomSync -> Encoding # toJSONList :: [JoinedRoomSync] -> Value # toEncodingList :: [JoinedRoomSync] -> Encoding #
Generic JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep JoinedRoomSync :: Type -> Type # Methods from :: JoinedRoomSync -> Rep JoinedRoomSync x # to :: Rep JoinedRoomSync x -> JoinedRoomSync #
Show JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> JoinedRoomSync -> ShowS # show :: JoinedRoomSync -> String # showList :: [JoinedRoomSync] -> ShowS #
Eq JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: JoinedRoomSync -> JoinedRoomSync -> Bool # (/=) :: JoinedRoomSync -> JoinedRoomSync -> Bool #
type Rep JoinedRoomSync Source #
Instance details Defined in Network.Matrix.Client type Rep JoinedRoomSync = D1 ('MetaData "JoinedRoomSync" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Constructors

SyncResult
Fields srNextBatch :: Text srRooms :: Maybe SyncResultRoom

Instances

Instances details

FromJSON SyncResult Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser SyncResult # parseJSONList :: Value -> Parser [SyncResult] #
ToJSON SyncResult Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: SyncResult -> Value # toEncoding :: SyncResult -> Encoding # toJSONList :: [SyncResult] -> Value # toEncodingList :: [SyncResult] -> Encoding #
Generic SyncResult Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep SyncResult :: Type -> Type # Methods from :: SyncResult -> Rep SyncResult x # to :: Rep SyncResult x -> SyncResult #
Show SyncResult Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> SyncResult -> ShowS # show :: SyncResult -> String # showList :: [SyncResult] -> ShowS #
Eq SyncResult Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: SyncResult -> SyncResult -> Bool # (/=) :: SyncResult -> SyncResult -> Bool #
type Rep SyncResult Source #
Instance details Defined in Network.Matrix.Client type Rep SyncResult = D1 ('MetaData "SyncResult" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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 Source #

Constructors

SyncResultRoom
Fields srrJoin :: Maybe (Map Text JoinedRoomSync) srrInvite :: Maybe (Map Text InvitedRoomSync)

Instances

Instances details

FromJSON SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client Methods parseJSON :: Value -> Parser SyncResultRoom # parseJSONList :: Value -> Parser [SyncResultRoom] #
ToJSON SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client Methods toJSON :: SyncResultRoom -> Value # toEncoding :: SyncResultRoom -> Encoding # toJSONList :: [SyncResultRoom] -> Value # toEncodingList :: [SyncResultRoom] -> Encoding #
Generic SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client Associated Types type Rep SyncResultRoom :: Type -> Type # Methods from :: SyncResultRoom -> Rep SyncResultRoom x # to :: Rep SyncResultRoom x -> SyncResultRoom #
Show SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client Methods showsPrec :: Int -> SyncResultRoom -> ShowS # show :: SyncResultRoom -> String # showList :: [SyncResultRoom] -> ShowS #
Eq SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client Methods (==) :: SyncResultRoom -> SyncResultRoom -> Bool # (/=) :: SyncResultRoom -> SyncResultRoom -> Bool #
type Rep SyncResultRoom Source #
Instance details Defined in Network.Matrix.Client type Rep SyncResultRoom = D1 ('MetaData "SyncResultRoom" "Network.Matrix.Client" "matrix-client-0.1.5.0-8hA0zxvoqujEIAR2je6bZW" '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)))))