1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: OpenID::SReg::Request</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">OpenID::SReg::Request</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/openid/extensions/sreg_rb.html">
lib/openid/extensions/sreg.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Extension
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
An object to hold the state of a simple registration request.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000091">all_requested_fields</a>
<a href="#M000089">from_openid_request</a>
<a href="#M000095">get_extension_args</a>
<a href="#M000096">member?</a>
<a href="#M000088">new</a>
<a href="#M000090">parse_extension_args</a>
<a href="#M000093">request_field</a>
<a href="#M000094">request_fields</a>
<a href="#M000092">were_fields_requested?</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">ns_uri</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">optional</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">policy_url</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">required</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000089" class="method-detail">
<a name="M000089"></a>
<div class="method-heading">
<a href="Request.src/M000089.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000089.html');return false;">
<span class="method-name">from_openid_request</span><span class="method-args">(request)</span>
</a>
</div>
<div class="method-description">
<p>
Create a simple registration request that contains the fields that were
requested in the <a href="../../OpenID.html">OpenID</a> request with the
given arguments Takes an OpenID::CheckIDRequest, returns an
OpenID::Sreg::Request return nil if the extension was not requested.
</p>
</div>
</div>
<div id="method-M000088" class="method-detail">
<a name="M000088"></a>
<div class="method-heading">
<a href="Request.src/M000088.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000088.html');return false;">
<span class="method-name">new</span><span class="method-args">(required = nil, optional = nil, policy_url = nil, ns_uri = NS_URI)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000091" class="method-detail">
<a name="M000091"></a>
<div class="method-heading">
<a href="Request.src/M000091.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000091.html');return false;">
<span class="method-name">all_requested_fields</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
A list of all of the simple registration fields that were requested,
whether they were required or optional.
</p>
</div>
</div>
<div id="method-M000095" class="method-detail">
<a name="M000095"></a>
<div class="method-heading">
<a href="Request.src/M000095.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000095.html');return false;">
<span class="method-name">get_extension_args</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Get a hash of unqualified simple registration arguments representing this
request. This method is essentially the inverse of <a
href="Request.html#M000090">parse_extension_args</a>. This method
serializes the simple registration request fields.
</p>
</div>
</div>
<div id="method-M000096" class="method-detail">
<a name="M000096"></a>
<div class="method-heading">
<a href="Request.src/M000096.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000096.html');return false;">
<span class="method-name">member?</span><span class="method-args">(field_name)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000090" class="method-detail">
<a name="M000090"></a>
<div class="method-heading">
<a href="Request.src/M000090.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000090.html');return false;">
<span class="method-name">parse_extension_args</span><span class="method-args">(args, strict = false)</span>
</a>
</div>
<div class="method-description">
<p>
Parse the unqualified simple registration request parameters and add them
to this object.
</p>
<p>
This method is essentially the inverse of getExtensionArgs. This method
restores the serialized simple registration request fields.
</p>
<p>
If you are extracting arguments from a standard <a
href="../../OpenID.html">OpenID</a> checkid_* request, you probably want to
use fromOpenIDRequest, which will extract the sreg namespace and arguments
from the <a href="../../OpenID.html">OpenID</a> request. This method is
intended for cases where the <a href="../../OpenID.html">OpenID</a> server
needs more control over how the arguments are parsed than that method
provides.
</p>
</div>
</div>
<div id="method-M000093" class="method-detail">
<a name="M000093"></a>
<div class="method-heading">
<a href="Request.src/M000093.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000093.html');return false;">
<span class="method-name">request_field</span><span class="method-args">(field_name, required=false, strict=false)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Request.html">Request</a> the specified field from the <a
href="../../OpenID.html">OpenID</a> user field_name: the unqualified simple
registration field name required: whether the given field should be
presented
</p>
<pre>
to the user as being a required to successfully complete
the request
</pre>
<p>
strict: whether to raise an exception when a field is
</p>
<pre>
added to a request more than once
</pre>
<p>
Raises ArgumentError if the field_name is not a simple registration field,
or if strict is set and a field is added more than once
</p>
</div>
</div>
<div id="method-M000094" class="method-detail">
<a name="M000094"></a>
<div class="method-heading">
<a href="Request.src/M000094.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000094.html');return false;">
<span class="method-name">request_fields</span><span class="method-args">(field_names, required = false, strict = false)</span>
</a>
</div>
<div class="method-description">
<p>
Add the given list of fields to the request.
</p>
</div>
</div>
<div id="method-M000092" class="method-detail">
<a name="M000092"></a>
<div class="method-heading">
<a href="Request.src/M000092.html" target="Code" class="method-signature"
onclick="popupCode('Request.src/M000092.html');return false;">
<span class="method-name">were_fields_requested?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Have any simple registration fields been requested?
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
