Class CSSearchable Item Attribute Set
The set of properties to display for a searchable item.
iOS 9.0+ macOS 10.11+ Mac Catalyst 13.0+ Beta Declaration @interface CSSearchableItemAttributeSet :
To make content searchable, create an attribute set that contains properties that specify the metadata to display about an item (represented by a
object) when it appears in a search result. CSSearchable Item
The attributes you choose depend on your domain. You can use the properties that Core Spotlight provides in categories defined on
(such as Media and Documents), or you can define your own. If you want to define a custom attribute, be as specific as possible in your definition and use the
CSSearchable Item Attribute Set property so that your custom attribute can inherit from a known type. content Type Tree
object should be changed from only one thread at a time. Concurrent access to properties in an attribute set has undefined behavior.
CSSearchable Item Attribute Set Topics Working with Custom Attributes Describing Documents audiences
A class of entity for whom the item is intended or useful.
The name of the application used to create the content.
The name of the application used to convert the original content into a PDF stream.
An array of font names used in the document.
A formal identifier that references the document the item represents.
A description of the kind of document the item represents.
The number of pages in the document.
The height of the document page in points (72 points per inch).
The width of the document page in points (72 points per inch).
The security method (that is, a type of encryption) used to protect the document file.
The subject of the document.
The theme of the document.
Describing Events all Day
A value that indicates if the event covers an entire day.
The date on which the item is due.
Describing General Attributes alternate Names
An array of localized strings that represent alternate display names for the item.
The uniform type identifier (that is, UTI) of the item.
content Type Tree
An attribute type that identifies a custom hierarchy of types to describe the attributes of your item.
The file URL of the content to be indexed.
A localized string that contains the name of the item, suitable to display in the user interface.
An array of keywords associated with the item, such as work, birthday, important, and so on.
The complete path to the item.
Image data that represents the thumbnail of the item.
The local file URL of the thumbnail image for the item.
Describing Places altitude
The altitude of the item in meters above sea level, expressed using the WGS84 datum.
The city of the item’s origin according to guidelines established by the provider.
The full, publishable name of the country or primary location in which the intellectual property of the item was created, according to guidelines established by the provider.
The GPS dilution of precision value.
The differential correction applied to the GPS receiver.
The measurement precision mode in use by the GPS receiver.
The direction of travel of the item in degrees from true north.
A publishable string that provides a synopsis of the contents of the item.
The direction of the item's image in degrees from true north.
Instructions that concern the use of the item, such as an embargo or warning.
The latitude of the item in degrees north of the equator, expressed using the WGS84 datum.
The longitude of the item in degrees east of the prime meridian, expressed using the WGS84 datum.
The name of the location or point of interest associated with the item.
The speed of the item in kilometers per hour.
state Or Province
The province or state of origin according to guidelines established by the provider.
The postal code for the item according to guidelines established by the provider.
The sublocation, such as a street number, for the item according to guidelines established by the provider.
The thoroughfare associated with the location, such as a street name, for the item according to guidelines established by the provider.
Describing Media comment
A comment related to the media file.
The most recent date on which the file was downloaded or received.
A list of editors who have worked on the file.
A list of people who are visible in an image or movie or written about in a document.
A list of projects of which this file is a part.
The date on which the item was moved into its current location.
The codecs used to encode/decode the media.
A list of contacts who are associated with the content in some way, not including the author.
The duration (if appropriate) of the content of the file, in seconds.
A list of companies or organizations that created the content.
A value that indicates if the content is prepared for streaming.
total Bit Rate
The total bit rate of the media, combining audio and video.
A version string associated with the file.
A list of people, organizations, or services that made contributions to the media content.
A list of the included languages for the intellectual content of the media.
A list of people, organizations, services, or other entities responsible for making the media available.
A link to information about the rights held in and over the media.
Indicates the role of the content creator.
A value that indicates if the media contains explicit content.
A list of descriptors that specify the extent or scope of the media.
The name of the director of the media (for example, a movie director).
A value that indicates if the media is local.
A user-supplied play count for the media.
The user-supplied rating of the media.
The URL associated with the media.
Describing Music album
The title for a collection of audio media.
The artist associated with the media.
audio Sample Rate
The sample rate of the audio data contained in the file as a float value representing HZ (that is, audio frames/second), such as 44100.0 or 22254.54.
audio Track Number
The track number of a song or audio composition when it is part of an album.
The composer of the song or audio composition contained in the audio file.
The musical key of the song or audio composition contained in the file, such as C, Dm, or F#m.
The lyricist or text writer for the song or audio composition contained in the file.
The musical genre of the song or audio composition contained in the file, such as Jazz, Pop, Rock, or Classical.
The recording date of the song or audio composition.
The tempo of the music contained in the audio file in beats per minute.
The time signature of the musical composition contained in the audio or MIDI file in a string, such as "4/4" or "7/8".
A value that indicates whether the MIDI sequence contained in the file is set up for use with a general MIDI device.
Describing Images ISOSpeed
The ISO speed setting for the camera at the time the image was captured.
The manufacturer of the device that was used to capture the image.
The size of the lens aperture at the time the image was captured, as a log-scale APEX value.
The owner of the camera used to capture the image.
The color space model used in this image, such as RGB, CMYK, YUV, or YCbCr.
A value that indicates if the flash was used to capture the image.
The actual focal length of the lens in millimeters.
An array that contains the names of the various layers in the file.
The model of the lens used to capture this image.
The total number of pixels in the image.
The height of the item, such as image or video frame height, in pixels.
The width of the item, such as image or video frame width, in pixels.
The white balance setting of the camera when the image was acquired.
The version of GPS Info IFD header that was used to generate the metadata for the image.
The version of the EXIF header that was used to generate the metadata for the image.
The mode that was used for the exposure for the image.
The class of the program used by the camera to set exposure when the image is captured.
The time that the lens was open during exposure, in seconds.
exposure Time String
The time that the lens was open during exposure, in a string, such as "1/250 seconds".
The focal length of the lens divided by the diameter of the aperture when the image was captured.
The name of the color profile used for the image.
red Eye On
A value that indicates if red-eye reduction was used when the image was captured.
Describing Messages HTMLContent Data
The HTML content of the document encoded as an NSData object representing a UTF-8 encoded string.
An array of the canonical handles for the account with which the message is associated.
The unique identifier for the account with which the message is associated, if any.
An array of addresses associated with the author of the message.
An array of names representing the authors who have worked on the message.
An array of
objects representing the content of the From: field in an item. CSPerson email Addresses
An array of email addresses associated with the message.
A dictionary that contains all the headers of the message.
A value that indicates if the message is likely to be considered junk.
An array of phone numbers associated with the message.
An array of names representing the recipients of this message.
Describing Containment container Display Name
A localized string that specifies the name of a container to which the item belongs, suitable to display in the user interface.
Supporting Actions supports Navigation
A value that indicates whether it makes sense to support navigation to the location represented by the item.
supports Phone Call
A value that indicates whether it makes sense to allow a phone call to a number associated with the item.
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