dropboxGetSharedLinkFile |
Type | command |
Dictionary | library.dropbox |
Library | Dropbox Library |
Syntax | dropboxGetSharedLinkFile <pAccessToken>, <pUrl>, [<pPath>, <pLinkPassword>, <pCallback>]
|
Associations | com.livecode.library.dropbox |
Summary | Download the shared link's file from a user's Dropbox.
|
Parameters | Name | Type | Description |
---|
pAccessToken | | An OAuth2 Access token to access the user's account
|
pURL | | URL of the shared link
|
pPath | | If the shared link is to a folder, this parameter can be used to retrieve the metadata
for a specific file or sub-folder in this folder. A relative path should be used. This field is optional.
|
pLinkPassword | | If the shared link has a password, this parameter can be used. This field is optional.
|
pCallback | | The handler to call when the request is complete. If empty the command
will block until complete.
|
|
Values | Name | Type | Description |
---|
It | | For asynchronous requests it will contain a request ID. This may be used with
tsNet's tsNetGetStatus function. If the request is synchronous and successful the it
variable will be the binary data of the file.
If an error occurred the JSON string will be in the following form:
{
"error_summary": string,
"error": {
".tag": string
}
}
|
The result | | An error if the HTTP request failed
|
|
Description | 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.
|