Files.UbiquitousItemStatus
--------------------------

Queries status of a ubiquitous item.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [Files](component_Files.md) | [13.4](newinversion134.md) | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |

MBS( "Files.UbiquitousItemStatus"; Path ) 

**MBS**( **"Files.UbiquitousItemStatus";** /\* Queries status of a ubiquitous item. \*/  
**$Path**) /\* The native path to the file or folder to be checked.e.g. "/Users/John/Desktop/test.txt" \*/ 

### Parameters

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

### Result

Returns JSON or error.

### Description

Queries status of a ubiquitous item.  
This allows you to check if a file in iCloud, Dropbox or similar provider is downloaded or not.  
  
You can use [Files.StartDownloadingUbiquitousItem](FilesStartDownloadingUbiquitousItem.md) function to start download or [Files.EvictUbiquitousItem](FilesEvictUbiquitousItem.md) to delete local copy of the file.  
  
Returns a JSON with the following keys:  
  
| 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. |

### Examples

Queries status for a file in DropBox:

 Set Variable \[ $r ; Value: MBS ("Files.UbiquitousItemStatus"; "/Users/cs/Library/CloudStorage/Dropbox/Test/test.zip") \]  
<small>  
Example result:   
{ "DownloadingError" : null, "DownloadingStatus" : "Current" , "UploadingError" : null, "IsExcludedFromSync" : false, "IsDownloading" : false, "IsUploading" : false, "IsUploaded" : true, "IsDownloaded" : 1 , "DownloadRequested" : false, "IsUbiquitousItem" : true, "HasUnresolvedConflicts" : false } </small>Query status of a not downloaded file:

 Set Variable \[ $r ; Value: MBS ("Files.UbiquitousItemStatus"; "/Users/cs/Library/CloudStorage/Dropbox/Test/test.zip") \]  
<small>  
Example result:   
{ "DownloadingError" : null, "DownloadingStatus" : "NotDownloaded" , "UploadingError" : null, "IsExcludedFromSync" : false, "IsDownloading" : false, "IsUploading" : false, "IsUploaded" : true, "IsDownloaded" : 0 , "DownloadRequested" : false, "IsUbiquitousItem" : true, "HasUnresolvedConflicts" : false } </small>### See also

- [Files.EvictUbiquitousItem](FilesEvictUbiquitousItem.md)
- [Files.StartDownloadingUbiquitousItem](FilesStartDownloadingUbiquitousItem.md)

### Release notes

- **Version 13.4**
    - Added [Files.UbiquitousItemStatus](https://www.mbsplugins.eu/FilesUbiquitousItemStatus.shtml) function.

### Blog Entries

- [News in MBS FileMaker Plugin 13.4](https://www.mbsplugins.de/archive/2023-09-20/News_in_MBS_FileMaker_Plugin_1/monkeybreadsoftware_blog_filemaker)
- [Neues MBS Plugin 13.4 für Claris FileMaker](https://www.mbsplugins.de/archive/2023-09-12/Neues_MBS_Plugin_134_für_Clar/monkeybreadsoftware_blog_filemaker)
- [MBS Plugin 13.4 for Claris FileMaker - More than 7100 Functions In One Plugin](https://www.mbsplugins.de/archive/2023-09-12/MBS_Plugin_134_for_Claris_File/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 13.4pr4](https://www.mbsplugins.de/archive/2023-08-22/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)

This function checks for a license.

Created 16th August 2023 , last changed 10th November 2025

  
[Files.USBSerialNumber](FilesUSBSerialNumber.md) - [Files.Unmount](FilesUnmount.md)

[HTML Version](FilesUbiquitousItemStatus.shtml)