Network.Matrix.Identity

This module contains the Identity service API https://matrix.org/docs/spec/identity_service/r0.3.0.html

Client

data IdentitySession

The session record, use createSession to create it.

newtype MatrixToken

Constructors

MatrixToken Text

getTokenFromEnv

Arguments

:: Text

The envirnoment variable name

-> IO MatrixToken

createIdentitySession

Arguments

:: Text

The matrix identity base url, e.g. "https://matrix.org"

-> MatrixToken

The user identity token

-> IO IdentitySession

createSession creates the session record.

API

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 :: (MonadIO m, MonadMask m) => MatrixM m a -> MatrixM m 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]

getIdentityTokenOwner :: IdentitySession -> MatrixIO UserID

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

Association lookup

data HashDetails

Constructors

HashDetails

Fields

• hdAlgorithms :: NonEmpty Text
• hdPepper :: Text

Instances

Eq HashDetails

Defined in Network.Matrix.Identity

Methods

(==) :: HashDetails -> HashDetails -> Bool

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

Show HashDetails

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> HashDetails -> ShowS

show :: HashDetails -> String

showList :: [HashDetails] -> ShowS

FromJSON HashDetails

Defined in Network.Matrix.Identity

Methods

parseJSON :: Value -> Parser HashDetails

parseJSONList :: Value -> Parser [HashDetails]

hashDetails :: IdentitySession -> MatrixIO HashDetails

data Identity

Constructors

Email Text

Msisdn Text

Instances

Eq Identity

Defined in Network.Matrix.Identity

Methods

(==) :: Identity -> Identity -> Bool

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

Show Identity

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> Identity -> ShowS

show :: Identity -> String

showList :: [Identity] -> ShowS

identityLookup :: IdentitySession -> HashDetails -> Identity -> MatrixIO (Maybe UserID)

Use identityLookup to lookup a single identity, otherwise uses the full identitiesLookup.

data HashedAddress

Instances

Eq HashedAddress

Defined in Network.Matrix.Identity

Methods

(==) :: HashedAddress -> HashedAddress -> Bool

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

Show HashedAddress

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> HashedAddress -> ShowS

show :: HashedAddress -> String

showList :: [HashedAddress] -> ShowS

data IdentityLookupRequest

Instances

Eq IdentityLookupRequest

Defined in Network.Matrix.Identity

Methods

(==) :: IdentityLookupRequest -> IdentityLookupRequest -> Bool

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

Show IdentityLookupRequest

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> IdentityLookupRequest -> ShowS

show :: IdentityLookupRequest -> String

showList :: [IdentityLookupRequest] -> ShowS

data IdentityLookupResponse

A newtype wrapper to decoded nested list

>>> decode "{\"mappings\": {\"hash\": \"user\"}}" :: Maybe IdentityLookupResponse
Just (IdentityLookupResponse [(HashedAddress "hash",UserID "user")])

Instances

Show IdentityLookupResponse

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> IdentityLookupResponse -> ShowS

show :: IdentityLookupResponse -> String

showList :: [IdentityLookupResponse] -> ShowS

FromJSON IdentityLookupResponse

Defined in Network.Matrix.Identity

Methods

parseJSON :: Value -> Parser IdentityLookupResponse

parseJSONList :: Value -> Parser [IdentityLookupResponse]

identitiesLookup :: IdentitySession -> IdentityLookupRequest -> MatrixIO IdentityLookupResponse

mkIdentityLookupRequest :: HashDetails -> [HashedAddress] -> IdentityLookupRequest

toHashedAddress :: HashDetails -> Identity -> HashedAddress

lookupIdentity :: HashedAddress -> IdentityLookupResponse -> Maybe UserID