Class: DropboxApi::Endpoints::Sharing::RevokeSharedLink

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

Constant Summary collapse

Method =
:post
Path =
"/2/sharing/revoke_shared_link".freeze
ResultType =
DropboxApi::Results::VoidResult
ErrorType =
DropboxApi::Errors::RevokeSharedLinkError

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

Revoke a shared link.

Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders.

A successful response indicates that the shared link was revoked.

Parameters:

  • url (String)

    shared url which needs to be revoked.


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

add_endpoint :revoke_shared_link do |url|
  perform_request({
    :url => url
  })
end