Class: DropboxApi::Endpoints::Files::CopyReferenceGet

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

Constant Summary collapse

Method = 
:post
Path = 
'/2/files/copy_reference/get'
ResultType = 
DropboxApi::Results::GetCopyReferenceResult
ErrorType = 
DropboxApi::Errors::GetCopyReferenceError

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_reference_get(path) ⇒ DropboxApi::Results::GetCopyReferenceResult

Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to Client#copy_reference_save.

Parameters:

  • path (String) —

    The path to the file or folder you want to get a copy reference to.

Returns:



16
17
18
19
20
 
# File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16

add_endpoint :copy_reference_get do |path|
  perform_request({
    path: path
  })
end