Package apple.corespotlight

Class CSSearchableItemAttributeSet

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class CSSearchableItemAttributeSet
extends NSObject
implements NSCopying, NSSecureCoding
    CSSearchableItemAttribute encapsulates a set of properties of an CSSearchableItem. CSSearchableItemAttribute set should only be mutated from one thread at a time. Concurrent access to properties has undefined behavior.

    • Constructor Detail

      • CSSearchableItemAttributeSet

        protected CSSearchableItemAttributeSet​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • EXIFGPSVersion

        @Nullable
public @Nullable java.lang.String EXIFGPSVersion()
        The version of GPSInfoIFD header that was used to generate the metadata

      • EXIFVersion

        @Nullable
public @Nullable java.lang.String EXIFVersion()
        The verion of the EXIF header that was used to generate the metadata

      • GPSAreaInformation

        @Nullable
public @Nullable java.lang.String GPSAreaInformation()

      • GPSDOP

        @Nullable
public @Nullable NSNumber GPSDOP()

      • GPSDateStamp

        @Nullable
public @Nullable NSDate GPSDateStamp()

      • GPSDestBearing

        @Nullable
public @Nullable NSNumber GPSDestBearing()

      • GPSDestDistance

        @Nullable
public @Nullable NSNumber GPSDestDistance()

      • GPSDestLatitude

        @Nullable
public @Nullable NSNumber GPSDestLatitude()

      • GPSDestLongitude

        @Nullable
public @Nullable NSNumber GPSDestLongitude()

      • GPSDifferental

        @Nullable
public @Nullable NSNumber GPSDifferental()

      • GPSMapDatum

        @Nullable
public @Nullable java.lang.String GPSMapDatum()

      • GPSMeasureMode

        @Nullable
public @Nullable java.lang.String GPSMeasureMode()

      • GPSProcessingMethod

        @Nullable
public @Nullable java.lang.String GPSProcessingMethod()

      • GPSStatus

        @Nullable
public @Nullable java.lang.String GPSStatus()

      • GPSTrack

        @Nullable
public @Nullable NSNumber GPSTrack()
        The direction of travel of the item, in degrees from true north.

      • HTMLContentData

        @Nullable
public @Nullable NSData HTMLContentData()
        Contains the HTML content of the document encoded as NSData of UTF-8 encoded string.

      • ISOSpeed

        @Nullable
public @Nullable NSNumber ISOSpeed()
        The ISO Speed the camera was set to when the image was taken. Examples are 100, 200, 400, etc.

      • URL

        @Nullable
public @Nullable NSURL URL()
        URL of the item

      • accountHandles

        @Nullable
public @Nullable NSArray<java.lang.String> accountHandles()
        Array of the canonical handles of the account the item is associated with (IM handle, e-mail address, phone number...). E.g. in Mail's case, all the email addresses the account receives email on.

      • accountIdentifier

        @Nullable
public @Nullable java.lang.String accountIdentifier()
        Unique identifier for the account the item is associated with, if any

      • acquisitionMake

        @Nullable
public @Nullable java.lang.String acquisitionMake()
        Device make that was used to acquire this item

      • acquisitionModel

        @Nullable
public @Nullable java.lang.String acquisitionModel()
        Device model that was used to acquire this item

      • addedDate

        @Nullable
public @Nullable NSDate addedDate()
        This is the date that the item was moved into the current location.

      • additionalRecipients

        @Nullable
public @Nullable NSArray<? extends CSPerson> additionalRecipients()
        An array of CSPerson objects representing the content of the Cc: field in an email

      • album

        @Nullable
public @Nullable java.lang.String album()
        The title for a collection of media. This is analagous to a record album, or photo album whichs are collections of audio or images.

      • allDay

        @Nullable
public @Nullable NSNumber allDay()
        Whether this event covers complete days

      • alternateNames

        @Nullable
public @Nullable NSArray<java.lang.String> alternateNames()
        An array of localized strings of alternate display names for this item.

      • altitude

        @Nullable
public @Nullable NSNumber altitude()
        The altitude of the item in meters above sea level, expressed using the WGS84 datum. Negative values lie below sea level.

      • aperture

        @Nullable
public @Nullable NSNumber aperture()
        The size of the lens aperture as a log-scale APEX value when the image was acquired.

      • artist

        @Nullable
public @Nullable java.lang.String artist()
        The artist for the media

      • audiences

        @Nullable
public @Nullable NSArray<java.lang.String> audiences()
        A class of entity for whom the resource is intended or useful. A class of entity may be determined by the creator or the publisher or by a third party.

      • audioBitRate

        @Nullable
public @Nullable NSNumber audioBitRate()
        The audio bit rate

      • audioChannelCount

        @Nullable
public @Nullable NSNumber audioChannelCount()
        The number of channels in the audio data contained in the file. This item only represents the number of discreet channels of audio data found in the file. It does not indicate any configuration of the data in regards to a user's speaker setup.

      • audioEncodingApplication

        @Nullable
public @Nullable java.lang.String audioEncodingApplication()
        The name of the application that encoded the data contained in the audio file.

      • audioSampleRate

        @Nullable
public @Nullable NSNumber audioSampleRate()
        The sample rate of the audio data contained in the file. The sample rate is a float value representing hz (audio_frames/second). For example: 44100.0, 22254.54.

      • audioTrackNumber

        @Nullable
public @Nullable NSNumber audioTrackNumber()
        The track number of a song/composition when it is part of an album

      • authorAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> authorAddresses()
        This attribute indicates the author addresses of the document.

      • authorEmailAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> authorEmailAddresses()
        This attribute indicates the author of the emails message addresses. (This is always the email address, and not the human readable version)

      • authorNames

        @Nullable
public @Nullable NSArray<java.lang.String> authorNames()
        The list of author/authors that have worked on this item. There could be 0 or more authors of a particular item. The order of the authors in the array is preserved, but is not intended to represent the main author or relative importance of the authors.

      • authors

        @Nullable
public @Nullable NSArray<? extends CSPerson> authors()
        An array of CSPerson objects representing the content of the From: field in an email

      • bitsPerSample

        @Nullable
public @Nullable NSNumber bitsPerSample()
        Number of bits per sample For example bit depth of an image (8-bit, 16-bit etc..) or bit depth per audio sample of uncompressed audio data (8, 16, 24, 32, 64, etc..)

      • cameraOwner

        @Nullable
public @Nullable java.lang.String cameraOwner()
        The owner of the camera used to capture this image.

      • city

        @Nullable
public @Nullable java.lang.String city()
        Identifies city of item origin according to guidelines established by the provider.

      • codecs

        @Nullable
public @Nullable NSArray<java.lang.String> codecs()
        The codecs used to encode/decode the media

      • colorSpace

        @Nullable
public @Nullable java.lang.String colorSpace()
        What color space model is this item following (For example, "RGB", "CMYK", "YUV", "YCbCr")

      • comment

        @Nullable
public @Nullable java.lang.String comment()
        This is a comment related to a file.

      • completionDate

        @Nullable
public @Nullable NSDate completionDate()
        Date the item was completed

      • composer

        @Nullable
public @Nullable java.lang.String composer()
        The composer of the song/composition contained in the audio file.

      • contactKeywords

        @Nullable
public @Nullable NSArray<java.lang.String> contactKeywords()
        A list of contacts that are somehow associated with this document, beyond what is captured as Author.

      • containerDisplayName

        @Nullable
public @Nullable java.lang.String containerDisplayName()

      • containerIdentifier

        @Nullable
public @Nullable java.lang.String containerIdentifier()

      • containerOrder

        @Nullable
public @Nullable NSNumber containerOrder()

      • containerTitle

        @Nullable
public @Nullable java.lang.String containerTitle()

      • contentCreationDate

        @Nullable
public @Nullable NSDate contentCreationDate()
        This is the date that the contents of the item were created

      • contentDescription

        @Nullable
public @Nullable java.lang.String contentDescription()
        An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.

      • contentModificationDate

        @Nullable
public @Nullable NSDate contentModificationDate()
        This is the date that the contents of the item were last modified

      • contentRating

        @Nullable
public @Nullable NSNumber contentRating()
        Whether or not the item has explicit content. Should be 1 if explicit, 0 for clean.

      • contentSources

        @Nullable
public @Nullable NSArray<java.lang.String> contentSources()
        This attribute indicates where the item was obtained from. Examples: - downloaded file may refer to the site they were downloaded from,the refering URL, etc - files received by email may indicate who sent the file, the message subject, etc

      • contentType

        @Nullable
public @Nullable java.lang.String contentType()
        UTI Type pedigree for an item. Common types can be found in UTCoreTypes.h

      • contentTypeTree

        @Nullable
public @Nullable NSArray<java.lang.String> contentTypeTree()

      • contentURL

        @Nullable
public @Nullable NSURL contentURL()
        Optional file URL representing the content to be indexed Applications that are also 'Documents & Data' clients can set this property to allow Spotlight to deduplicate their searchable items against the iCloud Drive's items. When this property is set, Spotlight will not display the iCloud Drive's searchable items that have the same contentURL property.

      • contributors

        @Nullable
public @Nullable NSArray<java.lang.String> contributors()
        Used to designate the entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization or a service. Typically, the name of a Contributor should be used to indicate the entity.

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • copyright

        @Nullable
public @Nullable java.lang.String copyright()
        This is the copyright of the content.

      • country

        @Nullable
public @Nullable java.lang.String country()
        Provides full, publishable, name of the country/primary location where the intellectual property of the item was created,according to guidelines of the provider.

      • coverage

        @Nullable
public @Nullable NSArray<java.lang.String> coverage()
        Used to designate the extent or scope of the content of the resource. Coverage will typically include spatial location (a place name or geographic co-ordinates), temporal period (a period label, date, or date range) or jurisdiction (such as a named administrative entity). Recommended best practice is to select a value from a controlled vocabulary, and that, where appropriate, named places or time periods be used in preference to numeric identifiers such as sets of co-ordinates or date ranges.

      • creator

        @Nullable
public @Nullable java.lang.String creator()
        Application used to create the document content (e.g. "Word", "Framemaker", etc.).

      • deliveryType

        @Nullable
public @Nullable NSNumber deliveryType()
        The delivery type of the item. Should be 0 for fast start and 1 for RTSP.

      • director

        @Nullable
public @Nullable java.lang.String director()
        Director of the item (e.g. movie director)

      • displayName

        @Nullable
public @Nullable java.lang.String displayName()
        A localized string to be displayed in the UI for this item.

      • domainIdentifier

        @Nullable
public @Nullable java.lang.String domainIdentifier()
        This property has the same semantics as -[CSSearchableItem domainIdentifier]. It can be set on the contentAttributeSet property of a NSUserActivity instance and then used to delete the user activity by calling [[CSSearchableIndex defaultSearchableIndex] deleteSearchableItemsWithDomainIdentifiers:]. API-Since: 10.0

      • downloadedDate

        @Nullable
public @Nullable NSDate downloadedDate()
        This is the date that the file was last downloaded / received.

      • dueDate

        @Nullable
public @Nullable NSDate dueDate()
        Date this item is due.

      • duration

        @Nullable
public @Nullable NSNumber duration()
        This is the duration, in seconds, of the content of the item (if appropriate).

      • editors

        @Nullable
public @Nullable NSArray<java.lang.String> editors()
        The list of editor/editors that have worked on this item.

      • emailAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> emailAddresses()
        Email addresses for this item.

      • emailHeaders

        @Nullable
public @Nullable NSDictionary<java.lang.String,​? extends NSArray<?>> emailHeaders()
        Dictionary with all the headers of the message Keys are header names and values arrays of strings (because a header might be present multiple times in an email)

      • encodingApplications

        @Nullable
public @Nullable NSArray<java.lang.String> encodingApplications()
        Software used to convert the original content into a PDF stream (e.g. "Distiller", etc.).

      • endDate

        @Nullable
public @Nullable NSDate endDate()
        End date for this item.

      • exposureMode

        @Nullable
public @Nullable NSNumber exposureMode()
        Mode that was used for the exposure. Should be 0 for AutoExposure, 1 for Manual, 2 for AutoBracket.

      • exposureProgram

        @Nullable
public @Nullable java.lang.String exposureProgram()
        The class of the program used by the camera to set exposure when the picture is taken (Manual, Normal, Aperture Priority, ...)

      • exposureTime

        @Nullable
public @Nullable NSNumber exposureTime()
        Time that the lens was open during exposure in seconds

      • exposureTimeString

        @Nullable
public @Nullable java.lang.String exposureTimeString()
        The time of the exposure as a string, e.g. "1/250 seconds".

      • fNumber

        @Nullable
public @Nullable NSNumber fNumber()
        The focal length of the lens divided by the diameter of the aperture when the image was acquired.

      • fileSize

        @Nullable
public @Nullable NSNumber fileSize()
        Size of the document in MB.

      • focalLength

        @Nullable
public @Nullable NSNumber focalLength()
        The actual focal length of the lens in mm.

      • fontNames

        @Nullable
public @Nullable NSArray<java.lang.String> fontNames()
        Array of font names used in the item.

      • fullyFormattedAddress

        @Nullable
public @Nullable java.lang.String fullyFormattedAddress()
        The fully formatted address of the item (obtained from MapKit)

      • genre

        @Nullable
public @Nullable java.lang.String genre()
        Genre of the item (e.g. movie genre)

      • hasAlphaChannel

        @Nullable
public @Nullable NSNumber hasAlphaChannel()
        Indicates if this image file has an alpha channel. Should be 0 for no alpha channel, 1 for alpha channel.

      • headline

        @Nullable
public @Nullable java.lang.String headline()
        A publishable entry providing a synopsis of the contents of the item.

      • hiddenAdditionalRecipients

        @Nullable
public @Nullable NSArray<? extends CSPerson> hiddenAdditionalRecipients()
        An array of CSPerson objects representing the content of the Bcc: field in an email

      • identifier

        @Nullable
public @Nullable java.lang.String identifier()
        Used to reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.

      • imageDirection

        @Nullable
public @Nullable NSNumber imageDirection()
        The direction of the item's image, in degrees from true north.

      • importantDates

        @Nullable
public @Nullable NSArray<? extends NSDate> importantDates()
        Important dates associated with this item

      • information

        @Nullable
public @Nullable java.lang.String information()
        Information about the item

      • initWithItemContentType

        @Deprecated
public CSSearchableItemAttributeSet initWithItemContentType​(@NotNull
                                                            @NotNull java.lang.String itemContentType)
        Deprecated.
        Creates an attribute set for the given content type. API-Since: 9.0 Deprecated-Since: 100000.0 Deprecated-Message: Use initWithContentType instead

      • instantMessageAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> instantMessageAddresses()
        Instant message addresses for this item.

      • instructions

        @Nullable
public @Nullable java.lang.String instructions()
        Other editorial instructions concerning the use of the item, such as embargoes and warnings.

      • isFlashOn

        @Nullable
public @Nullable NSNumber isFlashOn()
        Indicates if the flash was used to take the picture. Should be 1 if flash is on, 0 otherwise.

      • isFocalLength35mm

        @Nullable
public @Nullable NSNumber isFocalLength35mm()
        Indicates if the focal length is 35mm. Should be 1 if true, 0 otherwise

      • isGeneralMIDISequence

        @Nullable
public @Nullable NSNumber isGeneralMIDISequence()
        This attribute indicates whether the MIDI sequence contained in the file is setup for use with a General MIDI device. Should be 1 if true, 0 otherwise.

      • isLikelyJunk

        @NotNull
public @NotNull NSNumber isLikelyJunk()
        This attribute indicates if the document is likely to be considered junk. Should be 1 if true, 0 otherwise

      • isLocal

        @Nullable
public @Nullable NSNumber isLocal()
        Whether or not the item is local. Should be 1 if true, 0 otherwise.

      • isRedEyeOn

        @Nullable
public @Nullable NSNumber isRedEyeOn()
        Indicates if red-eye reduction was used to take the picture. Should be 0 for no red-eye, 1 for red-eye

      • isStreamable

        @Nullable
public @Nullable NSNumber isStreamable()
        Whether the content is prepared for streaming. Should be 0 for not streamable, 1 for streamable.

      • keySignature

        @Nullable
public @Nullable java.lang.String keySignature()
        The musical key of the song/composition contained in an audio file. For example: C, Dm, F#m, Bb.

      • keywords

        @Nullable
public @Nullable NSArray<java.lang.String> keywords()
        Represents keywords associated with this particular item. Example Keywords might be Birthday,Important etc.

      • kind

        @Nullable
public @Nullable java.lang.String kind()
        Kind that this item represents.

      • languages

        @Nullable
public @Nullable NSArray<java.lang.String> languages()
        Used to designate the languages of the intellectual content of the resource. Recommended best practice for the values of the Language element is defined by BCP 47.

      • lastUsedDate

        @Nullable
public @Nullable NSDate lastUsedDate()
        This is the date that the item was last used

      • latitude

        @Nullable
public @Nullable NSNumber latitude()
        The latitude of the item in degrees north of the equator, expressed using the WGS84 datum. Negative values lie south of the equator.

      • layerNames

        @Nullable
public @Nullable NSArray<java.lang.String> layerNames()
        The names of the various layers in the file

      • lensModel

        @Nullable
public @Nullable java.lang.String lensModel()
        The model of the lens used to capture this image.

      • longitude

        @Nullable
public @Nullable NSNumber longitude()
        The longitude of the item in degrees east of the prime meridian, expressed using the WGS84 datum. Negative values lie west of the prime meridian.

      • lyricist

        @Nullable
public @Nullable java.lang.String lyricist()
        The lyricist/text writer for song/composition contained in the audio file.

      • mailboxIdentifiers

        @Nullable
public @Nullable NSArray<java.lang.String> mailboxIdentifiers()
        Array of Mailbox identifiers associated with the item. e.g. CSMailboxInbox, CSMailboxDrafts, CSMailboxSent, or a custom identifier etc.

      • maxAperture

        @Nullable
public @Nullable NSNumber maxAperture()
        The smallest F number of the lens. The unit is the APEX value. Ordinarily it is given in the range of 00.00 to 99.99.

      • mediaTypes

        @Nullable
public @Nullable NSArray<java.lang.String> mediaTypes()
        Media types present in the content

      • metadataModificationDate

        @Nullable
public @Nullable NSDate metadataModificationDate()
        This is the date that the last metadata attribute was changed.

      • meteringMode

        @Nullable
public @Nullable java.lang.String meteringMode()
        The metering mode for the image (Average, Partial, Pattern, ...)

      • musicalGenre

        @Nullable
public @Nullable java.lang.String musicalGenre()
        The musical genre of the song/composition contained in the audio file. For example: Jazz, Pop, Rock, Classical.

      • musicalInstrumentCategory

        @Nullable
public @Nullable java.lang.String musicalInstrumentCategory()
        Meta data attribute that stores the category of instrument. Files should have an instrument associated with them ("Other Instrument" is provided as a catch-all). For some categories, like "Keyboards" there are instrument names which provide a more detailed instrument definition (e.g., Piano,Organ, etc.)

      • musicalInstrumentName

        @Nullable
public @Nullable java.lang.String musicalInstrumentName()
        Meta data attribute that stores the name of instrument (relative to the instrument category) Files can have an instrument name associated with them if they have certain instrument categories (e.g., the category Percussion has multiple instruments, including Conga and Bongo).

      • namedLocation

        @Nullable
public @Nullable java.lang.String namedLocation()
        The name of the location or point of interest associated with the item. The name may be user provided.

      • organizations

        @Nullable
public @Nullable NSArray<java.lang.String> organizations()
        Used to indicate company/Organization that created the document.

      • orientation

        @Nullable
public @Nullable NSNumber orientation()
        The orientation of the data. Should be 0 for Landscape or 1 for Portrait.

      • originalFormat

        @Nullable
public @Nullable java.lang.String originalFormat()
        Original format of the movie

      • originalSource

        @Nullable
public @Nullable java.lang.String originalSource()
        Original source of the movie

      • pageCount

        @Nullable
public @Nullable NSNumber pageCount()
        Number of pages in the item.

      • pageHeight

        @Nullable
public @Nullable NSNumber pageHeight()
        Height in points (72 points per inch) of the document page (first page only for PDF's - other pages within the PDF may not be the same height).

      • pageWidth

        @Nullable
public @Nullable NSNumber pageWidth()
        Width in points (72 points per inch) of the document page (first page only for PDF's - other pages within the PDF may not be the same width).

      • participants

        @Nullable
public @Nullable NSArray<java.lang.String> participants()
        The list of people who are visible in an image or movie or written about in a document.

      • path

        @Nullable
public @Nullable java.lang.String path()
        This is the complete path to the item.

      • performers

        @Nullable
public @Nullable NSArray<java.lang.String> performers()
        Performers in the movie

      • phoneNumbers

        @Nullable
public @Nullable NSArray<java.lang.String> phoneNumbers()
        Phone numbers for this item.

      • pixelCount

        @Nullable
public @Nullable NSNumber pixelCount()
        The total number of pixels in the item.

      • pixelHeight

        @Nullable
public @Nullable NSNumber pixelHeight()
        The height of the item in pixels (ie Image height or Video frame height)

      • pixelWidth

        @Nullable
public @Nullable NSNumber pixelWidth()
        The width of the item in pixels (ie Image width or Video frame width)

      • playCount

        @Nullable
public @Nullable NSNumber playCount()
        User play count of this item

      • postalCode

        @Nullable
public @Nullable java.lang.String postalCode()
        The postal code for the item according to guidelines established by the provider.

      • primaryRecipients

        @Nullable
public @Nullable NSArray<? extends CSPerson> primaryRecipients()
        An array of CSPerson objects representing the content of the To: field in an email

      • producer

        @Nullable
public @Nullable java.lang.String producer()
        Producer of the content

      • profileName

        @Nullable
public @Nullable java.lang.String profileName()
        Name of the color profile used for the image

      • projects

        @Nullable
public @Nullable NSArray<java.lang.String> projects()
        The list of projects that this item is part of. For example if you were working on a movie, all of the movie files could be marked as belonging to the project "My movie"

      • publishers

        @Nullable
public @Nullable NSArray<java.lang.String> publishers()
        Used to designate the entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.

      • rating

        @Nullable
public @Nullable NSNumber rating()
        User rating of this item out of 5 stars

      • ratingDescription

        @Nullable
public @Nullable java.lang.String ratingDescription()
        A description of the rating. E.g. the number of reviewers.

      • recipientAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> recipientAddresses()
        This attribute indicates the recipient addresses of the document.

      • recipientEmailAddresses

        @Nullable
public @Nullable NSArray<java.lang.String> recipientEmailAddresses()
        This attribute indicates the reciepients email addresses. (This is always the email address, and not the human readable version).

      • recipientNames

        @Nullable
public @Nullable NSArray<java.lang.String> recipientNames()
        This attribute indicates the recipients of this item.

      • recordingDate

        @Nullable
public @Nullable NSDate recordingDate()
        The recording date of the song/composition. This information differs from the contentCreationDate attribute as it indicates the date that the 'art' was created, in contrast to contentCreationDate which for example, could indicate the creation date of an edited or 'mastered' version of the original art.

      • relatedUniqueIdentifier

        @Nullable
public @Nullable java.lang.String relatedUniqueIdentifier()
        For activities, this is the unique identifier for the item this activity is related to. If the item doesn't exist in the index, the activity will not get stored. When the item is deleted, the activity will also be deleted.

      • resolutionHeightDPI

        @Nullable
public @Nullable NSNumber resolutionHeightDPI()
        Resolution height of this image in DPI

      • resolutionWidthDPI

        @Nullable
public @Nullable NSNumber resolutionWidthDPI()
        Resolution width of this image in DPI

      • rights

        @Nullable
public @Nullable java.lang.String rights()
        Used to provide a link to information about rights held in and over the resource. Typically a Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information often encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. If the rights element is absent, no assumptions can be made about the status of these and other rights with respect to the resource.

      • role

        @Nullable
public @Nullable java.lang.String role()
        Used to indicate the role of the document creator

      • securityMethod

        @Nullable
public @Nullable java.lang.String securityMethod()
        Security (encryption) method used in the file

      • setAccountHandles

        public void setAccountHandles​(@Nullable
                              @Nullable NSArray<java.lang.String> value)
        Array of the canonical handles of the account the item is associated with (IM handle, e-mail address, phone number...). E.g. in Mail's case, all the email addresses the account receives email on.

      • setAccountIdentifier

        public void setAccountIdentifier​(@Nullable
                                 @Nullable java.lang.String value)
        Unique identifier for the account the item is associated with, if any

      • setAcquisitionMake

        public void setAcquisitionMake​(@Nullable
                               @Nullable java.lang.String value)
        Device make that was used to acquire this item

      • setAcquisitionModel

        public void setAcquisitionModel​(@Nullable
                                @Nullable java.lang.String value)
        Device model that was used to acquire this item

      • setAddedDate

        public void setAddedDate​(@Nullable
                         @Nullable NSDate value)
        This is the date that the item was moved into the current location.

      • setAdditionalRecipients

        public void setAdditionalRecipients​(@Nullable
                                    @Nullable NSArray<? extends CSPerson> value)
        An array of CSPerson objects representing the content of the Cc: field in an email

      • setAlbum

        public void setAlbum​(@Nullable
                     @Nullable java.lang.String value)
        The title for a collection of media. This is analagous to a record album, or photo album whichs are collections of audio or images.

      • setAllDay

        public void setAllDay​(@Nullable
                      @Nullable NSNumber value)
        Whether this event covers complete days

      • setAlternateNames

        public void setAlternateNames​(@Nullable
                              @Nullable NSArray<java.lang.String> value)
        An array of localized strings of alternate display names for this item.

      • setAltitude

        public void setAltitude​(@Nullable
                        @Nullable NSNumber value)
        The altitude of the item in meters above sea level, expressed using the WGS84 datum. Negative values lie below sea level.

      • setAperture

        public void setAperture​(@Nullable
                        @Nullable NSNumber value)
        The size of the lens aperture as a log-scale APEX value when the image was acquired.

      • setArtist

        public void setArtist​(@Nullable
                      @Nullable java.lang.String value)
        The artist for the media

      • setAudiences

        public void setAudiences​(@Nullable
                         @Nullable NSArray<java.lang.String> value)
        A class of entity for whom the resource is intended or useful. A class of entity may be determined by the creator or the publisher or by a third party.

      • setAudioBitRate

        public void setAudioBitRate​(@Nullable
                            @Nullable NSNumber value)
        The audio bit rate

      • setAudioChannelCount

        public void setAudioChannelCount​(@Nullable
                                 @Nullable NSNumber value)
        The number of channels in the audio data contained in the file. This item only represents the number of discreet channels of audio data found in the file. It does not indicate any configuration of the data in regards to a user's speaker setup.

      • setAudioEncodingApplication

        public void setAudioEncodingApplication​(@Nullable
                                        @Nullable java.lang.String value)
        The name of the application that encoded the data contained in the audio file.

      • setAudioSampleRate

        public void setAudioSampleRate​(@Nullable
                               @Nullable NSNumber value)
        The sample rate of the audio data contained in the file. The sample rate is a float value representing hz (audio_frames/second). For example: 44100.0, 22254.54.

      • setAudioTrackNumber

        public void setAudioTrackNumber​(@Nullable
                                @Nullable NSNumber value)
        The track number of a song/composition when it is part of an album

      • setAuthorAddresses

        public void setAuthorAddresses​(@Nullable
                               @Nullable NSArray<java.lang.String> value)
        This attribute indicates the author addresses of the document.

      • setAuthorEmailAddresses

        public void setAuthorEmailAddresses​(@Nullable
                                    @Nullable NSArray<java.lang.String> value)
        This attribute indicates the author of the emails message addresses. (This is always the email address, and not the human readable version)

      • setAuthorNames

        public void setAuthorNames​(@Nullable
                           @Nullable NSArray<java.lang.String> value)
        The list of author/authors that have worked on this item. There could be 0 or more authors of a particular item. The order of the authors in the array is preserved, but is not intended to represent the main author or relative importance of the authors.

      • setAuthors

        public void setAuthors​(@Nullable
                       @Nullable NSArray<? extends CSPerson> value)
        An array of CSPerson objects representing the content of the From: field in an email

      • setBitsPerSample

        public void setBitsPerSample​(@Nullable
                             @Nullable NSNumber value)
        Number of bits per sample For example bit depth of an image (8-bit, 16-bit etc..) or bit depth per audio sample of uncompressed audio data (8, 16, 24, 32, 64, etc..)

      • setCameraOwner

        public void setCameraOwner​(@Nullable
                           @Nullable java.lang.String value)
        The owner of the camera used to capture this image.

      • setCity

        public void setCity​(@Nullable
                    @Nullable java.lang.String value)
        Identifies city of item origin according to guidelines established by the provider.

      • setCodecs

        public void setCodecs​(@Nullable
                      @Nullable NSArray<java.lang.String> value)
        The codecs used to encode/decode the media

      • setColorSpace

        public void setColorSpace​(@Nullable
                          @Nullable java.lang.String value)
        What color space model is this item following (For example, "RGB", "CMYK", "YUV", "YCbCr")

      • setComment

        public void setComment​(@Nullable
                       @Nullable java.lang.String value)
        This is a comment related to a file.

      • setCompletionDate

        public void setCompletionDate​(@Nullable
                              @Nullable NSDate value)
        Date the item was completed

      • setComposer

        public void setComposer​(@Nullable
                        @Nullable java.lang.String value)
        The composer of the song/composition contained in the audio file.

      • setContactKeywords

        public void setContactKeywords​(@Nullable
                               @Nullable NSArray<java.lang.String> value)
        A list of contacts that are somehow associated with this document, beyond what is captured as Author.

      • setContainerDisplayName

        public void setContainerDisplayName​(@Nullable
                                    @Nullable java.lang.String value)

      • setContainerIdentifier

        public void setContainerIdentifier​(@Nullable
                                   @Nullable java.lang.String value)

      • setContainerOrder

        public void setContainerOrder​(@Nullable
                              @Nullable NSNumber value)

      • setContainerTitle

        public void setContainerTitle​(@Nullable
                              @Nullable java.lang.String value)

      • setContentCreationDate

        public void setContentCreationDate​(@Nullable
                                   @Nullable NSDate value)
        This is the date that the contents of the item were created

      • setContentDescription

        public void setContentDescription​(@Nullable
                                  @Nullable java.lang.String value)
        An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.

      • setContentModificationDate

        public void setContentModificationDate​(@Nullable
                                       @Nullable NSDate value)
        This is the date that the contents of the item were last modified

      • setContentRating

        public void setContentRating​(@Nullable
                             @Nullable NSNumber value)
        Whether or not the item has explicit content. Should be 1 if explicit, 0 for clean.

      • setContentSources

        public void setContentSources​(@Nullable
                              @Nullable NSArray<java.lang.String> value)
        This attribute indicates where the item was obtained from. Examples: - downloaded file may refer to the site they were downloaded from,the refering URL, etc - files received by email may indicate who sent the file, the message subject, etc

      • setContentType

        public void setContentType​(@Nullable
                           @Nullable java.lang.String value)
        UTI Type pedigree for an item. Common types can be found in UTCoreTypes.h

      • setContentTypeTree

        public void setContentTypeTree​(@Nullable
                               @Nullable NSArray<java.lang.String> value)

      • setContentURL

        public void setContentURL​(@Nullable
                          @Nullable NSURL value)
        Optional file URL representing the content to be indexed Applications that are also 'Documents & Data' clients can set this property to allow Spotlight to deduplicate their searchable items against the iCloud Drive's items. When this property is set, Spotlight will not display the iCloud Drive's searchable items that have the same contentURL property.

      • setContributors

        public void setContributors​(@Nullable
                            @Nullable NSArray<java.lang.String> value)
        Used to designate the entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization or a service. Typically, the name of a Contributor should be used to indicate the entity.

      • setCopyright

        public void setCopyright​(@Nullable
                         @Nullable java.lang.String value)
        This is the copyright of the content.

      • setCountry

        public void setCountry​(@Nullable
                       @Nullable java.lang.String value)
        Provides full, publishable, name of the country/primary location where the intellectual property of the item was created,according to guidelines of the provider.

      • setCoverage

        public void setCoverage​(@Nullable
                        @Nullable NSArray<java.lang.String> value)
        Used to designate the extent or scope of the content of the resource. Coverage will typically include spatial location (a place name or geographic co-ordinates), temporal period (a period label, date, or date range) or jurisdiction (such as a named administrative entity). Recommended best practice is to select a value from a controlled vocabulary, and that, where appropriate, named places or time periods be used in preference to numeric identifiers such as sets of co-ordinates or date ranges.

      • setCreator

        public void setCreator​(@Nullable
                       @Nullable java.lang.String value)
        Application used to create the document content (e.g. "Word", "Framemaker", etc.).

      • setDeliveryType

        public void setDeliveryType​(@Nullable
                            @Nullable NSNumber value)
        The delivery type of the item. Should be 0 for fast start and 1 for RTSP.

      • setDirector

        public void setDirector​(@Nullable
                        @Nullable java.lang.String value)
        Director of the item (e.g. movie director)

      • setDisplayName

        public void setDisplayName​(@Nullable
                           @Nullable java.lang.String value)
        A localized string to be displayed in the UI for this item.

      • setDomainIdentifier

        public void setDomainIdentifier​(@Nullable
                                @Nullable java.lang.String value)
        This property has the same semantics as -[CSSearchableItem domainIdentifier]. It can be set on the contentAttributeSet property of a NSUserActivity instance and then used to delete the user activity by calling [[CSSearchableIndex defaultSearchableIndex] deleteSearchableItemsWithDomainIdentifiers:]. API-Since: 10.0

      • setDownloadedDate

        public void setDownloadedDate​(@Nullable
                              @Nullable NSDate value)
        This is the date that the file was last downloaded / received.

      • setDueDate

        public void setDueDate​(@Nullable
                       @Nullable NSDate value)
        Date this item is due.

      • setDuration

        public void setDuration​(@Nullable
                        @Nullable NSNumber value)
        This is the duration, in seconds, of the content of the item (if appropriate).

      • setEXIFGPSVersion

        public void setEXIFGPSVersion​(@Nullable
                              @Nullable java.lang.String value)
        The version of GPSInfoIFD header that was used to generate the metadata

      • setEXIFVersion

        public void setEXIFVersion​(@Nullable
                           @Nullable java.lang.String value)
        The verion of the EXIF header that was used to generate the metadata

      • setEditors

        public void setEditors​(@Nullable
                       @Nullable NSArray<java.lang.String> value)
        The list of editor/editors that have worked on this item.

      • setEmailAddresses

        public void setEmailAddresses​(@Nullable
                              @Nullable NSArray<java.lang.String> value)
        Email addresses for this item.

      • setEmailHeaders

        public void setEmailHeaders​(@Nullable
                            @Nullable NSDictionary<java.lang.String,​? extends NSArray<?>> value)
        Dictionary with all the headers of the message Keys are header names and values arrays of strings (because a header might be present multiple times in an email)

      • setEncodingApplications

        public void setEncodingApplications​(@Nullable
                                    @Nullable NSArray<java.lang.String> value)
        Software used to convert the original content into a PDF stream (e.g. "Distiller", etc.).

      • setEndDate

        public void setEndDate​(@Nullable
                       @Nullable NSDate value)
        End date for this item.

      • setExposureMode

        public void setExposureMode​(@Nullable
                            @Nullable NSNumber value)
        Mode that was used for the exposure. Should be 0 for AutoExposure, 1 for Manual, 2 for AutoBracket.

      • setExposureProgram

        public void setExposureProgram​(@Nullable
                               @Nullable java.lang.String value)
        The class of the program used by the camera to set exposure when the picture is taken (Manual, Normal, Aperture Priority, ...)

      • setExposureTime

        public void setExposureTime​(@Nullable
                            @Nullable NSNumber value)
        Time that the lens was open during exposure in seconds

      • setExposureTimeString

        public void setExposureTimeString​(@Nullable
                                  @Nullable java.lang.String value)
        The time of the exposure as a string, e.g. "1/250 seconds".

      • setFNumber

        public void setFNumber​(@Nullable
                       @Nullable NSNumber value)
        The focal length of the lens divided by the diameter of the aperture when the image was acquired.

      • setFileSize

        public void setFileSize​(@Nullable
                        @Nullable NSNumber value)
        Size of the document in MB.

      • setFlashOn

        public void setFlashOn​(@Nullable
                       @Nullable NSNumber value)
        Indicates if the flash was used to take the picture. Should be 1 if flash is on, 0 otherwise.

      • setFocalLength35mm

        public void setFocalLength35mm​(@Nullable
                               @Nullable NSNumber value)
        Indicates if the focal length is 35mm. Should be 1 if true, 0 otherwise

      • setFocalLength

        public void setFocalLength​(@Nullable
                           @Nullable NSNumber value)
        The actual focal length of the lens in mm.

      • setFontNames

        public void setFontNames​(@Nullable
                         @Nullable NSArray<java.lang.String> value)
        Array of font names used in the item.

      • setFullyFormattedAddress

        public void setFullyFormattedAddress​(@Nullable
                                     @Nullable java.lang.String value)
        The fully formatted address of the item (obtained from MapKit)

      • setGPSAreaInformation

        public void setGPSAreaInformation​(@Nullable
                                  @Nullable java.lang.String value)

      • setGPSDOP

        public void setGPSDOP​(@Nullable
                      @Nullable NSNumber value)

      • setGPSDateStamp

        public void setGPSDateStamp​(@Nullable
                            @Nullable NSDate value)

      • setGPSDestBearing

        public void setGPSDestBearing​(@Nullable
                              @Nullable NSNumber value)

      • setGPSDestDistance

        public void setGPSDestDistance​(@Nullable
                               @Nullable NSNumber value)

      • setGPSDestLatitude

        public void setGPSDestLatitude​(@Nullable
                               @Nullable NSNumber value)

      • setGPSDestLongitude

        public void setGPSDestLongitude​(@Nullable
                                @Nullable NSNumber value)

      • setGPSDifferental

        public void setGPSDifferental​(@Nullable
                              @Nullable NSNumber value)

      • setGPSMapDatum

        public void setGPSMapDatum​(@Nullable
                           @Nullable java.lang.String value)

      • setGPSMeasureMode

        public void setGPSMeasureMode​(@Nullable
                              @Nullable java.lang.String value)

      • setGPSProcessingMethod

        public void setGPSProcessingMethod​(@Nullable
                                   @Nullable java.lang.String value)

      • setGPSStatus

        public void setGPSStatus​(@Nullable
                         @Nullable java.lang.String value)

      • setGPSTrack

        public void setGPSTrack​(@Nullable
                        @Nullable NSNumber value)
        The direction of travel of the item, in degrees from true north.

      • setGeneralMIDISequence

        public void setGeneralMIDISequence​(@Nullable
                                   @Nullable NSNumber value)
        This attribute indicates whether the MIDI sequence contained in the file is setup for use with a General MIDI device. Should be 1 if true, 0 otherwise.

      • setGenre

        public void setGenre​(@Nullable
                     @Nullable java.lang.String value)
        Genre of the item (e.g. movie genre)

      • setHTMLContentData

        public void setHTMLContentData​(@Nullable
                               @Nullable NSData value)
        Contains the HTML content of the document encoded as NSData of UTF-8 encoded string.

      • setHasAlphaChannel

        public void setHasAlphaChannel​(@Nullable
                               @Nullable NSNumber value)
        Indicates if this image file has an alpha channel. Should be 0 for no alpha channel, 1 for alpha channel.

      • setHeadline

        public void setHeadline​(@Nullable
                        @Nullable java.lang.String value)
        A publishable entry providing a synopsis of the contents of the item.

      • setHiddenAdditionalRecipients

        public void setHiddenAdditionalRecipients​(@Nullable
                                          @Nullable NSArray<? extends CSPerson> value)
        An array of CSPerson objects representing the content of the Bcc: field in an email

      • setISOSpeed

        public void setISOSpeed​(@Nullable
                        @Nullable NSNumber value)
        The ISO Speed the camera was set to when the image was taken. Examples are 100, 200, 400, etc.

      • setIdentifier

        public void setIdentifier​(@Nullable
                          @Nullable java.lang.String value)
        Used to reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.

      • setImageDirection

        public void setImageDirection​(@Nullable
                              @Nullable NSNumber value)
        The direction of the item's image, in degrees from true north.

      • setImportantDates

        public void setImportantDates​(@Nullable
                              @Nullable NSArray<? extends NSDate> value)
        Important dates associated with this item

      • setInformation

        public void setInformation​(@Nullable
                           @Nullable java.lang.String value)
        Information about the item

      • setInstantMessageAddresses

        public void setInstantMessageAddresses​(@Nullable
                                       @Nullable NSArray<java.lang.String> value)
        Instant message addresses for this item.

      • setInstructions

        public void setInstructions​(@Nullable
                            @Nullable java.lang.String value)
        Other editorial instructions concerning the use of the item, such as embargoes and warnings.

      • setKeySignature

        public void setKeySignature​(@Nullable
                            @Nullable java.lang.String value)
        The musical key of the song/composition contained in an audio file. For example: C, Dm, F#m, Bb.

      • setKeywords

        public void setKeywords​(@Nullable
                        @Nullable NSArray<java.lang.String> value)
        Represents keywords associated with this particular item. Example Keywords might be Birthday,Important etc.

      • setKind

        public void setKind​(@Nullable
                    @Nullable java.lang.String value)
        Kind that this item represents.

      • setLanguages

        public void setLanguages​(@Nullable
                         @Nullable NSArray<java.lang.String> value)
        Used to designate the languages of the intellectual content of the resource. Recommended best practice for the values of the Language element is defined by BCP 47.

      • setLastUsedDate

        public void setLastUsedDate​(@Nullable
                            @Nullable NSDate value)
        This is the date that the item was last used

      • setLatitude

        public void setLatitude​(@Nullable
                        @Nullable NSNumber value)
        The latitude of the item in degrees north of the equator, expressed using the WGS84 datum. Negative values lie south of the equator.

      • setLayerNames

        public void setLayerNames​(@Nullable
                          @Nullable NSArray<java.lang.String> value)
        The names of the various layers in the file

      • setLensModel

        public void setLensModel​(@Nullable
                         @Nullable java.lang.String value)
        The model of the lens used to capture this image.

      • setLikelyJunk

        public void setLikelyJunk​(@NotNull
                          @NotNull NSNumber value)
        This attribute indicates if the document is likely to be considered junk. Should be 1 if true, 0 otherwise

      • setLocal

        public void setLocal​(@Nullable
                     @Nullable NSNumber value)
        Whether or not the item is local. Should be 1 if true, 0 otherwise.

      • setLongitude

        public void setLongitude​(@Nullable
                         @Nullable NSNumber value)
        The longitude of the item in degrees east of the prime meridian, expressed using the WGS84 datum. Negative values lie west of the prime meridian.

      • setLyricist

        public void setLyricist​(@Nullable
                        @Nullable java.lang.String value)
        The lyricist/text writer for song/composition contained in the audio file.

      • setMailboxIdentifiers

        public void setMailboxIdentifiers​(@Nullable
                                  @Nullable NSArray<java.lang.String> value)
        Array of Mailbox identifiers associated with the item. e.g. CSMailboxInbox, CSMailboxDrafts, CSMailboxSent, or a custom identifier etc.

      • setMaxAperture

        public void setMaxAperture​(@Nullable
                           @Nullable NSNumber value)
        The smallest F number of the lens. The unit is the APEX value. Ordinarily it is given in the range of 00.00 to 99.99.

      • setMediaTypes

        public void setMediaTypes​(@Nullable
                          @Nullable NSArray<java.lang.String> value)
        Media types present in the content

      • setMetadataModificationDate

        public void setMetadataModificationDate​(@Nullable
                                        @Nullable NSDate value)
        This is the date that the last metadata attribute was changed.

      • setMeteringMode

        public void setMeteringMode​(@Nullable
                            @Nullable java.lang.String value)
        The metering mode for the image (Average, Partial, Pattern, ...)

      • setMusicalGenre

        public void setMusicalGenre​(@Nullable
                            @Nullable java.lang.String value)
        The musical genre of the song/composition contained in the audio file. For example: Jazz, Pop, Rock, Classical.

      • setMusicalInstrumentCategory

        public void setMusicalInstrumentCategory​(@Nullable
                                         @Nullable java.lang.String value)
        Meta data attribute that stores the category of instrument. Files should have an instrument associated with them ("Other Instrument" is provided as a catch-all). For some categories, like "Keyboards" there are instrument names which provide a more detailed instrument definition (e.g., Piano,Organ, etc.)

      • setMusicalInstrumentName

        public void setMusicalInstrumentName​(@Nullable
                                     @Nullable java.lang.String value)
        Meta data attribute that stores the name of instrument (relative to the instrument category) Files can have an instrument name associated with them if they have certain instrument categories (e.g., the category Percussion has multiple instruments, including Conga and Bongo).

      • setNamedLocation

        public void setNamedLocation​(@Nullable
                             @Nullable java.lang.String value)
        The name of the location or point of interest associated with the item. The name may be user provided.

      • setOrganizations

        public void setOrganizations​(@Nullable
                             @Nullable NSArray<java.lang.String> value)
        Used to indicate company/Organization that created the document.

      • setOrientation

        public void setOrientation​(@Nullable
                           @Nullable NSNumber value)
        The orientation of the data. Should be 0 for Landscape or 1 for Portrait.

      • setOriginalFormat

        public void setOriginalFormat​(@Nullable
                              @Nullable java.lang.String value)
        Original format of the movie

      • setOriginalSource

        public void setOriginalSource​(@Nullable
                              @Nullable java.lang.String value)
        Original source of the movie

      • setPageCount

        public void setPageCount​(@Nullable
                         @Nullable NSNumber value)
        Number of pages in the item.

      • setPageHeight

        public void setPageHeight​(@Nullable
                          @Nullable NSNumber value)
        Height in points (72 points per inch) of the document page (first page only for PDF's - other pages within the PDF may not be the same height).

      • setPageWidth

        public void setPageWidth​(@Nullable
                         @Nullable NSNumber value)
        Width in points (72 points per inch) of the document page (first page only for PDF's - other pages within the PDF may not be the same width).

      • setParticipants

        public void setParticipants​(@Nullable
                            @Nullable NSArray<java.lang.String> value)
        The list of people who are visible in an image or movie or written about in a document.

      • setPath

        public void setPath​(@Nullable
                    @Nullable java.lang.String value)
        This is the complete path to the item.

      • setPerformers

        public void setPerformers​(@Nullable
                          @Nullable NSArray<java.lang.String> value)
        Performers in the movie

      • setPhoneNumbers

        public void setPhoneNumbers​(@Nullable
                            @Nullable NSArray<java.lang.String> value)
        Phone numbers for this item.

      • setPixelCount

        public void setPixelCount​(@Nullable
                          @Nullable NSNumber value)
        The total number of pixels in the item.

      • setPixelHeight

        public void setPixelHeight​(@Nullable
                           @Nullable NSNumber value)
        The height of the item in pixels (ie Image height or Video frame height)

      • setPixelWidth

        public void setPixelWidth​(@Nullable
                          @Nullable NSNumber value)
        The width of the item in pixels (ie Image width or Video frame width)

      • setPlayCount

        public void setPlayCount​(@Nullable
                         @Nullable NSNumber value)
        User play count of this item

      • setPostalCode

        public void setPostalCode​(@Nullable
                          @Nullable java.lang.String value)
        The postal code for the item according to guidelines established by the provider.

      • setPrimaryRecipients

        public void setPrimaryRecipients​(@Nullable
                                 @Nullable NSArray<? extends CSPerson> value)
        An array of CSPerson objects representing the content of the To: field in an email

      • setProducer

        public void setProducer​(@Nullable
                        @Nullable java.lang.String value)
        Producer of the content

      • setProfileName

        public void setProfileName​(@Nullable
                           @Nullable java.lang.String value)
        Name of the color profile used for the image

      • setProjects

        public void setProjects​(@Nullable
                        @Nullable NSArray<java.lang.String> value)
        The list of projects that this item is part of. For example if you were working on a movie, all of the movie files could be marked as belonging to the project "My movie"

      • setPublishers

        public void setPublishers​(@Nullable
                          @Nullable NSArray<java.lang.String> value)
        Used to designate the entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.

      • setRating

        public void setRating​(@Nullable
                      @Nullable NSNumber value)
        User rating of this item out of 5 stars

      • setRatingDescription

        public void setRatingDescription​(@Nullable
                                 @Nullable java.lang.String value)
        A description of the rating. E.g. the number of reviewers.

      • setRecipientAddresses

        public void setRecipientAddresses​(@Nullable
                                  @Nullable NSArray<java.lang.String> value)
        This attribute indicates the recipient addresses of the document.

      • setRecipientEmailAddresses

        public void setRecipientEmailAddresses​(@Nullable
                                       @Nullable NSArray<java.lang.String> value)
        This attribute indicates the reciepients email addresses. (This is always the email address, and not the human readable version).

      • setRecipientNames

        public void setRecipientNames​(@Nullable
                              @Nullable NSArray<java.lang.String> value)
        This attribute indicates the recipients of this item.

      • setRecordingDate

        public void setRecordingDate​(@Nullable
                             @Nullable NSDate value)
        The recording date of the song/composition. This information differs from the contentCreationDate attribute as it indicates the date that the 'art' was created, in contrast to contentCreationDate which for example, could indicate the creation date of an edited or 'mastered' version of the original art.

      • setRedEyeOn

        public void setRedEyeOn​(@Nullable
                        @Nullable NSNumber value)
        Indicates if red-eye reduction was used to take the picture. Should be 0 for no red-eye, 1 for red-eye

      • setRelatedUniqueIdentifier

        public void setRelatedUniqueIdentifier​(@Nullable
                                       @Nullable java.lang.String value)
        For activities, this is the unique identifier for the item this activity is related to. If the item doesn't exist in the index, the activity will not get stored. When the item is deleted, the activity will also be deleted.

      • setResolutionHeightDPI

        public void setResolutionHeightDPI​(@Nullable
                                   @Nullable NSNumber value)
        Resolution height of this image in DPI

      • setResolutionWidthDPI

        public void setResolutionWidthDPI​(@Nullable
                                  @Nullable NSNumber value)
        Resolution width of this image in DPI

      • setRights

        public void setRights​(@Nullable
                      @Nullable java.lang.String value)
        Used to provide a link to information about rights held in and over the resource. Typically a Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information often encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. If the rights element is absent, no assumptions can be made about the status of these and other rights with respect to the resource.

      • setRole

        public void setRole​(@Nullable
                    @Nullable java.lang.String value)
        Used to indicate the role of the document creator

      • setSecurityMethod

        public void setSecurityMethod​(@Nullable
                              @Nullable java.lang.String value)
        Security (encryption) method used in the file

      • setSpeed

        public void setSpeed​(@Nullable
                     @Nullable NSNumber value)
        The speed of the item, in kilometers per hour.

      • setStartDate

        public void setStartDate​(@Nullable
                         @Nullable NSDate value)
        Start date of this item.

      • setStateOrProvince

        public void setStateOrProvince​(@Nullable
                               @Nullable java.lang.String value)
        Identifies Province/State of origin according to guidelines established by the provider.

      • setStreamable

        public void setStreamable​(@Nullable
                          @Nullable NSNumber value)
        Whether the content is prepared for streaming. Should be 0 for not streamable, 1 for streamable.

      • setSubThoroughfare

        public void setSubThoroughfare​(@Nullable
                               @Nullable java.lang.String value)
        The sub-location (e.g., street number) for the item according to guidelines established by the provider.

      • setSubject

        public void setSubject​(@Nullable
                       @Nullable java.lang.String value)
        Subject of the this item.

      • setSupportsNavigation

        public void setSupportsNavigation​(@Nullable
                                  @Nullable NSNumber value)
        If supportsNavigation is set to 1, and the item has the latitude and longitude properties set, then the latitude and longitude may be used for navigation. For example, supportsNavigation would be set on a restaurant review, but not on a photo.

      • setSupportsPhoneCall

        public void setSupportsPhoneCall​(@Nullable
                                 @Nullable NSNumber value)
        If supportsPhoneCall is 1 and the item has the phoneNumbers property, then the phone number may be used to initiate phone calls. This should be used to indicate that using the phone number is appropriate, and a primary action for the user. For example, supportsPhoneCall would be set on a business, but not an academic paper that happens to have phone numbers for the authors or the institution.

      • setTempo

        public void setTempo​(@Nullable
                     @Nullable NSNumber value)
        The tempo of the music contained in the audio file in Beats Per Minute.

      • setTextContent

        public void setTextContent​(@Nullable
                           @Nullable java.lang.String value)
        Contains the text content of the document.

      • setTheme

        public void setTheme​(@Nullable
                     @Nullable java.lang.String value)
        Theme of the this item.

      • setThoroughfare

        public void setThoroughfare​(@Nullable
                            @Nullable java.lang.String value)
        The location (e.g., street name) for the item according to guidelines established by the provider.

      • setThumbnailData

        public void setThumbnailData​(@Nullable
                             @Nullable NSData value)
        Optional image data for thumbnail for this item

      • setThumbnailURL

        public void setThumbnailURL​(@Nullable
                            @Nullable NSURL value)
        Optional file URL pointing to a thumbnail image for this item

      • setTimeSignature

        public void setTimeSignature​(@Nullable
                             @Nullable java.lang.String value)
        The time signature of the musical composition contained in the audio/MIDI file. For example: "4/4", "7/8".

      • setTimestamp

        public void setTimestamp​(@Nullable
                         @Nullable NSDate value)
        The timestamp on the item. This generally is used to indicate the time at which the event captured by the item took place.

      • setTitle

        public void setTitle​(@Nullable
                     @Nullable java.lang.String value)
        The title of this particular item. Title of the document, or it could be the title of this mp3 or a subject of a mail message.

      • setTotalBitRate

        public void setTotalBitRate​(@Nullable
                            @Nullable NSNumber value)
        The total bit rate (audio & video combined) of the media

      • setURL

        public void setURL​(@Nullable
                   @Nullable NSURL value)
        URL of the item

      • setVersion

        public void setVersion​(@Nullable
                       @Nullable java.lang.String value)
        A version specifier for this item.

      • setVideoBitRate

        public void setVideoBitRate​(@Nullable
                            @Nullable NSNumber value)
        The video bit rate

      • setWeakRelatedUniqueIdentifier

        public void setWeakRelatedUniqueIdentifier​(@Nullable
                                           @Nullable java.lang.String value)
        For activities, this is the unique identifier for an item this activity is related to. Unlike relatedUniqueIdentifier, this attribute does not link the life time of the items. API-Since: 10.0

      • setWhiteBalance

        public void setWhiteBalance​(@Nullable
                            @Nullable NSNumber value)
        The white balance setting of the camera when the image was acquired. Should be 0 for Auto or 1 for Manual.

      • speed

        @Nullable
public @Nullable NSNumber speed()
        The speed of the item, in kilometers per hour.

      • startDate

        @Nullable
public @Nullable NSDate startDate()
        Start date of this item.

      • stateOrProvince

        @Nullable
public @Nullable java.lang.String stateOrProvince()
        Identifies Province/State of origin according to guidelines established by the provider.

      • subThoroughfare

        @Nullable
public @Nullable java.lang.String subThoroughfare()
        The sub-location (e.g., street number) for the item according to guidelines established by the provider.

      • subject

        @Nullable
public @Nullable java.lang.String subject()
        Subject of the this item.

      • supportsNavigation

        @Nullable
public @Nullable NSNumber supportsNavigation()
        If supportsNavigation is set to 1, and the item has the latitude and longitude properties set, then the latitude and longitude may be used for navigation. For example, supportsNavigation would be set on a restaurant review, but not on a photo.

      • supportsPhoneCall

        @Nullable
public @Nullable NSNumber supportsPhoneCall()
        If supportsPhoneCall is 1 and the item has the phoneNumbers property, then the phone number may be used to initiate phone calls. This should be used to indicate that using the phone number is appropriate, and a primary action for the user. For example, supportsPhoneCall would be set on a business, but not an academic paper that happens to have phone numbers for the authors or the institution.

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding

      • tempo

        @Nullable
public @Nullable NSNumber tempo()
        The tempo of the music contained in the audio file in Beats Per Minute.

      • textContent

        @Nullable
public @Nullable java.lang.String textContent()
        Contains the text content of the document.

      • theme

        @Nullable
public @Nullable java.lang.String theme()
        Theme of the this item.

      • thoroughfare

        @Nullable
public @Nullable java.lang.String thoroughfare()
        The location (e.g., street name) for the item according to guidelines established by the provider.

      • thumbnailData

        @Nullable
public @Nullable NSData thumbnailData()
        Optional image data for thumbnail for this item

      • thumbnailURL

        @Nullable
public @Nullable NSURL thumbnailURL()
        Optional file URL pointing to a thumbnail image for this item

      • timeSignature

        @Nullable
public @Nullable java.lang.String timeSignature()
        The time signature of the musical composition contained in the audio/MIDI file. For example: "4/4", "7/8".

      • timestamp

        @Nullable
public @Nullable NSDate timestamp()
        The timestamp on the item. This generally is used to indicate the time at which the event captured by the item took place.

      • title

        @Nullable
public @Nullable java.lang.String title()
        The title of this particular item. Title of the document, or it could be the title of this mp3 or a subject of a mail message.

      • totalBitRate

        @Nullable
public @Nullable NSNumber totalBitRate()
        The total bit rate (audio & video combined) of the media

      • version

        @Nullable
public @Nullable java.lang.String version()
        A version specifier for this item.

      • videoBitRate

        @Nullable
public @Nullable NSNumber videoBitRate()
        The video bit rate

      • weakRelatedUniqueIdentifier

        @Nullable
public @Nullable java.lang.String weakRelatedUniqueIdentifier()
        For activities, this is the unique identifier for an item this activity is related to. Unlike relatedUniqueIdentifier, this attribute does not link the life time of the items. API-Since: 10.0

      • whiteBalance

        @Nullable
public @Nullable NSNumber whiteBalance()
        The white balance setting of the camera when the image was acquired. Should be 0 for Auto or 1 for Manual.

      • isUserCreated

        @Nullable
public @Nullable NSNumber isUserCreated()
        This property is used to indicate if the indexed item was created by the user It is used to distinguish pushed app content from content that required explicit user interaction Example content that may set this field: user created notes, documents API-Since: 11.0

      • isUserCurated

        @Nullable
public @Nullable NSNumber isUserCurated()
        This property is used to indicate if the indexed item was selected by the user It is used to distinguish pushed app content from content that a user has chosen to add to a collection Example content that may set this field: downloaded media content, bookmarked websites/news articles API-Since: 11.0

      • isUserOwned

        @Nullable
public @Nullable NSNumber isUserOwned()
        This property is used to indicate if the indexed item has been purchased or otherwise acquired by the user Example content are songs bought by a user and made searchable API-Since: 11.0

      • providerDataTypeIdentifiers

        @Nullable
public @Nullable NSArray<java.lang.String> providerDataTypeIdentifiers()
        An array of types identifiers that owner can provided a NSData representation. API-Since: 11.0

      • providerFileTypeIdentifiers

        @Nullable
public @Nullable NSArray<java.lang.String> providerFileTypeIdentifiers()
        An array of types identifiers that owner can provided a NSURL to file representation. API-Since: 11.0

      • providerInPlaceFileTypeIdentifiers

        @Nullable
public @Nullable NSArray<java.lang.String> providerInPlaceFileTypeIdentifiers()
        An array of types identifiers that owner can provided a NSURL to inplace file representation. API-Since: 11.0

      • rankingHint

        @Nullable
public @Nullable NSNumber rankingHint()
        This property allows content donors to provide a ranking signal to each indexed item It will inform the ranker, allowing it to distinguish more easily between otherwise similar items This is query-independent and should be used to indicate the relative importance of an item w.r.t. all other items for the same application Expected value ∈ [0-100]; preferably integral values Monotonically increasing with larger values being considered better results API-Since: 11.0

      • setProviderDataTypeIdentifiers

        public void setProviderDataTypeIdentifiers​(@Nullable
                                           @Nullable NSArray<java.lang.String> value)
        An array of types identifiers that owner can provided a NSData representation. API-Since: 11.0

      • setProviderFileTypeIdentifiers

        public void setProviderFileTypeIdentifiers​(@Nullable
                                           @Nullable NSArray<java.lang.String> value)
        An array of types identifiers that owner can provided a NSURL to file representation. API-Since: 11.0

      • setProviderInPlaceFileTypeIdentifiers

        public void setProviderInPlaceFileTypeIdentifiers​(@Nullable
                                                  @Nullable NSArray<java.lang.String> value)
        An array of types identifiers that owner can provided a NSURL to inplace file representation. API-Since: 11.0

      • setRankingHint

        public void setRankingHint​(@Nullable
                           @Nullable NSNumber value)
        This property allows content donors to provide a ranking signal to each indexed item It will inform the ranker, allowing it to distinguish more easily between otherwise similar items This is query-independent and should be used to indicate the relative importance of an item w.r.t. all other items for the same application Expected value ∈ [0-100]; preferably integral values Monotonically increasing with larger values being considered better results API-Since: 11.0

      • setUserCreated

        public void setUserCreated​(@Nullable
                           @Nullable NSNumber value)
        This property is used to indicate if the indexed item was created by the user It is used to distinguish pushed app content from content that required explicit user interaction Example content that may set this field: user created notes, documents API-Since: 11.0

      • setUserCurated

        public void setUserCurated​(@Nullable
                           @Nullable NSNumber value)
        This property is used to indicate if the indexed item was selected by the user It is used to distinguish pushed app content from content that a user has chosen to add to a collection Example content that may set this field: downloaded media content, bookmarked websites/news articles API-Since: 11.0

      • setUserOwned

        public void setUserOwned​(@Nullable
                         @Nullable NSNumber value)
        This property is used to indicate if the indexed item has been purchased or otherwise acquired by the user Example content are songs bought by a user and made searchable API-Since: 11.0

      • actionIdentifiers

        @NotNull
public @NotNull NSArray<java.lang.String> actionIdentifiers()
        An array of strings that are the custom action identifiers. API-Since: 15.0

      • darkThumbnailURL

        @Nullable
public @Nullable NSURL darkThumbnailURL()
        Optional file URL pointing to a thumbnail image for this item that will be preferred in dark appearances

      • setActionIdentifiers

        public void setActionIdentifiers​(@NotNull
                                 @NotNull NSArray<java.lang.String> value)
        An array of strings that are the custom action identifiers. API-Since: 15.0

      • setDarkThumbnailURL

        public void setDarkThumbnailURL​(@Nullable
                                @Nullable NSURL value)
        Optional file URL pointing to a thumbnail image for this item that will be preferred in dark appearances

      • setSharedItemContentType

        public void setSharedItemContentType​(@Nullable
                                     @Nullable UTType value)
        The file type used for the share action. API-Since: 15.0

      • sharedItemContentType

        @Nullable
public @Nullable UTType sharedItemContentType()
        The file type used for the share action. API-Since: 15.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.