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

« back to all changes in this revision

Viewing changes to doc/openid.extension.Extension-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

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.extension.Extension</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://www.openidenabled.com/">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.extension-module.html">Module&nbsp;extension</a> ::
 
34
        Class&nbsp;Extension
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.extension.Extension-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
43
<h2 class="class">Type Extension</h2>
 
44
 
 
45
<pre class="base-tree">
 
46
<a href="__builtin__.object-class.html"><code>object</code></a> --+
 
47
         |
 
48
        <b>Extension</b>
 
49
</pre><br />
 
50
 
 
51
<dl><dt><b>Known Subclasses:</b></dt>
 
52
<dd>
 
53
    <a href="openid.sreg.SRegRequest-class.html"><code>SRegRequest</code></a>,
 
54
    <a href="openid.sreg.SRegResponse-class.html"><code>SRegResponse</code></a></dd></dl>
 
55
 
 
56
<hr/>
 
57
 
 
58
An interface for OpenID extensions.
 
59
<hr/>
 
60
 
 
61
 
 
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">&nbsp;</font></td>
 
67
  <td><code><span class="summary-sig"><a href="openid.extension.Extension-class.html#getExtensionArgs" class="summary-sig-name"><code>getExtensionArgs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
68
<br />
 
69
Get the string arguments that should be added to an OpenID message for 
 
70
this extension.</td></tr>
 
71
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
72
  <td><code><span class="summary-sig"><a href="openid.extension.Extension-class.html#toMessage" class="summary-sig-name"><code>toMessage</code></a>(<span class=summary-sig-arg>self</span>,
 
73
          <span class=summary-sig-arg>message</span>)</span></code>
 
74
<br />
 
75
Add the arguments from this extension to the provided message, or 
 
76
create a new message containing only those arguments.</td></tr>
 
77
  <tr><td colspan="2">
 
78
    <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
 
79
      <a href="__builtin__.object-class.html#__init__"><code>__init__</code></a>, 
 
80
      <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, 
 
81
      <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, 
 
82
      <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, 
 
83
      <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, 
 
84
      <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, 
 
85
      <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, 
 
86
      <a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>, 
 
87
      <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>, 
 
88
      <a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
 
89
    </td></tr>
 
90
</table><br />
 
91
 
 
92
 
 
93
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
 
94
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
95
<tr bgcolor="#70b0f0" class="summary">
 
96
  <th colspan="2">Instance Variable Summary</th></tr>
 
97
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
98
<td><b><a href="openid.extension.Extension-class.html#ns_uri"><code>ns_uri</code></a></b>: The namespace to which to add the arguments for this extension</td></tr>
 
99
</table><br />
 
100
 
 
101
 
 
102
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
103
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
104
<tr bgcolor="#70b0f0" class="summary">
 
105
  <th colspan="2">Class Variable Summary</th></tr>
 
106
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
107
<td><b><a href="openid.extension.Extension-class.html#ns_alias"><code>ns_alias</code></a></b> = <span title="None">None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
108
</table><br />
 
109
 
 
110
 
 
111
<!-- =========== START OF METHOD DETAILS =========== -->
 
112
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
113
<tr bgcolor="#70b0f0" class="details">
 
114
  <th colspan="2">Method Details</th></tr>
 
115
</table>
 
116
 
 
117
<a name="getExtensionArgs"></a>
 
118
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
119
  <h3><span class="sig"><span class="sig-name">getExtensionArgs</span>(<span class=sig-arg>self</span>)</span>
 
120
  </h3>
 
121
  Get the string arguments that should be added to an OpenID message 
 
122
  for this extension.
 
123
  <dl><dt></dt><dd>
 
124
  </dd></dl>
 
125
</td></tr></table>
 
126
 
 
127
<a name="toMessage"></a>
 
128
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
129
  <h3><span class="sig"><span class="sig-name">toMessage</span>(<span class=sig-arg>self</span>,
 
130
          <span class=sig-arg>message</span>=<span class=sig-default>None</span>)</span>
 
131
  </h3>
 
132
  Add the arguments from this extension to the provided message, or 
 
133
  create a new message containing only those arguments.
 
134
  <dl><dt></dt><dd>
 
135
    <dl><dt><b>Returns:</b></dt>
 
136
      <dd>
 
137
        The message with the extension arguments added
 
138
      </dd>
 
139
    </dl>
 
140
  </dd></dl>
 
141
</td></tr></table>
 
142
<br />
 
143
 
 
144
 
 
145
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
 
146
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
147
<tr bgcolor="#70b0f0" class="details">
 
148
  <th colspan="2">Instance Variable Details</th></tr>
 
149
</table>
 
150
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
151
<a name="ns_uri"></a>
 
152
<h3>ns_uri</h3>
 
153
The namespace to which to add the arguments for this extension
 
154
<dl>
 
155
  <dt></dt>
 
156
  <dd>
 
157
    <dl>
 
158
      <dt><b>Type:</b></dt>
 
159
      <dd>
 
160
          <code>NoneType</code>
 
161
 
 
162
      </dd>
 
163
<span title="None">      <dt><b>Value:</b></dt>
 
164
      <dd><table><tr><td>
 
165
<pre class="variable">
 
166
None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
167
        </td></tr></table></dd>
 
168
</span>    </dl>
 
169
  </dd>
 
170
</dl></td></tr></table>
 
171
<br />
 
172
 
 
173
 
 
174
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
175
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
176
<tr bgcolor="#70b0f0" class="details">
 
177
  <th colspan="2">Class Variable Details</th></tr>
 
178
</table>
 
179
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
180
<a name="ns_alias"></a>
 
181
<h3>ns_alias</h3>
 
182
<dl>
 
183
  <dt></dt>
 
184
  <dd>
 
185
    <dl>
 
186
      <dt><b>Type:</b></dt>
 
187
      <dd>
 
188
          <code>NoneType</code>
 
189
 
 
190
      </dd>
 
191
<span title="None">      <dt><b>Value:</b></dt>
 
192
      <dd><table><tr><td>
 
193
<pre class="variable">
 
194
None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
195
        </td></tr></table></dd>
 
196
</span>    </dl>
 
197
  </dd>
 
198
</dl></td></tr></table>
 
199
<br />
 
200
 
 
201
 
 
202
<!-- =========== START OF NAVBAR =========== -->
 
203
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
204
  <tr valign="center">
 
205
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
206
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
207
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
208
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
209
    <th class="navbar" align="right" width="100%">
 
210
      <table border="0" cellpadding="0" cellspacing="0">
 
211
      <tr><th class="navbar" align="center">
 
212
        <p class="nomargin">
 
213
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
214
      </p></th></tr></table>
 
215
    </th>
 
216
  </tr>
 
217
</table>
 
218
 
 
219
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
220
  <tr>
 
221
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
 
222
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
223
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
224
  </tr>
 
225
</table>
 
226
</body>
 
227
</html>