Class: DropboxApi::Endpoints::Files::Upload

Inherits:
ContentUpload show all
Includes:
OptionsValidator
Defined in:
lib/dropbox_api/endpoints/files/upload.rb

Constant Summary collapse

Method = 
:post
Path = 
"/2/files/upload".freeze
ResultType = 
DropboxApi::Metadata::File
ErrorType = 
DropboxApi::Errors::UploadError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from ContentUpload

#build_request, #initialize, #perform_request

Methods inherited from Base

add_endpoint

Constructor Details

This class inherits a constructor from DropboxApi::Endpoints::ContentUpload

Instance Method Details

#upload(path, content, options = {}) ⇒ Object

Creates a new file.

Do not use this to upload a file larger than 150 MB. Instead, create an upload session with #upload_session_start().

Examples:

client = DropboxApi::Client.new
file_content = IO.read "local_image.png"
client.upload "/image.png", file_content
#=> #<DropboxApi::Metadata::File: @name="image.png" ...>
client = DropboxApi::Client.new
client.upload "/file.txt", "Contents of a plain text file."
#=> #<DropboxApi::Metadata::File: @name="file.txt" ...>
client = DropboxApi::Client.new
client.upload "/file.txt", "File contents...", :mode => :add
#=> #<DropboxApi::Metadata::File: @name="file (1).txt" ...>

Options Hash (options):

  • mode (DropboxApi::Metadata::WriteMode) —

    Selects what to do if the file already exists. The default is add.

  • autorename (Boolean) —

    If there’s a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is false.

  • client_modified (DateTime) —

    The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

See Also:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/dropbox_api/endpoints/files/upload.rb', line 44

add_endpoint :upload do |path, content, options = {}|
  validate_options([
    :mode,
    :autorename,
    :client_modified,
    :mute
  ], options)

  options[:mode] = build_write_mode_param(options[:mode]) if options[:mode]
  options[:client_modified] = options[:client_modified].utc.strftime("%FT%TZ") if options[:client_modified]

  perform_request(options.merge({
    :path => path
  }), content)
end