RubyGems - dropbox_api - Versions diffs - 0.1.17 → 0.1.18 - Mend

dropbox_api 0.1.17 → 0.1.18

Files changed (279) hide show

data/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html ADDED

@@ -0,0 +1,234 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: DropboxApi::Results::CreateFolderBatchResultEntry
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "DropboxApi::Results::CreateFolderBatchResultEntry";
+  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 (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+     &raquo;
+    <span class="title">CreateFolderBatchResultEntry</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>Class: DropboxApi::Results::CreateFolderBatchResultEntry
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+            <li class="next">DropboxApi::Results::CreateFolderBatchResultEntry</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/dropbox_api/results/create_folder_batch_result_entry.rb</dd>
+  </dl>
+</div>
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+</div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="new-class_method">
+    .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+</h3>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/create_folder_batch_result_entry.rb', line 3</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_result_data'>result_data</span><span class='rparen'>)</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span>
+    <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span>
+    <span class='comment'># At the moment, this is a `CreateFolderEntryError` which is an open
+</span>    <span class='comment'># union that can only be a `WriteError`. In the future, more errors
+</span>    <span class='comment'># could be added to the API which means we&#39;d have to implement the
+</span>    <span class='comment'># actual `CreateFolderEntryError` class.
+</span>    <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors/WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span>
+      <span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Folder operation failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri May 31 17:53:37 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.2).
+</div>
+    </div>
+  </body>
+</html>

data/docs/DropboxApi/Results/DeleteBatchResult.html ADDED

@@ -0,0 +1,241 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: DropboxApi::Results::DeleteBatchResult
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "DropboxApi::Results::DeleteBatchResult";
+  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 (D)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+     &raquo;
+    <span class="title">DeleteBatchResult</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>Class: DropboxApi::Results::DeleteBatchResult
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+            <li class="next">DropboxApi::Results::DeleteBatchResult</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/dropbox_api/results/delete_batch_result.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Result returned by <span class='object_link'><a href="../Client.html#delete_batch-instance_method" title="DropboxApi::Client#delete_batch (method)">Client#delete_batch</a></span> that may either launch an
+asynchronous job or complete synchronously.</p>
+<p>The value will be either a job id or a list of job statuses.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+</div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="new-class_method">
+    .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+</h3>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/delete_batch_result.rb', line 7</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_result_data'>result_data</span><span class='rparen'>)</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_result_data'>result_data</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+      <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DeleteBatchResultEntry.html" title="DropboxApi::Results::DeleteBatchResultEntry (class)">DeleteBatchResultEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DeleteBatchResultEntry.html#new-class_method" title="DropboxApi::Results::DeleteBatchResultEntry.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri May 31 17:53:35 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.2).
+</div>
+    </div>
+  </body>
+</html>