~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.extensions.ax.StoreResponse-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-12-10 10:29:01 UTC
  • mfrom: (2.1.2 pyopenid-2.1)
  • Revision ID: launchpad@pqm.canonical.com-20071210102901-f5mk3xr5ggx0vtwh
[rs=jamesh] Upgrade to python-openid-2.1 for better support of final OpenID 2.0 standard

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>openid.extensions.ax.StoreResponse</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="openid-module.html">Package&nbsp;openid</a> ::
 
33
        <a href="openid.extensions-module.html">Package&nbsp;extensions</a> ::
 
34
        <a href="openid.extensions.ax-module.html">Module&nbsp;ax</a> ::
 
35
        Class&nbsp;StoreResponse
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.extensions.ax.StoreResponse-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Type StoreResponse</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="__builtin__.object-class.html"><code>object</code></a> --+        
 
48
         |        
 
49
 <a href="openid.extension.Extension-class.html"><code>Extension</code></a> --+    
 
50
             |    
 
51
     <code>AXMessage</code> --+
 
52
                 |
 
53
                <b>StoreResponse</b>
 
54
</pre><br />
 
55
 
 
56
<hr/>
 
57
 
 
58
An indication that the store request was processed along with this 
 
59
OpenID transaction.
 
60
<hr/>
 
61
 
 
62
 
 
63
<!-- =========== START OF METHOD SUMMARY =========== -->
 
64
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
65
<tr bgcolor="#70b0f0" class="summary">
 
66
  <th colspan="2">Method Summary</th></tr>
 
67
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
68
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
 
69
          <span class=summary-sig-arg>succeeded</span>,
 
70
          <span class=summary-sig-arg>error_message</span>)</span></code>
 
71
</td></tr>
 
72
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
73
  <td><code><span class="summary-sig"><a href="openid.extensions.ax.StoreResponse-class.html#getExtensionArgs" class="summary-sig-name"><code>getExtensionArgs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
74
</td></tr>
 
75
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
76
  <td><code><span class="summary-sig"><a href="openid.extensions.ax.StoreResponse-class.html#succeeded" class="summary-sig-name"><code>succeeded</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
77
<br />
 
78
Was this response a success response?</td></tr>
 
79
  <tr><td colspan="2">
 
80
    <b>Inherited from <a href="openid.extension.Extension-class.html"><code>Extension</code></a>:</b>
 
81
      <a href="openid.extension.Extension-class.html#toMessage"><code>toMessage</code></a>
 
82
      <br />
 
83
    <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
 
84
      <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, 
 
85
      <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, 
 
86
      <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, 
 
87
      <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, 
 
88
      <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, 
 
89
      <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, 
 
90
      <a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>, 
 
91
      <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>, 
 
92
      <a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
 
93
    </td></tr>
 
94
</table><br />
 
95
 
 
96
 
 
97
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
98
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
99
<tr bgcolor="#70b0f0" class="summary">
 
100
  <th colspan="2">Class Variable Summary</th></tr>
 
101
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
102
<td><b><a href="openid.extensions.ax.StoreResponse-class.html#FAILURE_MODE"><code>FAILURE_MODE</code></a></b> = <span title="'store_response_failure'"><code><span class="variable-quote">'</span>store_response_failure<span class="variable-quote">'</span>                  </code>
 
103
</span></td></tr>
 
104
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
105
<td><b><a href="openid.extensions.ax.StoreResponse-class.html#SUCCESS_MODE"><code>SUCCESS_MODE</code></a></b> = <span title="'store_response_success'"><code><span class="variable-quote">'</span>store_response_success<span class="variable-quote">'</span>                  </code>
 
106
</span></td></tr>
 
107
  <tr><td colspan="2">
 
108
 
 
109
    </td></tr>
 
110
</table><br />
 
111
 
 
112
 
 
113
<!-- =========== START OF METHOD DETAILS =========== -->
 
114
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
115
<tr bgcolor="#70b0f0" class="details">
 
116
  <th colspan="2">Method Details</th></tr>
 
117
</table>
 
118
 
 
119
<a name="getExtensionArgs"></a>
 
120
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
121
  <h3><span class="sig"><span class="sig-name">getExtensionArgs</span>(<span class=sig-arg>self</span>)</span>
 
122
  </h3>
 
123
  <dl><dt></dt><dd>
 
124
    <dl><dt><b>Overrides:</b></dt>
 
125
      <dd><a href="openid.extension.Extension-class.html#getExtensionArgs"><code>openid.extension.Extension.getExtensionArgs</code></a></dd>
 
126
    </dl>
 
127
<p><b>See Also:</b> {Extension.getExtensionArgs&lt;openid.extension.Extension.getExtensionArgs&gt;}
 
128
</p>
 
129
 
 
130
  </dd></dl>
 
131
</td></tr></table>
 
132
 
 
133
<a name="succeeded"></a>
 
134
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
135
  <h3><span class="sig"><span class="sig-name">succeeded</span>(<span class=sig-arg>self</span>)</span>
 
136
  </h3>
 
137
  Was this response a success response?
 
138
  <dl><dt></dt><dd>
 
139
  </dd></dl>
 
140
</td></tr></table>
 
141
<br />
 
142
 
 
143
 
 
144
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
145
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
146
<tr bgcolor="#70b0f0" class="details">
 
147
  <th colspan="2">Class Variable Details</th></tr>
 
148
</table>
 
149
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
150
<a name="FAILURE_MODE"></a>
 
151
<h3>FAILURE_MODE</h3>
 
152
<dl>
 
153
  <dt></dt>
 
154
  <dd>
 
155
    <dl>
 
156
      <dt><b>Type:</b></dt>
 
157
      <dd>
 
158
          <code>str</code>
 
159
 
 
160
      </dd>
 
161
<span title="'store_response_failure'">      <dt><b>Value:</b></dt>
 
162
      <dd><table><tr><td>
 
163
<pre class="variable">
 
164
<span class="variable-quote">'</span>store_response_failure<span class="variable-quote">'</span>                                               </pre>
 
165
        </td></tr></table></dd>
 
166
</span>    </dl>
 
167
  </dd>
 
168
</dl></td></tr></table>
 
169
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
170
<a name="SUCCESS_MODE"></a>
 
171
<h3>SUCCESS_MODE</h3>
 
172
<dl>
 
173
  <dt></dt>
 
174
  <dd>
 
175
    <dl>
 
176
      <dt><b>Type:</b></dt>
 
177
      <dd>
 
178
          <code>str</code>
 
179
 
 
180
      </dd>
 
181
<span title="'store_response_success'">      <dt><b>Value:</b></dt>
 
182
      <dd><table><tr><td>
 
183
<pre class="variable">
 
184
<span class="variable-quote">'</span>store_response_success<span class="variable-quote">'</span>                                               </pre>
 
185
        </td></tr></table></dd>
 
186
</span>    </dl>
 
187
  </dd>
 
188
</dl></td></tr></table>
 
189
<br />
 
190
 
 
191
 
 
192
<!-- =========== START OF NAVBAR =========== -->
 
193
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
194
  <tr valign="center">
 
195
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
196
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
197
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
198
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
199
    <th class="navbar" align="right" width="100%">
 
200
      <table border="0" cellpadding="0" cellspacing="0">
 
201
      <tr><th class="navbar" align="center">
 
202
        <p class="nomargin">
 
203
          <a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
 
204
      </p></th></tr></table>
 
205
    </th>
 
206
  </tr>
 
207
</table>
 
208
 
 
209
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
210
  <tr>
 
211
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Dec  5 13:57:49 2007</font></td>
 
212
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
213
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
214
  </tr>
 
215
</table>
 
216
</body>
 
217
</html>