Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Files.StartDownloadingUbiquitousItem

Starts download of a cloud hosted file.

Component Version macOS Windows Linux Server iOS SDK
Files 13.4 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "Files.StartDownloadingUbiquitousItem"; Path )   More

Parameters

Parameter Description Example
Path The native path to the file or folder to be checked. "/Users/John/Desktop/test.txt"

Result

Returns OK or error.

Description

Starts download of a cloud hosted file.
This function starts downloading (if necessary) the specified item to the local system.

If a cloud-based file or directory has not been downloaded yet, calling this method starts the download process. If the item exists locally, calling this method synchronizes the local copy with the version in the cloud.

Examples

Request download of a file:

Set Variable [ $r; Value: MBS( "Files.StartDownloadingUbiquitousItem"; "/Users/cs/Library/CloudStorage/Dropbox/Test/test.zip" )]

See also

Release notes

Blog Entries

This function checks for a license.

Created 16th August 2023, last changed 16th August 2023


Files.StandardizePath - Files.UbiquitousItemStatus