examples/api-samples/public/docs/sample09.html in groupdocs-1.6.0 vs examples/api-samples/public/docs/sample09.html in groupdocs-1.7.0
- old
+ new
@@ -29,13 +29,13 @@
</div>
<p>GET request</p>
</div>
- <div class="content"><div class='highlight'><pre>get <span class="string">'/sample09'</span> <span class="keyword">do</span>
- haml <span class="symbol">:sample09</span>
-<span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-9-how-to-generate-an-embedded-viewer-url-for-a-document'</span> <span class="hljs-keyword">do</span>
+ haml <span class="hljs-symbol">:sample09</span>
+<span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-2">
@@ -46,11 +46,11 @@
</div>
<p>POST request</p>
</div>
- <div class="content"><div class='highlight'><pre>post <span class="string">'/sample09'</span> <span class="keyword">do</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-9-how-to-generate-an-embedded-viewer-url-for-a-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
</li>
<li id="section-3">
@@ -61,21 +61,21 @@
</div>
<p>Set variables</p>
</div>
- <div class="content"><div class='highlight'><pre> set <span class="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
- set <span class="symbol">:width</span>, params[<span class="symbol">:width</span>]
- set <span class="symbol">:height</span>, params[<span class="symbol">:height</span>]
- set <span class="symbol">:source</span>, params[<span class="symbol">:source</span>]
- 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">:check</span>, params[<span class="symbol">:check</span>]
- set <span class="symbol">:url</span>, params[<span class="symbol">:url</span>]
- set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
+ <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:file_id</span>, params[<span class="hljs-symbol">:fileId</span>]
+ set <span class="hljs-symbol">:width</span>, params[<span class="hljs-symbol">:width</span>]
+ set <span class="hljs-symbol">:height</span>, params[<span class="hljs-symbol">:height</span>]
+ set <span class="hljs-symbol">:source</span>, params[<span class="hljs-symbol">:source</span>]
+ set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
+ set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
+ set <span class="hljs-symbol">:check</span>, params[<span class="hljs-symbol">:check</span>]
+ set <span class="hljs-symbol">:url</span>, params[<span class="hljs-symbol">:url</span>]
+ set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]
- <span class="keyword">begin</span></pre></div></div>
+ <span class="hljs-keyword">begin</span></pre></div></div>
</li>
<li id="section-4">
@@ -86,11 +86,11 @@
</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.width.empty? <span class="keyword">or</span> settings.height.empty?</pre></div></div>
+ <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'Please enter all required parameters'</span> <span class="hljs-keyword">if</span> settings.client_id.empty? <span class="hljs-keyword">or</span> settings.private_key.empty? <span class="hljs-keyword">or</span> settings.width.empty? <span class="hljs-keyword">or</span> settings.height.empty?</pre></div></div>
</li>
<li id="section-5">
@@ -101,17 +101,17 @@
</div>
<p>Prepare base path</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
- base_path = <span class="string">'https://api.groupdocs.com'</span>
- <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
- base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
- <span class="keyword">else</span>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
+ base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
+ <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
+ base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
+ <span class="hljs-keyword">else</span>
base_path = settings.base_path
- <span class="keyword">end</span></pre></div></div>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-6">
@@ -122,11 +122,11 @@
</div>
<p>Configure your access to API server</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
groupdocs.client_id = settings.client_id
groupdocs.private_key = settings.private_key</pre></div></div>
</li>
@@ -139,12 +139,12 @@
</div>
<p>Optionally specify API server and version</p>
</div>
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
- <span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-8">
@@ -155,15 +155,15 @@
</div>
<p>Get document by file GUID</p>
</div>
- <div class="content"><div class='highlight'><pre> file = <span class="keyword">nil</span>
- <span class="keyword">case</span> settings.source
- <span class="keyword">when</span> <span class="string">'guid'</span>
- file = <span class="constant">GroupDocs::Storage::File</span>.new({<span class="symbol">:guid</span> => settings.file_id})
- <span class="keyword">when</span> <span class="string">'local'</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-keyword">nil</span>
+ <span class="hljs-keyword">case</span> settings.source
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'guid'</span>
+ file = <span class="hljs-constant">GroupDocs::Storage::File</span>.new({<span class="hljs-symbol">:guid</span> => settings.file_id})
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'local'</span></pre></div></div>
</li>
<li id="section-9">
@@ -174,11 +174,11 @@
</div>
<p>Construct path</p>
</div>
- <div class="content"><div class='highlight'><pre> filepath = <span class="string">"<span class="subst">#{<span class="constant">Dir</span>.tmpdir}</span>/<span class="subst">#{params[<span class="symbol">:file</span>][<span class="symbol">:filename</span>]}</span>"</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> filepath = <span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">Dir</span>.tmpdir}</span>/<span class="hljs-subst">#{params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:filename</span>]}</span>"</span></pre></div></div>
</li>
<li id="section-10">
@@ -189,11 +189,11 @@
</div>
<p>Open file</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="constant">File</span>.open(filepath, <span class="string">'wb'</span>) { |f| f.write(params[<span class="symbol">:file</span>][<span class="symbol">:tempfile</span>].read) }</pre></div></div>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">File</span>.open(filepath, <span class="hljs-string">'wb'</span>) { |f| f.write(params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:tempfile</span>].read) }</pre></div></div>
</li>
<li id="section-11">
@@ -204,20 +204,20 @@
</div>
<p>Make a request to API using client_id and private_key</p>
</div>
- <div class="content"><div class='highlight'><pre> file = <span class="constant">GroupDocs::Storage::File</span>.upload!(filepath, {})
- <span class="keyword">when</span> <span class="string">'url'</span>
- file = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
- <span class="keyword">else</span>
- raise <span class="string">'Wrong GUID source.'</span>
- <span class="keyword">end</span>
- url = <span class="keyword">nil</span>
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload!(filepath, {})
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'url'</span>
+ file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
+ <span class="hljs-keyword">else</span>
+ raise <span class="hljs-string">'Wrong GUID source.'</span>
+ <span class="hljs-keyword">end</span>
+ url = <span class="hljs-keyword">nil</span>
- <span class="keyword">case</span> settings.check
- <span class="keyword">when</span> <span class="string">'viewer'</span></pre></div></div>
+ <span class="hljs-keyword">case</span> settings.check
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'viewer'</span></pre></div></div>
</li>
<li id="section-12">
@@ -228,12 +228,12 @@
</div>
<p>Prepare to sign url</p>
</div>
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"/document-viewer/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
- <span class="keyword">when</span> <span class="string">'annotation'</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"/document-viewer/embed/<span class="hljs-subst">#{file.guid}</span>?frameborder='0' width='<span class="hljs-subst">#{settings.width}</span>' height='<span class="hljs-subst">#{settings.height}</span>'"</span>
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'annotation'</span></pre></div></div>
</li>
<li id="section-13">
@@ -244,12 +244,12 @@
</div>
<p>Prepare to sign url</p>
</div>
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"/document-annotation2/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
- <span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"/document-annotation2/embed/<span class="hljs-subst">#{file.guid}</span>?frameborder='0' width='<span class="hljs-subst">#{settings.width}</span>' height='<span class="hljs-subst">#{settings.height}</span>'"</span>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-14">
@@ -260,11 +260,11 @@
</div>
<p>Sign url</p>
</div>
- <div class="content"><div class='highlight'><pre> url = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> => iframe).prepare_and_sign_url</pre></div></div>
+ <div class="content"><div class='highlight'><pre> url = <span class="hljs-constant">GroupDocs::Api::Request</span>.new(<span class="hljs-symbol">:path</span> => iframe).prepare_and_sign_url</pre></div></div>
</li>
<li id="section-15">
@@ -275,22 +275,22 @@
</div>
<p>Generate iframe URL</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="keyword">case</span> settings.base_path
- <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
- iframe = <span class="string">"https://stage-api-groupdocs.dynabic.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
- iframe = <span class="string">"https://dev-apps.groupdocs.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">else</span>
- iframe = <span class="string">"https://apps.groupdocs.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">end</span>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> settings.base_path
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://stage-api-groupdocs.dynabic.com'</span>
+ iframe = <span class="hljs-string">"https://stage-api-groupdocs.dynabic.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://dev-api-groupdocs.dynabic.com'</span>
+ iframe = <span class="hljs-string">"https://dev-apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">else</span>
+ iframe = <span class="hljs-string">"https://apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">end</span>
- <span class="keyword">rescue</span> <span class="constant">Exception</span> => e
+ <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> => e
err = e.message
- <span class="keyword">end</span></pre></div></div>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-16">
@@ -301,11 +301,11 @@
</div>
<p>Set variables for template</p>
</div>
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample09</span>, <span class="symbol">:locals</span> => {<span class="symbol">:guid</span> => file.guid, <span class="symbol">:width</span> => settings.width, <span class="symbol">:height</span> => settings.height, <span class="symbol">:v_url</span> => iframe, <span class="symbol">:err</span> => err}
-<span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample09</span>, <span class="hljs-symbol">:locals</span> => {<span class="hljs-symbol">:guid</span> => file.guid, <span class="hljs-symbol">:width</span> => settings.width, <span class="hljs-symbol">:height</span> => settings.height, <span class="hljs-symbol">:v_url</span> => iframe, <span class="hljs-symbol">:err</span> => err}
+<span class="hljs-keyword">end</span></pre></div></div>
</li>
</ul>
</div>