NSMetadataItem Class Reference

Inherits from
NSObject
Conforms to
NSObject (NSObject)
Framework
/System/Library/Frameworks/Foundation.framework
Availability
Available in OS X v10.4 and later.
Declared in
NSMetadata.h
Companion guides
File Metadata Search Programming Guide
File Metadata Attributes Reference
Related sample code

Overview

The NSMetadataItem class represents the metadata associated with a file, providing a simple interface to retrieve the available attribute names and values.

Adopted Protocols

NSCopying

Tasks

Getting Item Attributes

Instance Methods

attributes

Returns an array containing the attribute names of the receiver’s values.

- (NSArray *)attributes
Return Value

An array containing the attribute names of the receiver’s values. See the "Constants” section for a list of possible keys.

Availability
  • Available in OS X v10.4 and later.
Declared In
NSMetadata.h

valueForAttribute:

Returns the receiver’s metadata attribute name specified by a given key.

- (id)valueForAttribute:(NSString *)key
Parameters
key

The name of a metadata attribute. See the "Constants” section for a list of possible keys.

Return Value

The receiver’s metadata attribute name specified by key.

Availability
  • Available in OS X v10.4 and later.
Related Sample Code
Declared In
NSMetadata.h

valuesForAttributes:

Returns a dictionary containing the key-value pairs for the attribute names specified by a given array of keys.

- (NSDictionary *)valuesForAttributes:(NSArray *)keys
Parameters
keys

An array containing NSString objects that specify the names of a metadata attributes. See the "Constants” section for a list of possible keys.

Return Value

A dictionary containing the key-value pairs for the attribute names specified by keys.

Availability
  • Available in OS X v10.4 and later.
Declared In
NSMetadata.h

Constants

Attribute Keys

Attribute keys that may be associated with an item.

NSString * const NSMetadataItemFSNameKey;
NSString * const NSMetadataItemDisplayNameKey;
NSString * const NSMetadataItemURLKey;
NSString * const NSMetadataItemPathKey;
NSString * const NSMetadataItemFSSizeKey;
NSString * const NSMetadataItemFSCreationDateKey;
NSString * const NSMetadataItemFSContentChangeDateKey;
Constants
NSMetadataItemFSNameKey

The value is an NSString object with the name of the item as seen in the file system.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemDisplayNameKey

The value is an NSString object with the display name of the item, which may be different then the file system name.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemURLKey

The value is an NSURL object that you can use to open the file.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemPathKey

The value is an NSString object that contains the full path to the file

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemFSSizeKey

The value is an NSNumber object that indicates the size (in bytes) of the file on disk.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemFSCreationDateKey

The value is an NSDate object that contains the date and time that the file was created.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataItemFSContentChangeDateKey

The value is an NSDate object that contains the date and time that the file contents last changed.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

Cloud Storage Keys

Attribute keys that describe cloud-related information about the item.

NSString * const NSMetadataItemIsUbiquitousKey;
NSString * const NSMetadataUbiquitousItemHasUnresolvedConflictsKey;
NSString * const NSMetadataUbiquitousItemIsDownloadedKey;
NSString * const NSMetadataUbiquitousItemIsDownloadingKey;
NSString * const NSMetadataUbiquitousItemIsUploadedKey;
NSString * const NSMetadataUbiquitousItemIsUploadingKey;
NSString * const NSMetadataUbiquitousItemPercentDownloadedKey;
NSString * const NSMetadataUbiquitousItemPercentUploadedKey;
Constants
NSMetadataItemIsUbiquitousKey

The value is an NSNumber object that contains a Boolean indicating whether the item is stored in the cloud.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemHasUnresolvedConflictsKey

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.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemIsDownloadedKey

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.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemIsDownloadingKey

The value is an NSNumber object that contains a Boolean indicating whether the item is currently being downloaded to the local device.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemIsUploadedKey

The value is an NSNumber object that contains a Boolean indicating whether the item has been uploaded to the cloud.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemIsUploadingKey

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.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemPercentDownloadedKey

The value is an NSNumber object that contains the percentage of the file that has already been downloaded from the cloud. The value is a double in the range 0.0 to 100.0.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.

NSMetadataUbiquitousItemPercentUploadedKey

The value is an NSNumber object that contains the percentage of the file that has already been uploaded to the cloud. The value is a double in the range 0.0 to 100.0.

Available in OS X v10.7 and later.

Declared in NSMetadata.h.



© 2011 Apple Inc. All Rights Reserved. (Last updated: 2011-10-12)

Did this document help you? Yes It's good, but... Not helpful...