docs/OpConnect/Client/Files.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: OpConnect::Client::Files
— Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "OpConnect::Client::Files";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../../OpConnect.html" title="OpConnect (module)">OpConnect</a></span></span> » <span class='title'><span class='object_link'><a href="../Client.html" title="OpConnect::Client (class)">Client</a></span></span>
»
<span class="title">Files</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: OpConnect::Client::Files
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Client.html" title="OpConnect::Client (class)">OpConnect::Client</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/op_connect/client/files.rb</dd>
</dl>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#get_file-instance_method" title="#get_file (instance method)">#<strong>get_file</strong>(vault_id:, item_id:, id:, **params) ⇒ Object </a>
(also: #file)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_file_content-instance_method" title="#get_file_content (instance method)">#<strong>get_file_content</strong>(vault_id:, item_id:, id:) ⇒ Object </a>
(also: #file_content)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list_files-instance_method" title="#list_files (instance method)">#<strong>list_files</strong>(vault_id:, item_id:, **params) ⇒ Object </a>
(also: #files)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="get_file-instance_method">
#<strong>get_file</strong>(vault_id:, item_id:, id:, **params) ⇒ <tt><span class='object_link'><a href="../Object.html" title="OpConnect::Object (class)">Object</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='file-instance_method'>file</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/op_connect/client/files.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_file'>get_file</span><span class='lparen'>(</span><span class='label'>vault_id:</span><span class='comma'>,</span> <span class='label'>item_id:</span><span class='comma'>,</span> <span class='label'>id:</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../Item.html" title="OpConnect::Item (class)">Item</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Item/File.html" title="OpConnect::Item::File (class)">File</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Item/File.html#initialize-instance_method" title="OpConnect::Item::File#initialize (method)">new</a></span></span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vault_id'>vault_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/items/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_item_id'>item_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_file_content-instance_method">
#<strong>get_file_content</strong>(vault_id:, item_id:, id:) ⇒ <tt><span class='object_link'><a href="../Object.html" title="OpConnect::Object (class)">Object</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='file_content-instance_method'>file_content</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/op_connect/client/files.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_file_content'>get_file_content</span><span class='lparen'>(</span><span class='label'>vault_id:</span><span class='comma'>,</span> <span class='label'>item_id:</span><span class='comma'>,</span> <span class='label'>id:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vault_id'>vault_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/items/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_item_id'>item_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/content</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="list_files-instance_method">
#<strong>list_files</strong>(vault_id:, item_id:, **params) ⇒ <tt><span class='object_link'><a href="../Object.html" title="OpConnect::Object (class)">Object</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='files-instance_method'>files</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/op_connect/client/files.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_list_files'>list_files</span><span class='lparen'>(</span><span class='label'>vault_id:</span><span class='comma'>,</span> <span class='label'>item_id:</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vault_id'>vault_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/items/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_item_id'>item_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../Item.html" title="OpConnect::Item (class)">Item</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Item/File.html" title="OpConnect::Item::File (class)">File</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Item/File.html#initialize-instance_method" title="OpConnect::Item::File#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Mar 14 05:16:28 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.1.1).
</div>
</div>
</body>
</html>