Visitar URL original
Network.Matrix.Identity
matrix-client-0.1.9.0: A matrix client library
Safe HaskellNone
LanguageHaskell2010

Network.Matrix.Identity

Description

This module contains the Identity service API https:/matrix.orgdocsspecidentity_service/r0.3.0.html

Synopsis

Client

data IdentitySession Source #

The session record, use createSession to create it.

newtype MatrixToken Source #

Constructors

MatrixToken Text 

getTokenFromEnv Source #

Arguments

:: Text

The envirnoment variable name

-> IO MatrixToken 

createIdentitySession Source #

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

MatrixIO is a convenient type alias for server response

data MatrixError Source #

Constructors

MatrixError 

Fields

Instances

Instances details
FromJSON MatrixError Source # 
Instance details

Defined in Network.Matrix.Internal

Methods

parseJSON :: Value -> Parser MatrixError #

parseJSONList :: Value -> Parser [MatrixError] #

omittedField :: Maybe MatrixError #

Generic MatrixError Source # 
Instance details

Defined in Network.Matrix.Internal

Associated Types

type Rep MatrixError 
Instance details

Defined in Network.Matrix.Internal

type Rep MatrixError = D1 ('MetaData "MatrixError" "Network.Matrix.Internal" "matrix-client-0.1.9.0-ITLhONOsc146bTdB6wSMw3" 'False) (C1 ('MetaCons "MatrixError" 'PrefixI 'True) (S1 ('MetaSel ('Just "meErrcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "meError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "meRetryAfterMS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

Methods

from :: MatrixError -> Rep MatrixError x #

to :: Rep MatrixError x -> 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 #

type Rep MatrixError Source # 
Instance details

Defined in Network.Matrix.Internal

type Rep MatrixError = D1 ('MetaData "MatrixError" "Network.Matrix.Internal" "matrix-client-0.1.9.0-ITLhONOsc146bTdB6wSMw3" 'False) (C1 ('MetaCons "MatrixError" 'PrefixI 'True) (S1 ('MetaSel ('Just "meErrcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "meError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "meRetryAfterMS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

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

omittedField :: Maybe 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 #

getIdentityTokenOwner :: IdentitySession -> MatrixIO UserID Source #

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

Association lookup

data HashDetails Source #

Constructors

HashDetails 

Fields

Instances

Instances details
FromJSON HashDetails Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

parseJSON :: Value -> Parser HashDetails #

parseJSONList :: Value -> Parser [HashDetails] #

omittedField :: Maybe HashDetails #

Show HashDetails Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> HashDetails -> ShowS #

show :: HashDetails -> String #

showList :: [HashDetails] -> ShowS #

Eq HashDetails Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

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

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

hashDetails :: IdentitySession -> MatrixIO HashDetails Source #

data Identity Source #

Constructors

Email Text 
Msisdn Text 

Instances

Instances details
Show Identity Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> Identity -> ShowS #

show :: Identity -> String #

showList :: [Identity] -> ShowS #

Eq Identity Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

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

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

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

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

data HashedAddress Source #

Instances

Instances details
Show HashedAddress Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> HashedAddress -> ShowS #

show :: HashedAddress -> String #

showList :: [HashedAddress] -> ShowS #

Eq HashedAddress Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

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

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

data IdentityLookupRequest Source #

Instances

Instances details
Show IdentityLookupRequest Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> IdentityLookupRequest -> ShowS #

show :: IdentityLookupRequest -> String #

showList :: [IdentityLookupRequest] -> ShowS #

Eq IdentityLookupRequest Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

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

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

data IdentityLookupResponse Source #

A newtype wrapper to decoded nested list

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

Instances

Instances details
FromJSON IdentityLookupResponse Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

parseJSON :: Value -> Parser IdentityLookupResponse #

parseJSONList :: Value -> Parser [IdentityLookupResponse] #

omittedField :: Maybe IdentityLookupResponse #

Show IdentityLookupResponse Source # 
Instance details

Defined in Network.Matrix.Identity

Methods

showsPrec :: Int -> IdentityLookupResponse -> ShowS #

show :: IdentityLookupResponse -> String #

showList :: [IdentityLookupResponse] -> ShowS #

identitiesLookup :: IdentitySession -> IdentityLookupRequest -> MatrixIO IdentityLookupResponse Source #

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

toHashedAddress :: HashDetails -> Identity -> HashedAddress Source #

lookupIdentity :: HashedAddress -> IdentityLookupResponse -> Maybe UserID Source #