Class: DropboxApi::Endpoints::Sharing::ListSharedLinks

Inherits:
Rpc
  • Object
show all
Includes:
OptionsValidator
Defined in:
lib/dropbox_api/endpoints/sharing/list_shared_links.rb

Constant Summary collapse

Method = 
:post
Path = 
"/2/sharing/list_shared_links".freeze
ResultType = 
DropboxApi::Results::ListSharedLinksResult
ErrorType = 
DropboxApi::Errors::ListSharedLinksError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from Rpc

#build_request, #initialize, #request_body

Methods inherited from Base

add_endpoint

Constructor Details

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

Instance Method Details

List shared links of this user.

If no path is given or the path is empty, returns a list of all shared links for the current user.

If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

Options Hash (options):

  • path (String)
  • cursor (String) —

    The cursor returned by your last call.

  • direct_only (Boolean)

Returns:

  • (ListSharedLinksResult) 


24
25
26
27
28
 
# File 'lib/dropbox_api/endpoints/sharing/list_shared_links.rb', line 24

add_endpoint :list_shared_links do |options = {}|
  validate_options([:path, :cursor, :direct_only], options)

  perform_request options
end