PageRenderTime 33ms CodeModel.GetById 11ms app.highlight 15ms RepoModel.GetById 1ms app.codeStats 1ms

/doc/modules/mod_authentication/resource_logon.html

https://code.google.com/p/zotonic/
HTML | 99 lines | 83 code | 16 blank | 0 comment | 0 complexity | 0424035e226c81d8529048111d1e2a43 MD5 | raw file
 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2<html>
 3<head>
 4<title>Module resource_logon</title>
 5<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
 6</head>
 7<body bgcolor="white">
 8<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 9<hr>
10
11<h1>Module resource_logon</h1>
12<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Log on an user.
13<p>Copyright Š 2010 Marc Worrell
14  Date: 2010-05-07</p>
15
16<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
17
18<h2><a name="description">Description</a></h2>Log on an user. Set optional "rememberme" cookie.
19<h2><a name="index">Function Index</a></h2>
20<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#charsets_provided-2">charsets_provided/2</a></td><td></td></tr>
21<tr><td valign="top"><a href="#content_types_provided-2">content_types_provided/2</a></td><td></td></tr>
22<tr><td valign="top"><a href="#event-2">event/2</a></td><td>Handle the submit of the logon form, this will be handed over to the
23  different authentication handlers.</td></tr>
24<tr><td valign="top"><a href="#get_rememberme_cookie-1">get_rememberme_cookie/1</a></td><td>Check if there is a "rememberme" cookie.</td></tr>
25<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
26<tr><td valign="top"><a href="#moved_temporarily-2">moved_temporarily/2</a></td><td>Temporary redirect if we have an automatic log on due to a rememberme cookie or if
27  the user was already logged on and we don't have a redirect page.</td></tr>
28<tr><td valign="top"><a href="#previously_existed-2">previously_existed/2</a></td><td></td></tr>
29<tr><td valign="top"><a href="#provide_content-2">provide_content/2</a></td><td></td></tr>
30<tr><td valign="top"><a href="#reset_rememberme_cookie-1">reset_rememberme_cookie/1</a></td><td>Reset the rememberme cookie.</td></tr>
31<tr><td valign="top"><a href="#resource_exists-2">resource_exists/2</a></td><td></td></tr>
32<tr><td valign="top"><a href="#service_available-2">service_available/2</a></td><td></td></tr>
33</table>
34
35<h2><a name="functions">Function Details</a></h2>
36
37<h3 class="function"><a name="charsets_provided-2">charsets_provided/2</a></h3>
38<div class="spec">
39<p><tt>charsets_provided(ReqData, Context) -&gt; any()</tt></p>
40</div>
41
42<h3 class="function"><a name="content_types_provided-2">content_types_provided/2</a></h3>
43<div class="spec">
44<p><tt>content_types_provided(ReqData, Context) -&gt; any()</tt></p>
45</div>
46
47<h3 class="function"><a name="event-2">event/2</a></h3>
48<div class="spec">
49<p><tt>event(X1, Context) -&gt; any()</tt></p>
50</div><p>Handle the submit of the logon form, this will be handed over to the
51  different authentication handlers.</p>
52
53<h3 class="function"><a name="get_rememberme_cookie-1">get_rememberme_cookie/1</a></h3>
54<div class="spec">
55<p><tt>get_rememberme_cookie(Context) -&gt; any()</tt></p>
56</div><p>Check if there is a "rememberme" cookie.  If so then return the user id
57  belonging to the cookie.</p>
58
59<h3 class="function"><a name="init-1">init/1</a></h3>
60<div class="spec">
61<p><tt>init(DispatchArgs) -&gt; any()</tt></p>
62</div>
63
64<h3 class="function"><a name="moved_temporarily-2">moved_temporarily/2</a></h3>
65<div class="spec">
66<p><tt>moved_temporarily(ReqData, Context) -&gt; any()</tt></p>
67</div><p>Temporary redirect if we have an automatic log on due to a rememberme cookie or if
68  the user was already logged on and we don't have a redirect page.</p>
69
70<h3 class="function"><a name="previously_existed-2">previously_existed/2</a></h3>
71<div class="spec">
72<p><tt>previously_existed(ReqData, Context) -&gt; any()</tt></p>
73</div>
74
75<h3 class="function"><a name="provide_content-2">provide_content/2</a></h3>
76<div class="spec">
77<p><tt>provide_content(ReqData, Context) -&gt; any()</tt></p>
78</div>
79
80<h3 class="function"><a name="reset_rememberme_cookie-1">reset_rememberme_cookie/1</a></h3>
81<div class="spec">
82<p><tt>reset_rememberme_cookie(Context) -&gt; any()</tt></p>
83</div><p>Reset the rememberme cookie.</p>
84
85<h3 class="function"><a name="resource_exists-2">resource_exists/2</a></h3>
86<div class="spec">
87<p><tt>resource_exists(ReqData, Context) -&gt; any()</tt></p>
88</div>
89
90<h3 class="function"><a name="service_available-2">service_available/2</a></h3>
91<div class="spec">
92<p><tt>service_available(ReqData, DispatchArgs) -&gt; any()</tt></p>
93</div>
94<hr>
95
96<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
97<p><i>Generated by EDoc, Aug 12 2011, 19:36:11.</i></p>
98</body>
99</html>