-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | A matrix client library -- -- Matrix client is a library to interface with -- https://matrix.org. -- -- Use this library to interact with matrix server. -- -- Read the Network.Matrix.Tutorial for a detailed tutorial. -- -- Please see the README at -- https://github.com/softwarefactory-project/matrix-client-haskell#readme @package matrix-client @version 0.1.2.0 -- | This module contains the Identity service API -- https://matrix.org/docs/spec/identity_service/r0.3.0.html module Network.Matrix.Identity -- | The session record, use createSession to create it. data IdentitySession newtype MatrixToken MatrixToken :: Text -> MatrixToken getTokenFromEnv :: Text -> IO MatrixToken -- | createSession creates the session record. createIdentitySession :: Text -> MatrixToken -> IO IdentitySession -- | MatrixIO is a convenient type alias for server response type MatrixIO a = MatrixM IO a data MatrixError MatrixError :: Text -> Text -> Maybe Int -> MatrixError [meErrcode] :: MatrixError -> Text [meError] :: MatrixError -> Text [meRetryAfterMS] :: MatrixError -> Maybe Int retry :: MatrixIO a -> MatrixIO a -- | Retry a network action retryWithLog :: (MonadMask m, MonadIO m) => Int -> (Text -> m ()) -> MatrixM m a -> MatrixM m a newtype UserID UserID :: Text -> UserID -- | getIdentityTokenOwner gets information about the owner of a -- given access token. getIdentityTokenOwner :: IdentitySession -> MatrixIO UserID data HashDetails HashDetails :: NonEmpty Text -> Text -> HashDetails [hdAlgorithms] :: HashDetails -> NonEmpty Text [hdPepper] :: HashDetails -> Text hashDetails :: IdentitySession -> MatrixIO HashDetails data Identity Email :: Text -> Identity Msisdn :: Text -> Identity -- | Use identityLookup to lookup a single identity, otherwise uses -- the full identitiesLookup. identityLookup :: IdentitySession -> HashDetails -> Identity -> MatrixIO (Maybe UserID) data HashedAddress data IdentityLookupRequest -- | A newtype wrapper to decoded nested list -- -- 
--   >>> decode "{\"mappings\": {\"hash\": \"user\"}}" :: Maybe IdentityLookupResponse
--   Just (IdentityLookupResponse [(HashedAddress "hash",UserID "user")])
--
data IdentityLookupResponse identitiesLookup :: IdentitySession -> IdentityLookupRequest -> MatrixIO IdentityLookupResponse mkIdentityLookupRequest :: HashDetails -> [HashedAddress] -> IdentityLookupRequest toHashedAddress :: HashDetails -> Identity -> HashedAddress lookupIdentity :: HashedAddress -> IdentityLookupResponse -> Maybe UserID instance GHC.Classes.Eq Network.Matrix.Identity.HashDetails instance GHC.Show.Show Network.Matrix.Identity.HashDetails instance GHC.Classes.Eq Network.Matrix.Identity.HashedAddress instance GHC.Show.Show Network.Matrix.Identity.HashedAddress instance GHC.Classes.Eq Network.Matrix.Identity.IdentityLookupRequest instance GHC.Show.Show Network.Matrix.Identity.IdentityLookupRequest instance GHC.Show.Show Network.Matrix.Identity.IdentityLookupResponse instance GHC.Classes.Eq Network.Matrix.Identity.Identity instance GHC.Show.Show Network.Matrix.Identity.Identity instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Identity.IdentityLookupResponse instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Identity.HashDetails -- | This module contains the client-server API -- https://matrix.org/docs/spec/client_server/r0.6.1 module Network.Matrix.Client -- | The session record, use createSession to create it. data ClientSession newtype MatrixToken MatrixToken :: Text -> MatrixToken getTokenFromEnv :: Text -> IO MatrixToken -- | createSession creates the session record. createSession :: Text -> MatrixToken -> IO ClientSession type MatrixM m a = m (Either MatrixError a) -- | MatrixIO is a convenient type alias for server response type MatrixIO a = MatrixM IO a data MatrixError MatrixError :: Text -> Text -> Maybe Int -> MatrixError [meErrcode] :: MatrixError -> Text [meError] :: MatrixError -> Text [meRetryAfterMS] :: MatrixError -> Maybe Int retry :: MatrixIO a -> MatrixIO a -- | Retry a network action retryWithLog :: (MonadMask m, MonadIO m) => Int -> (Text -> m ()) -> MatrixM m a -> MatrixM m a newtype UserID UserID :: Text -> UserID -- | getTokenOwner gets information about the owner of a given -- access token. getTokenOwner :: ClientSession -> MatrixIO UserID -- | -- https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-createroom data RoomCreatePreset PrivateChat :: RoomCreatePreset TrustedPrivateChat :: RoomCreatePreset PublicChat :: RoomCreatePreset data RoomCreateRequest RoomCreateRequest :: RoomCreatePreset -> Text -> Text -> Text -> RoomCreateRequest [rcrPreset] :: RoomCreateRequest -> RoomCreatePreset [rcrRoomAliasName] :: RoomCreateRequest -> Text [rcrName] :: RoomCreateRequest -> Text [rcrTopic] :: RoomCreateRequest -> Text createRoom :: ClientSession -> RoomCreateRequest -> MatrixIO RoomID newtype TxnID TxnID :: Text -> TxnID sendMessage :: ClientSession -> RoomID -> Event -> TxnID -> MatrixIO EventID -- | Prepare a reply event mkReply :: RoomID -> RoomEvent -> MessageText -> Event data MessageTextType TextType :: MessageTextType EmoteType :: MessageTextType NoticeType :: MessageTextType data MessageText MessageText :: Text -> MessageTextType -> Maybe Text -> Maybe Text -> MessageText [mtBody] :: MessageText -> Text [mtType] :: MessageText -> MessageTextType [mtFormat] :: MessageText -> Maybe Text [mtFormattedBody] :: MessageText -> Maybe Text newtype RoomMessage RoomMessageText :: MessageText -> RoomMessage data Event EventRoomMessage :: RoomMessage -> Event -- | A reply defined by the parent event id and the reply message EventRoomReply :: EventID -> RoomMessage -> Event -- | An edit defined by the original message and the new message EventRoomEdit :: (EventID, RoomMessage) -> RoomMessage -> Event EventUnknown :: Object -> Event newtype EventID EventID :: Text -> EventID [unEventID] :: EventID -> Text eventType :: Event -> Text newtype RoomID RoomID :: Text -> RoomID getJoinedRooms :: ClientSession -> MatrixIO [RoomID] -- | Note that this API takes either a room ID or alias, unlike -- joinRoomById joinRoom :: ClientSession -> Text -> MatrixIO RoomID joinRoomById :: ClientSession -> RoomID -> MatrixIO RoomID leaveRoomById :: ClientSession -> RoomID -> MatrixIO () data EventFormat Client :: EventFormat Federation :: EventFormat data EventFilter EventFilter :: Maybe Int -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> EventFilter [efLimit] :: EventFilter -> Maybe Int [efNotSenders] :: EventFilter -> Maybe [Text] [efNotTypes] :: EventFilter -> Maybe [Text] [efSenders] :: EventFilter -> Maybe [Text] [efTypes] :: EventFilter -> Maybe [Text] defaultEventFilter :: EventFilter -- | A filter that should match nothing eventFilterAll :: EventFilter data RoomEventFilter RoomEventFilter :: Maybe Int -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> Maybe Bool -> Maybe Bool -> Maybe [Text] -> Maybe [Text] -> Maybe Bool -> RoomEventFilter [refLimit] :: RoomEventFilter -> Maybe Int [refNotSenders] :: RoomEventFilter -> Maybe [Text] [refNotTypes] :: RoomEventFilter -> Maybe [Text] [refSenders] :: RoomEventFilter -> Maybe [Text] [refTypes] :: RoomEventFilter -> Maybe [Text] [refLazyLoadMembers] :: RoomEventFilter -> Maybe Bool [refIncludeRedundantMembers] :: RoomEventFilter -> Maybe Bool [refNotRooms] :: RoomEventFilter -> Maybe [Text] [refRooms] :: RoomEventFilter -> Maybe [Text] [refContainsUrl] :: RoomEventFilter -> Maybe Bool defaultRoomEventFilter :: RoomEventFilter -- | A filter that should match nothing roomEventFilterAll :: RoomEventFilter data StateFilter StateFilter :: Maybe Int -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> Maybe [Text] -> Maybe Bool -> Maybe Bool -> Maybe [Text] -> Maybe [Text] -> Maybe Bool -> StateFilter [sfLimit] :: StateFilter -> Maybe Int [sfNotSenders] :: StateFilter -> Maybe [Text] [sfNotTypes] :: StateFilter -> Maybe [Text] [sfSenders] :: StateFilter -> Maybe [Text] [sfTypes] :: StateFilter -> Maybe [Text] [sfLazyLoadMembers] :: StateFilter -> Maybe Bool [sfIncludeRedundantMembers] :: StateFilter -> Maybe Bool [sfNotRooms] :: StateFilter -> Maybe [Text] [sfRooms] :: StateFilter -> Maybe [Text] [sfContains_url] :: StateFilter -> Maybe Bool defaultStateFilter :: StateFilter stateFilterAll :: StateFilter data RoomFilter RoomFilter :: Maybe [Text] -> Maybe [Text] -> Maybe RoomEventFilter -> Maybe Bool -> Maybe StateFilter -> Maybe RoomEventFilter -> Maybe RoomEventFilter -> RoomFilter [rfNotRooms] :: RoomFilter -> Maybe [Text] [rfRooms] :: RoomFilter -> Maybe [Text] [rfEphemeral] :: RoomFilter -> Maybe RoomEventFilter [rfIncludeLeave] :: RoomFilter -> Maybe Bool [rfState] :: RoomFilter -> Maybe StateFilter [rfTimeline] :: RoomFilter -> Maybe RoomEventFilter [rfAccountData] :: RoomFilter -> Maybe RoomEventFilter defaultRoomFilter :: RoomFilter data Filter Filter :: Maybe [Text] -> Maybe EventFormat -> Maybe EventFilter -> Maybe EventFilter -> Maybe RoomFilter -> Filter [filterEventFields] :: Filter -> Maybe [Text] [filterEventFormat] :: Filter -> Maybe EventFormat [filterPresence] :: Filter -> Maybe EventFilter [filterAccountData] :: Filter -> Maybe EventFilter [filterRoom] :: Filter -> Maybe RoomFilter defaultFilter :: Filter newtype FilterID FilterID :: Text -> FilterID -- | A filter to keep all the messages messageFilter :: Filter -- | Upload a new filter definition to the homeserver -- https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-user-userid-filter createFilter :: ClientSession -> UserID -> Filter -> MatrixIO FilterID getFilter :: ClientSession -> UserID -> FilterID -> MatrixIO Filter sync :: ClientSession -> Maybe FilterID -> Maybe Text -> Maybe Presence -> Maybe Int -> MatrixIO SyncResult -- | Extract room events from a sync result getTimelines :: SyncResult -> [(RoomID, NonEmpty RoomEvent)] syncPoll :: MonadIO m => ClientSession -> Maybe FilterID -> Maybe Text -> Maybe Presence -> (SyncResult -> m ()) -> MatrixM m () newtype Author Author :: Text -> Author [unAuthor] :: Author -> Text data Presence Offline :: Presence Online :: Presence Unavailable :: Presence data RoomEvent RoomEvent :: Event -> Text -> EventID -> Author -> RoomEvent [reContent] :: RoomEvent -> Event [reType] :: RoomEvent -> Text [reEventId] :: RoomEvent -> EventID [reSender] :: RoomEvent -> Author data RoomSummary RoomSummary :: Maybe Int -> Maybe Int -> RoomSummary [rsJoinedMemberCount] :: RoomSummary -> Maybe Int [rsInvitedMemberCount] :: RoomSummary -> Maybe Int data TimelineSync TimelineSync :: Maybe [RoomEvent] -> Maybe Bool -> Maybe Text -> TimelineSync [tsEvents] :: TimelineSync -> Maybe [RoomEvent] [tsLimited] :: TimelineSync -> Maybe Bool [tsPrevBatch] :: TimelineSync -> Maybe Text data InvitedRoomSync InvitedRoomSync :: InvitedRoomSync data JoinedRoomSync JoinedRoomSync :: Maybe RoomSummary -> TimelineSync -> JoinedRoomSync [jrsSummary] :: JoinedRoomSync -> Maybe RoomSummary [jrsTimeline] :: JoinedRoomSync -> TimelineSync data SyncResult SyncResult :: Text -> Maybe SyncResultRoom -> SyncResult [srNextBatch] :: SyncResult -> Text [srRooms] :: SyncResult -> Maybe SyncResultRoom data SyncResultRoom SyncResultRoom :: Maybe (Map Text JoinedRoomSync) -> Maybe (Map Text InvitedRoomSync) -> SyncResultRoom [srrJoin] :: SyncResultRoom -> Maybe (Map Text JoinedRoomSync) [srrInvite] :: SyncResultRoom -> Maybe (Map Text InvitedRoomSync) instance GHC.Classes.Eq Network.Matrix.Client.TxnID instance GHC.Show.Show Network.Matrix.Client.TxnID instance Data.Hashable.Class.Hashable Network.Matrix.Client.RoomID instance GHC.Classes.Ord Network.Matrix.Client.RoomID instance GHC.Classes.Eq Network.Matrix.Client.RoomID instance GHC.Show.Show Network.Matrix.Client.RoomID instance GHC.Show.Show Network.Matrix.Client.JoinedRooms instance Data.Hashable.Class.Hashable Network.Matrix.Client.FilterID instance GHC.Classes.Eq Network.Matrix.Client.FilterID instance GHC.Show.Show Network.Matrix.Client.FilterID instance GHC.Classes.Eq Network.Matrix.Client.EventFormat instance GHC.Show.Show Network.Matrix.Client.EventFormat instance GHC.Generics.Generic Network.Matrix.Client.EventFilter instance GHC.Classes.Eq Network.Matrix.Client.EventFilter instance GHC.Show.Show Network.Matrix.Client.EventFilter instance GHC.Generics.Generic Network.Matrix.Client.RoomEventFilter instance GHC.Classes.Eq Network.Matrix.Client.RoomEventFilter instance GHC.Show.Show Network.Matrix.Client.RoomEventFilter instance GHC.Generics.Generic Network.Matrix.Client.StateFilter instance GHC.Classes.Eq Network.Matrix.Client.StateFilter instance GHC.Show.Show Network.Matrix.Client.StateFilter instance GHC.Generics.Generic Network.Matrix.Client.RoomFilter instance GHC.Classes.Eq Network.Matrix.Client.RoomFilter instance GHC.Show.Show Network.Matrix.Client.RoomFilter instance GHC.Generics.Generic Network.Matrix.Client.Filter instance GHC.Classes.Eq Network.Matrix.Client.Filter instance GHC.Show.Show Network.Matrix.Client.Filter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.Author instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.Author instance GHC.Classes.Eq Network.Matrix.Client.Author instance GHC.Show.Show Network.Matrix.Client.Author instance GHC.Generics.Generic Network.Matrix.Client.RoomEvent instance GHC.Classes.Eq Network.Matrix.Client.RoomEvent instance GHC.Show.Show Network.Matrix.Client.RoomEvent instance GHC.Generics.Generic Network.Matrix.Client.RoomSummary instance GHC.Classes.Eq Network.Matrix.Client.RoomSummary instance GHC.Show.Show Network.Matrix.Client.RoomSummary instance GHC.Generics.Generic Network.Matrix.Client.TimelineSync instance GHC.Classes.Eq Network.Matrix.Client.TimelineSync instance GHC.Show.Show Network.Matrix.Client.TimelineSync instance GHC.Generics.Generic Network.Matrix.Client.JoinedRoomSync instance GHC.Classes.Eq Network.Matrix.Client.JoinedRoomSync instance GHC.Show.Show Network.Matrix.Client.JoinedRoomSync instance GHC.Classes.Eq Network.Matrix.Client.Presence instance GHC.Generics.Generic Network.Matrix.Client.InvitedRoomSync instance GHC.Classes.Eq Network.Matrix.Client.InvitedRoomSync instance GHC.Show.Show Network.Matrix.Client.InvitedRoomSync instance GHC.Generics.Generic Network.Matrix.Client.SyncResultRoom instance GHC.Classes.Eq Network.Matrix.Client.SyncResultRoom instance GHC.Show.Show Network.Matrix.Client.SyncResultRoom instance GHC.Generics.Generic Network.Matrix.Client.SyncResult instance GHC.Classes.Eq Network.Matrix.Client.SyncResult instance GHC.Show.Show Network.Matrix.Client.SyncResult instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.SyncResult instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.SyncResult instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.SyncResultRoom instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.SyncResultRoom instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.InvitedRoomSync instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.InvitedRoomSync instance GHC.Show.Show Network.Matrix.Client.Presence instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.Presence instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.Presence instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.JoinedRoomSync instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.JoinedRoomSync instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.TimelineSync instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.TimelineSync instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.RoomSummary instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.RoomSummary instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.RoomEvent instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.RoomEvent instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.Filter instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.Filter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.RoomFilter instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.RoomFilter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.StateFilter instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.StateFilter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.RoomEventFilter instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.RoomEventFilter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.EventFilter instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.EventFilter instance Data.Aeson.Types.ToJSON.ToJSON Network.Matrix.Client.EventFormat instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.EventFormat instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.FilterID instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.JoinedRooms instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.RoomID instance Data.Aeson.Types.FromJSON.FromJSON Network.Matrix.Client.CreateRoomResponse -- | The matrix-client library provides a simple interface for -- interacting with Matrix servers. -- -- This tutorial introduces how to use the matrix-client -- library. -- -- You will need a token to create a session, if you already have an -- account, you can get it with the element client by visiting -- the account Settings page, Help & About panel, -- then click Access Token. -- -- Alternatively, you can setup a test service by running these commands -- in a terminal: -- -- 
--   git clone https://github.com/matrix-org/dendrite
--   cd dendrite; ./build.sh; ./bin/generate-keys --private-key matrix_key.pem; cp dendrite-config.yaml dendrite.yaml
--   ./bin/dendrite-monolith-server --config dendrite.yaml
--   curl -XPOST http://localhost:8008/_matrix/client/r0/register -d'{"username": "tristanC", "password": "supersecret", "auth": {"type": "mlogin.dummy"}}
--
-- -- To avoid manipulating the token directly, put it in your environment: -- -- 
--   export MATRIX_TOKEN="THE_ACCESS_TOKEN"
--
module Network.Matrix.Tutorial