Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
Queres status of a ubiquitous item.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
Files | 13.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
Parameter | Description | Example |
---|---|---|
Path | The native path to the file or folder to be checked. | "/Users/John/Desktop/test.txt" |
Returns JSON or error.
IsUbiquitousItem | True if this item is synced to the cloud, false if it is only a local file. |
IsExcludedFromSync | True if the item is excluded from sync, which means it is locally on disk but won't be available on the server. An excluded item is no longer ubiquitous. |
IsDownloading | True if data is being downloaded for this item. |
IsUploading | True if data is being uploaded for this item. |
IsUploaded | True if there is data present in the cloud for this item. |
IsDownloaded | True if file is downloaded. |
DownloadingError | The error when downloading the item from iCloud failed. |
DownloadingStatus | The download status of this item. Can be NotDownloaded, Downloaded, Current or undefined. |
DownloadRequested | Whether a download of this item has already been requested. |
UploadingError | The error when uploading the item to iCloud failed. |
HasUnresolvedConflicts | True if this item has conflicts outstanding. |
Queries status for a file in DropBox:
Set Variable [ $r; Value: MBS("Files.UbiquitousItemStatus"; "/Users/cs/Library/CloudStorage/Dropbox/Test/test.zip") ]
Example result:
{
"DownloadingError" : null,
"DownloadingStatus" : "Current",
"UploadingError" : null,
"IsExcludedFromSync" : false,
"IsDownloading" : false,
"IsUploading" : false,
"IsUploaded" : true,
"IsDownloaded" : 1,
"DownloadRequested" : false,
"IsUbiquitousItem" : true,
"HasUnresolvedConflicts" : false
}
Query status of a not downloaded file:
Set Variable [ $r; Value: MBS("Files.UbiquitousItemStatus"; "/Users/cs/Library/CloudStorage/Dropbox/Test/test.zip") ]
Example result:
{
"DownloadingError" : null,
"DownloadingStatus" : "NotDownloaded",
"UploadingError" : null,
"IsExcludedFromSync" : false,
"IsDownloading" : false,
"IsUploading" : false,
"IsUploaded" : true,
"IsDownloaded" : 0,
"DownloadRequested" : false,
"IsUbiquitousItem" : true,
"HasUnresolvedConflicts" : false
}
This function checks for a license.
Created 16th August 2023, last changed 16th August 2023