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

Inherits:

Rpc

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

Defined in:

lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb

Constant Summary

Method =

:post

Path =

'/2/sharing/revoke_shared_link'

ResultType =

DropboxApi::Results::VoidResult

ErrorType =

DropboxApi::Errors::RevokeSharedLinkError

Instance Method Summary

• #revoke_shared_link(url) ⇒ Object

  Revoke a shared link.

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

#revoke_shared_link(url) ⇒ Object

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.

# File 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb', line 18

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