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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
<?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::Consumer::CheckIDRequest</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::Consumer::CheckIDRequest</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/openid/consumer/checkid_request_rb.html">
lib/openid/consumer/checkid_request.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
An object that holds the state necessary for generating an <a
href="../../OpenID.html">OpenID</a> authentication request. This object
holds the association with the server and the discovered information with
which the request will be made.
</p>
<p>
It is separate from the consumer because you may wish to add things to the
request before sending it on its way to the server. It also has
serialization options that let you encode the authentication request as a
URL or as a form POST.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000344">add_extension</a>
<a href="#M000345">add_extension_arg</a>
<a href="#M000343">anonymous=</a>
<a href="#M000348">form_markup</a>
<a href="#M000346">get_message</a>
<a href="#M000349">html_markup</a>
<a href="#M000342">new</a>
<a href="#M000347">redirect_url</a>
<a href="#M000350">send_redirect?</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">anonymous</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">endpoint</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">message</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">return_to_args</td>
<td class="context-item-value"> [RW] </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-M000342" class="method-detail">
<a name="M000342"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000342.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000342.html');return false;">
<span class="method-name">new</span><span class="method-args">(assoc, endpoint)</span>
</a>
</div>
<div class="method-description">
<p>
Users of this library should not create instances of this class. Instances
of this class are created by the library when needed.
</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000344" class="method-detail">
<a name="M000344"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000344.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000344.html');return false;">
<span class="method-name">add_extension</span><span class="method-args">(extension_request)</span>
</a>
</div>
<div class="method-description">
<p>
Add an object that implements the extension interface for adding arguments
to an <a href="../../OpenID.html">OpenID</a> message to this checkid
request.
</p>
<p>
extension_request: an <a href="../Extension.html">OpenID::Extension</a>
object.
</p>
</div>
</div>
<div id="method-M000345" class="method-detail">
<a name="M000345"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000345.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000345.html');return false;">
<span class="method-name">add_extension_arg</span><span class="method-args">(namespace, key, value)</span>
</a>
</div>
<div class="method-description">
<p>
Add an extension argument to this <a href="../../OpenID.html">OpenID</a>
authentication request. You probably want to use <a
href="CheckIDRequest.html#M000344">add_extension</a> and the <a
href="../Extension.html">OpenID::Extension</a> interface.
</p>
<p>
Use caution when adding arguments, because they will be URL-escaped and
appended to the redirect URL, which can easily get quite long.
</p>
</div>
</div>
<div id="method-M000343" class="method-detail">
<a name="M000343"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000343.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000343.html');return false;">
<span class="method-name">anonymous=</span><span class="method-args">(is_anonymous)</span>
</a>
</div>
<div class="method-description">
<p>
Set whether this request should be made anonymously. If a request is
anonymous, the identifier will not be sent in the request. This is only
useful if you are making another kind of request with an extension in this
request.
</p>
<p>
Anonymous requests are not allowed when the request is made with <a
href="../../OpenID.html">OpenID</a> 1.
</p>
</div>
</div>
<div id="method-M000348" class="method-detail">
<a name="M000348"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000348.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000348.html');return false;">
<span class="method-name">form_markup</span><span class="method-args">(realm, return_to=nil, immediate=false, form_tag_attrs=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Get html for a form to submit this request to the IDP.
</p>
<p>
form_tag_attrs is a hash of attributes to be added to the form tag.
‘accept-charset’ and ‘enctype’ have defaults that
can be overridden. If a value is supplied for ‘action’ or
‘method’, it will be replaced.
</p>
</div>
</div>
<div id="method-M000346" class="method-detail">
<a name="M000346"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000346.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000346.html');return false;">
<span class="method-name">get_message</span><span class="method-args">(realm, return_to=nil, immediate=false)</span>
</a>
</div>
<div class="method-description">
<p>
Produce a <a href="../Message.html">OpenID::Message</a> representing this
request.
</p>
<p>
Not specifying a return_to URL means that the user will not be returned to
the site issuing the request upon its completion.
</p>
<p>
If immediate mode is requested, the <a href="../../OpenID.html">OpenID</a>
provider is to send back a response immediately, useful for
behind-the-scenes authentication attempts. Otherwise the <a
href="../../OpenID.html">OpenID</a> provider may engage the user before
providing a response. This is the default case, as the user may need to
provide credentials or approve the request before a positive response can
be sent.
</p>
</div>
</div>
<div id="method-M000349" class="method-detail">
<a name="M000349"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000349.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000349.html');return false;">
<span class="method-name">html_markup</span><span class="method-args">(realm, return_to=nil, immediate=false, form_tag_attrs=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Get a complete HTML document that autosubmits the request to the IDP with
javascript. This method wraps <a
href="CheckIDRequest.html#M000348">form_markup</a> - see that
method‘s documentation for help with the parameters.
</p>
</div>
</div>
<div id="method-M000347" class="method-detail">
<a name="M000347"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000347.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000347.html');return false;">
<span class="method-name">redirect_url</span><span class="method-args">(realm, return_to=nil, immediate=false)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a URL with an encoded <a href="../../OpenID.html">OpenID</a>
request.
</p>
<p>
The resulting URL is the <a href="../../OpenID.html">OpenID</a>
provider‘s endpoint URL with parameters appended as query arguments.
You should redirect the user agent to this URL.
</p>
<p>
<a href="../../OpenID.html">OpenID</a> 2.0 endpoints also accept POST
requests, see ‘<a
href="CheckIDRequest.html#M000350">send_redirect?</a>’ and ‘<a
href="CheckIDRequest.html#M000348">form_markup</a>’.
</p>
</div>
</div>
<div id="method-M000350" class="method-detail">
<a name="M000350"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000350.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000350.html');return false;">
<span class="method-name">send_redirect?</span><span class="method-args">(realm, return_to=nil, immediate=false)</span>
</a>
</div>
<div class="method-description">
<p>
Should this <a href="../../OpenID.html">OpenID</a> authentication request
be sent as a HTTP redirect or as a POST (form submission)?
</p>
<p>
This takes the same parameters as <a
href="CheckIDRequest.html#M000347">redirect_url</a> or <a
href="CheckIDRequest.html#M000348">form_markup</a>
</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>
|
