dropboxListFolderLongPoll |
Type | command |
Dictionary | library.dropbox |
Library | Dropbox Library |
Syntax | dropboxListFolderLongPoll <pCursor>, <pTimeout>, [<pCallback>]
|
Associations | com.livecode.library.dropbox |
Summary | A longpoll endpoint to wait for changes on an account.
|
Parameters | Name | Type | Description |
---|
pCursor | | A cursor as returned by dropboxListFolder or dropboxListFolderContinue. Cursors retrieved
by setting ListFolderArg.include_media_info to true are not supported.
|
pTimeOut | | A timeout in seconds. The request will block for at most this length of time, plus up to
90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when
using this parameter, as some network infrastructure does not support long timeouts. The default for
this field is 30.
|
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 a UTF-8 encoded JSON string in the form:
{
"changes": true
}
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 | In conjunction with dropboxListFolderContinue, this call gives you a low-latency way to monitor an account
for file changes. The connection will block until there are changes available or a timeout occurs.
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.
|