Class: DropboxApi::Endpoints::Files::CopyBatchCheck

Inherits:
Rpc
  • Object
show all
Defined in:
lib/dropbox_api/endpoints/files/copy_batch_check.rb

Constant Summary collapse

Method = 
:post
Path = 
'/2/files/copy_batch/check_v2'
ResultType = 
DropboxApi::Results::RelocationBatchResult
ErrorType = 
DropboxApi::Errors::PollError

Instance Method Summary collapse

Methods inherited from Rpc

#build_connection, #build_request, #request_body

Methods inherited from Base

add_endpoint, #initialize

Constructor Details

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

Instance Method Details

#copy_batch_check(async_job_id) ⇒ :in_progress, Array

Returns the status of an asynchronous job for Client#copy_batch. It returns a list of results for each entry.

Parameters:

  • async_job_id (String) —

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns:

  • (:in_progress, Array) —

    This could be either the :in_progress flag or a list of job statuses.



17
18
19
 
# File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17

add_endpoint :copy_batch_check do |async_job_id|
  perform_request async_job_id: async_job_id
end