dropboxDownload

Typecommand
Dictionarylibrary.dropbox
LibraryDropbox Library
Syntax
dropboxDownload <pAccessToken>, <pPath>, [<pCallback>]
Associationscom.livecode.library.dropbox
Summary

Download a file from a user's Dropbox.

Parameters
NameTypeDescription
pAccessToken

An OAuth2 Access token to access the user's account

pPath

Path in the user's Dropbox to be download.

pCallback

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

Values
NameTypeDescription
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 it will be a JSON string 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.