Skip to main content

dropboxCreateSharedLinkWithSettings

Type​

command

Summary​

Create a shared link with custom settings

Syntax​

dropboxCreateSharedLinkWithSettings <pAccessToken>, <pPath>, [<pSettings>, <pCallback>]

Description​

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

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

pPath

The path to be shared by the shared link

pSettings

&#123;
\"requested_visibility\" (enum): The requested access for this shared link. This field is optional.

- \"public\": Anyone who has received the link can access it. No login required.
- \"team_only\": Only members of the same team can access the link. Login is required.
- \"password\": A link-specific password is required to access the link. Login is not required.
\"link_password\": If requested_visibility is password this is needed to specify the password to access the link. This field is optional.
\"expires\": format=\"%Y-%m-%dT%H:%M:%SZ\" - Expiration time of the shared link. By default the link won\'t expire. This field is optional.
&#125;

pCallback

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