Sha256: 69a63d6ff07e7e0e31091544ed969875ae249a4d6f1e88ea502634081ab73c40

Contents?: true

Size: 796 Bytes

Versions: 7

Compression:

Stored size: 796 Bytes

Contents

module DropboxApi::Endpoints::Files
  class Delete < DropboxApi::Endpoints::Rpc
    Method      = :post
    Path        = "/2/files/delete".freeze
    ResultType  = DropboxApi::Metadata::Resource
    ErrorType   = DropboxApi::Errors::DeleteError

    # Delete the file or folder at a given path.
    #
    # If the path is a folder, all its contents will be deleted too.
    #
    # A successful response indicates that the file or folder was deleted.
    # The returned metadata will be the corresponding FileMetadata or
    # FolderMetadata for the item at time of deletion, and not a
    # DeletedMetadata object.
    #
    # @param path [String] Path in the user's Dropbox to delete.
    add_endpoint :delete do |path|
      perform_request({
        :path => path
      })
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
dropbox_api-0.1.11 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.10 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.9 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.8 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.7 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.6 lib/dropbox_api/endpoints/files/delete.rb
dropbox_api-0.1.5 lib/dropbox_api/endpoints/files/delete.rb