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

Inherits:

Rpc

• Object
• Base
• Rpc
• DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings

Defined in:

lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb

Constant Summary

Method =

:post

Path =

"/2/sharing/create_shared_link_with_settings".freeze

ResultType =

DropboxApi::Metadata::SharedLinkMetadata

ErrorType =

DropboxApi::Errors::CreateSharedLinkWithSettingsError

Instance Method Summary

• #create_shared_link_with_settings(path, settings = {}) ⇒ DropboxApi::Metadata::SharedLinkMetadata

  Create a shared link with custom settings.

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_shared_link_with_settings(path, settings = {}) ⇒ DropboxApi::Metadata::SharedLinkMetadata

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:

• (DropboxApi::Metadata::SharedLinkMetadata)

# 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
  #       has been implemented but will work only for pro users and it will return no permission error for basic users.
  perform_request :path => path
end