examples/api-samples/public/docs/sample30.html in groupdocs-1.5.7 vs examples/api-samples/public/docs/sample30.html in groupdocs-1.5.8
- old
+ new
@@ -57,17 +57,18 @@
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
- <p>set variables</p>
+ <p>Set variables</p>
</div>
- <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:client_id</span>]
- set <span class="symbol">:private_key</span>, params[<span class="symbol">:private_key</span>]
- set <span class="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
+ <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
+ set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
+ set <span class="symbol">:name</span>, params[<span class="symbol">:fileName</span>]
+ set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
<span class="keyword">begin</span></pre></div></div>
</li>
@@ -80,61 +81,116 @@
</div>
<p>check required variables</p>
</div>
- <div class="content"><div class='highlight'><pre> raise <span class="string">'Please enter all required parameters'</span> <span class="keyword">if</span> settings.client_id.empty? <span class="keyword">or</span> settings.private_key.empty? <span class="keyword">or</span> settings.file_id.empty?</pre></div></div>
+ <div class="content"><div class='highlight'><pre> raise <span class="string">'Please enter all required parameters'</span> <span class="keyword">if</span> settings.client_id.empty? <span class="keyword">or</span> settings.private_key.empty? <span class="keyword">or</span> settings.name.empty?
+
+ <span class="keyword">if</span> settings.base_path.empty? <span class="keyword">then</span> settings.base_path = <span class="string">'https://api.groupdocs.com'</span> <span class="keyword">end</span></pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
- <p>make a request to API using client_id and private_key</p>
+ <p>Configure your access to API server</p>
</div>
- <div class="content"><div class='highlight'><pre> file = <span class="constant">GroupDocs::Storage::File</span>.new({<span class="symbol">:guid</span> => settings.file_id})</pre></div></div>
+ <div class="content"><div class='highlight'><pre> <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
+ groupdocs.client_id = settings.client_id
+ groupdocs.private_key = settings.private_key</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
- <p>delete file from GroupDocs Storage</p>
+ <p>Optionally specify API server and version</p>
</div>
- <div class="content"><div class='highlight'><pre> result = file.delete!({<span class="symbol">:client_id</span> => settings.client_id, <span class="symbol">:private_key</span> => settings.private_key})
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
+ <span class="keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-7">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-7">¶</a>
+ </div>
+ <p>Make a request to API using client_id and private_key</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> files_list = <span class="constant">GroupDocs::Storage::Folder</span>.list!(<span class="string">'/'</span>, {})
+ document = <span class="string">''</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-8">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-8">¶</a>
+ </div>
+ <p>Get document by file ID</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> files_list.each <span class="keyword">do</span> |element|
+ <span class="keyword">if</span> element.respond_to?(<span class="string">'name'</span>) == <span class="keyword">true</span> <span class="keyword">and</span> element.name == settings.name
+ document = element
+ <span class="keyword">end</span>
+ <span class="keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-9">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-9">¶</a>
+ </div>
+ <p>Delete file from GroupDocs Storage</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> document.delete!()
- message = <span class="string">'File was deleted from GroupDocs Storage'</span>
+ message = <span class="string">'Done, file deleted from your GroupDocs Storage'</span>
<span class="keyword">rescue</span> <span class="constant">Exception</span> => e
err = e.message
<span class="keyword">end</span></pre></div></div>
</li>
- <li id="section-7">
+ <li id="section-10">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-7">¶</a>
+ <a class="pilcrow" href="#section-10">¶</a>
</div>
- <p>set variables for template</p>
+ <p>Set variables for template</p>
</div>
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample30</span>, <span class="symbol">:locals</span> => {<span class="symbol">:userId</span> => settings.client_id, <span class="symbol">:privateKey</span> => settings.private_key, <span class="symbol">:message</span> => message, <span class="symbol">:fileId</span> => settings.file_id, <span class="symbol">:err</span> => err}
+ <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample30</span>, <span class="symbol">:locals</span> => {<span class="symbol">:userId</span> => settings.client_id, <span class="symbol">:privateKey</span> => settings.private_key, <span class="symbol">:message</span> => message, <span class="symbol">:name</span> => settings.name, <span class="symbol">:err</span> => err}
<span class="keyword">end</span></pre></div></div>
</li>
</ul>