echosign 1.0.2 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +2 -1
- data/.rubocop.yml +14 -0
- data/.rubocop_todo.yml +241 -0
- data/.simplecov +2 -0
- data/.travis.yml +9 -0
- data/Gemfile +3 -3
- data/Gemfile.lock +74 -48
- data/README.md +43 -8
- data/Rakefile +2 -2
- data/doc/Echosign.html +135 -0
- data/doc/Echosign/Agreement.html +545 -0
- data/doc/Echosign/Client.html +5365 -0
- data/doc/Echosign/CounterSignerInfo.html +267 -0
- data/doc/Echosign/Credentials.html +1053 -0
- data/doc/Echosign/Fileinfo.html +305 -0
- data/doc/Echosign/FormFieldLocation.html +264 -0
- data/doc/Echosign/MegaSign.html +533 -0
- data/doc/Echosign/ParameterError.html +124 -0
- data/doc/Echosign/PhoneInfo.html +281 -0
- data/doc/Echosign/Recipient.html +311 -0
- data/doc/Echosign/RecipientSecurityOption.html +296 -0
- data/doc/Echosign/Refresh.html +288 -0
- data/doc/Echosign/Reminder.html +279 -0
- data/doc/Echosign/Request.html +5289 -0
- data/doc/Echosign/Request/EndpointHash.html +328 -0
- data/doc/Echosign/Request/Failure.html +290 -0
- data/doc/Echosign/RequestFormField.html +244 -0
- data/doc/Echosign/RequiredParameterError.html +124 -0
- data/doc/Echosign/UrlFileInfo.html +297 -0
- data/doc/Echosign/User.html +422 -0
- data/doc/Echosign/Validatable.html +355 -0
- data/doc/Echosign/Widget.html +924 -0
- data/doc/Echosign/WidgetCompletionInfo.html +323 -0
- data/doc/Echosign/WidgetPersonalization.html +330 -0
- data/doc/Echosign/WidgetSecurityOption.html +361 -0
- data/doc/Echosign/WidgetSignerSecurityOption.html +298 -0
- data/doc/Echosign/WidgetStatus.html +316 -0
- data/doc/Echosign/WidgetVaultingInfo.html +267 -0
- data/doc/_index.html +378 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +191 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +191 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1035 -0
- data/doc/top-level-namespace.html +110 -0
- data/echosign.gemspec +18 -20
- data/features/support/env.rb +8 -8
- data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +2 -2
- data/fixtures/vcr_cassettes/agreement_document_file.yml +1 -1
- data/fixtures/vcr_cassettes/agreement_documents.yml +2 -2
- data/fixtures/vcr_cassettes/agreement_form_data.yml +1 -1
- data/fixtures/vcr_cassettes/agreement_info.yml +1 -1
- data/fixtures/vcr_cassettes/agreement_signing_urls.yml +1 -1
- data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1 -1
- data/fixtures/vcr_cassettes/cancel_agreement.yml +1 -1
- data/fixtures/vcr_cassettes/create_agreement.yml +1 -1
- data/fixtures/vcr_cassettes/create_reminder.yml +1 -1
- data/fixtures/vcr_cassettes/create_transient_document.yml +1 -1
- data/fixtures/vcr_cassettes/create_user.yml +1 -1
- data/fixtures/vcr_cassettes/create_widget.yml +1 -1
- data/fixtures/vcr_cassettes/get_agreements.yml +1 -1
- data/fixtures/vcr_cassettes/get_library_document.yml +1 -1
- data/fixtures/vcr_cassettes/get_library_document_data.yml +1 -1
- data/fixtures/vcr_cassettes/get_library_document_file.yml +1 -1
- data/fixtures/vcr_cassettes/get_library_documents.yml +1 -1
- data/fixtures/vcr_cassettes/get_token.yml +22 -20
- data/fixtures/vcr_cassettes/get_user.yml +1 -1
- data/fixtures/vcr_cassettes/get_users.yml +2 -2
- data/fixtures/vcr_cassettes/get_widget.yml +1 -1
- data/fixtures/vcr_cassettes/get_widget_document_file.yml +1 -1
- data/fixtures/vcr_cassettes/get_widget_documents.yml +1 -1
- data/fixtures/vcr_cassettes/get_widgets.yml +1 -1
- data/fixtures/vcr_cassettes/library_combined_document.yml +2 -2
- data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1 -1
- data/fixtures/vcr_cassettes/personalize_widget.yml +1 -1
- data/fixtures/vcr_cassettes/refresh_token.yml +46 -0
- data/fixtures/vcr_cassettes/revoke_token.yml +44 -0
- data/fixtures/vcr_cassettes/update_widget_status.yml +1 -1
- data/lib/echosign.rb +11 -11
- data/lib/echosign/agreement.rb +26 -10
- data/lib/echosign/agreement/client.rb +111 -104
- data/lib/echosign/agreement/fileinfo.rb +1 -3
- data/lib/echosign/agreement/form_field_location.rb +2 -3
- data/lib/echosign/agreement/phone_info.rb +5 -5
- data/lib/echosign/agreement/recipient.rb +9 -8
- data/lib/echosign/agreement/recipient_security_option.rb +5 -4
- data/lib/echosign/agreement/request.rb +33 -43
- data/lib/echosign/agreement/request_form_field.rb +2 -3
- data/lib/echosign/agreement/url_file_info.rb +8 -6
- data/lib/echosign/client.rb +33 -24
- data/lib/echosign/credentials.rb +95 -24
- data/lib/echosign/library_documents/client.rb +18 -23
- data/lib/echosign/library_documents/request.rb +19 -20
- data/lib/echosign/mega_sign.rb +20 -10
- data/lib/echosign/mega_sign/client.rb +109 -104
- data/lib/echosign/mega_sign/request.rb +32 -43
- data/lib/echosign/refresh.rb +6 -10
- data/lib/echosign/reminder.rb +2 -2
- data/lib/echosign/request.rb +85 -75
- data/lib/echosign/user.rb +13 -7
- data/lib/echosign/validatable.rb +6 -10
- data/lib/echosign/version.rb +1 -1
- data/lib/echosign/widget.rb +53 -27
- data/lib/echosign/widget/client.rb +33 -36
- data/lib/echosign/widget/counter_signer_info.rb +4 -5
- data/lib/echosign/widget/request.rb +28 -52
- data/lib/echosign/widget/widget_completion_info.rb +22 -12
- data/lib/echosign/widget/widget_personalization.rb +9 -7
- data/lib/echosign/widget/widget_security_option.rb +21 -11
- data/lib/echosign/widget/widget_signer_security_option.rb +8 -6
- data/lib/echosign/widget/widget_status.rb +10 -8
- data/lib/echosign/widget/widget_vaulting_info.rb +4 -5
- data/spec/lib/agreement/client_spec.rb +25 -31
- data/spec/lib/client_spec.rb +15 -18
- data/spec/lib/credentials_spec.rb +48 -0
- data/spec/lib/library_documents/client_spec.rb +11 -15
- data/spec/lib/shared_client.rb +9 -16
- data/spec/lib/user_spec.rb +0 -2
- data/spec/lib/validatable_spec.rb +12 -18
- data/spec/lib/version_spec.rb +1 -1
- data/spec/lib/widget/client_spec.rb +46 -49
- data/spec/spec_helper.rb +12 -5
- metadata +125 -60
- data/spec/lib/request_spec.rb +0 -18
|
@@ -0,0 +1,924 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Echosign::Widget
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.16
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Echosign::Widget";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (W)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Echosign.html" title="Echosign (module)">Echosign</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Widget</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Echosign::Widget
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Hash</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Hash</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Echosign::Widget</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<dl>
|
|
93
|
+
<dt>Includes:</dt>
|
|
94
|
+
<dd><span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></dd>
|
|
95
|
+
</dl>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<dl>
|
|
103
|
+
<dt>Defined in:</dt>
|
|
104
|
+
<dd>lib/echosign/widget.rb</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
114
|
+
<ul class="summary">
|
|
115
|
+
|
|
116
|
+
<li class="public ">
|
|
117
|
+
<span class="summary_signature">
|
|
118
|
+
|
|
119
|
+
<a href="#user_email-instance_method" title="#user_email (instance method)">#<strong>user_email</strong> ⇒ Object </a>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</span>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<span class="note title readonly">readonly</span>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="summary_desc"><div class='inline'>
|
|
139
|
+
<p>Returns the value of attribute user_email.</p>
|
|
140
|
+
</div></span>
|
|
141
|
+
|
|
142
|
+
</li>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<li class="public ">
|
|
146
|
+
<span class="summary_signature">
|
|
147
|
+
|
|
148
|
+
<a href="#user_id-instance_method" title="#user_id (instance method)">#<strong>user_id</strong> ⇒ Object </a>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</span>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<span class="note title readonly">readonly</span>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>Returns the value of attribute user_id.</p>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
</ul>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<h2>
|
|
181
|
+
Instance Method Summary
|
|
182
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
183
|
+
</h2>
|
|
184
|
+
|
|
185
|
+
<ul class="summary">
|
|
186
|
+
|
|
187
|
+
<li class="public ">
|
|
188
|
+
<span class="summary_signature">
|
|
189
|
+
|
|
190
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(user_id = nil, user_email = nil, params) ⇒ Widget </a>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</span>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class="note title constructor">constructor</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class="summary_desc"><div class='inline'>
|
|
207
|
+
<p>Widget initialization object.</p>
|
|
208
|
+
</div></span>
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</ul>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echosign::Validatable (module)">Validatable</a></span></h3>
|
|
226
|
+
<p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echosign::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echosign::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echosign::Validatable#validate_field (method)">#validate_field</a></span></p>
|
|
227
|
+
|
|
228
|
+
<div id="constructor_details" class="method_details_list">
|
|
229
|
+
<h2>Constructor Details</h2>
|
|
230
|
+
|
|
231
|
+
<div class="method_details first">
|
|
232
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
233
|
+
|
|
234
|
+
#<strong>initialize</strong>(user_id = nil, user_email = nil, params) ⇒ <tt><span class='object_link'><a href="" title="Echosign::Widget (class)">Widget</a></span></tt>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
</h3><div class="docstring">
|
|
241
|
+
<div class="discussion">
|
|
242
|
+
|
|
243
|
+
<p>Widget initialization object</p>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</div>
|
|
247
|
+
</div>
|
|
248
|
+
<div class="tags">
|
|
249
|
+
<p class="tag_title">Parameters:</p>
|
|
250
|
+
<ul class="param">
|
|
251
|
+
|
|
252
|
+
<li>
|
|
253
|
+
|
|
254
|
+
<span class='name'>user_id</span>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
—
|
|
264
|
+
<div class='inline'>
|
|
265
|
+
<p>The ID of the user on whose behalf widget is being created.</p>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
</li>
|
|
269
|
+
|
|
270
|
+
<li>
|
|
271
|
+
|
|
272
|
+
<span class='name'>user_email</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
—
|
|
282
|
+
<div class='inline'>
|
|
283
|
+
<p>The email address of the user on whose behalf widget is being created. If
|
|
284
|
+
both X-User-Id and X-User-Email are provided then X-User-Id is given
|
|
285
|
+
preference. If neither is specified then the user is inferred from the
|
|
286
|
+
access token.</p>
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
</li>
|
|
290
|
+
|
|
291
|
+
<li>
|
|
292
|
+
|
|
293
|
+
<span class='name'>params</span>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
—
|
|
301
|
+
<div class='inline'>
|
|
302
|
+
<p>SYMBOL-referenced Hash containing: (REQUIRED)</p>
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
<li>
|
|
308
|
+
|
|
309
|
+
<span class='name'>param</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
—
|
|
317
|
+
<div class='inline'>
|
|
318
|
+
<p>a customizable set of options</p>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</li>
|
|
322
|
+
|
|
323
|
+
</ul>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
333
|
+
<ul class="option">
|
|
334
|
+
|
|
335
|
+
<li>
|
|
336
|
+
<span class="name">:name</span>
|
|
337
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
338
|
+
<span class="default">
|
|
339
|
+
|
|
340
|
+
</span>
|
|
341
|
+
|
|
342
|
+
— <div class='inline'>
|
|
343
|
+
<p>The name of the widget that will be used to identify it, in emails and on
|
|
344
|
+
the website (REQUIRED)</p>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</li>
|
|
348
|
+
|
|
349
|
+
<li>
|
|
350
|
+
<span class="name">:fileInfos</span>
|
|
351
|
+
<span class="type">(<tt>Array</tt>)</span>
|
|
352
|
+
<span class="default">
|
|
353
|
+
|
|
354
|
+
</span>
|
|
355
|
+
|
|
356
|
+
— <div class='inline'>
|
|
357
|
+
<p>Populate with instances of <span class='object_link'><a href="Fileinfo.html" title="Echosign::Fileinfo (class)">Echosign::Fileinfo</a></span>. A list
|
|
358
|
+
of one or more files (or references to files) that will be used to create
|
|
359
|
+
the widget. If more than one file is provided, they will be combined before
|
|
360
|
+
the widget is created. Library documents are not permitted. Note: Only one
|
|
361
|
+
of the four parameters in every Fileinfo object must be specified
|
|
362
|
+
(REQUIRED)</p>
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
</li>
|
|
366
|
+
|
|
367
|
+
<li>
|
|
368
|
+
<span class="name">:formFieldLayerTemplates</span>
|
|
369
|
+
<span class="type">(<tt>Array</tt>)</span>
|
|
370
|
+
<span class="default">
|
|
371
|
+
|
|
372
|
+
</span>
|
|
373
|
+
|
|
374
|
+
— <div class='inline'>
|
|
375
|
+
<p>Populate with instances of <span class='object_link'><a href="Fileinfo.html" title="Echosign::Fileinfo (class)">Echosign::Fileinfo</a></span>.
|
|
376
|
+
Specifies the form field layer template or source of form fields to apply
|
|
377
|
+
on the files in this transaction. If specified, the FileInfo for this
|
|
378
|
+
parameter must refer to a form field layer template via libraryDocumentId
|
|
379
|
+
or libraryDocumentName, or if specified via transientDocumentId or
|
|
380
|
+
documentURL, it must be of a supported file type. Note: Only one of the
|
|
381
|
+
four parameters in every FileInfo object must be specified.</p>
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
</li>
|
|
385
|
+
|
|
386
|
+
<li>
|
|
387
|
+
<span class="name">:widgetCompletionInfo</span>
|
|
388
|
+
<span class="type">(<tt><span class='object_link'><a href="WidgetCompletionInfo.html" title="Echosign::WidgetCompletionInfo (class)">Echosign::WidgetCompletionInfo</a></span></tt>)</span>
|
|
389
|
+
<span class="default">
|
|
390
|
+
|
|
391
|
+
</span>
|
|
392
|
+
|
|
393
|
+
— <div class='inline'>
|
|
394
|
+
<p>URL and associated properties for the success page the user will be taken
|
|
395
|
+
to after filling out the widget</p>
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
<li>
|
|
401
|
+
<span class="name">:callbackInfo</span>
|
|
402
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
403
|
+
<span class="default">
|
|
404
|
+
|
|
405
|
+
</span>
|
|
406
|
+
|
|
407
|
+
— <div class='inline'>
|
|
408
|
+
<p>A publicly accessible url to which EchoSign will perform an HTTP PUT
|
|
409
|
+
operation with the final signed PDF file. HTTP authentication is supported
|
|
410
|
+
using standard embedded syntax - i.e. <a
|
|
411
|
+
href="http://username:password@your.server.com/path/to/file">username:password@your.server.com/path/to/file</a>.
|
|
412
|
+
EchoSign can also communicate with your system using HTTP GET, every time
|
|
413
|
+
there is a new agreement event. Please contact support@echosign.com if you
|
|
414
|
+
wish to use this option.</p>
|
|
415
|
+
</div>
|
|
416
|
+
|
|
417
|
+
</li>
|
|
418
|
+
|
|
419
|
+
<li>
|
|
420
|
+
<span class="name">:securityOptions</span>
|
|
421
|
+
<span class="type">(<tt><span class='object_link'><a href="WidgetSecurityOption.html" title="Echosign::WidgetSecurityOption (class)">Echosign::WidgetSecurityOption</a></span></tt>)</span>
|
|
422
|
+
<span class="default">
|
|
423
|
+
|
|
424
|
+
</span>
|
|
425
|
+
|
|
426
|
+
— <div class='inline'>
|
|
427
|
+
<p>Sets optional secondary security parameters for your widget</p>
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
</li>
|
|
431
|
+
|
|
432
|
+
<li>
|
|
433
|
+
<span class="name">:locale</span>
|
|
434
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
435
|
+
<span class="default">
|
|
436
|
+
|
|
437
|
+
</span>
|
|
438
|
+
|
|
439
|
+
— <div class='inline'>
|
|
440
|
+
<p>The locale associated with this widget - specifies the language for the
|
|
441
|
+
signing page and emails, for example en_US or fr_FR. If none specified,
|
|
442
|
+
defaults to the language configured for the widget creator</p>
|
|
443
|
+
</div>
|
|
444
|
+
|
|
445
|
+
</li>
|
|
446
|
+
|
|
447
|
+
<li>
|
|
448
|
+
<span class="name">:counterSigners</span>
|
|
449
|
+
<span class="type">(<tt><span class='object_link'><a href="CounterSignerInfo.html" title="Echosign::CounterSignerInfo (class)">Echosign::CounterSignerInfo</a></span></tt>)</span>
|
|
450
|
+
<span class="default">
|
|
451
|
+
|
|
452
|
+
</span>
|
|
453
|
+
|
|
454
|
+
— <div class='inline'>
|
|
455
|
+
<p>A list of one or more counter signers</p>
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
</li>
|
|
459
|
+
|
|
460
|
+
<li>
|
|
461
|
+
<span class="name">:vaultingInfo</span>
|
|
462
|
+
<span class="type">(<tt><span class='object_link'><a href="WidgetVaultingInfo.html" title="Echosign::WidgetVaultingInfo (class)">Echosign::WidgetVaultingInfo</a></span></tt>)</span>
|
|
463
|
+
<span class="default">
|
|
464
|
+
|
|
465
|
+
</span>
|
|
466
|
+
|
|
467
|
+
— <div class='inline'>
|
|
468
|
+
<p>Sets the vaulting properties that allows EchoSign to securely store
|
|
469
|
+
documents with a vault provider</p>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
</li>
|
|
473
|
+
|
|
474
|
+
<li>
|
|
475
|
+
<span class="name">:mergeFieldInfo</span>
|
|
476
|
+
<span class="type">(<tt>Echosign::WidgetMergefieldInfo</tt>)</span>
|
|
477
|
+
<span class="default">
|
|
478
|
+
|
|
479
|
+
</span>
|
|
480
|
+
|
|
481
|
+
— <div class='inline'>
|
|
482
|
+
<p>Optional default values for fields to merge into the document. The values
|
|
483
|
+
will be presented to the signers for editable fields; for read-only fields
|
|
484
|
+
the provided values will not be editable during the signing process.
|
|
485
|
+
Merging data into fields is currently not supported when used with
|
|
486
|
+
libraryDocumentId or libraryDocumentName. Only file and url are curently
|
|
487
|
+
supported</p>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
</li>
|
|
491
|
+
|
|
492
|
+
<li>
|
|
493
|
+
<span class="name">:widgetAuthFailureInfo</span>
|
|
494
|
+
<span class="type">(<tt><span class='object_link'><a href="WidgetCompletionInfo.html" title="Echosign::WidgetCompletionInfo (class)">Echosign::WidgetCompletionInfo</a></span></tt>)</span>
|
|
495
|
+
<span class="default">
|
|
496
|
+
|
|
497
|
+
</span>
|
|
498
|
+
|
|
499
|
+
— <div class='inline'>
|
|
500
|
+
<p>URL and associated properties for the error page the user will be taken
|
|
501
|
+
after failing to authenticate</p>
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
<li>
|
|
507
|
+
<span class="name">:widgetSignerSecurityOptions</span>
|
|
508
|
+
<span class="type">(<tt><span class='object_link'><a href="WidgetSignerSecurityOption.html" title="Echosign::WidgetSignerSecurityOption (class)">Echosign::WidgetSignerSecurityOption</a></span></tt>)</span>
|
|
509
|
+
<span class="default">
|
|
510
|
+
|
|
511
|
+
</span>
|
|
512
|
+
|
|
513
|
+
— <div class='inline'>
|
|
514
|
+
<p>Security options that apply to widget signers</p>
|
|
515
|
+
</div>
|
|
516
|
+
|
|
517
|
+
</li>
|
|
518
|
+
|
|
519
|
+
</ul>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div><table class="source_code">
|
|
524
|
+
<tr>
|
|
525
|
+
<td>
|
|
526
|
+
<pre class="lines">
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
60
|
|
530
|
+
61
|
|
531
|
+
62
|
|
532
|
+
63
|
|
533
|
+
64
|
|
534
|
+
65
|
|
535
|
+
66
|
|
536
|
+
67
|
|
537
|
+
68
|
|
538
|
+
69
|
|
539
|
+
70
|
|
540
|
+
71
|
|
541
|
+
72
|
|
542
|
+
73
|
|
543
|
+
74
|
|
544
|
+
75
|
|
545
|
+
76
|
|
546
|
+
77
|
|
547
|
+
78
|
|
548
|
+
79
|
|
549
|
+
80
|
|
550
|
+
81
|
|
551
|
+
82
|
|
552
|
+
83
|
|
553
|
+
84
|
|
554
|
+
85
|
|
555
|
+
86
|
|
556
|
+
87
|
|
557
|
+
88
|
|
558
|
+
89
|
|
559
|
+
90
|
|
560
|
+
91
|
|
561
|
+
92
|
|
562
|
+
93
|
|
563
|
+
94
|
|
564
|
+
95
|
|
565
|
+
96
|
|
566
|
+
97
|
|
567
|
+
98
|
|
568
|
+
99
|
|
569
|
+
100
|
|
570
|
+
101
|
|
571
|
+
102
|
|
572
|
+
103
|
|
573
|
+
104
|
|
574
|
+
105
|
|
575
|
+
106
|
|
576
|
+
107
|
|
577
|
+
108
|
|
578
|
+
109
|
|
579
|
+
110
|
|
580
|
+
111
|
|
581
|
+
112
|
|
582
|
+
113
|
|
583
|
+
114
|
|
584
|
+
115
|
|
585
|
+
116
|
|
586
|
+
117
|
|
587
|
+
118
|
|
588
|
+
119
|
|
589
|
+
120
|
|
590
|
+
121
|
|
591
|
+
122
|
|
592
|
+
123
|
|
593
|
+
124
|
|
594
|
+
125
|
|
595
|
+
126
|
|
596
|
+
127
|
|
597
|
+
128
|
|
598
|
+
129
|
|
599
|
+
130
|
|
600
|
+
131
|
|
601
|
+
132
|
|
602
|
+
133
|
|
603
|
+
134
|
|
604
|
+
135
|
|
605
|
+
136
|
|
606
|
+
137
|
|
607
|
+
138
|
|
608
|
+
139
|
|
609
|
+
140
|
|
610
|
+
141
|
|
611
|
+
142
|
|
612
|
+
143
|
|
613
|
+
144
|
|
614
|
+
145
|
|
615
|
+
146
|
|
616
|
+
147
|
|
617
|
+
148
|
|
618
|
+
149
|
|
619
|
+
150
|
|
620
|
+
151
|
|
621
|
+
152
|
|
622
|
+
153
|
|
623
|
+
154
|
|
624
|
+
155
|
|
625
|
+
156
|
|
626
|
+
157
|
|
627
|
+
158
|
|
628
|
+
159
|
|
629
|
+
160
|
|
630
|
+
161
|
|
631
|
+
162
|
|
632
|
+
163
|
|
633
|
+
164
|
|
634
|
+
165
|
|
635
|
+
166
|
|
636
|
+
167
|
|
637
|
+
168
|
|
638
|
+
169
|
|
639
|
+
170
|
|
640
|
+
171
|
|
641
|
+
172
|
|
642
|
+
173
|
|
643
|
+
174
|
|
644
|
+
175
|
|
645
|
+
176
|
|
646
|
+
177
|
|
647
|
+
178
|
|
648
|
+
179
|
|
649
|
+
180
|
|
650
|
+
181
|
|
651
|
+
182
|
|
652
|
+
183
|
|
653
|
+
184
|
|
654
|
+
185
|
|
655
|
+
186
|
|
656
|
+
187
|
|
657
|
+
188
|
|
658
|
+
189
|
|
659
|
+
190
|
|
660
|
+
191
|
|
661
|
+
192
|
|
662
|
+
193
|
|
663
|
+
194
|
|
664
|
+
195
|
|
665
|
+
196
|
|
666
|
+
197
|
|
667
|
+
198
|
|
668
|
+
199
|
|
669
|
+
200</pre>
|
|
670
|
+
</td>
|
|
671
|
+
<td>
|
|
672
|
+
<pre class="code"><span class="info file"># File 'lib/echosign/widget.rb', line 60</span>
|
|
673
|
+
|
|
674
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
675
|
+
<span class='id identifier rubyid_require_keys'>require_keys</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:fileInfos</span><span class='comma'>,</span> <span class='symbol'>:signatureFlow</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
676
|
+
<span class='ivar'>@user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
|
|
677
|
+
<span class='ivar'>@user_email</span> <span class='op'>=</span> <span class='id identifier rubyid_user_email'>user_email</span>
|
|
678
|
+
|
|
679
|
+
<span class='comment'># {
|
|
680
|
+
</span> <span class='comment'># "widgetCreationInfo": {
|
|
681
|
+
</span> <span class='comment'># "widgetCompletionInfo": {
|
|
682
|
+
</span> <span class='comment'># "deframe": false,
|
|
683
|
+
</span> <span class='comment'># "delay": 0,
|
|
684
|
+
</span> <span class='comment'># "url": ""
|
|
685
|
+
</span> <span class='comment'># },
|
|
686
|
+
</span> <span class='comment'># "widgetAuthFailureInfo": {
|
|
687
|
+
</span> <span class='comment'># "deframe": false,
|
|
688
|
+
</span> <span class='comment'># "delay": 0,
|
|
689
|
+
</span> <span class='comment'># "url": ""
|
|
690
|
+
</span> <span class='comment'># },
|
|
691
|
+
</span> <span class='comment'># "mergeFieldInfo": [
|
|
692
|
+
</span> <span class='comment'># {
|
|
693
|
+
</span> <span class='comment'># "fieldName": "",
|
|
694
|
+
</span> <span class='comment'># "defaultValue": ""
|
|
695
|
+
</span> <span class='comment'># }
|
|
696
|
+
</span> <span class='comment'># ],
|
|
697
|
+
</span> <span class='comment'># "formFieldLayerTemplates": [
|
|
698
|
+
</span> <span class='comment'># {
|
|
699
|
+
</span> <span class='comment'># "transientDocumentId": "",
|
|
700
|
+
</span> <span class='comment'># "libraryDocumentId": "",
|
|
701
|
+
</span> <span class='comment'># "libraryDocumentName": "",
|
|
702
|
+
</span> <span class='comment'># "documentURL": {
|
|
703
|
+
</span> <span class='comment'># "name": "",
|
|
704
|
+
</span> <span class='comment'># "url": "",
|
|
705
|
+
</span> <span class='comment'># "mimeType": ""
|
|
706
|
+
</span> <span class='comment'># }
|
|
707
|
+
</span> <span class='comment'># }
|
|
708
|
+
</span> <span class='comment'># ],
|
|
709
|
+
</span> <span class='comment'># "securityOptions": {
|
|
710
|
+
</span> <span class='comment'># "passwordProtection": {
|
|
711
|
+
</span> <span class='comment'># "ALL_USERS": "enum",
|
|
712
|
+
</span> <span class='comment'># "EXTERNAL_USERS": "enum",
|
|
713
|
+
</span> <span class='comment'># "NONE": "enum",
|
|
714
|
+
</span> <span class='comment'># "INTERNAL_USERS": "enum"
|
|
715
|
+
</span> <span class='comment'># },
|
|
716
|
+
</span> <span class='comment'># "kbaProtection": {
|
|
717
|
+
</span> <span class='comment'># "ALL_USERS": "enum",
|
|
718
|
+
</span> <span class='comment'># "EXTERNAL_USERS": "enum",
|
|
719
|
+
</span> <span class='comment'># "NONE": "enum",
|
|
720
|
+
</span> <span class='comment'># "INTERNAL_USERS": "enum"
|
|
721
|
+
</span> <span class='comment'># },
|
|
722
|
+
</span> <span class='comment'># "webIdentityProtection": {
|
|
723
|
+
</span> <span class='comment'># "ALL_USERS": "enum",
|
|
724
|
+
</span> <span class='comment'># "EXTERNAL_USERS": "enum",
|
|
725
|
+
</span> <span class='comment'># "NONE": "enum",
|
|
726
|
+
</span> <span class='comment'># "INTERNAL_USERS": "enum"
|
|
727
|
+
</span> <span class='comment'># },
|
|
728
|
+
</span> <span class='comment'># "protectOpen": false,
|
|
729
|
+
</span> <span class='comment'># "internalPassword": "",
|
|
730
|
+
</span> <span class='comment'># "externalPassword": "",
|
|
731
|
+
</span> <span class='comment'># "openPassword": ""
|
|
732
|
+
</span> <span class='comment'># },
|
|
733
|
+
</span> <span class='comment'># "fileInfos": [
|
|
734
|
+
</span> <span class='comment'># {
|
|
735
|
+
</span> <span class='comment'># "transientDocumentId": "",
|
|
736
|
+
</span> <span class='comment'># "libraryDocumentId": "",
|
|
737
|
+
</span> <span class='comment'># "libraryDocumentName": "",
|
|
738
|
+
</span> <span class='comment'># "documentURL": {
|
|
739
|
+
</span> <span class='comment'># "name": "",
|
|
740
|
+
</span> <span class='comment'># "url": "",
|
|
741
|
+
</span> <span class='comment'># "mimeType": ""
|
|
742
|
+
</span> <span class='comment'># }
|
|
743
|
+
</span> <span class='comment'># }
|
|
744
|
+
</span> <span class='comment'># ],
|
|
745
|
+
</span> <span class='comment'># "counterSignerSetInfos": [
|
|
746
|
+
</span> <span class='comment'># {
|
|
747
|
+
</span> <span class='comment'># "counterSignerSetRole": {
|
|
748
|
+
</span> <span class='comment'># "SIGNER": "enum",
|
|
749
|
+
</span> <span class='comment'># "DELEGATE_TO_SIGNER": "enum",
|
|
750
|
+
</span> <span class='comment'># "DELEGATE_TO_APPROVER": "enum",
|
|
751
|
+
</span> <span class='comment'># "APPROVER": "enum"
|
|
752
|
+
</span> <span class='comment'># },
|
|
753
|
+
</span> <span class='comment'># "counterSignerSetMemberInfos": [
|
|
754
|
+
</span> <span class='comment'># {
|
|
755
|
+
</span> <span class='comment'># "securityOptions": [
|
|
756
|
+
</span> <span class='comment'># {
|
|
757
|
+
</span> <span class='comment'># "authenticationMethod": {
|
|
758
|
+
</span> <span class='comment'># "PHONE": "enum",
|
|
759
|
+
</span> <span class='comment'># "INHERITED_FROM_DOCUMENT": "enum",
|
|
760
|
+
</span> <span class='comment'># "KBA": "enum",
|
|
761
|
+
</span> <span class='comment'># "WEB_IDENTITY": "enum",
|
|
762
|
+
</span> <span class='comment'># "PASSWORD": "enum",
|
|
763
|
+
</span> <span class='comment'># "NONE": "enum"
|
|
764
|
+
</span> <span class='comment'># },
|
|
765
|
+
</span> <span class='comment'># "phoneInfos": [
|
|
766
|
+
</span> <span class='comment'># {
|
|
767
|
+
</span> <span class='comment'># "phone": "",
|
|
768
|
+
</span> <span class='comment'># "countryCode": ""
|
|
769
|
+
</span> <span class='comment'># }
|
|
770
|
+
</span> <span class='comment'># ],
|
|
771
|
+
</span> <span class='comment'># "password": ""
|
|
772
|
+
</span> <span class='comment'># }
|
|
773
|
+
</span> <span class='comment'># ],
|
|
774
|
+
</span> <span class='comment'># "email": ""
|
|
775
|
+
</span> <span class='comment'># }
|
|
776
|
+
</span> <span class='comment'># ]
|
|
777
|
+
</span> <span class='comment'># }
|
|
778
|
+
</span> <span class='comment'># ],
|
|
779
|
+
</span> <span class='comment'># "callbackInfo": "",
|
|
780
|
+
</span> <span class='comment'># "widgetSignerSecurityOptions": {
|
|
781
|
+
</span> <span class='comment'># "authenticationMethod": {
|
|
782
|
+
</span> <span class='comment'># "PHONE": "enum",
|
|
783
|
+
</span> <span class='comment'># "INHERITED_FROM_DOCUMENT": "enum",
|
|
784
|
+
</span> <span class='comment'># "KBA": "enum",
|
|
785
|
+
</span> <span class='comment'># "WEB_IDENTITY": "enum",
|
|
786
|
+
</span> <span class='comment'># "PASSWORD": "enum",
|
|
787
|
+
</span> <span class='comment'># "NONE": "enum"
|
|
788
|
+
</span> <span class='comment'># },
|
|
789
|
+
</span> <span class='comment'># "phoneInfos": [
|
|
790
|
+
</span> <span class='comment'># {
|
|
791
|
+
</span> <span class='comment'># "phone": "",
|
|
792
|
+
</span> <span class='comment'># "countryCode": ""
|
|
793
|
+
</span> <span class='comment'># }
|
|
794
|
+
</span> <span class='comment'># ],
|
|
795
|
+
</span> <span class='comment'># "password": ""
|
|
796
|
+
</span> <span class='comment'># },
|
|
797
|
+
</span> <span class='comment'># "name": "",
|
|
798
|
+
</span> <span class='comment'># "locale": "",
|
|
799
|
+
</span> <span class='comment'># "vaultingInfo": {
|
|
800
|
+
</span> <span class='comment'># "enabled": false
|
|
801
|
+
</span> <span class='comment'># },
|
|
802
|
+
</span> <span class='comment'># "signatureFlow": ""
|
|
803
|
+
</span> <span class='comment'># }
|
|
804
|
+
</span> <span class='comment'># }
|
|
805
|
+
</span>
|
|
806
|
+
<span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
807
|
+
<span class='label'>widgetCreationInfo:</span> <span class='lbrace'>{</span>
|
|
808
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
809
|
+
<span class='label'>fileInfos:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:fileInfos</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
810
|
+
<span class='label'>signatureFlow:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:signatureFlow</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
811
|
+
<span class='label'>widgetCompletion_Info:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:widget_completion_info</span><span class='rbracket'>]</span>
|
|
812
|
+
<span class='rbrace'>}</span>
|
|
813
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
814
|
+
<span class='kw'>end</span></pre>
|
|
815
|
+
</td>
|
|
816
|
+
</tr>
|
|
817
|
+
</table>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
</div>
|
|
821
|
+
|
|
822
|
+
<div id="instance_attr_details" class="attr_details">
|
|
823
|
+
<h2>Instance Attribute Details</h2>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<span id=""></span>
|
|
827
|
+
<div class="method_details first">
|
|
828
|
+
<h3 class="signature first" id="user_email-instance_method">
|
|
829
|
+
|
|
830
|
+
#<strong>user_email</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
</h3><div class="docstring">
|
|
837
|
+
<div class="discussion">
|
|
838
|
+
|
|
839
|
+
<p>Returns the value of attribute user_email</p>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
</div>
|
|
844
|
+
<div class="tags">
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</div><table class="source_code">
|
|
848
|
+
<tr>
|
|
849
|
+
<td>
|
|
850
|
+
<pre class="lines">
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
12
|
|
854
|
+
13
|
|
855
|
+
14</pre>
|
|
856
|
+
</td>
|
|
857
|
+
<td>
|
|
858
|
+
<pre class="code"><span class="info file"># File 'lib/echosign/widget.rb', line 12</span>
|
|
859
|
+
|
|
860
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_user_email'>user_email</span>
|
|
861
|
+
<span class='ivar'>@user_email</span>
|
|
862
|
+
<span class='kw'>end</span></pre>
|
|
863
|
+
</td>
|
|
864
|
+
</tr>
|
|
865
|
+
</table>
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<span id=""></span>
|
|
870
|
+
<div class="method_details ">
|
|
871
|
+
<h3 class="signature " id="user_id-instance_method">
|
|
872
|
+
|
|
873
|
+
#<strong>user_id</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
</h3><div class="docstring">
|
|
880
|
+
<div class="discussion">
|
|
881
|
+
|
|
882
|
+
<p>Returns the value of attribute user_id</p>
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
</div>
|
|
886
|
+
</div>
|
|
887
|
+
<div class="tags">
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</div><table class="source_code">
|
|
891
|
+
<tr>
|
|
892
|
+
<td>
|
|
893
|
+
<pre class="lines">
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
12
|
|
897
|
+
13
|
|
898
|
+
14</pre>
|
|
899
|
+
</td>
|
|
900
|
+
<td>
|
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/echosign/widget.rb', line 12</span>
|
|
902
|
+
|
|
903
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
|
|
904
|
+
<span class='ivar'>@user_id</span>
|
|
905
|
+
<span class='kw'>end</span></pre>
|
|
906
|
+
</td>
|
|
907
|
+
</tr>
|
|
908
|
+
</table>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
</div>
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
<div id="footer">
|
|
917
|
+
Generated on Thu Oct 18 12:44:48 2018 by
|
|
918
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
919
|
+
0.9.16 (ruby-2.6.0).
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</div>
|
|
923
|
+
</body>
|
|
924
|
+
</html>
|