iCloud Metadata Attributes

These metadata attributes provide information on iCloud files. The attributes allow you to determine if a file is in the cloud, whether the file is uploading or downloading to or from iCloud, and the percentage of the action in progress.


These attributes provide general information on the status of iCloud files.

The value is an NSNumber object that contains a Boolean indicating whether the item is stored in the cloud.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.


The value is an NSNumber object that contains a Boolean indicating whether the item is currently in conflict with another version of the file somewhere else.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.


The value is an NSNumber object that contains a Boolean indicating whether the current version of the item has been downloaded and is available locally.

This attribute is deprecated. Use NSMetadataUbiquitousItemDownloadingStatusKey instead.

Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 through OS X 10.9.Available in iOS 5.0 through iOS 7.0.


The value is a string constant that indicates the download status of the item. Possible values of the string are given in Downloading Status Values.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in iOS 7.0 and later.




The following attributes provide information on the download state of an iCloud file.

The value is an NSNumber object that contains a Boolean indicating whether the item is currently being downloaded to the local device.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.


The value is an NSNumber object that contains the percentage of the file that has already been downloaded from the cloud.
Value Type:  NSNumber
Expected Values:  A double in the range 0.0 to 100.0.
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.




The following attributes provide information on the upload state of an iCloud file.

The value is an NSNumber object that contains a Boolean indicating whether the item has been uploaded to the cloud.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.


The value is an NSNumber object that contains a Boolean indicating whether the current version of the item is currently being uploaded to the cloud.
Value Type:  NSNumber
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.


The value is an NSNumber object that contains the percentage of the file that has already been uploaded to the cloud.
Value Type:  NSNumber
Expected Values:  A double in the range 0.0 to 100.0.
Framework:  /System/Library/Frameworks/Foundation.framework
Header:  NSMetadata.h
Availability:  Available in OS X v10.7 and later.Available in iOS 5.0 and later.