Contents

module DropboxApi::Endpoints::Files
  class ListFolder < DropboxApi::Endpoints::Rpc
    Method      = :post
    Path        = "/2/files/list_folder".freeze
    ResultType  = DropboxApi::Results::ListFolderResult
    ErrorType   = DropboxApi::Errors::ListFolderError

    include DropboxApi::OptionsValidator

    # Returns the contents of a folder.
    #
    # @param path [String] The path to the folder you want to read.
    # @option recursive [Boolean] If `true`, the list folder operation will be
    #   applied recursively to all subfolders and the response will contain
    #   contents of all subfolders. The default for this field is `false`.
    # @option include_media_info [Boolean] If `true`, FileMetadata.media_info
    #   is set for photo and video. The default for this field is `false`.
    # @option include_deleted [Boolean] If `true`, DeletedMetadata will be
    #   returned for deleted file or folder, otherwise LookupError.not_found
    #   will be returned. The default for this field is `false`.
    add_endpoint :list_folder do |path, options = {}|
      validate_options([
        :recursive,
        :include_media_info,
        :include_deleted,
        :shared_link,
        :include_has_explicit_shared_members
      ], options)
      options[:recursive] ||= false
      options[:include_media_info] ||= false
      options[:include_deleted] ||= false
      options[:shared_link] = build_shared_link_param(options[:shared_link]) if options[:shared_link]

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

    private

    def build_shared_link_param(shared_link_param)
      case shared_link_param
      when String, Symbol
        DropboxApi::Metadata::SharedLink.new shared_link_param
      when DropboxApi::Metadata::SharedLink
        shared_link_param
      else
        raise ArgumentError, "Invalid `shared_link`: #{shared_link.inspect}"
      end.to_hash
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
dropbox_api-0.1.11	lib/dropbox_api/endpoints/files/list_folder.rb