Ubiquitous Item Resource Keys

Keys that describe the iCloud storage state of a file.

Overview

To request information about the iCloud storage state of an item, pass one of these keys to the forKey: parameter of the getResourceValue(_:forKey:) instance method.

Symbols

Constants

static let isUbiquitousItemKey: URLResourceKey

A boolean NSNumber that contains true if this item is in iCloud storage, false if it is a local item (read-only).

static let ubiquitousItemDownloadingErrorKey: URLResourceKey

An error object that indicates why downloading the item from iCloud failed. See Foundation Constants for possible error codes.

static let ubiquitousItemDownloadingStatusKey: URLResourceKey

The current download state for the item, indicating whether a local copy exists and whether that copy is the most current version of the item. The possible values for this key are described in URLUbiquitousItemDownloadingStatus.

static let ubiquitousItemHasUnresolvedConflictsKey: URLResourceKey

A boolean NSNumber that contains true if this item has conflicts outstanding, false otherwise (read-only).

static let ubiquitousItemIsDownloadingKey: URLResourceKey

A boolean NSNumber that contains true if this item is being downloaded from iCloud, false otherwise (read-only).

static let ubiquitousItemIsUploadedKey: URLResourceKey

A boolean NSNumber that contains true if this item’s data has been uploaded to iCloud storage, false otherwise (read-only).

static let ubiquitousItemIsUploadingKey: URLResourceKey

A boolean NSNumber that contains true if this item is being uploaded to iCloud, false otherwise (read-only).

static let ubiquitousItemUploadingErrorKey: URLResourceKey

An error object that indicates why uploading the item to iCloud failed. See Foundation Constants for possible error codes.

static let ubiquitousItemDownloadRequestedKey: URLResourceKey

A Boolean indicating whether a call to startDownloadingUbiquitousItem(at:) has already been made to download the item. The value of this key is read-only.

static let ubiquitousItemContainerDisplayNameKey: URLResourceKey

A string containing the name of the item’s container, as it is displayed to the user.