Deutsches LiveCode Wiki
Advertisement

Get a preview for a file.

Syntax:

dropboxGetPreview ''pAccessToken'', ''pPath'', [''pCallback'']

Parameters:

  • pAccessToken: An OAuth2 Access token to access the user's account
  • pPath: Path in the user's Dropbox to be deleted.
  • pCallback: The handler to call when the request is complete. If empty the command will block until complete. Requires tsNet with LiveCode Indy License.

Currently previews are only generated for the files with the following extensions:

.doc, .docx, .docm, .ppt, .pps, .ppsx, .ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf.

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.

Output values:

  • The result: An error if the HTTP request failed
  • 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 contain the data of the preview PDF. If an error occurred the JSON string will be in the following form:

{
"error_summary": string,
"error": {
".tag": string
}
}
Advertisement