Clckwrks.Authenticate.API

Documentation

newtype Username

an arbitrary, but unique string that the user uses to identify themselves

Constructors

Username

Fields

• _unUsername :: Text

Instances

Eq Username

Defined in Happstack.Authenticate.Core

Methods

(==) :: Username -> Username -> Bool

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

Data Username

Defined in Happstack.Authenticate.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Username -> c Username

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Username

toConstr :: Username -> Constr

dataTypeOf :: Username -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Username)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Username)

gmapT :: (forall b. Data b => b -> b) -> Username -> Username

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Username -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Username -> r

gmapQ :: (forall d. Data d => d -> u) -> Username -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Username -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Username -> m Username

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Username -> m Username

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Username -> m Username

Ord Username

Defined in Happstack.Authenticate.Core

Methods

compare :: Username -> Username -> Ordering

(<) :: Username -> Username -> Bool

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

(>) :: Username -> Username -> Bool

(>=) :: Username -> Username -> Bool

max :: Username -> Username -> Username

min :: Username -> Username -> Username

Read Username

Defined in Happstack.Authenticate.Core

Methods

readsPrec :: Int -> ReadS Username

readList :: ReadS [Username]

readPrec :: ReadPrec Username

readListPrec :: ReadPrec [Username]

Show Username

Defined in Happstack.Authenticate.Core

Methods

showsPrec :: Int -> Username -> ShowS

show :: Username -> String

showList :: [Username] -> ShowS

Generic Username

Defined in Happstack.Authenticate.Core

Associated Types

type Rep Username :: Type -> Type

Methods

from :: Username -> Rep Username x

to :: Rep Username x -> Username

SafeCopy Username

Defined in Happstack.Authenticate.Core

Methods

version :: Version Username

kind :: Kind Username

getCopy :: Contained (Get Username)

putCopy :: Username -> Contained Put

internalConsistency :: Consistency Username

objectProfile :: Profile Username

errorTypeName :: Proxy Username -> String

ToJSON Username

Defined in Happstack.Authenticate.Core

Methods

toJSON :: Username -> Value

toEncoding :: Username -> Encoding

toJSONList :: [Username] -> Value

toEncodingList :: [Username] -> Encoding

FromJSON Username

Defined in Happstack.Authenticate.Core

Methods

parseJSON :: Value -> Parser Username

parseJSONList :: Value -> Parser [Username]

PathInfo Username

Defined in Happstack.Authenticate.Core

Methods

toPathSegments :: Username -> [Text]

fromPathSegments :: URLParser Username

Indexable UserIxs User

Defined in Happstack.Authenticate.Core

Methods

indices :: IxList UserIxs User

type Rep Username

Defined in Happstack.Authenticate.Core

type Rep Username = D1 ('MetaData "Username" "Happstack.Authenticate.Core" "happstack-authenticate-2.5.1-EObaskq0zT2FJPI5Kud07U" 'True) (C1 ('MetaCons "Username" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

getEmail :: UserId -> Clck url (Maybe Email)

getUser :: UserId -> Clck url (Maybe User)

getUsername :: UserId -> Clck url (Maybe Username)

insecureUpdateUser :: User -> Clck url ()

Update an existing User. Must already have a valid UserId.

no security checks are performed to ensure that the caller is authorized to change data for the User.