filestack 2.1.0 → 2.2.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/CHANGELOG.md +3 -0
- data/README.md +2 -2
- data/VERSION +1 -1
- data/docs/AV.html +557 -0
- data/docs/Filestack.html +115 -0
- data/docs/Filestack/Ruby.html +115 -0
- data/docs/FilestackClient.html +702 -0
- data/docs/FilestackCommon.html +884 -0
- data/docs/FilestackConfig.html +197 -0
- data/docs/FilestackFilelink.html +1277 -0
- data/docs/FilestackSecurity.html +654 -0
- data/docs/IntelligentState.html +729 -0
- data/docs/IntelligentUtils.html +1639 -0
- data/docs/MultipartUploadUtils.html +1543 -0
- data/docs/Transform.html +1152 -0
- data/docs/TransformConfig.html +138 -0
- data/docs/TransformUtils.html +272 -0
- data/docs/UploadUtils.html +673 -0
- data/docs/_index.html +227 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +492 -0
- data/docs/file.README.html +210 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +210 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +643 -0
- data/docs/top-level-namespace.html +145 -0
- data/examples/file_transformations.rb +6 -0
- data/examples/intelligent_upload.rb +7 -0
- data/examples/normal_upload.rb +5 -0
- data/examples/upload_external_url.rb +7 -0
- data/examples/upload_with_security.rb +6 -0
- data/examples/video_convert.rb +10 -0
- data/filestack-ruby.gemspec +1 -0
- data/lib/filestack/config.rb +9 -5
- data/lib/filestack/mixins/filestack_common.rb +17 -1
- data/lib/filestack/models/filelink.rb +8 -1
- data/lib/filestack/models/filestack_client.rb +17 -3
- data/lib/filestack/ruby/version.rb +1 -1
- data/lib/filestack/utils/multipart_upload_utils.rb +91 -36
- data/lib/filestack/utils/utils.rb +309 -1
- metadata +52 -3
@@ -0,0 +1,197 @@
|
|
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: FilestackConfig
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.9
|
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 = "FilestackConfig";
|
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 (F)</a> »
|
40
|
+
|
41
|
+
|
42
|
+
<span class="title">FilestackConfig</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: FilestackConfig
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">FilestackConfig</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dt>Defined in:</dt>
|
97
|
+
<dd>lib/filestack/config.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
|
103
|
+
<h2>Constant Summary</h2>
|
104
|
+
<dl class="constants">
|
105
|
+
|
106
|
+
<dt id="API_URL-constant" class="">API_URL =
|
107
|
+
|
108
|
+
</dt>
|
109
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://www.filestackapi.com/api</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
110
|
+
|
111
|
+
<dt id="CDN_URL-constant" class="">CDN_URL =
|
112
|
+
|
113
|
+
</dt>
|
114
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://cdn.filestackcontent.com</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
115
|
+
|
116
|
+
<dt id="PROCESS_URL-constant" class="">PROCESS_URL =
|
117
|
+
|
118
|
+
</dt>
|
119
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://process.filestackapi.com</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
120
|
+
|
121
|
+
<dt id="MULTIPART_START_URL-constant" class="">MULTIPART_START_URL =
|
122
|
+
|
123
|
+
</dt>
|
124
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://rc-upload.filestackapi.com/multipart/start</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
125
|
+
|
126
|
+
<dt id="MULTIPART_UPLOAD_URL-constant" class="">MULTIPART_UPLOAD_URL =
|
127
|
+
|
128
|
+
</dt>
|
129
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://rc-upload.filestackapi.com/multipart/upload</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
130
|
+
|
131
|
+
<dt id="MULTIPART_COMMIT_URL-constant" class="">MULTIPART_COMMIT_URL =
|
132
|
+
|
133
|
+
</dt>
|
134
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://rc-upload.filestackapi.com/multipart/commit</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
135
|
+
|
136
|
+
<dt id="MULTIPART_COMPLETE_URL-constant" class="">MULTIPART_COMPLETE_URL =
|
137
|
+
|
138
|
+
</dt>
|
139
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://rc-upload.filestackapi.com/multipart/complete</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
140
|
+
|
141
|
+
<dt id="MULTIPART_PARAMS-constant" class="">MULTIPART_PARAMS =
|
142
|
+
|
143
|
+
</dt>
|
144
|
+
<dd><pre class="code"><span class='qwords_beg'>%w[
|
145
|
+
</span><span class='tstring_content'> store_location</span><span class='words_sep'> </span><span class='tstring_content'>store_region</span><span class='words_sep'> </span><span class='tstring_content'>store_container</span><span class='words_sep'>
|
146
|
+
</span><span class='tstring_content'> store_path</span><span class='words_sep'> </span><span class='tstring_content'>store_access</span><span class='words_sep'>
|
147
|
+
</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
148
|
+
|
149
|
+
<dt id="DEFAULT_CHUNK_SIZE-constant" class="">DEFAULT_CHUNK_SIZE =
|
150
|
+
|
151
|
+
</dt>
|
152
|
+
<dd><pre class="code"><span class='int'>8</span> <span class='op'>*</span> <span class='int'>1024</span><span class='op'>**</span><span class='int'>2</span></pre></dd>
|
153
|
+
|
154
|
+
<dt id="DEFAULT_OFFSET_SIZE-constant" class="">DEFAULT_OFFSET_SIZE =
|
155
|
+
|
156
|
+
</dt>
|
157
|
+
<dd><pre class="code"><span class='int'>1</span> <span class='op'>*</span> <span class='int'>1024</span><span class='op'>**</span><span class='int'>2</span></pre></dd>
|
158
|
+
|
159
|
+
<dt id="VERSION-constant" class="">VERSION =
|
160
|
+
|
161
|
+
</dt>
|
162
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="Filestack.html" title="Filestack (module)">Filestack</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Filestack/Ruby.html" title="Filestack::Ruby (module)">Ruby</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Filestack/Ruby.html#VERSION-constant" title="Filestack::Ruby::VERSION (constant)">VERSION</a></span></span></pre></dd>
|
163
|
+
|
164
|
+
<dt id="HEADERS-constant" class="">HEADERS =
|
165
|
+
|
166
|
+
</dt>
|
167
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
168
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filestack-ruby </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="FilestackConfig::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
169
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Filestack-Source</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Ruby-</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="FilestackConfig::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
170
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
171
|
+
|
172
|
+
<dt id="INTELLIGENT_ERROR_MESSAGES-constant" class="">INTELLIGENT_ERROR_MESSAGES =
|
173
|
+
|
174
|
+
</dt>
|
175
|
+
<dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BACKEND_SERVER</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BACKEND_NETWORK</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>S3_SERVER</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>S3_NETWORK</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span></pre></dd>
|
176
|
+
|
177
|
+
</dl>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
</div>
|
188
|
+
|
189
|
+
<div id="footer">
|
190
|
+
Generated on Thu Aug 17 10:04:38 2017 by
|
191
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
192
|
+
0.9.9 (ruby-2.4.0).
|
193
|
+
</div>
|
194
|
+
|
195
|
+
</div>
|
196
|
+
</body>
|
197
|
+
</html>
|
@@ -0,0 +1,1277 @@
|
|
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: FilestackFilelink
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.9
|
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 = "FilestackFilelink";
|
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 (F)</a> »
|
40
|
+
|
41
|
+
|
42
|
+
<span class="title">FilestackFilelink</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: FilestackFilelink
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">FilestackFilelink</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
<dl>
|
91
|
+
<dt>Includes:</dt>
|
92
|
+
<dd><span class='object_link'><a href="FilestackCommon.html" title="FilestackCommon (module)">FilestackCommon</a></span>, <span class='object_link'><a href="UploadUtils.html" title="UploadUtils (module)">UploadUtils</a></span></dd>
|
93
|
+
</dl>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
<dl>
|
101
|
+
<dt>Defined in:</dt>
|
102
|
+
<dd>lib/filestack/models/filelink.rb</dd>
|
103
|
+
</dl>
|
104
|
+
|
105
|
+
</div>
|
106
|
+
|
107
|
+
<h2>Overview</h2><div class="docstring">
|
108
|
+
<div class="discussion">
|
109
|
+
|
110
|
+
<p>This class represents a file stored on your Filestack storage. Once
|
111
|
+
initialized, you may perform transformations, conversions, get metadata,
|
112
|
+
update, or delete it.</p>
|
113
|
+
|
114
|
+
|
115
|
+
</div>
|
116
|
+
</div>
|
117
|
+
<div class="tags">
|
118
|
+
|
119
|
+
|
120
|
+
</div>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
125
|
+
<ul class="summary">
|
126
|
+
|
127
|
+
<li class="public ">
|
128
|
+
<span class="summary_signature">
|
129
|
+
|
130
|
+
<a href="#apikey-instance_method" title="#apikey (instance method)">#<strong>apikey</strong> ⇒ Object </a>
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
</span>
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
<span class="note title readonly">readonly</span>
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
150
|
+
<p>Returns the value of attribute apikey.</p>
|
151
|
+
</div></span>
|
152
|
+
|
153
|
+
</li>
|
154
|
+
|
155
|
+
|
156
|
+
<li class="public ">
|
157
|
+
<span class="summary_signature">
|
158
|
+
|
159
|
+
<a href="#handle-instance_method" title="#handle (instance method)">#<strong>handle</strong> ⇒ Object </a>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
</span>
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
<span class="note title readonly">readonly</span>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
<span class="summary_desc"><div class='inline'>
|
179
|
+
<p>Returns the value of attribute handle.</p>
|
180
|
+
</div></span>
|
181
|
+
|
182
|
+
</li>
|
183
|
+
|
184
|
+
|
185
|
+
<li class="public ">
|
186
|
+
<span class="summary_signature">
|
187
|
+
|
188
|
+
<a href="#security-instance_method" title="#security (instance method)">#<strong>security</strong> ⇒ Object </a>
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
</span>
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
<span class="note title readonly">readonly</span>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
<span class="summary_desc"><div class='inline'>
|
208
|
+
<p>Returns the value of attribute security.</p>
|
209
|
+
</div></span>
|
210
|
+
|
211
|
+
</li>
|
212
|
+
|
213
|
+
|
214
|
+
</ul>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
<h2>
|
221
|
+
Instance Method Summary
|
222
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
223
|
+
</h2>
|
224
|
+
|
225
|
+
<ul class="summary">
|
226
|
+
|
227
|
+
<li class="public ">
|
228
|
+
<span class="summary_signature">
|
229
|
+
|
230
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> ⇒ Unirest::Response </a>
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
</span>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
<span class="summary_desc"><div class='inline'>
|
245
|
+
<p>Delete filelink.</p>
|
246
|
+
</div></span>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
|
251
|
+
<li class="public ">
|
252
|
+
<span class="summary_signature">
|
253
|
+
|
254
|
+
<a href="#download-instance_method" title="#download (instance method)">#<strong>download</strong>(filepath) ⇒ Unirest::Response </a>
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
</span>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
<span class="summary_desc"><div class='inline'>
|
269
|
+
<p>Download FilestackFilelink.</p>
|
270
|
+
</div></span>
|
271
|
+
|
272
|
+
</li>
|
273
|
+
|
274
|
+
|
275
|
+
<li class="public ">
|
276
|
+
<span class="summary_signature">
|
277
|
+
|
278
|
+
<a href="#get_content-instance_method" title="#get_content (instance method)">#<strong>get_content</strong> ⇒ Bytes </a>
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
</span>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
<span class="summary_desc"><div class='inline'>
|
293
|
+
<p>Get content of filelink.</p>
|
294
|
+
</div></span>
|
295
|
+
|
296
|
+
</li>
|
297
|
+
|
298
|
+
|
299
|
+
<li class="public ">
|
300
|
+
<span class="summary_signature">
|
301
|
+
|
302
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(handle, apikey: nil, security: nil) ⇒ FilestackFilelink </a>
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
</span>
|
307
|
+
|
308
|
+
|
309
|
+
<span class="note title constructor">constructor</span>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
<span class="summary_desc"><div class='inline'>
|
319
|
+
<p>Initialize FilestackFilelink.</p>
|
320
|
+
</div></span>
|
321
|
+
|
322
|
+
</li>
|
323
|
+
|
324
|
+
|
325
|
+
<li class="public ">
|
326
|
+
<span class="summary_signature">
|
327
|
+
|
328
|
+
<a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong>(params = {}) ⇒ Unirest::Response </a>
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
</span>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
<span class="summary_desc"><div class='inline'>
|
343
|
+
<p>Return metadata for file handle.</p>
|
344
|
+
</div></span>
|
345
|
+
|
346
|
+
</li>
|
347
|
+
|
348
|
+
|
349
|
+
<li class="public ">
|
350
|
+
<span class="summary_signature">
|
351
|
+
|
352
|
+
<a href="#overwrite-instance_method" title="#overwrite (instance method)">#<strong>overwrite</strong>(filepath) ⇒ Unirest::Response </a>
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
</span>
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
<span class="summary_desc"><div class='inline'>
|
367
|
+
<p>Ovewrite filelink by uploading local file.</p>
|
368
|
+
</div></span>
|
369
|
+
|
370
|
+
</li>
|
371
|
+
|
372
|
+
|
373
|
+
<li class="public ">
|
374
|
+
<span class="summary_signature">
|
375
|
+
|
376
|
+
<a href="#sfw-instance_method" title="#sfw (instance method)">#<strong>sfw</strong> ⇒ Bool </a>
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
</span>
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
<span class="summary_desc"><div class='inline'>
|
391
|
+
<p>Return true (SFW) or false (NSFW).</p>
|
392
|
+
</div></span>
|
393
|
+
|
394
|
+
</li>
|
395
|
+
|
396
|
+
|
397
|
+
<li class="public ">
|
398
|
+
<span class="summary_signature">
|
399
|
+
|
400
|
+
<a href="#tags-instance_method" title="#tags (instance method)">#<strong>tags</strong> ⇒ Hash </a>
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
</span>
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
<span class="summary_desc"><div class='inline'>
|
415
|
+
<p>Return auto and user tags for the filelink.</p>
|
416
|
+
</div></span>
|
417
|
+
|
418
|
+
</li>
|
419
|
+
|
420
|
+
|
421
|
+
<li class="public ">
|
422
|
+
<span class="summary_signature">
|
423
|
+
|
424
|
+
<a href="#transform-instance_method" title="#transform (instance method)">#<strong>transform</strong> ⇒ Filestack::Transform </a>
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
</span>
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
<span class="summary_desc"><div class='inline'>
|
439
|
+
<p>Turn the filelink into a transform object to perform transform operations.</p>
|
440
|
+
</div></span>
|
441
|
+
|
442
|
+
</li>
|
443
|
+
|
444
|
+
|
445
|
+
<li class="public ">
|
446
|
+
<span class="summary_signature">
|
447
|
+
|
448
|
+
<a href="#url-instance_method" title="#url (instance method)">#<strong>url</strong> ⇒ String </a>
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
</span>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
<span class="summary_desc"><div class='inline'>
|
463
|
+
<p>Get the URL of the FilestackFilelink.</p>
|
464
|
+
</div></span>
|
465
|
+
|
466
|
+
</li>
|
467
|
+
|
468
|
+
|
469
|
+
</ul>
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="UploadUtils.html" title="UploadUtils (module)">UploadUtils</a></span></h3>
|
482
|
+
<p class="inherited"><span class='object_link'><a href="UploadUtils.html#get_url-instance_method" title="UploadUtils#get_url (method)">#get_url</a></span>, <span class='object_link'><a href="UploadUtils.html#make_call-instance_method" title="UploadUtils#make_call (method)">#make_call</a></span>, <span class='object_link'><a href="UploadUtils.html#send_upload-instance_method" title="UploadUtils#send_upload (method)">#send_upload</a></span></p>
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="FilestackCommon.html" title="FilestackCommon (module)">FilestackCommon</a></span></h3>
|
493
|
+
<p class="inherited"><span class='object_link'><a href="FilestackCommon.html#send_delete-instance_method" title="FilestackCommon#send_delete (method)">#send_delete</a></span>, <span class='object_link'><a href="FilestackCommon.html#send_download-instance_method" title="FilestackCommon#send_download (method)">#send_download</a></span>, <span class='object_link'><a href="FilestackCommon.html#send_get_content-instance_method" title="FilestackCommon#send_get_content (method)">#send_get_content</a></span>, <span class='object_link'><a href="FilestackCommon.html#send_metadata-instance_method" title="FilestackCommon#send_metadata (method)">#send_metadata</a></span>, <span class='object_link'><a href="FilestackCommon.html#send_overwrite-instance_method" title="FilestackCommon#send_overwrite (method)">#send_overwrite</a></span>, <span class='object_link'><a href="FilestackCommon.html#send_tags-instance_method" title="FilestackCommon#send_tags (method)">#send_tags</a></span></p>
|
494
|
+
<div id="constructor_details" class="method_details_list">
|
495
|
+
<h2>Constructor Details</h2>
|
496
|
+
|
497
|
+
<div class="method_details first">
|
498
|
+
<h3 class="signature first" id="initialize-instance_method">
|
499
|
+
|
500
|
+
#<strong>initialize</strong>(handle, apikey: nil, security: nil) ⇒ <tt><span class='object_link'><a href="" title="FilestackFilelink (class)">FilestackFilelink</a></span></tt>
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
</h3><div class="docstring">
|
507
|
+
<div class="discussion">
|
508
|
+
|
509
|
+
<p>Initialize FilestackFilelink</p>
|
510
|
+
|
511
|
+
|
512
|
+
</div>
|
513
|
+
</div>
|
514
|
+
<div class="tags">
|
515
|
+
<p class="tag_title">Parameters:</p>
|
516
|
+
<ul class="param">
|
517
|
+
|
518
|
+
<li>
|
519
|
+
|
520
|
+
<span class='name'>file_handle</span>
|
521
|
+
|
522
|
+
|
523
|
+
<span class='type'>(<tt>String</tt>)</span>
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
—
|
528
|
+
<div class='inline'>
|
529
|
+
<p>The FilestackFilelink handle</p>
|
530
|
+
</div>
|
531
|
+
|
532
|
+
</li>
|
533
|
+
|
534
|
+
<li>
|
535
|
+
|
536
|
+
<span class='name'>apikey</span>
|
537
|
+
|
538
|
+
|
539
|
+
<span class='type'>(<tt>String</tt>)</span>
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
—
|
544
|
+
<div class='inline'>
|
545
|
+
<p>Your Filestack API Key (optional)</p>
|
546
|
+
</div>
|
547
|
+
|
548
|
+
</li>
|
549
|
+
|
550
|
+
<li>
|
551
|
+
|
552
|
+
<span class='name'>security</span>
|
553
|
+
|
554
|
+
|
555
|
+
<span class='type'>(<tt><span class='object_link'><a href="FilestackSecurity.html" title="FilestackSecurity (class)">FilestackSecurity</a></span></tt>)</span>
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
—
|
560
|
+
<div class='inline'>
|
561
|
+
<p>Filestack security object, if security is enabled.</p>
|
562
|
+
</div>
|
563
|
+
|
564
|
+
</li>
|
565
|
+
|
566
|
+
</ul>
|
567
|
+
|
568
|
+
|
569
|
+
</div><table class="source_code">
|
570
|
+
<tr>
|
571
|
+
<td>
|
572
|
+
<pre class="lines">
|
573
|
+
|
574
|
+
|
575
|
+
21
|
576
|
+
22
|
577
|
+
23
|
578
|
+
24
|
579
|
+
25</pre>
|
580
|
+
</td>
|
581
|
+
<td>
|
582
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 21</span>
|
583
|
+
|
584
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='comma'>,</span> <span class='label'>apikey:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>security:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
585
|
+
<span class='ivar'>@handle</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span>
|
586
|
+
<span class='ivar'>@apikey</span> <span class='op'>=</span> <span class='id identifier rubyid_apikey'>apikey</span>
|
587
|
+
<span class='ivar'>@security</span> <span class='op'>=</span> <span class='id identifier rubyid_security'>security</span>
|
588
|
+
<span class='kw'>end</span></pre>
|
589
|
+
</td>
|
590
|
+
</tr>
|
591
|
+
</table>
|
592
|
+
</div>
|
593
|
+
|
594
|
+
</div>
|
595
|
+
|
596
|
+
<div id="instance_attr_details" class="attr_details">
|
597
|
+
<h2>Instance Attribute Details</h2>
|
598
|
+
|
599
|
+
|
600
|
+
<span id=""></span>
|
601
|
+
<div class="method_details first">
|
602
|
+
<h3 class="signature first" id="apikey-instance_method">
|
603
|
+
|
604
|
+
#<strong>apikey</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
605
|
+
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
</h3><div class="docstring">
|
611
|
+
<div class="discussion">
|
612
|
+
|
613
|
+
<p>Returns the value of attribute apikey</p>
|
614
|
+
|
615
|
+
|
616
|
+
</div>
|
617
|
+
</div>
|
618
|
+
<div class="tags">
|
619
|
+
|
620
|
+
|
621
|
+
</div><table class="source_code">
|
622
|
+
<tr>
|
623
|
+
<td>
|
624
|
+
<pre class="lines">
|
625
|
+
|
626
|
+
|
627
|
+
13
|
628
|
+
14
|
629
|
+
15</pre>
|
630
|
+
</td>
|
631
|
+
<td>
|
632
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 13</span>
|
633
|
+
|
634
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_apikey'>apikey</span>
|
635
|
+
<span class='ivar'>@apikey</span>
|
636
|
+
<span class='kw'>end</span></pre>
|
637
|
+
</td>
|
638
|
+
</tr>
|
639
|
+
</table>
|
640
|
+
</div>
|
641
|
+
|
642
|
+
|
643
|
+
<span id=""></span>
|
644
|
+
<div class="method_details ">
|
645
|
+
<h3 class="signature " id="handle-instance_method">
|
646
|
+
|
647
|
+
#<strong>handle</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
</h3><div class="docstring">
|
654
|
+
<div class="discussion">
|
655
|
+
|
656
|
+
<p>Returns the value of attribute handle</p>
|
657
|
+
|
658
|
+
|
659
|
+
</div>
|
660
|
+
</div>
|
661
|
+
<div class="tags">
|
662
|
+
|
663
|
+
|
664
|
+
</div><table class="source_code">
|
665
|
+
<tr>
|
666
|
+
<td>
|
667
|
+
<pre class="lines">
|
668
|
+
|
669
|
+
|
670
|
+
13
|
671
|
+
14
|
672
|
+
15</pre>
|
673
|
+
</td>
|
674
|
+
<td>
|
675
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 13</span>
|
676
|
+
|
677
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_handle'>handle</span>
|
678
|
+
<span class='ivar'>@handle</span>
|
679
|
+
<span class='kw'>end</span></pre>
|
680
|
+
</td>
|
681
|
+
</tr>
|
682
|
+
</table>
|
683
|
+
</div>
|
684
|
+
|
685
|
+
|
686
|
+
<span id=""></span>
|
687
|
+
<div class="method_details ">
|
688
|
+
<h3 class="signature " id="security-instance_method">
|
689
|
+
|
690
|
+
#<strong>security</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
</h3><div class="docstring">
|
697
|
+
<div class="discussion">
|
698
|
+
|
699
|
+
<p>Returns the value of attribute security</p>
|
700
|
+
|
701
|
+
|
702
|
+
</div>
|
703
|
+
</div>
|
704
|
+
<div class="tags">
|
705
|
+
|
706
|
+
|
707
|
+
</div><table class="source_code">
|
708
|
+
<tr>
|
709
|
+
<td>
|
710
|
+
<pre class="lines">
|
711
|
+
|
712
|
+
|
713
|
+
13
|
714
|
+
14
|
715
|
+
15</pre>
|
716
|
+
</td>
|
717
|
+
<td>
|
718
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 13</span>
|
719
|
+
|
720
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_security'>security</span>
|
721
|
+
<span class='ivar'>@security</span>
|
722
|
+
<span class='kw'>end</span></pre>
|
723
|
+
</td>
|
724
|
+
</tr>
|
725
|
+
</table>
|
726
|
+
</div>
|
727
|
+
|
728
|
+
</div>
|
729
|
+
|
730
|
+
|
731
|
+
<div id="instance_method_details" class="method_details_list">
|
732
|
+
<h2>Instance Method Details</h2>
|
733
|
+
|
734
|
+
|
735
|
+
<div class="method_details first">
|
736
|
+
<h3 class="signature first" id="delete-instance_method">
|
737
|
+
|
738
|
+
#<strong>delete</strong> ⇒ <tt>Unirest::Response</tt>
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
</h3><div class="docstring">
|
745
|
+
<div class="discussion">
|
746
|
+
|
747
|
+
<p>Delete filelink</p>
|
748
|
+
|
749
|
+
|
750
|
+
</div>
|
751
|
+
</div>
|
752
|
+
<div class="tags">
|
753
|
+
|
754
|
+
<p class="tag_title">Returns:</p>
|
755
|
+
<ul class="return">
|
756
|
+
|
757
|
+
<li>
|
758
|
+
|
759
|
+
|
760
|
+
<span class='type'>(<tt>Unirest::Response</tt>)</span>
|
761
|
+
|
762
|
+
|
763
|
+
|
764
|
+
</li>
|
765
|
+
|
766
|
+
</ul>
|
767
|
+
|
768
|
+
</div><table class="source_code">
|
769
|
+
<tr>
|
770
|
+
<td>
|
771
|
+
<pre class="lines">
|
772
|
+
|
773
|
+
|
774
|
+
46
|
775
|
+
47
|
776
|
+
48</pre>
|
777
|
+
</td>
|
778
|
+
<td>
|
779
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 46</span>
|
780
|
+
|
781
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
|
782
|
+
<span class='id identifier rubyid_send_delete'>send_delete</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='comma'>,</span> <span class='id identifier rubyid_apikey'>apikey</span><span class='comma'>,</span> <span class='id identifier rubyid_security'>security</span><span class='rparen'>)</span>
|
783
|
+
<span class='kw'>end</span></pre>
|
784
|
+
</td>
|
785
|
+
</tr>
|
786
|
+
</table>
|
787
|
+
</div>
|
788
|
+
|
789
|
+
<div class="method_details ">
|
790
|
+
<h3 class="signature " id="download-instance_method">
|
791
|
+
|
792
|
+
#<strong>download</strong>(filepath) ⇒ <tt>Unirest::Response</tt>
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
|
797
|
+
|
798
|
+
</h3><div class="docstring">
|
799
|
+
<div class="discussion">
|
800
|
+
|
801
|
+
<p>Download FilestackFilelink</p>
|
802
|
+
|
803
|
+
|
804
|
+
</div>
|
805
|
+
</div>
|
806
|
+
<div class="tags">
|
807
|
+
<p class="tag_title">Parameters:</p>
|
808
|
+
<ul class="param">
|
809
|
+
|
810
|
+
<li>
|
811
|
+
|
812
|
+
<span class='name'>filepath</span>
|
813
|
+
|
814
|
+
|
815
|
+
<span class='type'>(<tt>String</tt>)</span>
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
—
|
820
|
+
<div class='inline'>
|
821
|
+
<p>The local destination of the downloaded filelink</p>
|
822
|
+
</div>
|
823
|
+
|
824
|
+
</li>
|
825
|
+
|
826
|
+
</ul>
|
827
|
+
|
828
|
+
<p class="tag_title">Returns:</p>
|
829
|
+
<ul class="return">
|
830
|
+
|
831
|
+
<li>
|
832
|
+
|
833
|
+
|
834
|
+
<span class='type'>(<tt>Unirest::Response</tt>)</span>
|
835
|
+
|
836
|
+
|
837
|
+
|
838
|
+
</li>
|
839
|
+
|
840
|
+
</ul>
|
841
|
+
|
842
|
+
</div><table class="source_code">
|
843
|
+
<tr>
|
844
|
+
<td>
|
845
|
+
<pre class="lines">
|
846
|
+
|
847
|
+
|
848
|
+
39
|
849
|
+
40
|
850
|
+
41</pre>
|
851
|
+
</td>
|
852
|
+
<td>
|
853
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 39</span>
|
854
|
+
|
855
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_download'>download</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
|
856
|
+
<span class='id identifier rubyid_send_download'>send_download</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
|
857
|
+
<span class='kw'>end</span></pre>
|
858
|
+
</td>
|
859
|
+
</tr>
|
860
|
+
</table>
|
861
|
+
</div>
|
862
|
+
|
863
|
+
<div class="method_details ">
|
864
|
+
<h3 class="signature " id="get_content-instance_method">
|
865
|
+
|
866
|
+
#<strong>get_content</strong> ⇒ <tt>Bytes</tt>
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
</h3><div class="docstring">
|
873
|
+
<div class="discussion">
|
874
|
+
|
875
|
+
<p>Get content of filelink</p>
|
876
|
+
|
877
|
+
|
878
|
+
</div>
|
879
|
+
</div>
|
880
|
+
<div class="tags">
|
881
|
+
|
882
|
+
<p class="tag_title">Returns:</p>
|
883
|
+
<ul class="return">
|
884
|
+
|
885
|
+
<li>
|
886
|
+
|
887
|
+
|
888
|
+
<span class='type'>(<tt>Bytes</tt>)</span>
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
</li>
|
893
|
+
|
894
|
+
</ul>
|
895
|
+
|
896
|
+
</div><table class="source_code">
|
897
|
+
<tr>
|
898
|
+
<td>
|
899
|
+
<pre class="lines">
|
900
|
+
|
901
|
+
|
902
|
+
30
|
903
|
+
31
|
904
|
+
32</pre>
|
905
|
+
</td>
|
906
|
+
<td>
|
907
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 30</span>
|
908
|
+
|
909
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_content'>get_content</span>
|
910
|
+
<span class='id identifier rubyid_send_get_content'>send_get_content</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
911
|
+
<span class='kw'>end</span></pre>
|
912
|
+
</td>
|
913
|
+
</tr>
|
914
|
+
</table>
|
915
|
+
</div>
|
916
|
+
|
917
|
+
<div class="method_details ">
|
918
|
+
<h3 class="signature " id="metadata-instance_method">
|
919
|
+
|
920
|
+
#<strong>metadata</strong>(params = {}) ⇒ <tt>Unirest::Response</tt>
|
921
|
+
|
922
|
+
|
923
|
+
|
924
|
+
|
925
|
+
|
926
|
+
</h3><div class="docstring">
|
927
|
+
<div class="discussion">
|
928
|
+
|
929
|
+
<p>Return metadata for file handle</p>
|
930
|
+
|
931
|
+
|
932
|
+
</div>
|
933
|
+
</div>
|
934
|
+
<div class="tags">
|
935
|
+
|
936
|
+
<p class="tag_title">Returns:</p>
|
937
|
+
<ul class="return">
|
938
|
+
|
939
|
+
<li>
|
940
|
+
|
941
|
+
|
942
|
+
<span class='type'>(<tt>Unirest::Response</tt>)</span>
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
</li>
|
947
|
+
|
948
|
+
</ul>
|
949
|
+
|
950
|
+
</div><table class="source_code">
|
951
|
+
<tr>
|
952
|
+
<td>
|
953
|
+
<pre class="lines">
|
954
|
+
|
955
|
+
|
956
|
+
77
|
957
|
+
78
|
958
|
+
79</pre>
|
959
|
+
</td>
|
960
|
+
<td>
|
961
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 77</span>
|
962
|
+
|
963
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
964
|
+
<span class='id identifier rubyid_send_metadata'>send_metadata</span><span class='lparen'>(</span><span class='ivar'>@handle</span><span class='comma'>,</span> <span class='ivar'>@security</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
965
|
+
<span class='kw'>end</span></pre>
|
966
|
+
</td>
|
967
|
+
</tr>
|
968
|
+
</table>
|
969
|
+
</div>
|
970
|
+
|
971
|
+
<div class="method_details ">
|
972
|
+
<h3 class="signature " id="overwrite-instance_method">
|
973
|
+
|
974
|
+
#<strong>overwrite</strong>(filepath) ⇒ <tt>Unirest::Response</tt>
|
975
|
+
|
976
|
+
|
977
|
+
|
978
|
+
|
979
|
+
|
980
|
+
</h3><div class="docstring">
|
981
|
+
<div class="discussion">
|
982
|
+
|
983
|
+
<p>Ovewrite filelink by uploading local file</p>
|
984
|
+
|
985
|
+
|
986
|
+
</div>
|
987
|
+
</div>
|
988
|
+
<div class="tags">
|
989
|
+
<p class="tag_title">Parameters:</p>
|
990
|
+
<ul class="param">
|
991
|
+
|
992
|
+
<li>
|
993
|
+
|
994
|
+
<span class='name'>filepath</span>
|
995
|
+
|
996
|
+
|
997
|
+
<span class='type'>(<tt>String</tt>)</span>
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
—
|
1002
|
+
<div class='inline'>
|
1003
|
+
<p>filepath of file to upload</p>
|
1004
|
+
</div>
|
1005
|
+
|
1006
|
+
</li>
|
1007
|
+
|
1008
|
+
</ul>
|
1009
|
+
|
1010
|
+
<p class="tag_title">Returns:</p>
|
1011
|
+
<ul class="return">
|
1012
|
+
|
1013
|
+
<li>
|
1014
|
+
|
1015
|
+
|
1016
|
+
<span class='type'>(<tt>Unirest::Response</tt>)</span>
|
1017
|
+
|
1018
|
+
|
1019
|
+
|
1020
|
+
</li>
|
1021
|
+
|
1022
|
+
</ul>
|
1023
|
+
|
1024
|
+
</div><table class="source_code">
|
1025
|
+
<tr>
|
1026
|
+
<td>
|
1027
|
+
<pre class="lines">
|
1028
|
+
|
1029
|
+
|
1030
|
+
55
|
1031
|
+
56
|
1032
|
+
57</pre>
|
1033
|
+
</td>
|
1034
|
+
<td>
|
1035
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 55</span>
|
1036
|
+
|
1037
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
|
1038
|
+
<span class='id identifier rubyid_send_overwrite'>send_overwrite</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='comma'>,</span> <span class='id identifier rubyid_handle'>handle</span><span class='comma'>,</span> <span class='id identifier rubyid_apikey'>apikey</span><span class='comma'>,</span> <span class='id identifier rubyid_security'>security</span><span class='rparen'>)</span>
|
1039
|
+
<span class='kw'>end</span></pre>
|
1040
|
+
</td>
|
1041
|
+
</tr>
|
1042
|
+
</table>
|
1043
|
+
</div>
|
1044
|
+
|
1045
|
+
<div class="method_details ">
|
1046
|
+
<h3 class="signature " id="sfw-instance_method">
|
1047
|
+
|
1048
|
+
#<strong>sfw</strong> ⇒ <tt>Bool</tt>
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
|
1053
|
+
|
1054
|
+
</h3><div class="docstring">
|
1055
|
+
<div class="discussion">
|
1056
|
+
|
1057
|
+
<p>Return true (SFW) or false (NSFW)</p>
|
1058
|
+
|
1059
|
+
|
1060
|
+
</div>
|
1061
|
+
</div>
|
1062
|
+
<div class="tags">
|
1063
|
+
|
1064
|
+
<p class="tag_title">Returns:</p>
|
1065
|
+
<ul class="return">
|
1066
|
+
|
1067
|
+
<li>
|
1068
|
+
|
1069
|
+
|
1070
|
+
<span class='type'>(<tt>Bool</tt>)</span>
|
1071
|
+
|
1072
|
+
|
1073
|
+
|
1074
|
+
</li>
|
1075
|
+
|
1076
|
+
</ul>
|
1077
|
+
|
1078
|
+
</div><table class="source_code">
|
1079
|
+
<tr>
|
1080
|
+
<td>
|
1081
|
+
<pre class="lines">
|
1082
|
+
|
1083
|
+
|
1084
|
+
84
|
1085
|
+
85
|
1086
|
+
86</pre>
|
1087
|
+
</td>
|
1088
|
+
<td>
|
1089
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 84</span>
|
1090
|
+
|
1091
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sfw'>sfw</span>
|
1092
|
+
<span class='id identifier rubyid_send_tags'>send_tags</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sfw</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@handle</span><span class='comma'>,</span> <span class='ivar'>@security</span><span class='rparen'>)</span>
|
1093
|
+
<span class='kw'>end</span></pre>
|
1094
|
+
</td>
|
1095
|
+
</tr>
|
1096
|
+
</table>
|
1097
|
+
</div>
|
1098
|
+
|
1099
|
+
<div class="method_details ">
|
1100
|
+
<h3 class="signature " id="tags-instance_method">
|
1101
|
+
|
1102
|
+
#<strong>tags</strong> ⇒ <tt>Hash</tt>
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
|
1107
|
+
|
1108
|
+
</h3><div class="docstring">
|
1109
|
+
<div class="discussion">
|
1110
|
+
|
1111
|
+
<p>Return auto and user tags for the filelink</p>
|
1112
|
+
|
1113
|
+
|
1114
|
+
</div>
|
1115
|
+
</div>
|
1116
|
+
<div class="tags">
|
1117
|
+
|
1118
|
+
<p class="tag_title">Returns:</p>
|
1119
|
+
<ul class="return">
|
1120
|
+
|
1121
|
+
<li>
|
1122
|
+
|
1123
|
+
|
1124
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1125
|
+
|
1126
|
+
|
1127
|
+
|
1128
|
+
</li>
|
1129
|
+
|
1130
|
+
</ul>
|
1131
|
+
|
1132
|
+
</div><table class="source_code">
|
1133
|
+
<tr>
|
1134
|
+
<td>
|
1135
|
+
<pre class="lines">
|
1136
|
+
|
1137
|
+
|
1138
|
+
70
|
1139
|
+
71
|
1140
|
+
72</pre>
|
1141
|
+
</td>
|
1142
|
+
<td>
|
1143
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 70</span>
|
1144
|
+
|
1145
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tags'>tags</span>
|
1146
|
+
<span class='id identifier rubyid_send_tags'>send_tags</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tags</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@handle</span><span class='comma'>,</span> <span class='ivar'>@security</span><span class='rparen'>)</span>
|
1147
|
+
<span class='kw'>end</span></pre>
|
1148
|
+
</td>
|
1149
|
+
</tr>
|
1150
|
+
</table>
|
1151
|
+
</div>
|
1152
|
+
|
1153
|
+
<div class="method_details ">
|
1154
|
+
<h3 class="signature " id="transform-instance_method">
|
1155
|
+
|
1156
|
+
#<strong>transform</strong> ⇒ <tt>Filestack::Transform</tt>
|
1157
|
+
|
1158
|
+
|
1159
|
+
|
1160
|
+
|
1161
|
+
|
1162
|
+
</h3><div class="docstring">
|
1163
|
+
<div class="discussion">
|
1164
|
+
|
1165
|
+
<p>Turn the filelink into a transform object to perform transform operations</p>
|
1166
|
+
|
1167
|
+
|
1168
|
+
</div>
|
1169
|
+
</div>
|
1170
|
+
<div class="tags">
|
1171
|
+
|
1172
|
+
<p class="tag_title">Returns:</p>
|
1173
|
+
<ul class="return">
|
1174
|
+
|
1175
|
+
<li>
|
1176
|
+
|
1177
|
+
|
1178
|
+
<span class='type'>(<tt>Filestack::Transform</tt>)</span>
|
1179
|
+
|
1180
|
+
|
1181
|
+
|
1182
|
+
</li>
|
1183
|
+
|
1184
|
+
</ul>
|
1185
|
+
|
1186
|
+
</div><table class="source_code">
|
1187
|
+
<tr>
|
1188
|
+
<td>
|
1189
|
+
<pre class="lines">
|
1190
|
+
|
1191
|
+
|
1192
|
+
63
|
1193
|
+
64
|
1194
|
+
65</pre>
|
1195
|
+
</td>
|
1196
|
+
<td>
|
1197
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 63</span>
|
1198
|
+
|
1199
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_transform'>transform</span>
|
1200
|
+
<span class='const'><span class='object_link'><a href="Transform.html" title="Transform (class)">Transform</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Transform.html#initialize-instance_method" title="Transform#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>handle:</span> <span class='ivar'>@handle</span><span class='comma'>,</span> <span class='label'>apikey:</span> <span class='ivar'>@apikey</span><span class='comma'>,</span> <span class='label'>security:</span> <span class='ivar'>@security</span><span class='rparen'>)</span>
|
1201
|
+
<span class='kw'>end</span></pre>
|
1202
|
+
</td>
|
1203
|
+
</tr>
|
1204
|
+
</table>
|
1205
|
+
</div>
|
1206
|
+
|
1207
|
+
<div class="method_details ">
|
1208
|
+
<h3 class="signature " id="url-instance_method">
|
1209
|
+
|
1210
|
+
#<strong>url</strong> ⇒ <tt>String</tt>
|
1211
|
+
|
1212
|
+
|
1213
|
+
|
1214
|
+
|
1215
|
+
|
1216
|
+
</h3><div class="docstring">
|
1217
|
+
<div class="discussion">
|
1218
|
+
|
1219
|
+
<p>Get the URL of the FilestackFilelink</p>
|
1220
|
+
|
1221
|
+
|
1222
|
+
</div>
|
1223
|
+
</div>
|
1224
|
+
<div class="tags">
|
1225
|
+
|
1226
|
+
<p class="tag_title">Returns:</p>
|
1227
|
+
<ul class="return">
|
1228
|
+
|
1229
|
+
<li>
|
1230
|
+
|
1231
|
+
|
1232
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1233
|
+
|
1234
|
+
|
1235
|
+
|
1236
|
+
</li>
|
1237
|
+
|
1238
|
+
</ul>
|
1239
|
+
|
1240
|
+
</div><table class="source_code">
|
1241
|
+
<tr>
|
1242
|
+
<td>
|
1243
|
+
<pre class="lines">
|
1244
|
+
|
1245
|
+
|
1246
|
+
91
|
1247
|
+
92
|
1248
|
+
93
|
1249
|
+
94
|
1250
|
+
95</pre>
|
1251
|
+
</td>
|
1252
|
+
<td>
|
1253
|
+
<pre class="code"><span class="info file"># File 'lib/filestack/models/filelink.rb', line 91</span>
|
1254
|
+
|
1255
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
1256
|
+
<span class='const'><span class='object_link'><a href="UploadUtils.html" title="UploadUtils (module)">UploadUtils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get_url'><span class='object_link'><a href="UploadUtils.html#get_url-instance_method" title="UploadUtils#get_url (method)">get_url</a></span></span><span class='lparen'>(</span>
|
1257
|
+
<span class='const'><span class='object_link'><a href="FilestackConfig.html" title="FilestackConfig (class)">FilestackConfig</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FilestackConfig.html#CDN_URL-constant" title="FilestackConfig::CDN_URL (constant)">CDN_URL</a></span></span><span class='comma'>,</span> <span class='label'>handle:</span> <span class='id identifier rubyid_handle'>handle</span><span class='comma'>,</span> <span class='label'>security:</span> <span class='id identifier rubyid_security'>security</span>
|
1258
|
+
<span class='rparen'>)</span>
|
1259
|
+
<span class='kw'>end</span></pre>
|
1260
|
+
</td>
|
1261
|
+
</tr>
|
1262
|
+
</table>
|
1263
|
+
</div>
|
1264
|
+
|
1265
|
+
</div>
|
1266
|
+
|
1267
|
+
</div>
|
1268
|
+
|
1269
|
+
<div id="footer">
|
1270
|
+
Generated on Thu Aug 17 10:04:38 2017 by
|
1271
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1272
|
+
0.9.9 (ruby-2.4.0).
|
1273
|
+
</div>
|
1274
|
+
|
1275
|
+
</div>
|
1276
|
+
</body>
|
1277
|
+
</html>
|