Skip to main content

dropboxUnshareFolder

Type​

command

Summary​

Allows a shared folder owner to unshare the folder.

Syntax​

dropboxUnshareFolder <pAccessToken>, <pSharedFolderId>, <pLeaveACopy>, [<pCallback>]

Description​

You'll need to call droboxCheckJobStatus to determine if the action has completed successfully.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters​

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pSharedFolderID

The ID for the shared folder.

pLeaveACopy

If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy. The default for this field is False.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.