Added haddocks to setCreds/clearCreds
This commit is contained in:
parent
f5f84e830d
commit
f6b12764e4
@ -164,7 +164,11 @@ mkYesodSub "Auth"
|
||||
/page/#Text/STRINGS PluginR
|
||||
|]
|
||||
|
||||
setCreds :: YesodAuth master => Bool -> Creds master -> GHandler sub master ()
|
||||
-- | Sets user credentials for the session after checking them with authentication backends.
|
||||
setCreds :: YesodAuth master
|
||||
=> Bool -- ^ if HTTP redirects should be done
|
||||
-> Creds master -- ^ new credentials
|
||||
-> GHandler sub master ()
|
||||
setCreds doRedirects creds = do
|
||||
y <- getYesod
|
||||
maid <- getAuthId creds
|
||||
@ -185,7 +189,10 @@ $newline never
|
||||
onLogin
|
||||
redirectUltDest $ loginDest y
|
||||
|
||||
clearCreds :: YesodAuth master => Bool -> GHandler sub master ()
|
||||
-- | Clears current user credentials for the session.
|
||||
clearCreds :: YesodAuth master
|
||||
=> Bool -- ^ if HTTP redirect to 'logoutDest' should be done
|
||||
-> GHandler sub master ()
|
||||
clearCreds doRedirects = do
|
||||
y <- getYesod
|
||||
deleteSession credsKey
|
||||
|
||||
Loading…
Reference in New Issue
Block a user