Protocol

NSFileProviderItem

A protocol that defines the properties of an item managed by the File Provider extension.

Declaration

@protocol NSFileProviderItem

Overview

Most of these properties are optional. A File Provider extension doesn't need to implement all properties for all items.

Topics

Providing Required Properties

itemIdentifier

The item's persistent identifier.

Required.

filename

The item's filename.

Required.

typeIdentifier

The item's uniform type identifiers.

Required.

capabilities

The item's capabilities.

Managing Content

childItemCount

The number of items contained by this item.

documentSize

The document's size, in bytes.

Specifying Content Location

parentItemIdentifier

The persistent identifier of the item's parent folder.

Required.

trashed

A Boolean value that indicates whether an item is in the trash.

Tracking Usage

contentModificationDate

The date the item was last modified.

creationDate

The date the item was created.

lastUsedDate

The date the item was last used.

Tracking Versions

versionIdentifier

A data value used to determine when the item changes.

Deprecated
mostRecentVersionDownloaded

A Boolean value that indicates whether the item is the most recent version downloaded from the server.

Monitoring File Transfers

uploading

A Boolean value that indicates whether the item is currently uploading to your remote server.

uploaded

A Boolean value that indicates whether the item has been uploaded to your remote server.

uploadingError

An error that occurred while uploading to your remote server.

downloading

A Boolean value that indicates whether the item is currently downloading from your remote server.

downloaded

A Boolean value that indicates whether the item has been downloaded from your remote server.

downloadingError

An error that occurred while downloading the item.

Sharing

shared

A Boolean value that indicates whether the item is shared with other users.

sharedByCurrentUser

A Boolean value that indicates whether the item was shared by the current user.

mostRecentEditorNameComponents

The most recent editor's name.

ownerNameComponents

The name of the item's owner.

Managing Metadata

tagData

An abstract data blob representing the tags associated with the item.

favoriteRank

A 64-bit, unsigned integer indicating the order of the favorite item in the Favorites list.

NSFileProviderFavoriteRankUnranked

A value that indicates that the item is not ranked.

userInfo

A property list that contains additional data about the item.

Relationships

Inherits From

See Also

Provided Items

NSFileProviderItem

An item managed by the File Provider extension.

NSFileProviderItemIdentifier

A unique identifier for an item managed by the File Provider extension.

NSFileProviderItemCapabilities

An item's capabilities, which define the actions that the user can perform in the document browser.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software