CSSearchableItemAttributeSet
The detailed metadata for a searchable item.
Declaration
class CSSearchableItemAttributeSetMentioned in
Overview
A CSSearchableItemAttributeSet contains an extensive set of attributes that describe your app’s content. Attributes include information such as its title and a brief description. They can also refer to who created the item, what kind of data it represents, when someone created it, and more. During the indexing process, you create CSSearchableItem objects and use a CSSearchableItemAttributeSet to fill in the attributes for that item. During a search, you can query the index for items with attributes that match specific values.
When creating a CSSearchableItem, it’s important to fill out as much information in the accompanying CSSearchableItemAttributeSet object as possible. You don’t have to provide values for every attribute. Instead, choose attributes that match the domain of your content. This type divides attributes into groups such as media, documents, events, places, music, images, and more. You can also add custom attributes to describe new types of content. When defining custom attributes, be as specific as possible in your definition, and provide a value for the contentTypeTree property so your custom attribute inherits from a known type.
Topics
Creating an attribute set
Accessing custom attributes
Adding an indexable app entity
Handling Apple Intelligence prioritization and summarization
Providing item representations
Describing general attributes
alternateNamescontentTypecontentTypeTreecontentURLdarkThumbnailURLdisplayNamekeywordsmetadataModificationDatepathrankingHintrelatedUniqueIdentifierthumbnailDatathumbnailURLtitledomainIdentifierweakRelatedUniqueIdentifier
Describing document content
audiencescontentDescriptioncreatorencodingApplicationsfileSizefontNamesidentifierkindpageCountpageHeightpageWidthsecurityMethodsubjecttheme
Describing user involvement
Describing events
Describing places
altitudecitycountrygpsAreaInformationgpsdopgpsDateStampgpsDestBearinggpsDestDistancegpsDestLatitudegpsDestLongitudegpsDifferentalgpsMapDatumgpsMeasureModegpsProcessingMethodgpsStatusgpsTrackheadlineimageDirectioninstructionslatitudelongitudenamedLocationspeedstateOrProvincetimestampfullyFormattedAddresspostalCodesubThoroughfarethoroughfare
Describing media
commentcontentCreationDatecontentModificationDatecontentSourcescopyrightdownloadedDateeditorslastUsedDateparticipantsprojectsaddedDatecodecscontactKeywordsdeliveryTypedurationmediaTypesorganizationsstreamabletotalBitRateaudioBitRateversionvideoBitRatecontributorslanguagespublishersrightsrolecontentRatingcoveragedirectorgenreinformationlocaloriginalFormatoriginalSourceperformersplayCountproducerratingratingDescriptionurl
Describing music
albumartistaudioChannelCountaudioEncodingApplicationaudioSampleRateaudioTrackNumbercomposerkeySignaturelyricistmusicalGenrerecordingDatetempotimeSignaturegeneralMIDISequencemusicalInstrumentCategorymusicalInstrumentName
Describing images
isoSpeedacquisitionMakeacquisitionModelaperturebitsPerSamplecameraOwnercolorSpaceflashOnfocalLengthfocalLength35mmlayerNameslensModelorientationpixelCountpixelHeightpixelWidthwhiteBalanceexifgpsVersionexifVersionexposureModeexposureProgramexposureTimeexposureTimeStringfNumberhasAlphaChannelmaxAperturemeteringModeprofileNameredEyeOnresolutionHeightDPIresolutionWidthDPI
Describing messages
Common Mailbox IdentifiershtmlContentDataaccountHandlesaccountIdentifieradditionalRecipientsauthorAddressesauthorEmailAddressesauthorNamesauthorsemailAddressesemailHeadershiddenAdditionalRecipientsinstantMessageAddresseslikelyJunkmailboxIdentifiersphoneNumbersprimaryRecipientsrecipientAddressesrecipientEmailAddressesrecipientNamestextContent