<h1>Vuzit::Document.upload function</h1>
<p>Uploads a document to the Vuzit web service.</p>
<h2>Signatures</h2>
<ul>
<li><em>static</em> [[Vuzit_Document|Document]] upload(path, options = nil)</li>
</ul>
<h2>Parameters</h2>
<ul>
<li><em>string</em> <strong>path</strong> : Path to a file on the file system.</li>
<li><a href="http://www.ruby-doc.org/core/classes/Hash.html">Hash</a> <strong>options</strong> : Options for the uploaded file. See “Options” below.</li>
</ul>
<h3>Options</h3>
<p>Options for the Hash.</p>
<ul>
<li><strong>download_document</strong> – bool : Specifies if the original document (such as a <span class="caps">DOC</span>, <span class="caps">XLS</span>, <span class="caps">PDF</span>, <span class="caps">PPT</span> file) is downloadable via the viewer control bar. The value is either “true” or “false”.</li>
<li><strong>download_pdf</strong> – bool : Specifies if the generated <span class="caps">PDF</span> file, if the originating document was not a <span class="caps">PDF</span>, is downloadable via the viewer control bar. The value is either “true” or “false”.</li>
<li><strong>secure</strong> – bool : Specifies whether the document should be public or private. The value is either “true” or “false”.</li>
</ul>
<h2>Return type</h2>
<ul>
<li>[[Vuzit_Document|Document]] : The new document with an ID. None of the other properties will be available. You’ll need to use the find_by_id method to load them.</li>
</ul>
<h2>Usage Examples</h2>
<p>Simple upload example.</p>
<pre>
<code>
Vuzit::Service.public_key = "YOUR_PUBLIC_API_KEY"
Vuzit::Service.private_key = "YOUR_PRIVATE_API_KEY"
doc = Vuzit::Document.upload('c:\path\to\document.pdf')
puts "Document id: " + doc.Id
</code>
</pre>
<p>Example that sets the “secure” and “file_type” options for the document.</p>
<pre>
<code>
Vuzit::Service.public_key = "YOUR_PUBLIC_API_KEY"
Vuzit::Service.private_key = "YOUR_PRIVATE_API_KEY"
doc = Vuzit::Document.upload("c:/path/to/document.pdf", :secure => true,
:file_type => "pdf"))
puts "Document id: " + doc.id
</code>
</pre>
2009-11-24T03:56:35-08:00
315479
vuzit_document_upload
164824
Vuzit_Document_upload
2009-11-02T08:13:25-08:00
62149