1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_security.views package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-security-views-package"> |
|
54 <h1>pyams_security.views package<a class="headerlink" href="#pyams-security-views-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="submodules"> |
|
56 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
57 </div> |
|
58 <div class="section" id="module-pyams_security.views.login"> |
|
59 <span id="pyams-security-views-login-module"></span><h2>pyams_security.views.login module<a class="headerlink" href="#module-pyams_security.views.login" title="Permalink to this headline">¶</a></h2> |
|
60 <dl class="function"> |
|
61 <dt id="pyams_security.views.login.ForbiddenAJAXView"> |
|
62 <code class="descclassname">pyams_security.views.login.</code><code class="descname">ForbiddenAJAXView</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.ForbiddenAJAXView" title="Permalink to this definition">¶</a></dt> |
|
63 <dd><p>AJAX call forbidden view</p> |
|
64 </dd></dl> |
|
65 |
|
66 <dl class="function"> |
|
67 <dt id="pyams_security.views.login.ForbiddenView"> |
|
68 <code class="descclassname">pyams_security.views.login.</code><code class="descname">ForbiddenView</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.ForbiddenView" title="Permalink to this definition">¶</a></dt> |
|
69 <dd><p>Default forbidden view</p> |
|
70 </dd></dl> |
|
71 |
|
72 <dl class="class"> |
|
73 <dt id="pyams_security.views.login.LoginAJAXForm"> |
|
74 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginAJAXForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginAJAXForm" title="Permalink to this definition">¶</a></dt> |
|
75 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AJAXAddForm" title="pyams_form.form.AJAXAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AJAXAddForm</span></code></a>, <a class="reference internal" href="#pyams_security.views.login.LoginForm" title="pyams_security.views.login.LoginForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.views.login.LoginForm</span></code></a></p> |
|
76 <p>Login form, AJAX view</p> |
|
77 <dl class="method"> |
|
78 <dt id="pyams_security.views.login.LoginAJAXForm.get_ajax_output"> |
|
79 <code class="descname">get_ajax_output</code><span class="sig-paren">(</span><em>changes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginAJAXForm.get_ajax_output" title="Permalink to this definition">¶</a></dt> |
|
80 <dd></dd></dl> |
|
81 |
|
82 </dd></dl> |
|
83 |
|
84 <dl class="class"> |
|
85 <dt id="pyams_security.views.login.LoginDialogAJAXForm"> |
|
86 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginDialogAJAXForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogAJAXForm" title="Permalink to this definition">¶</a></dt> |
|
87 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AJAXAddForm" title="pyams_form.form.AJAXAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AJAXAddForm</span></code></a>, <a class="reference internal" href="#pyams_security.views.login.LoginDialogForm" title="pyams_security.views.login.LoginDialogForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.views.login.LoginDialogForm</span></code></a></p> |
|
88 <p>Login dialog form, AJAX view</p> |
|
89 <dl class="method"> |
|
90 <dt id="pyams_security.views.login.LoginDialogAJAXForm.get_ajax_output"> |
|
91 <code class="descname">get_ajax_output</code><span class="sig-paren">(</span><em>changes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogAJAXForm.get_ajax_output" title="Permalink to this definition">¶</a></dt> |
|
92 <dd></dd></dl> |
|
93 |
|
94 </dd></dl> |
|
95 |
|
96 <dl class="class"> |
|
97 <dt id="pyams_security.views.login.LoginDialogForm"> |
|
98 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginDialogForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm" title="Permalink to this definition">¶</a></dt> |
|
99 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.DialogAddForm" title="pyams_form.form.DialogAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.DialogAddForm</span></code></a></p> |
|
100 <p>Login dialog form</p> |
|
101 <dl class="attribute"> |
|
102 <dt id="pyams_security.views.login.LoginDialogForm.ajax_handler"> |
|
103 <code class="descname">ajax_handler</code><em class="property"> = 'login-dialog.json'</em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.ajax_handler" title="Permalink to this definition">¶</a></dt> |
|
104 <dd></dd></dl> |
|
105 |
|
106 <dl class="attribute"> |
|
107 <dt id="pyams_security.views.login.LoginDialogForm.buttons"> |
|
108 <code class="descname">buttons</code><em class="property"> = <z3c.form.button.Buttons object></em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.buttons" title="Permalink to this definition">¶</a></dt> |
|
109 <dd></dd></dl> |
|
110 |
|
111 <dl class="method"> |
|
112 <dt id="pyams_security.views.login.LoginDialogForm.createAndAdd"> |
|
113 <code class="descname">createAndAdd</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.createAndAdd" title="Permalink to this definition">¶</a></dt> |
|
114 <dd></dd></dl> |
|
115 |
|
116 <dl class="attribute"> |
|
117 <dt id="pyams_security.views.login.LoginDialogForm.edit_permission"> |
|
118 <code class="descname">edit_permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
119 <dd></dd></dl> |
|
120 |
|
121 <dl class="attribute"> |
|
122 <dt id="pyams_security.views.login.LoginDialogForm.fields"> |
|
123 <code class="descname">fields</code><em class="property"> = <z3c.form.field.Fields object></em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.fields" title="Permalink to this definition">¶</a></dt> |
|
124 <dd></dd></dl> |
|
125 |
|
126 <dl class="attribute"> |
|
127 <dt id="pyams_security.views.login.LoginDialogForm.legend"> |
|
128 <code class="descname">legend</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.legend" title="Permalink to this definition">¶</a></dt> |
|
129 <dd></dd></dl> |
|
130 |
|
131 <dl class="attribute"> |
|
132 <dt id="pyams_security.views.login.LoginDialogForm.title"> |
|
133 <code class="descname">title</code><em class="property"> = 'Please enter valid credentials to log-in'</em><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.title" title="Permalink to this definition">¶</a></dt> |
|
134 <dd></dd></dl> |
|
135 |
|
136 <dl class="method"> |
|
137 <dt id="pyams_security.views.login.LoginDialogForm.update"> |
|
138 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.update" title="Permalink to this definition">¶</a></dt> |
|
139 <dd></dd></dl> |
|
140 |
|
141 <dl class="method"> |
|
142 <dt id="pyams_security.views.login.LoginDialogForm.updateActions"> |
|
143 <code class="descname">updateActions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginDialogForm.updateActions" title="Permalink to this definition">¶</a></dt> |
|
144 <dd></dd></dl> |
|
145 |
|
146 </dd></dl> |
|
147 |
|
148 <dl class="class"> |
|
149 <dt id="pyams_security.views.login.LoginForm"> |
|
150 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginForm" title="Permalink to this definition">¶</a></dt> |
|
151 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AddForm" title="pyams_form.form.AddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AddForm</span></code></a></p> |
|
152 <p>Login form</p> |
|
153 <dl class="attribute"> |
|
154 <dt id="pyams_security.views.login.LoginForm.ajax_handler"> |
|
155 <code class="descname">ajax_handler</code><em class="property"> = 'login.json'</em><a class="headerlink" href="#pyams_security.views.login.LoginForm.ajax_handler" title="Permalink to this definition">¶</a></dt> |
|
156 <dd></dd></dl> |
|
157 |
|
158 <dl class="attribute"> |
|
159 <dt id="pyams_security.views.login.LoginForm.buttons"> |
|
160 <code class="descname">buttons</code><em class="property"> = <z3c.form.button.Buttons object></em><a class="headerlink" href="#pyams_security.views.login.LoginForm.buttons" title="Permalink to this definition">¶</a></dt> |
|
161 <dd></dd></dl> |
|
162 |
|
163 <dl class="method"> |
|
164 <dt id="pyams_security.views.login.LoginForm.createAndAdd"> |
|
165 <code class="descname">createAndAdd</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginForm.createAndAdd" title="Permalink to this definition">¶</a></dt> |
|
166 <dd></dd></dl> |
|
167 |
|
168 <dl class="attribute"> |
|
169 <dt id="pyams_security.views.login.LoginForm.edit_permission"> |
|
170 <code class="descname">edit_permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.views.login.LoginForm.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
171 <dd></dd></dl> |
|
172 |
|
173 <dl class="attribute"> |
|
174 <dt id="pyams_security.views.login.LoginForm.fields"> |
|
175 <code class="descname">fields</code><em class="property"> = <z3c.form.field.Fields object></em><a class="headerlink" href="#pyams_security.views.login.LoginForm.fields" title="Permalink to this definition">¶</a></dt> |
|
176 <dd></dd></dl> |
|
177 |
|
178 <dl class="attribute"> |
|
179 <dt id="pyams_security.views.login.LoginForm.legend"> |
|
180 <code class="descname">legend</code><em class="property"> = 'Please enter valid credentials to log-in'</em><a class="headerlink" href="#pyams_security.views.login.LoginForm.legend" title="Permalink to this definition">¶</a></dt> |
|
181 <dd></dd></dl> |
|
182 |
|
183 <dl class="method"> |
|
184 <dt id="pyams_security.views.login.LoginForm.update"> |
|
185 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginForm.update" title="Permalink to this definition">¶</a></dt> |
|
186 <dd></dd></dl> |
|
187 |
|
188 <dl class="method"> |
|
189 <dt id="pyams_security.views.login.LoginForm.updateActions"> |
|
190 <code class="descname">updateActions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginForm.updateActions" title="Permalink to this definition">¶</a></dt> |
|
191 <dd></dd></dl> |
|
192 |
|
193 </dd></dl> |
|
194 |
|
195 <dl class="class"> |
|
196 <dt id="pyams_security.views.login.LoginFormHeaderViewlet"> |
|
197 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginFormHeaderViewlet</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginFormHeaderViewlet" title="Permalink to this definition">¶</a></dt> |
|
198 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.Viewlet" title="pyams_viewlet.viewlet.Viewlet"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.Viewlet</span></code></a></p> |
|
199 <p>Login form header viewlet</p> |
|
200 </dd></dl> |
|
201 |
|
202 <dl class="class"> |
|
203 <dt id="pyams_security.views.login.LoginFormPrefixViewlet"> |
|
204 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginFormPrefixViewlet</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginFormPrefixViewlet" title="Permalink to this definition">¶</a></dt> |
|
205 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.Viewlet" title="pyams_viewlet.viewlet.Viewlet"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.Viewlet</span></code></a></p> |
|
206 <p>Login form prefix viewlet</p> |
|
207 <dl class="method"> |
|
208 <dt id="pyams_security.views.login.LoginFormPrefixViewlet.render"> |
|
209 <code class="descname">render</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginFormPrefixViewlet.render" title="Permalink to this definition">¶</a></dt> |
|
210 <dd></dd></dl> |
|
211 |
|
212 </dd></dl> |
|
213 |
|
214 <dl class="class"> |
|
215 <dt id="pyams_security.views.login.LoginFormSuffixViewlet"> |
|
216 <em class="property">class </em><code class="descclassname">pyams_security.views.login.</code><code class="descname">LoginFormSuffixViewlet</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginFormSuffixViewlet" title="Permalink to this definition">¶</a></dt> |
|
217 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.Viewlet" title="pyams_viewlet.viewlet.Viewlet"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.Viewlet</span></code></a></p> |
|
218 <p>Login form suffix viewlet</p> |
|
219 <dl class="method"> |
|
220 <dt id="pyams_security.views.login.LoginFormSuffixViewlet.render"> |
|
221 <code class="descname">render</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.LoginFormSuffixViewlet.render" title="Permalink to this definition">¶</a></dt> |
|
222 <dd></dd></dl> |
|
223 |
|
224 </dd></dl> |
|
225 |
|
226 <dl class="function"> |
|
227 <dt id="pyams_security.views.login.handle_login_form_data"> |
|
228 <code class="descclassname">pyams_security.views.login.</code><code class="descname">handle_login_form_data</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.handle_login_form_data" title="Permalink to this definition">¶</a></dt> |
|
229 <dd><p>Check credentials after data extraction</p> |
|
230 </dd></dl> |
|
231 |
|
232 <dl class="function"> |
|
233 <dt id="pyams_security.views.login.logout"> |
|
234 <code class="descclassname">pyams_security.views.login.</code><code class="descname">logout</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.login.logout" title="Permalink to this definition">¶</a></dt> |
|
235 <dd><p>Logout view</p> |
|
236 </dd></dl> |
|
237 |
|
238 </div> |
|
239 <div class="section" id="module-pyams_security.views.oauth"> |
|
240 <span id="pyams-security-views-oauth-module"></span><h2>pyams_security.views.oauth module<a class="headerlink" href="#module-pyams_security.views.oauth" title="Permalink to this headline">¶</a></h2> |
|
241 <dl class="class"> |
|
242 <dt id="pyams_security.views.oauth.SocialLoginViewletsSuffix"> |
|
243 <em class="property">class </em><code class="descclassname">pyams_security.views.oauth.</code><code class="descname">SocialLoginViewletsSuffix</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.oauth.SocialLoginViewletsSuffix" title="Permalink to this definition">¶</a></dt> |
|
244 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.Viewlet" title="pyams_viewlet.viewlet.Viewlet"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.Viewlet</span></code></a></p> |
|
245 <p>Social login viewlets suffix</p> |
|
246 <dl class="attribute"> |
|
247 <dt id="pyams_security.views.oauth.SocialLoginViewletsSuffix.providers"> |
|
248 <code class="descname">providers</code><a class="headerlink" href="#pyams_security.views.oauth.SocialLoginViewletsSuffix.providers" title="Permalink to this definition">¶</a></dt> |
|
249 <dd></dd></dl> |
|
250 |
|
251 <dl class="attribute"> |
|
252 <dt id="pyams_security.views.oauth.SocialLoginViewletsSuffix.use_popup"> |
|
253 <code class="descname">use_popup</code><a class="headerlink" href="#pyams_security.views.oauth.SocialLoginViewletsSuffix.use_popup" title="Permalink to this definition">¶</a></dt> |
|
254 <dd></dd></dl> |
|
255 |
|
256 </dd></dl> |
|
257 |
|
258 <dl class="function"> |
|
259 <dt id="pyams_security.views.oauth.login"> |
|
260 <code class="descclassname">pyams_security.views.oauth.</code><code class="descname">login</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.oauth.login" title="Permalink to this definition">¶</a></dt> |
|
261 <dd><p>Login view for Authautomatic authentication</p> |
|
262 </dd></dl> |
|
263 |
|
264 </div> |
|
265 <div class="section" id="module-pyams_security.views.userfolder"> |
|
266 <span id="pyams-security-views-userfolder-module"></span><h2>pyams_security.views.userfolder module<a class="headerlink" href="#module-pyams_security.views.userfolder" title="Permalink to this headline">¶</a></h2> |
|
267 <dl class="class"> |
|
268 <dt id="pyams_security.views.userfolder.UserConfirmationAJAXForm"> |
|
269 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserConfirmationAJAXForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationAJAXForm" title="Permalink to this definition">¶</a></dt> |
|
270 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AJAXAddForm" title="pyams_form.form.AJAXAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AJAXAddForm</span></code></a>, <a class="reference internal" href="#pyams_security.views.userfolder.UserConfirmationForm" title="pyams_security.views.userfolder.UserConfirmationForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.views.userfolder.UserConfirmationForm</span></code></a></p> |
|
271 <p>User registration confirmation form, AJAX view</p> |
|
272 <dl class="method"> |
|
273 <dt id="pyams_security.views.userfolder.UserConfirmationAJAXForm.get_ajax_output"> |
|
274 <code class="descname">get_ajax_output</code><span class="sig-paren">(</span><em>changes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationAJAXForm.get_ajax_output" title="Permalink to this definition">¶</a></dt> |
|
275 <dd></dd></dl> |
|
276 |
|
277 </dd></dl> |
|
278 |
|
279 <dl class="class"> |
|
280 <dt id="pyams_security.views.userfolder.UserConfirmationForm"> |
|
281 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserConfirmationForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm" title="Permalink to this definition">¶</a></dt> |
|
282 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AddForm" title="pyams_form.form.AddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AddForm</span></code></a></p> |
|
283 <p>User registration confirmation form</p> |
|
284 <dl class="attribute"> |
|
285 <dt id="pyams_security.views.userfolder.UserConfirmationForm.ajax_handler"> |
|
286 <code class="descname">ajax_handler</code><em class="property"> = 'user-confirmation.json'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.ajax_handler" title="Permalink to this definition">¶</a></dt> |
|
287 <dd></dd></dl> |
|
288 |
|
289 <dl class="attribute"> |
|
290 <dt id="pyams_security.views.userfolder.UserConfirmationForm.autocomplete"> |
|
291 <code class="descname">autocomplete</code><em class="property"> = 'off'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.autocomplete" title="Permalink to this definition">¶</a></dt> |
|
292 <dd></dd></dl> |
|
293 |
|
294 <dl class="attribute"> |
|
295 <dt id="pyams_security.views.userfolder.UserConfirmationForm.buttons"> |
|
296 <code class="descname">buttons</code><em class="property"> = <z3c.form.button.Buttons object></em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.buttons" title="Permalink to this definition">¶</a></dt> |
|
297 <dd></dd></dl> |
|
298 |
|
299 <dl class="method"> |
|
300 <dt id="pyams_security.views.userfolder.UserConfirmationForm.createAndAdd"> |
|
301 <code class="descname">createAndAdd</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.createAndAdd" title="Permalink to this definition">¶</a></dt> |
|
302 <dd></dd></dl> |
|
303 |
|
304 <dl class="attribute"> |
|
305 <dt id="pyams_security.views.userfolder.UserConfirmationForm.edit_permission"> |
|
306 <code class="descname">edit_permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
307 <dd></dd></dl> |
|
308 |
|
309 <dl class="attribute"> |
|
310 <dt id="pyams_security.views.userfolder.UserConfirmationForm.fields"> |
|
311 <code class="descname">fields</code><em class="property"> = <z3c.form.field.Fields object></em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.fields" title="Permalink to this definition">¶</a></dt> |
|
312 <dd></dd></dl> |
|
313 |
|
314 <dl class="attribute"> |
|
315 <dt id="pyams_security.views.userfolder.UserConfirmationForm.icon_css_class"> |
|
316 <code class="descname">icon_css_class</code><em class="property"> = 'fa fa-fw fa-user'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.icon_css_class" title="Permalink to this definition">¶</a></dt> |
|
317 <dd></dd></dl> |
|
318 |
|
319 <dl class="attribute"> |
|
320 <dt id="pyams_security.views.userfolder.UserConfirmationForm.legend"> |
|
321 <code class="descname">legend</code><em class="property"> = 'Please confirm your registration info'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.legend" title="Permalink to this definition">¶</a></dt> |
|
322 <dd></dd></dl> |
|
323 |
|
324 <dl class="method"> |
|
325 <dt id="pyams_security.views.userfolder.UserConfirmationForm.nextURL"> |
|
326 <code class="descname">nextURL</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.nextURL" title="Permalink to this definition">¶</a></dt> |
|
327 <dd></dd></dl> |
|
328 |
|
329 <dl class="attribute"> |
|
330 <dt id="pyams_security.views.userfolder.UserConfirmationForm.title"> |
|
331 <code class="descname">title</code><em class="property"> = 'User registration confirmation'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.title" title="Permalink to this definition">¶</a></dt> |
|
332 <dd></dd></dl> |
|
333 |
|
334 <dl class="method"> |
|
335 <dt id="pyams_security.views.userfolder.UserConfirmationForm.updateActions"> |
|
336 <code class="descname">updateActions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.updateActions" title="Permalink to this definition">¶</a></dt> |
|
337 <dd></dd></dl> |
|
338 |
|
339 <dl class="method"> |
|
340 <dt id="pyams_security.views.userfolder.UserConfirmationForm.updateWidgets"> |
|
341 <code class="descname">updateWidgets</code><span class="sig-paren">(</span><em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserConfirmationForm.updateWidgets" title="Permalink to this definition">¶</a></dt> |
|
342 <dd></dd></dl> |
|
343 |
|
344 </dd></dl> |
|
345 |
|
346 <dl class="class"> |
|
347 <dt id="pyams_security.views.userfolder.UserRegistrationAJAXForm"> |
|
348 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserRegistrationAJAXForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationAJAXForm" title="Permalink to this definition">¶</a></dt> |
|
349 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.AJAXAddForm" title="pyams_form.form.AJAXAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.AJAXAddForm</span></code></a>, <a class="reference internal" href="#pyams_security.views.userfolder.UserRegistrationForm" title="pyams_security.views.userfolder.UserRegistrationForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.views.userfolder.UserRegistrationForm</span></code></a></p> |
|
350 <p>User registration form, AJAX view</p> |
|
351 <dl class="method"> |
|
352 <dt id="pyams_security.views.userfolder.UserRegistrationAJAXForm.get_ajax_output"> |
|
353 <code class="descname">get_ajax_output</code><span class="sig-paren">(</span><em>changes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationAJAXForm.get_ajax_output" title="Permalink to this definition">¶</a></dt> |
|
354 <dd></dd></dl> |
|
355 |
|
356 </dd></dl> |
|
357 |
|
358 <dl class="class"> |
|
359 <dt id="pyams_security.views.userfolder.UserRegistrationEnd"> |
|
360 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserRegistrationEnd</code><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationEnd" title="Permalink to this definition">¶</a></dt> |
|
361 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
362 <p>User registration end</p> |
|
363 </dd></dl> |
|
364 |
|
365 <dl class="class"> |
|
366 <dt id="pyams_security.views.userfolder.UserRegistrationForm"> |
|
367 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserRegistrationForm</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm" title="Permalink to this definition">¶</a></dt> |
|
368 <dd><p>Bases: <a class="reference internal" href="pyams_form.html#pyams_form.form.DialogAddForm" title="pyams_form.form.DialogAddForm"><code class="xref py py-class docutils literal"><span class="pre">pyams_form.form.DialogAddForm</span></code></a></p> |
|
369 <p>User registration form</p> |
|
370 <dl class="method"> |
|
371 <dt id="pyams_security.views.userfolder.UserRegistrationForm.add"> |
|
372 <code class="descname">add</code><span class="sig-paren">(</span><em>user</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.add" title="Permalink to this definition">¶</a></dt> |
|
373 <dd></dd></dl> |
|
374 |
|
375 <dl class="attribute"> |
|
376 <dt id="pyams_security.views.userfolder.UserRegistrationForm.ajax_handler"> |
|
377 <code class="descname">ajax_handler</code><em class="property"> = 'user-registration.json'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.ajax_handler" title="Permalink to this definition">¶</a></dt> |
|
378 <dd></dd></dl> |
|
379 |
|
380 <dl class="attribute"> |
|
381 <dt id="pyams_security.views.userfolder.UserRegistrationForm.autocomplete"> |
|
382 <code class="descname">autocomplete</code><em class="property"> = 'off'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.autocomplete" title="Permalink to this definition">¶</a></dt> |
|
383 <dd></dd></dl> |
|
384 |
|
385 <dl class="attribute"> |
|
386 <dt id="pyams_security.views.userfolder.UserRegistrationForm.buttons"> |
|
387 <code class="descname">buttons</code><em class="property"> = <z3c.form.button.Buttons object></em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.buttons" title="Permalink to this definition">¶</a></dt> |
|
388 <dd></dd></dl> |
|
389 |
|
390 <dl class="method"> |
|
391 <dt id="pyams_security.views.userfolder.UserRegistrationForm.create"> |
|
392 <code class="descname">create</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.create" title="Permalink to this definition">¶</a></dt> |
|
393 <dd></dd></dl> |
|
394 |
|
395 <dl class="attribute"> |
|
396 <dt id="pyams_security.views.userfolder.UserRegistrationForm.edit_permission"> |
|
397 <code class="descname">edit_permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
398 <dd></dd></dl> |
|
399 |
|
400 <dl class="attribute"> |
|
401 <dt id="pyams_security.views.userfolder.UserRegistrationForm.fields"> |
|
402 <code class="descname">fields</code><em class="property"> = <z3c.form.field.Fields object></em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.fields" title="Permalink to this definition">¶</a></dt> |
|
403 <dd></dd></dl> |
|
404 |
|
405 <dl class="attribute"> |
|
406 <dt id="pyams_security.views.userfolder.UserRegistrationForm.icon_css_class"> |
|
407 <code class="descname">icon_css_class</code><em class="property"> = 'fa fa-fw fa-user'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.icon_css_class" title="Permalink to this definition">¶</a></dt> |
|
408 <dd></dd></dl> |
|
409 |
|
410 <dl class="attribute"> |
|
411 <dt id="pyams_security.views.userfolder.UserRegistrationForm.input_css_class"> |
|
412 <code class="descname">input_css_class</code><em class="property"> = 'col-md-8'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.input_css_class" title="Permalink to this definition">¶</a></dt> |
|
413 <dd></dd></dl> |
|
414 |
|
415 <dl class="attribute"> |
|
416 <dt id="pyams_security.views.userfolder.UserRegistrationForm.label_css_class"> |
|
417 <code class="descname">label_css_class</code><em class="property"> = 'control-label col-md-4'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.label_css_class" title="Permalink to this definition">¶</a></dt> |
|
418 <dd></dd></dl> |
|
419 |
|
420 <dl class="attribute"> |
|
421 <dt id="pyams_security.views.userfolder.UserRegistrationForm.legend"> |
|
422 <code class="descname">legend</code><em class="property"> = 'Please enter registration info'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.legend" title="Permalink to this definition">¶</a></dt> |
|
423 <dd></dd></dl> |
|
424 |
|
425 <dl class="attribute"> |
|
426 <dt id="pyams_security.views.userfolder.UserRegistrationForm.title"> |
|
427 <code class="descname">title</code><em class="property"> = 'User registration'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.title" title="Permalink to this definition">¶</a></dt> |
|
428 <dd></dd></dl> |
|
429 |
|
430 <dl class="method"> |
|
431 <dt id="pyams_security.views.userfolder.UserRegistrationForm.updateActions"> |
|
432 <code class="descname">updateActions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.updateActions" title="Permalink to this definition">¶</a></dt> |
|
433 <dd></dd></dl> |
|
434 |
|
435 <dl class="method"> |
|
436 <dt id="pyams_security.views.userfolder.UserRegistrationForm.updateWidgets"> |
|
437 <code class="descname">updateWidgets</code><span class="sig-paren">(</span><em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.updateWidgets" title="Permalink to this definition">¶</a></dt> |
|
438 <dd></dd></dl> |
|
439 |
|
440 <dl class="method"> |
|
441 <dt id="pyams_security.views.userfolder.UserRegistrationForm.update_content"> |
|
442 <code class="descname">update_content</code><span class="sig-paren">(</span><em>user</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationForm.update_content" title="Permalink to this definition">¶</a></dt> |
|
443 <dd></dd></dl> |
|
444 |
|
445 </dd></dl> |
|
446 |
|
447 <dl class="class"> |
|
448 <dt id="pyams_security.views.userfolder.UserRegistrationViewletsSuffix"> |
|
449 <em class="property">class </em><code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">UserRegistrationViewletsSuffix</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationViewletsSuffix" title="Permalink to this definition">¶</a></dt> |
|
450 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.Viewlet" title="pyams_viewlet.viewlet.Viewlet"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.Viewlet</span></code></a></p> |
|
451 <p>User registration viewlet suffix</p> |
|
452 <dl class="attribute"> |
|
453 <dt id="pyams_security.views.userfolder.UserRegistrationViewletsSuffix.button_label"> |
|
454 <code class="descname">button_label</code><em class="property"> = 'Register new account'</em><a class="headerlink" href="#pyams_security.views.userfolder.UserRegistrationViewletsSuffix.button_label" title="Permalink to this definition">¶</a></dt> |
|
455 <dd></dd></dl> |
|
456 |
|
457 </dd></dl> |
|
458 |
|
459 <dl class="function"> |
|
460 <dt id="pyams_security.views.userfolder.handle_confirmation_data_extraction"> |
|
461 <code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">handle_confirmation_data_extraction</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.handle_confirmation_data_extraction" title="Permalink to this definition">¶</a></dt> |
|
462 <dd><p>Handle confirmation data extraction</p> |
|
463 </dd></dl> |
|
464 |
|
465 <dl class="function"> |
|
466 <dt id="pyams_security.views.userfolder.handle_registration_data_extraction"> |
|
467 <code class="descclassname">pyams_security.views.userfolder.</code><code class="descname">handle_registration_data_extraction</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.userfolder.handle_registration_data_extraction" title="Permalink to this definition">¶</a></dt> |
|
468 <dd><p>Handle registration data extraction</p> |
|
469 </dd></dl> |
|
470 |
|
471 </div> |
|
472 <div class="section" id="module-pyams_security.views.utility"> |
|
473 <span id="pyams-security-views-utility-module"></span><h2>pyams_security.views.utility module<a class="headerlink" href="#module-pyams_security.views.utility" title="Permalink to this headline">¶</a></h2> |
|
474 <dl class="function"> |
|
475 <dt id="pyams_security.views.utility.find_principals"> |
|
476 <code class="descclassname">pyams_security.views.utility.</code><code class="descname">find_principals</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.views.utility.find_principals" title="Permalink to this definition">¶</a></dt> |
|
477 <dd><p>Find all principals matching given query</p> |
|
478 </dd></dl> |
|
479 |
|
480 </div> |
|
481 <div class="section" id="module-pyams_security.views"> |
|
482 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security.views" title="Permalink to this headline">¶</a></h2> |
|
483 </div> |
|
484 </div> |
|
485 |
|
486 |
|
487 </div> |
|
488 </div> |
|
489 </div> |
|
490 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
491 <div class="sphinxsidebarwrapper"> |
|
492 <h3><a href="index.html">Table Of Contents</a></h3> |
|
493 <ul> |
|
494 <li><a class="reference internal" href="#">pyams_security.views package</a><ul> |
|
495 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
496 <li><a class="reference internal" href="#module-pyams_security.views.login">pyams_security.views.login module</a></li> |
|
497 <li><a class="reference internal" href="#module-pyams_security.views.oauth">pyams_security.views.oauth module</a></li> |
|
498 <li><a class="reference internal" href="#module-pyams_security.views.userfolder">pyams_security.views.userfolder module</a></li> |
|
499 <li><a class="reference internal" href="#module-pyams_security.views.utility">pyams_security.views.utility module</a></li> |
|
500 <li><a class="reference internal" href="#module-pyams_security.views">Module contents</a></li> |
|
501 </ul> |
|
502 </li> |
|
503 </ul> |
|
504 |
|
505 <div id="searchbox" style="display: none" role="search"> |
|
506 <h3>Quick search</h3> |
|
507 <form class="search" action="search.html" method="get"> |
|
508 <div><input type="text" name="q" /></div> |
|
509 <div><input type="submit" value="Go" /></div> |
|
510 <input type="hidden" name="check_keywords" value="yes" /> |
|
511 <input type="hidden" name="area" value="default" /> |
|
512 </form> |
|
513 </div> |
|
514 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
515 </div> |
|
516 </div> |
|
517 <div class="clearer"></div> |
|
518 </div> |
|
519 <div class="related" role="navigation" aria-label="related navigation"> |
|
520 <h3>Navigation</h3> |
|
521 <ul> |
|
522 <li class="right" style="margin-right: 10px"> |
|
523 <a href="genindex.html" title="General Index" |
|
524 >index</a></li> |
|
525 <li class="right" > |
|
526 <a href="py-modindex.html" title="Python Module Index" |
|
527 >modules</a> |</li> |
|
528 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
529 </ul> |
|
530 </div> |
|
531 <div class="footer" role="contentinfo"> |
|
532 © Copyright 2017, Thierry Florac. |
|
533 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
534 </div> |
|
535 </body> |
|
536 </html> |
|