Class: DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings

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

Constant Summary collapse

Method = 
:post
Path = 
"/2/sharing/create_shared_link_with_settings".freeze
ResultType = 
DropboxApi::Metadata::SharedLinkMetadata
ErrorType = 
DropboxApi::Errors::CreateSharedLinkWithSettingsError

Instance Method Summary collapse

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

Create a shared link with custom settings. If no settings are given then the default visibility is :public. (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).

Parameters:

  • path (String) —

    The path to be shared by the shared link.

  • settings (SharedLinkSettings) (defaults to: {}) —

    The requested settings for the newly created shared link This field is optional.

Returns:



17
18
19
20
21
 
# File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 17

add_endpoint :create_shared_link_with_settings do |path, settings = {}|
  # NOTE: This endpoint accepts an additional option `settings` which
  #       hasn't been implemented.
  perform_request :path => path
end