1
<?xml version="1.0" encoding="ascii"?>
1
<?xml version="1.0" encoding="iso-8859-1"?>
2
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
"DTD/xhtml1-transitional.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
6
<title>openid.consumer.consumer.SetupNeededResponse</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
11
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="openid-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
24
</p></th></tr></table>
41
28
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
31
<font size="-1"><b class="breadcrumbs">
45
32
<a href="openid-module.html">Package openid</a> ::
46
33
<a href="openid.consumer-module.html">Package consumer</a> ::
47
34
<a href="openid.consumer.consumer-module.html">Module consumer</a> ::
48
35
Class SetupNeededResponse
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options"
55
>[<a href="frames.html" target="_top">frames</a
56
>] | <a href="openid.consumer.consumer.SetupNeededResponse-class.html"
57
target="_top">no frames</a>]</span></td></tr>
62
<!-- ==================== CLASS DESCRIPTION ==================== -->
63
<h1 class="epydoc">Class SetupNeededResponse</h1><span class="codelink"><a href="openid.consumer.consumer-pysrc.html#SetupNeededResponse">source code</a></span><br /><br />
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.consumer.consumer.SetupNeededResponse-class.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Type SetupNeededResponse</h2>
64
46
<pre class="base-tree">
47
<a href="__builtin__.object-class.html"><code>object</code></a> --+
49
<code>Response</code> --+
69
<strong class="uidshort">SetupNeededResponse</strong>
51
<b>SetupNeededResponse</b>
73
56
A response with a status of SETUP_NEEDED. Indicates that the request
74
was in immediate mode, and the server is unable to authenticate the user
75
without further interaction.<br /><br />
77
<!-- ==================== INSTANCE METHODS ==================== -->
78
<a name="section-InstanceMethods"></a>
79
<table class="summary" border="1" cellpadding="3"
80
cellspacing="0" width="100%" bgcolor="white">
81
<tr bgcolor="#70b0f0" class="table-header">
82
<td colspan="2" class="table-header">
83
<table border="0" cellpadding="0" cellspacing="0" width="100%">
85
<td align="left"><span class="table-header">Instance Methods</span></td>
86
<td align="right" valign="top"
87
><span class="options">[<a href="#section-InstanceMethods"
88
class="privatelink" onclick="toggle_private();"
89
>hide private</a>]</span></td>
95
<td width="15%" align="right" valign="top" class="summary">
96
<span class="summary-type"> </span>
97
</td><td class="summary">
98
<span class="summary-sig"><a href="openid.consumer.consumer.SetupNeededResponse-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
99
<span class="summary-sig-arg">endpoint</span>,
100
<span class="summary-sig-arg">setup_url</span>=<span class="summary-sig-default">None</span>)</span><br />
101
x.__init__(...) initializes x; see x.__class__.__doc__ for
106
<td colspan="2" class="summary">
107
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
108
<code>__delattr__</code>,
109
<code>__getattribute__</code>,
110
<code>__hash__</code>,
111
<code>__new__</code>,
112
<code>__reduce__</code>,
113
<code>__reduce_ex__</code>,
114
<code>__repr__</code>,
115
<code>__setattr__</code>,
123
<!-- ==================== CLASS VARIABLES ==================== -->
124
<a name="section-ClassVariables"></a>
125
<table class="summary" border="1" cellpadding="3"
126
cellspacing="0" width="100%" bgcolor="white">
127
<tr bgcolor="#70b0f0" class="table-header">
128
<td colspan="2" class="table-header">
129
<table border="0" cellpadding="0" cellspacing="0" width="100%">
131
<td align="left"><span class="table-header">Class Variables</span></td>
132
<td align="right" valign="top"
133
><span class="options">[<a href="#section-ClassVariables"
134
class="privatelink" onclick="toggle_private();"
135
>hide private</a>]</span></td>
141
<td width="15%" align="right" valign="top" class="summary">
142
<span class="summary-type"> </span>
143
</td><td class="summary">
144
<a href="openid.consumer.consumer.SetupNeededResponse-class.html#status">status</a> = <code title="'setup_needed'">'setup_needed'</code><br />
151
<!-- ==================== INSTANCE VARIABLES ==================== -->
152
<a name="section-InstanceVariables"></a>
153
<table class="summary" border="1" cellpadding="3"
154
cellspacing="0" width="100%" bgcolor="white">
155
<tr bgcolor="#70b0f0" class="table-header">
156
<td colspan="2" class="table-header">
157
<table border="0" cellpadding="0" cellspacing="0" width="100%">
159
<td align="left"><span class="table-header">Instance Variables</span></td>
160
<td align="right" valign="top"
161
><span class="options">[<a href="#section-InstanceVariables"
162
class="privatelink" onclick="toggle_private();"
163
>hide private</a>]</span></td>
169
<td width="15%" align="right" valign="top" class="summary">
170
<span class="summary-type"> </span>
171
</td><td class="summary">
172
<a href="openid.consumer.consumer.SetupNeededResponse-class.html#identity_url">identity_url</a><br />
173
The identity URL for which authenitcation was attempted.
177
<td width="15%" align="right" valign="top" class="summary">
178
<span class="summary-type"> </span>
179
</td><td class="summary">
180
<a href="openid.consumer.consumer.SetupNeededResponse-class.html#setup_url">setup_url</a><br />
181
A URL that can be used to send the user to the server to set up
188
<!-- ==================== PROPERTIES ==================== -->
189
<a name="section-Properties"></a>
190
<table class="summary" border="1" cellpadding="3"
191
cellspacing="0" width="100%" bgcolor="white">
192
<tr bgcolor="#70b0f0" class="table-header">
193
<td colspan="2" class="table-header">
194
<table border="0" cellpadding="0" cellspacing="0" width="100%">
196
<td align="left"><span class="table-header">Properties</span></td>
197
<td align="right" valign="top"
198
><span class="options">[<a href="#section-Properties"
199
class="privatelink" onclick="toggle_private();"
200
>hide private</a>]</span></td>
206
<td colspan="2" class="summary">
207
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
208
<code>__class__</code>
215
<!-- ==================== METHOD DETAILS ==================== -->
216
<a name="section-MethodDetails"></a>
217
<table class="summary" border="1" cellpadding="3"
218
cellspacing="0" width="100%" bgcolor="white">
219
<tr bgcolor="#70b0f0" class="table-header">
220
<td colspan="2" class="table-header">
221
<table border="0" cellpadding="0" cellspacing="0" width="100%">
223
<td align="left"><span class="table-header">Method Details</span></td>
224
<td align="right" valign="top"
225
><span class="options">[<a href="#section-MethodDetails"
226
class="privatelink" onclick="toggle_private();"
227
>hide private</a>]</span></td>
233
<a name="__init__"></a>
235
<table class="details" border="1" cellpadding="3"
236
cellspacing="0" width="100%" bgcolor="white">
238
<table width="100%" cellpadding="0" cellspacing="0" border="0">
239
<tr valign="top"><td>
240
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
241
<span class="sig-arg">endpoint</span>,
242
<span class="sig-arg">setup_url</span>=<span class="sig-default">None</span>)</span>
243
<br /><em class="fname">(Constructor)</em>
245
</td><td align="right" valign="top"
246
><span class="codelink"><a href="openid.consumer.consumer-pysrc.html#SetupNeededResponse.__init__">source code</a></span>
250
<br />x.__init__(...) initializes x; see x.__class__.__doc__ for
255
<dd><em class="note">(inherited documentation)</em></dd>
261
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
262
<a name="section-ClassVariableDetails"></a>
263
<table class="summary" border="1" cellpadding="3"
264
cellspacing="0" width="100%" bgcolor="white">
265
<tr bgcolor="#70b0f0" class="table-header">
266
<td colspan="2" class="table-header">
267
<table border="0" cellpadding="0" cellspacing="0" width="100%">
269
<td align="left"><span class="table-header">Class Variable Details</span></td>
270
<td align="right" valign="top"
271
><span class="options">[<a href="#section-ClassVariableDetails"
272
class="privatelink" onclick="toggle_private();"
273
>hide private</a>]</span></td>
279
<a name="status"></a>
281
<table class="details" border="1" cellpadding="3"
282
cellspacing="0" width="100%" bgcolor="white">
284
<h3 class="epydoc">status</h3>
288
<dd><table><tr><td><pre class="variable">
289
<span class="variable-quote">'</span>setup_needed<span class="variable-quote">'</span>
290
</pre></td></tr></table></dd>
296
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
297
<a name="section-InstanceVariableDetails"></a>
298
<table class="summary" border="1" cellpadding="3"
299
cellspacing="0" width="100%" bgcolor="white">
300
<tr bgcolor="#70b0f0" class="table-header">
301
<td colspan="2" class="table-header">
302
<table border="0" cellpadding="0" cellspacing="0" width="100%">
304
<td align="left"><span class="table-header">Instance Variable Details</span></td>
305
<td align="right" valign="top"
306
><span class="options">[<a href="#section-InstanceVariableDetails"
307
class="privatelink" onclick="toggle_private();"
308
>hide private</a>]</span></td>
57
was in immediate mode, and the server is unable to authenticate the user
58
without further interaction.
62
<!-- =========== START OF METHOD SUMMARY =========== -->
63
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
64
<tr bgcolor="#70b0f0" class="summary">
65
<th colspan="2">Method Summary</th></tr>
66
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
67
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
68
<span class=summary-sig-arg>endpoint</span>,
69
<span class=summary-sig-arg>setup_url</span>)</span></code>
72
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
73
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
74
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
75
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
76
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
77
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
78
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
79
<a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>,
80
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>,
81
<a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
86
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
87
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
88
<tr bgcolor="#70b0f0" class="summary">
89
<th colspan="2">Instance Variable Summary</th></tr>
90
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
91
<td><b><a href="openid.consumer.consumer.SetupNeededResponse-class.html#identity_url"><code>identity_url</code></a></b>: The identity URL for which authenitcation was attempted.</td></tr>
92
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
93
<td><b><a href="openid.consumer.consumer.SetupNeededResponse-class.html#setup_url"><code>setup_url</code></a></b>: A URL that can be used to send the user to the server to set up for
94
authentication.</td></tr>
98
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
99
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
100
<tr bgcolor="#70b0f0" class="summary">
101
<th colspan="2">Class Variable Summary</th></tr>
102
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
103
<td><b><a href="openid.consumer.consumer.SetupNeededResponse-class.html#status"><code>status</code></a></b>: SETUP_NEEDED</td></tr>
107
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
108
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
109
<tr bgcolor="#70b0f0" class="details">
110
<th colspan="2">Instance Variable Details</th></tr>
112
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
314
113
<a name="identity_url"></a>
316
<table class="details" border="1" cellpadding="3"
317
cellspacing="0" width="100%" bgcolor="white">
319
<h3 class="epydoc">identity_url</h3>
320
<br />The identity URL for which authenitcation was attempted.
114
<h3>identity_url</h3>
115
The identity URL for which authenitcation was attempted.
323
116
</td></tr></table>
117
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
325
118
<a name="setup_url"></a>
327
<table class="details" border="1" cellpadding="3"
328
cellspacing="0" width="100%" bgcolor="white">
330
<h3 class="epydoc">setup_url</h3>
331
<br />A URL that can be used to send the user to the server to set up for
332
authentication. The user should be redirected in to the setup_url, either
333
in the current window or in a new browser window.
120
A URL that can be used to send the user to the server to set up for
121
authentication. The user should be redirected in to the setup_url, either
122
in the current window or in a new browser window. <code>None</code> in
336
124
</td></tr></table>
339
<!-- ==================== NAVIGATION BAR ==================== -->
340
<table class="navbar" border="0" width="100%" cellpadding="0"
341
bgcolor="#a0c0ff" cellspacing="0">
344
<th> <a
345
href="openid-module.html">Home</a> </th>
348
<th> <a
349
href="module-tree.html">Trees</a> </th>
352
<th> <a
353
href="identifier-index.html">Indices</a> </th>
356
<th> <a
357
href="help.html">Help</a> </th>
359
<!-- Project homepage -->
360
<th class="navbar" align="right" width="100%">
361
<table border="0" cellpadding="0" cellspacing="0">
362
<tr><th class="navbar" align="center"
363
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
128
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
129
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
130
<tr bgcolor="#70b0f0" class="details">
131
<th colspan="2">Class Variable Details</th></tr>
133
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
134
<a name="status"></a>
141
<dt><b>Type:</b></dt>
146
<span title="'setup_needed'"> <dt><b>Value:</b></dt>
148
<pre class="variable">
149
<span class="variable-quote">'</span>setup_needed<span class="variable-quote">'</span> </pre>
150
</td></tr></table></dd>
153
</dl></td></tr></table>
157
<!-- =========== START OF NAVBAR =========== -->
158
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
160
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
161
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
162
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
163
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
164
<th class="navbar" align="right" width="100%">
165
<table border="0" cellpadding="0" cellspacing="0">
166
<tr><th class="navbar" align="center">
168
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
169
</p></th></tr></table>
367
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
174
<table border="0" cellpadding="0" cellspacing="0" width="100%">
369
<td align="left" class="footer">Generated by Epydoc
370
3.0alpha3 on Fri Dec 8 13:26:20 2006</td>
371
<td align="right" class="footer">
372
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
176
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
177
<td align="right"><a href="http://epydoc.sourceforge.net"
178
><font size="-2">http://epydoc.sf.net</font></a></td>
377
<script type="text/javascript">
379
// Private objects are initially displayed (because if
380
// javascript is turned off then we want them to be
381
// visible); but by default, we want to hide them. So hide
382
// them unless we have a cookie that says to show them.