corespotlight

func (CSCustomAttributeKey) Autorelease ¶

func (c CSCustomAttributeKey) Autorelease() CSCustomAttributeKey

Autorelease adds the receiver to the current autorelease pool.

func (CSCustomAttributeKey) EncodeWithCoder ¶

func (c CSCustomAttributeKey) EncodeWithCoder(coder foundation.INSCoder)

func (CSCustomAttributeKey) Init ¶

func (c CSCustomAttributeKey) Init() CSCustomAttributeKey

Init initializes the instance.

func (CSCustomAttributeKey) InitWithCoder ¶

func (c CSCustomAttributeKey) InitWithCoder(coder foundation.INSCoder) CSCustomAttributeKey

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/init(coder:)

func (CSCustomAttributeKey) InitWithKeyName ¶

func (c CSCustomAttributeKey) InitWithKeyName(keyName string) CSCustomAttributeKey

Returns a new custom attribute key with the specified name.

keyName: The name of the custom attribute for use as a key in a CSSearchableItemAttributeSet. The key name must be a string that contains only ASCII characters and no punctuation other than the underscore (that is “_”). The prefix `kMD` is reserved.

Return Value ¶

A new custom attribute key.

Discussion ¶

To create custom attribute key names, use a reverse DNS format that includes your company name and does not include the period character (”.”). For example, a key name of the form `com_mycompany_myapp_mykeyname` works well.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/init(keyName:)

func (CSCustomAttributeKey) InitWithKeyNameSearchableSearchableByDefaultUniqueMultiValued ¶

func (c CSCustomAttributeKey) InitWithKeyNameSearchableSearchableByDefaultUniqueMultiValued(keyName string, searchable bool, searchableByDefault bool, unique bool, multiValued bool) CSCustomAttributeKey

Returns a new custom attribute key with the specified name and properties.

keyName: The name of the custom attribute for use as a key in a CSSearchableItemAttributeSet. The key name must be a string that contains only ASCII characters and no punctuation other than the underscore (that is, “_”). The prefix `kMD` is reserved.

searchable: A Boolean value that indicates if the attribute can be specified as a search term.

searchableByDefault: A Boolean value that indicates if the attribute should be searchable by default.

unique: A Boolean value that indicates if duplicate values should be treated as the same value to save storage space.

multiValued: A Boolean value that indicates if the attribute is likely to have multiple values, such as arrays, associated with it.

Return Value ¶

A new custom attribute key with the specified name and properties.

Discussion ¶

To create custom attribute key names, it’s recommended that you use a reverse DNS format that includes your company name and does not include the period character (”.”). For example, a key name of the form `com_mycompany_myapp_mykeyname` works well.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/init(keyName:searchable:searchableByDefault:unique:multiValued:)

func (CSCustomAttributeKey) IsMultiValued ¶

func (c CSCustomAttributeKey) IsMultiValued() bool

A Boolean value that indicates if the custom attribute is likely to have multiple values, such as arrays, associated with it.

Discussion ¶

The default value of this property is `false`.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/isMultiValued

func (CSCustomAttributeKey) IsSearchable ¶

func (c CSCustomAttributeKey) IsSearchable() bool

A Boolean value that indicates if the custom attribute can be specified as a search term.

Discussion ¶

The default value of this property is `true`.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/isSearchable

func (CSCustomAttributeKey) IsSearchableByDefault ¶

func (c CSCustomAttributeKey) IsSearchableByDefault() bool

A Boolean value that indicates if the custom attribute should be searchable by default.

Discussion ¶

The default value of this property is `false`.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/isSearchableByDefault

func (CSCustomAttributeKey) IsUnique ¶

func (c CSCustomAttributeKey) IsUnique() bool

A Boolean value that indicates if duplicate custom attribute values should be treated as the same value to save storage space.

Discussion ¶

The default value of this property is `false`.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/isUnique

func (CSCustomAttributeKey) KeyName ¶

func (c CSCustomAttributeKey) KeyName() string

The name of the custom attribute key.

Discussion ¶

The key name is a string that contains only ASCII characters and no punctuation other than the underscore (that is “_”). The prefix `kMD` is reserved. To create a custom attribute key name, it’s recommended that you use a reverse DNS format that includes your company name and does not include the period character (”.”). For example, a key name of the form `com_mycompany_myapp_mykeyname` works well.

See: https://developer.apple.com/documentation/CoreSpotlight/CSCustomAttributeKey/keyName

func (CSCustomAttributeKeyClass) Alloc ¶

func (cc CSCustomAttributeKeyClass) Alloc() CSCustomAttributeKey

Alloc allocates memory for a new instance of the class.

func (CSCustomAttributeKeyClass) Class ¶

func (cc CSCustomAttributeKeyClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSImportExtension) Autorelease ¶

func (c CSImportExtension) Autorelease() CSImportExtension

Autorelease adds the receiver to the current autorelease pool.

func (CSImportExtension) Init ¶

func (c CSImportExtension) Init() CSImportExtension

Init initializes the instance.

func (CSImportExtension) UpdateAttributesForFileAtURLError ¶

func (c CSImportExtension) UpdateAttributesForFileAtURLError(attributes ICSSearchableItemAttributeSet, contentURL foundation.NSURL) (bool, error)

Provides searchable attributes for a file at the specified URL.

attributes: The attribute set for the file at `contentURL`.

contentURL: The URL of the file to provide attributes for.

Discussion ¶

When Core Spotlight invokes this method, update the properties of the attribute set according to the content in the specified file. For a complete list of properties available, see CSSearchableItemAttributeSet.

See: https://developer.apple.com/documentation/CoreSpotlight/CSImportExtension/update(_:forFileAt:)

func (CSImportExtensionClass) Alloc ¶

func (cc CSImportExtensionClass) Alloc() CSImportExtension

Alloc allocates memory for a new instance of the class.

func (CSImportExtensionClass) Class ¶

func (cc CSImportExtensionClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSIndexErrorCode) String ¶

func (e CSIndexErrorCode) String() string

func (CSIndexExtensionRequestHandler) Autorelease ¶

func (c CSIndexExtensionRequestHandler) Autorelease() CSIndexExtensionRequestHandler

Autorelease adds the receiver to the current autorelease pool.

func (CSIndexExtensionRequestHandler) DataForSearchableIndexItemIdentifierTypeIdentifierError ¶

func (c CSIndexExtensionRequestHandler) DataForSearchableIndexItemIdentifierTypeIdentifierError(searchableIndex ICSSearchableIndex, itemIdentifier string, typeIdentifier string) (foundation.NSData, error)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/data(for:itemIdentifier:typeIdentifier:)

func (CSIndexExtensionRequestHandler) FileURLForSearchableIndexItemIdentifierTypeIdentifierInPlaceError ¶

func (c CSIndexExtensionRequestHandler) FileURLForSearchableIndexItemIdentifierTypeIdentifierInPlaceError(searchableIndex ICSSearchableIndex, itemIdentifier string, typeIdentifier string, inPlace bool) (foundation.NSURL, error)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/fileURL(for:itemIdentifier:typeIdentifier:inPlace:)

func (CSIndexExtensionRequestHandler) Init ¶

func (c CSIndexExtensionRequestHandler) Init() CSIndexExtensionRequestHandler

Init initializes the instance.

func (CSIndexExtensionRequestHandler) SearchableIndexDidFinishThrottle ¶

func (c CSIndexExtensionRequestHandler) SearchableIndexDidFinishThrottle(searchableIndex ICSSearchableIndex)

Tells the delegate that the index throttling has finished.

searchableIndex: The index that was throttled.

Discussion ¶

In some situations, such as when the device is using battery only, the system may throttle indexing to save power. You can implement this method to be notified when throttling is finished so that your app can resume its standard indexing behavior.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndexDidFinishThrottle(_:)

func (CSIndexExtensionRequestHandler) SearchableIndexDidThrottle ¶

func (c CSIndexExtensionRequestHandler) SearchableIndexDidThrottle(searchableIndex ICSSearchableIndex)

Tells the delegate that indexing is being throttled.

searchableIndex: The indexing that’s being throttled.

Discussion ¶

In some situations, such as when the device is using battery only, the system may throttle indexing to save power. You can implement this method to be notified of this situation so that you can respond by, for example, prioritizing the items to index.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndexDidThrottle(_:)

func (CSIndexExtensionRequestHandler) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandler ¶

func (c CSIndexExtensionRequestHandler) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandler(searchableIndex ICSSearchableIndex, acknowledgementHandler VoidHandler)

Tells the delegate to reindex all searchable data and clear all local state information.

searchableIndex: The index in which to reindex the searchable data. The delegate or app extension should pass `searchableIndex` to CSSearchableIndex.IndexSearchableItemsCompletionHandler.

acknowledgementHandler: The handler to call after all client state has been saved. Note that if the app passes client state information in a batch (for example, by calling CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler), the acknowledgement handler can be called immediately.

The delegate or app extension must call the acknowledgement handler after all client state information has been saved, so that the indexer can call this method again in case of a crash.

Discussion ¶

Typically, the index tells the delegate to reindex its searchable data and clear local state when the index has been lost. An app extension should not use the index passed in `searchableIndex` when a custom data protection class is needed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndex(_:reindexAllSearchableItemsWithAcknowledgementHandler:)

func (CSIndexExtensionRequestHandler) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandlerSync ¶

func (c CSIndexExtensionRequestHandler) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandlerSync(ctx context.Context, searchableIndex ICSSearchableIndex) error

SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandlerSync is a synchronous wrapper around CSIndexExtensionRequestHandler.SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSIndexExtensionRequestHandler) SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler ¶

func (c CSIndexExtensionRequestHandler) SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler(searchableIndex ICSSearchableIndex, identifiers []string, acknowledgementHandler VoidHandler)

Tells the delegate to reindex the searchable items associated with the specified identifiers.

searchableIndex: The index in which to reindex the specified searchable data. To update the state of the items, the delegate or app extension should call CSSearchableIndex.IndexSearchableItemsCompletionHandler passing in `searchableIndex`.

identifiers: An array of identifiers that specify searchable items.

acknowledgementHandler: The handler to call after all client state has been saved. Note that if the app passes client state information in a batch (for example, by calling CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler), the acknowledgement handler can be called immediately.

The delegate or app extension must call the acknowledgement handler after all client state information has been saved, so that the indexer can call this method again in case of a crash.

Discussion ¶

An app extension should not use the index passed in `searchableIndex` when a custom data protection class is needed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndex(_:reindexSearchableItemsWithIdentifiers:acknowledgementHandler:)

func (CSIndexExtensionRequestHandler) SearchableItemsDidUpdate ¶

func (c CSIndexExtensionRequestHandler) SearchableItemsDidUpdate(items []CSSearchableItem)

Tells the delegate that the framework updated the list of searchable items.

items: The items the framework updated.

Discussion ¶

The framework calls this method when it updates an item with specific attributes; see CSSearchableItem.UpdateListenerOptions for Apple Intelligence attributes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItemsDidUpdate(_:)

func (CSIndexExtensionRequestHandler) SearchableItemsForIdentifiersProtectionClassSearchableItemsHandler ¶

func (c CSIndexExtensionRequestHandler) SearchableItemsForIdentifiersProtectionClassSearchableItemsHandler(identifiers []string, protectionClass foundation.NSFileProtectionType, searchableItemsHandler CSSearchableItemArrayHandler)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItems(forIdentifiers:protectionClass:searchableItemsHandler:)

func (CSIndexExtensionRequestHandler) SearchableItemsForIdentifiersSearchableItemsHandler ¶

func (c CSIndexExtensionRequestHandler) SearchableItemsForIdentifiersSearchableItemsHandler(identifiers []string, searchableItemsHandler CSSearchableItemArrayHandler)

Requests that the delegate provide searchable items for the provided identifiers.

identifiers: An array of strings that represent the identifiers.

searchableItemsHandler: A method the framework calls that provides an array of CSSearchableItem objects.

Discussion ¶

Use this method to provide the framework with a list of identifiers to search for.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItems(forIdentifiers:searchableItemsHandler:)

func (CSIndexExtensionRequestHandlerClass) Alloc ¶

func (cc CSIndexExtensionRequestHandlerClass) Alloc() CSIndexExtensionRequestHandler

Alloc allocates memory for a new instance of the class.

func (CSIndexExtensionRequestHandlerClass) Class ¶

func (cc CSIndexExtensionRequestHandlerClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSLocalizedString) Autorelease ¶

func (c CSLocalizedString) Autorelease() CSLocalizedString

Autorelease adds the receiver to the current autorelease pool.

func (CSLocalizedString) Init ¶

func (c CSLocalizedString) Init() CSLocalizedString

Init initializes the instance.

func (CSLocalizedString) InitWithLocalizedStrings ¶

func (c CSLocalizedString) InitWithLocalizedStrings(localizedStrings foundation.INSDictionary) CSLocalizedString

Initializes a CSLocalizedString object with the specified dictionary of localized strings.

localizedStrings: A dictionary in which each key-value pair consists of a language designator and a localized string. For example, you might pass in a dictionary like `@{@"en":@"Email Message"}`.

Return Value ¶

An object that contains the localized versions for a specific string.

See: https://developer.apple.com/documentation/CoreSpotlight/CSLocalizedString/init(localizedStrings:)

func (CSLocalizedString) LocalizedString ¶

func (c CSLocalizedString) LocalizedString() string

Returns the localized string for the current language.

Return Value ¶

The localized string for the current language.

See: https://developer.apple.com/documentation/CoreSpotlight/CSLocalizedString/localizedString()

func (CSLocalizedStringClass) Alloc ¶

func (cc CSLocalizedStringClass) Alloc() CSLocalizedString

Alloc allocates memory for a new instance of the class.

func (CSLocalizedStringClass) Class ¶

func (cc CSLocalizedStringClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSPerson) Autorelease ¶

func (c CSPerson) Autorelease() CSPerson

Autorelease adds the receiver to the current autorelease pool.

func (CSPerson) ContactIdentifier ¶

func (c CSPerson) ContactIdentifier() string

The identifier for the contact associated with the person.

Discussion ¶

When you use the contact’s identifier value for the optional CSPerson.ContactIdentifier property, it enables a direct way to look up the associated contact.

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/contactIdentifier

func (CSPerson) DisplayName ¶

func (c CSPerson) DisplayName() string

A display name for the person.

Discussion ¶

Use this optional property to provide a name for the person object that can be displayed to users.

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/displayName

func (CSPerson) EncodeWithCoder ¶

func (c CSPerson) EncodeWithCoder(coder foundation.INSCoder)

func (CSPerson) HandleIdentifier ¶

func (c CSPerson) HandleIdentifier() string

A key that identifies the type of contact property represented by the person object’s handle.

Discussion ¶

The value of this property is a CNContact property key, such as CNContactPhoneNumbersKey or CNContactEmailAddressesKey.

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/handleIdentifier

func (CSPerson) Handles ¶

func (c CSPerson) Handles() []string

An array of contact handles related to the person.

Discussion ¶

Contact handles can include phone numbers, email addresses, and URLs. For additional contact handles, see Metadata Keys in CNContact.

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/handles

func (CSPerson) Init ¶

func (c CSPerson) Init() CSPerson

Init initializes the instance.

func (CSPerson) InitWithCoder ¶

func (c CSPerson) InitWithCoder(coder foundation.INSCoder) CSPerson

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/init(coder:)

func (CSPerson) InitWithDisplayNameHandlesHandleIdentifier ¶

func (c CSPerson) InitWithDisplayNameHandlesHandleIdentifier(displayName string, handles []string, handleIdentifier string) CSPerson

Returns a new CSPerson object initialized with the specified display name and contact attributes.

displayName: The name of the person in a user-displayable string.

handles: An array of contact handles, such as phone number or email address.

handleIdentifier: A property key that specifies a handle type, such as CNContactEmailAddressesKey.

Return Value ¶

An initialized person object that represents a user’s contact.

See: https://developer.apple.com/documentation/CoreSpotlight/CSPerson/init(displayName:handles:handleIdentifier:)

func (CSPerson) SetContactIdentifier ¶

func (c CSPerson) SetContactIdentifier(value string)

func (CSPersonClass) Alloc ¶

func (cc CSPersonClass) Alloc() CSPerson

Alloc allocates memory for a new instance of the class.

func (CSPersonClass) Class ¶

func (cc CSPersonClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSSearchQuery) Autorelease ¶

func (c CSSearchQuery) Autorelease() CSSearchQuery

Autorelease adds the receiver to the current autorelease pool.

func (CSSearchQuery) Cancel ¶

func (c CSSearchQuery) Cancel()

Cancels the current query operation.

Discussion ¶

Cancel a query operation when you no longer need the results. You can use this method to cancel a query you started, by using either the CSSearchQuery.Start method or by accessing the CSSearchQuery.Results property. After you cancel a query operation, you can’t restart it. To perform a new query, create a new query object. For example, you might cancel one query and start a new one when the text in your app’s search control changes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/cancel()

func (CSSearchQuery) CompletionHandler ¶

func (c CSSearchQuery) CompletionHandler() ErrorHandler

The block to execute when the query finishes delivering all results.

Discussion ¶

Specify a value for this property only if you start your query with the CSSearchQuery.Start method. When the query finishes, the query object executes the provided closure once to let you know the search is complete. Use your handler to perform any related cleanup. The block you assign to this property returns no parameters and takes the following parameter:

error: An error object with details about a problem that occurred, or `nil` if the query completed successfully.

If you start the query by accessing the CSSearchQuery.Results property of CSSearchQuery or the CSUserQuery.Responses property of CSUserQuery, the query object doesn’t execute the block in this property.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/completionHandler

func (CSSearchQuery) FoundItemCount ¶

func (c CSSearchQuery) FoundItemCount() uint

The number of matching items found for the given query string.

Discussion ¶

As Spotlight finds matches to the query string, it updates the value of this property and delivers the new results to the handler in the CSSearchQuery.FoundItemsHandler property. This value reflects the total number of matching items, including the number of items the query delivered to your handler block previously.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/foundItemCount

func (CSSearchQuery) FoundItemsHandler ¶

func (c CSSearchQuery) FoundItemsHandler() CSSearchableItemArrayHandler

The block to execute when the query delivers a new batch of matching items.

Discussion ¶

Assign a block to this property that has no return value and takes the following parameter:

items: An array of items that match the specified query.

Specify a value for this property only if you start your query with the CSSearchQuery.Start method. While the query runs, the query object executes the provided closure one or more times to deliver suggested search results for the current search term. Use your handler to retrieve the those results and display them. The query object stops delivering matching items when it reaches the maximum number found in the CSUserQueryContext.MaxResultCount property of the query configuration parameters.

Each time the query object calls your handler, it delivers only the new items that it found since the last time it called your handler. However, the query object updates the value of the CSSearchQuery.FoundItemCount property with the total number of items before it calls your handler.

If you start the query by accessing the CSSearchQuery.Results property of CSSearchQuery or the CSUserQuery.Responses property of CSUserQuery, the query object doesn’t execute the block in this property. property of CSUserQuery, the query object doesn’t execute the block in this property.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/foundItemsHandler

func (CSSearchQuery) Init ¶

func (c CSSearchQuery) Init() CSSearchQuery

Init initializes the instance.

func (CSSearchQuery) InitWithQueryStringQueryContext ¶

func (c CSSearchQuery) InitWithQueryStringQueryContext(queryString string, queryContext ICSSearchQueryContext) CSSearchQuery

Initializes and returns a query object with the specified query string and query context.

Return Value ¶

An initialized query object.

Discussion ¶

- queryString: A formatted string that defines the matching criteria to apply to indexed items. To learn how to construct a query string, see Create a query string for your search. - This parameter must not be `nil`. - - queryContext: A CSSearchQueryContext object that focuses the query results.

Discussion ¶

After you create and initialize a query object, and call CSSearchQuery.Start to begin the query, you can’t update or reuse the query object for a new query.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/init(queryString:queryContext:)

func (CSSearchQuery) IsCancelled ¶

func (c CSSearchQuery) IsCancelled() bool

A Boolean value that indicates whether the current query is no longer running.

Discussion ¶

The value of this property is `true` if you canceled it, and `false` if it’s still running or able to run.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/isCancelled

func (CSSearchQuery) ProtectionClasses ¶

func (c CSSearchQuery) ProtectionClasses() []string

The protection types of the indexes you want to search.

Discussion ¶

When creating an index to store your app’s data, you can associate a file protection type with that index to encrypt the data it contains. File protections prevent access to the data unless specific conditions occur. For example, you can make the data available only when the device is unlocked, or make it available after the first successful unlocking of the device. This property indicates which of your app’s protected indexes you want to search.

Possible values for this property are complete, completeUnlessOpen, and completeUntilFirstUserAuthentication. By default, the system retrives the data protection class from the `com.AppleXCUIElementTypeDeveloperXCUIElementTypeDefault()-data-protection` entitlement, if it exists; otherwise, the default value is completeUntilFirstUserAuthentication.

For more information on how to configure file protection types with an index, see Adding your app’s content to Spotlight indexes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/protectionClasses

func (CSSearchQuery) Results ¶

func (c CSSearchQuery) Results() unsafe.Pointer

The results that match the current query string.

See: https://developer.apple.com/documentation/corespotlight/cssearchquery/results-swift.property

func (CSSearchQuery) SetCompletionHandler ¶

func (c CSSearchQuery) SetCompletionHandler(value ErrorHandler)

func (CSSearchQuery) SetFoundItemsHandler ¶

func (c CSSearchQuery) SetFoundItemsHandler(value CSSearchableItemArrayHandler)

func (CSSearchQuery) SetProtectionClasses ¶

func (c CSSearchQuery) SetProtectionClasses(value []string)

func (CSSearchQuery) SetResults ¶

func (c CSSearchQuery) SetResults(value unsafe.Pointer)

func (CSSearchQuery) Start ¶

func (c CSSearchQuery) Start()

Starts searching the index for items that match the current query string and parameters.

Discussion ¶

This method uses the configured search parameters and query string to begin a search of the index. It then delivers the results of that search to the closures in the CSSearchQuery.FoundItemsHandler and CSSearchQuery.CompletionHandler properties of the query object.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQuery/start()

func (CSSearchQueryClass) Alloc ¶

func (cc CSSearchQueryClass) Alloc() CSSearchQuery

Alloc allocates memory for a new instance of the class.

func (CSSearchQueryClass) Class ¶

func (cc CSSearchQueryClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSSearchQueryContext) Autorelease ¶

func (c CSSearchQueryContext) Autorelease() CSSearchQueryContext

Autorelease adds the receiver to the current autorelease pool.

func (CSSearchQueryContext) EncodeWithCoder ¶

func (c CSSearchQueryContext) EncodeWithCoder(coder foundation.INSCoder)

func (CSSearchQueryContext) FetchAttributes ¶

func (c CSSearchQueryContext) FetchAttributes() []string

The attributes the system fetches for the searchable items.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQueryContext/fetchAttributes

func (CSSearchQueryContext) FilterQueries ¶

func (c CSSearchQueryContext) FilterQueries() []string

The query string used to filter the results.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQueryContext/filterQueries

func (CSSearchQueryContext) Init ¶

func (c CSSearchQueryContext) Init() CSSearchQueryContext

Init initializes the instance.

func (CSSearchQueryContext) InitWithCoder ¶

func (c CSSearchQueryContext) InitWithCoder(coder foundation.INSCoder) CSSearchQueryContext

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQueryContext/init(coder:)

func (CSSearchQueryContext) KeyboardLanguage ¶

func (c CSSearchQueryContext) KeyboardLanguage() string

The language used for the query.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQueryContext/keyboardLanguage

func (CSSearchQueryContext) SetFetchAttributes ¶

func (c CSSearchQueryContext) SetFetchAttributes(value []string)

func (CSSearchQueryContext) SetFilterQueries ¶

func (c CSSearchQueryContext) SetFilterQueries(value []string)

func (CSSearchQueryContext) SetKeyboardLanguage ¶

func (c CSSearchQueryContext) SetKeyboardLanguage(value string)

func (CSSearchQueryContext) SetSourceOptions ¶

func (c CSSearchQueryContext) SetSourceOptions(value CSSearchQuerySourceOptions)

func (CSSearchQueryContext) SourceOptions ¶

func (c CSSearchQueryContext) SourceOptions() CSSearchQuerySourceOptions

The query source options to allow or deny Mail messages in the search.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchQueryContext/sourceOptions-swift.property

func (CSSearchQueryContextClass) Alloc ¶

func (cc CSSearchQueryContextClass) Alloc() CSSearchQueryContext

Alloc allocates memory for a new instance of the class.

func (CSSearchQueryContextClass) Class ¶

func (cc CSSearchQueryContextClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSSearchQueryErrorCode) String ¶

func (e CSSearchQueryErrorCode) String() string

func (CSSearchQuerySourceOptions) String ¶

func (e CSSearchQuerySourceOptions) String() string

func (CSSearchableIndex) Autorelease ¶

func (c CSSearchableIndex) Autorelease() CSSearchableIndex

Autorelease adds the receiver to the current autorelease pool.

func (CSSearchableIndex) BeginIndexBatch ¶

func (c CSSearchableIndex) BeginIndexBatch()

Begins a batch of updates to an index.

Discussion ¶

Don’t call this method again before CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler has returned. (You can call it again before the completion handler passed to CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler has been called.)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/beginBatch()

func (CSSearchableIndex) DeleteAllSearchableItems ¶

func (c CSSearchableIndex) DeleteAllSearchableItems(ctx context.Context) error

DeleteAllSearchableItems is a synchronous wrapper around CSSearchableIndex.DeleteAllSearchableItemsWithCompletionHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSSearchableIndex) DeleteAllSearchableItemsWithCompletionHandler ¶

func (c CSSearchableIndex) DeleteAllSearchableItemsWithCompletionHandler(completionHandler ErrorHandler)

Deletes all searchable items from the index.

completionHandler: The block that’s called when the request has been journaled by the index (“journaled” means that the index makes a note that it has to perform this operation). Note that the request may not have completed.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/deleteAllSearchableItems(completionHandler:)

func (CSSearchableIndex) DeleteSearchableItemsWithDomainIdentifiersCompletionHandler ¶

func (c CSSearchableIndex) DeleteSearchableItemsWithDomainIdentifiersCompletionHandler(domainIdentifiers []string, completionHandler ErrorHandler)

Removes from the index all searchable items associated with the specified domain.

domainIdentifiers: The domain identifier that describes the group of items to delete. To learn more about domain identifiers, see CSSearchableItem.DomainIdentifier.

completionHandler: The block that’s called when the request has been journaled by the index (“journaled” means that the index makes a note that it has to perform this operation). Note that the request may not have completed.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

Use this method to delete groups of items. Note that the delete operation is recursive. For example, if domain identifiers are of the form `.`, calling this method and specifying “ deletes items with the specified account and any mailbox.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/deleteSearchableItems(withDomainIdentifiers:completionHandler:)

func (CSSearchableIndex) DeleteSearchableItemsWithIdentifiersCompletionHandler ¶

func (c CSSearchableIndex) DeleteSearchableItemsWithIdentifiersCompletionHandler(identifiers []string, completionHandler ErrorHandler)

Removes from the index all items with the specified identifiers.

identifiers: An array of identifiers that specify the items to delete.

completionHandler: The block that’s called when the data has been journaled by the index, which means that the index makes a note that it has to perform this operation. If the completion handler returns an error, it means that the data wasn’t journaled correctly and the client should retry the request.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

The [SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler] protocol method is called in the case that the journaling completed successfully, but the data was not able to be indexed for some reason.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/deleteSearchableItems(withIdentifiers:completionHandler:)

func (CSSearchableIndex) EndIndexBatchWithClientState ¶

func (c CSSearchableIndex) EndIndexBatchWithClientState(ctx context.Context, clientState foundation.NSData) error

EndIndexBatchWithClientState is a synchronous wrapper around CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSSearchableIndex) EndIndexBatchWithClientStateCompletionHandler ¶

func (c CSSearchableIndex) EndIndexBatchWithClientStateCompletionHandler(clientState foundation.NSData, completionHandler ErrorHandler)

Ends a batch of index updates and stores the specified state information.

clientState: Up to 250 bytes of information that can help you recover from a crash and resume indexing.

completionHandler: The block that’s called after the client state has been stored.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/endBatch(withClientState:completionHandler:)

func (CSSearchableIndex) EndIndexBatchWithExpectedClientStateNewClientState ¶

func (c CSSearchableIndex) EndIndexBatchWithExpectedClientStateNewClientState(ctx context.Context, expectedClientState foundation.NSData, newClientState foundation.NSData) error

EndIndexBatchWithExpectedClientStateNewClientState is a synchronous wrapper around CSSearchableIndex.EndIndexBatchWithExpectedClientStateNewClientStateCompletionHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSSearchableIndex) EndIndexBatchWithExpectedClientStateNewClientStateCompletionHandler ¶

func (c CSSearchableIndex) EndIndexBatchWithExpectedClientStateNewClientStateCompletionHandler(expectedClientState foundation.NSData, newClientState foundation.NSData, completionHandler ErrorHandler)

Ends a batch of index updates and stores the specified state information.

expectedClientState: The client state data from the previous batch.

newClientState: Up to 250 bytes of app-specific data that can help you recover from a crash and resume indexing.

completionHandler: The block to call with the results. The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/endIndexBatch(expectedClientState:newClientState:completionHandler:)

func (CSSearchableIndex) FetchDataForBundleIdentifierItemIdentifierContentType ¶

func (c CSSearchableIndex) FetchDataForBundleIdentifierItemIdentifierContentType(ctx context.Context, bundleIdentifier string, itemIdentifier string, contentType uniformtypeidentifiers.UTType) (*foundation.NSData, error)

FetchDataForBundleIdentifierItemIdentifierContentType is a synchronous wrapper around CSSearchableIndex.FetchDataForBundleIdentifierItemIdentifierContentTypeCompletionHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSSearchableIndex) FetchDataForBundleIdentifierItemIdentifierContentTypeCompletionHandler ¶

func (c CSSearchableIndex) FetchDataForBundleIdentifierItemIdentifierContentTypeCompletionHandler(bundleIdentifier string, itemIdentifier string, contentType uniformtypeidentifiers.UTType, completionHandler DataErrorHandler)

Fetches data from an external provider.

bundleIdentifier: The bundle identifier of the app to search.

itemIdentifier: The app-specific identifier of the item you want.

contentType: The type of data to fetch.

completionHandler: The block to execute with the results. The block has no return value and takes the following parameters:

data: The data for the specified item, if successful. error: An error object, or `nil` if the method retrieved the data successfully.

Discussion ¶

Clients with the appropriate entitlements can use this method to fetch data from an external app such as Mail.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/fetchData(forBundleIdentifier:itemIdentifier:contentType:completionHandler:)

func (CSSearchableIndex) FetchLastClientState ¶

func (c CSSearchableIndex) FetchLastClientState(ctx context.Context) (*foundation.NSData, error)

FetchLastClientState is a synchronous wrapper around CSSearchableIndex.FetchLastClientStateWithCompletionHandler. It blocks until the completion handler fires or the context is cancelled.

func (CSSearchableIndex) FetchLastClientStateWithCompletionHandler ¶

func (c CSSearchableIndex) FetchLastClientStateWithCompletionHandler(completionHandler DataErrorHandler)

Fetches the app’s most recent client state information asynchronously.

completionHandler: The block to call when the request has been journaled by the index, which means that the index makes a note that it has to perform this operation. Note that the request may not have completed.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/fetchLastClientState(completionHandler:)

func (CSSearchableIndex) IndexDelegate ¶

func (c CSSearchableIndex) IndexDelegate() CSSearchableIndexDelegate

The delegate object that can handle index-management tasks.

Discussion ¶

The delegate should conform to the CSSearchableIndexDelegate protocol. Set this property to handle communication with the index and perform index-management tasks for your app. In particular, long-running apps should set a delegate so that the index can be updated while the app is in the background. Alternatively, you can create an extension with a request handler that conforms to the CSSearchableIndexDelegate protocol and let the extension perform index updates when your app isn’t running.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/indexDelegate

func (CSSearchableIndex) IndexSearchableItemsCompletionHandler ¶

func (c CSSearchableIndex) IndexSearchableItemsCompletionHandler(items []CSSearchableItem, completionHandler ErrorHandler)

Adds or updates items in the index.

items: An array of searchable items to add or update.

completionHandler: The block that’s called when the data has been journaled by the index, which means that the index makes a note that it has to perform this operation. If the completion handler returns an error, it means that the data wasn’t journaled correctly and the client should retry the request.

The block receives the following parameter:

error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is `nil`.

Discussion ¶

The [SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler] protocol method is called in the case that the journaling completed successfully but the data was not able to be indexed for some reason.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/indexSearchableItems(_:completionHandler:)

func (CSSearchableIndex) Init ¶

func (c CSSearchableIndex) Init() CSSearchableIndex

Init initializes the instance.

func (CSSearchableIndex) InitWithName ¶

func (c CSSearchableIndex) InitWithName(name string) CSSearchableIndex

Returns an on-device index with the specified name.

name: A name that pertains to your custom organization.

Return Value ¶

An on-device index.

Discussion ¶

If you want to use batching or you want to index items in a specific protection class, you need to use your own index (you can’t perform batch updates on the default index).

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/init(name:)

func (CSSearchableIndex) InitWithNameProtectionClass ¶

func (c CSSearchableIndex) InitWithNameProtectionClass(name string, protectionClass foundation.NSFileProtectionType) CSSearchableIndex

Returns an on-device index with the specified name and data protection class.

name: A name that pertains to your custom organization.

protectionClass: The file protection class. Acceptable values are none, complete, completeUnlessOpen, or completeUntilFirstUserAuthentication.

Return Value ¶

An index that can handle items within the specified protection class.

Discussion ¶

Use this method to specify a protection class for an index. You can specify a default protection class for index items in the entitlements for your app.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/init(name:protectionClass:)

func (CSSearchableIndex) ProtectionClass ¶

func (c CSSearchableIndex) ProtectionClass() foundation.NSFileProtectionType

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/protectionClass

func (CSSearchableIndex) SetIndexDelegate ¶

func (c CSSearchableIndex) SetIndexDelegate(value CSSearchableIndexDelegate)

func (CSSearchableIndexClass) Alloc ¶

func (cc CSSearchableIndexClass) Alloc() CSSearchableIndex

Alloc allocates memory for a new instance of the class.

func (CSSearchableIndexClass) Class ¶

func (cc CSSearchableIndexClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CSSearchableIndexClass) DefaultSearchableIndex ¶

func (_CSSearchableIndexClass CSSearchableIndexClass) DefaultSearchableIndex() CSSearchableIndex

Returns the default on-device index.

Return Value ¶

The default on-device index.

Discussion ¶

If you want to use batching or you want to index items in a specific protection class, you need to use your own index (you can’t perform batch updates on the default index).

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/default()

func (CSSearchableIndexClass) IsIndexingAvailable ¶

func (_CSSearchableIndexClass CSSearchableIndexClass) IsIndexingAvailable() bool

Returns a Boolean value that indicates whether indexing is available on the current device.

Return Value ¶

`true` if indexing is available on the current device, or `false` if it isn’t.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndex/isIndexingAvailable()

func (CSSearchableIndexDelegateObject) BaseObject ¶

func (o CSSearchableIndexDelegateObject) BaseObject() objectivec.Object

func (CSSearchableIndexDelegateObject) DataForSearchableIndexItemIdentifierTypeIdentifierError ¶

func (o CSSearchableIndexDelegateObject) DataForSearchableIndexItemIdentifierTypeIdentifierError(searchableIndex ICSSearchableIndex, itemIdentifier string, typeIdentifier string) (foundation.NSData, error)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/data(for:itemIdentifier:typeIdentifier:)

func (CSSearchableIndexDelegateObject) FileURLForSearchableIndexItemIdentifierTypeIdentifierInPlaceError ¶

func (o CSSearchableIndexDelegateObject) FileURLForSearchableIndexItemIdentifierTypeIdentifierInPlaceError(searchableIndex ICSSearchableIndex, itemIdentifier string, typeIdentifier string, inPlace bool) (foundation.NSURL, error)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/fileURL(for:itemIdentifier:typeIdentifier:inPlace:)

func (CSSearchableIndexDelegateObject) SearchableIndexDidFinishThrottle ¶

func (o CSSearchableIndexDelegateObject) SearchableIndexDidFinishThrottle(searchableIndex ICSSearchableIndex)

Tells the delegate that the index throttling has finished.

searchableIndex: The index that was throttled.

Discussion ¶

In some situations, such as when the device is using battery only, the system may throttle indexing to save power. You can implement this method to be notified when throttling is finished so that your app can resume its standard indexing behavior.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndexDidFinishThrottle(_:)

func (CSSearchableIndexDelegateObject) SearchableIndexDidThrottle ¶

func (o CSSearchableIndexDelegateObject) SearchableIndexDidThrottle(searchableIndex ICSSearchableIndex)

Tells the delegate that indexing is being throttled.

searchableIndex: The indexing that’s being throttled.

Discussion ¶

In some situations, such as when the device is using battery only, the system may throttle indexing to save power. You can implement this method to be notified of this situation so that you can respond by, for example, prioritizing the items to index.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndexDidThrottle(_:)

func (CSSearchableIndexDelegateObject) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandler ¶

func (o CSSearchableIndexDelegateObject) SearchableIndexReindexAllSearchableItemsWithAcknowledgementHandler(searchableIndex ICSSearchableIndex, acknowledgementHandler VoidHandler)

Tells the delegate to reindex all searchable data and clear all local state information.

searchableIndex: The index in which to reindex the searchable data. The delegate or app extension should pass `searchableIndex` to CSSearchableIndex.IndexSearchableItemsCompletionHandler.

acknowledgementHandler: The handler to call after all client state has been saved. Note that if the app passes client state information in a batch (for example, by calling CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler), the acknowledgement handler can be called immediately.

The delegate or app extension must call the acknowledgement handler after all client state information has been saved, so that the indexer can call this method again in case of a crash.

Discussion ¶

Typically, the index tells the delegate to reindex its searchable data and clear local state when the index has been lost. An app extension should not use the index passed in `searchableIndex` when a custom data protection class is needed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndex(_:reindexAllSearchableItemsWithAcknowledgementHandler:)

func (CSSearchableIndexDelegateObject) SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler ¶

func (o CSSearchableIndexDelegateObject) SearchableIndexReindexSearchableItemsWithIdentifiersAcknowledgementHandler(searchableIndex ICSSearchableIndex, identifiers []string, acknowledgementHandler VoidHandler)

Tells the delegate to reindex the searchable items associated with the specified identifiers.

searchableIndex: The index in which to reindex the specified searchable data. To update the state of the items, the delegate or app extension should call CSSearchableIndex.IndexSearchableItemsCompletionHandler passing in `searchableIndex`.

identifiers: An array of identifiers that specify searchable items.

acknowledgementHandler: The handler to call after all client state has been saved. Note that if the app passes client state information in a batch (for example, by calling CSSearchableIndex.EndIndexBatchWithClientStateCompletionHandler), the acknowledgement handler can be called immediately.

The delegate or app extension must call the acknowledgement handler after all client state information has been saved, so that the indexer can call this method again in case of a crash.

Discussion ¶

An app extension should not use the index passed in `searchableIndex` when a custom data protection class is needed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableIndex(_:reindexSearchableItemsWithIdentifiers:acknowledgementHandler:)

func (CSSearchableIndexDelegateObject) SearchableItemsDidUpdate ¶

func (o CSSearchableIndexDelegateObject) SearchableItemsDidUpdate(items []CSSearchableItem)

Tells the delegate that the framework updated the list of searchable items.

items: The items the framework updated.

Discussion ¶

The framework calls this method when it updates an item with specific attributes; see CSSearchableItem.UpdateListenerOptions for Apple Intelligence attributes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItemsDidUpdate(_:)

func (CSSearchableIndexDelegateObject) SearchableItemsForIdentifiersProtectionClassSearchableItemsHandler ¶

func (o CSSearchableIndexDelegateObject) SearchableItemsForIdentifiersProtectionClassSearchableItemsHandler(identifiers []string, protectionClass foundation.NSFileProtectionType, searchableItemsHandler CSSearchableItemArrayHandler)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItems(forIdentifiers:protectionClass:searchableItemsHandler:)

func (CSSearchableIndexDelegateObject) SearchableItemsForIdentifiersSearchableItemsHandler ¶

func (o CSSearchableIndexDelegateObject) SearchableItemsForIdentifiersSearchableItemsHandler(identifiers []string, searchableItemsHandler CSSearchableItemArrayHandler)

Requests that the delegate provide searchable items for the provided identifiers.

identifiers: An array of strings that represent the identifiers.

searchableItemsHandler: A method the framework calls that provides an array of CSSearchableItem objects.

Discussion ¶

Use this method to provide the framework with a list of identifiers to search for.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableIndexDelegate/searchableItems(forIdentifiers:searchableItemsHandler:)

func (CSSearchableItem) AttributeSet ¶

func (c CSSearchableItem) AttributeSet() ICSSearchableItemAttributeSet

The set of attributes that contain metadata associated with the item in a CSSearchableItemAttributeSet object.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/attributeSet

func (CSSearchableItem) Autorelease ¶

func (c CSSearchableItem) Autorelease() CSSearchableItem

Autorelease adds the receiver to the current autorelease pool.

func (CSSearchableItem) CompareByRank ¶

func (c CSSearchableItem) CompareByRank(other ICSSearchableItem) foundation.ComparisonResult

Compares two items by rank and returns the result.

other: The other item to compare against the current one.

Return Value ¶

A comparison result that indicates the ranked order of the items.

Discussion ¶

Call this function when you want to compare the current item with the one you specify. The method compares the ranks of the items.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/compare(byRank:)

func (CSSearchableItem) DomainIdentifier ¶

func (c CSSearchableItem) DomainIdentifier() string

An optional identifier that represents the domain or owner of the item.

Discussion ¶

Specify a domain identifier to group items together and to make it easy to delete groups of items from the index. For example, you might specify an identifier for a mailbox in an account whose indexed data you want to remove when the account is deleted. In this example, CSSearchableItem.DomainIdentifier should be of the form `.`, where neither “ nor “ contain periods. To delete all items associated with the specified account and mailbox, you can call CSSearchableIndex.DeleteSearchableItemsWithDomainIdentifiersCompletionHandler with a CSSearchableItem.DomainIdentifier of `.`. Or to delete all items associated with all mailboxes in the specified account, you can call CSSearchableIndex.DeleteSearchableItemsWithDomainIdentifiersCompletionHandler with a CSSearchableItem.DomainIdentifier of “.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/domainIdentifier

func (CSSearchableItem) EncodeWithCoder ¶

func (c CSSearchableItem) EncodeWithCoder(coder foundation.INSCoder)

func (CSSearchableItem) ExpirationDate ¶

func (c CSSearchableItem) ExpirationDate() foundation.NSDate

The date after which the searchable item should no longer exist.

Discussion ¶

If you don’t set the CSSearchableItem.ExpirationDate property appropriately, the system automatically expires the item after a period of time.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/expirationDate

func (CSSearchableItem) Init ¶

func (c CSSearchableItem) Init() CSSearchableItem

Init initializes the instance.

func (CSSearchableItem) InitWithCoder ¶

func (c CSSearchableItem) InitWithCoder(coder foundation.INSCoder) CSSearchableItem

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/init(coder:)

func (CSSearchableItem) InitWithUniqueIdentifierDomainIdentifierAttributeSet ¶

func (c CSSearchableItem) InitWithUniqueIdentifierDomainIdentifierAttributeSet(uniqueIdentifier string, domainIdentifier string, attributeSet ICSSearchableItemAttributeSet) CSSearchableItem

Returns a searchable item associated with the specified identifier, domain identifier, and attribute set.

uniqueIdentifier: The unique identifier for the item. If you specify [NULL], an identifier is generated automatically.

domainIdentifier: An identifier for a domain, such as an album, that helps you group items together in a way that makes sense.

attributeSet: A set of properties that specify the metadata you want to display about an item in a search result. See CSSearchableItemAttributeSet for the types of properties you can use.

Return Value ¶

A searchable item that’s associated with the specified identifier, domain identifier, and attribute set.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/init(uniqueIdentifier:domainIdentifier:attributeSet:)

func (CSSearchableItem) IsUpdate ¶

func (c CSSearchableItem) IsUpdate() bool

A Boolean value that indicates whether to treat the item as an update instead of a new item.

Discussion ¶

Set the value of this property to `true` if the item represents an update to information already in the index. Marking an item as an update makes the indexing process more efficient. If this property is `false` and the system encounters an item with the same identifier in the index, it deletes the old item and then inserts the new one. When the property is `true`, it updates the existing item, which saves time. If this property is `true` and the item doesn’t exist in the index, the system ignores the request to index the item and doesn’t create a new item.

When configuring the attributes for the item, set an attribute to `nil` to remove its value.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/isUpdate

func (CSSearchableItem) SetAttributeSet ¶

func (c CSSearchableItem) SetAttributeSet(value ICSSearchableItemAttributeSet)

func (CSSearchableItem) SetDomainIdentifier ¶

func (c CSSearchableItem) SetDomainIdentifier(value string)

func (CSSearchableItem) SetExpirationDate ¶

func (c CSSearchableItem) SetExpirationDate(value foundation.NSDate)

func (CSSearchableItem) SetIsUpdate ¶

func (c CSSearchableItem) SetIsUpdate(value bool)

func (CSSearchableItem) SetUniqueIdentifier ¶

func (c CSSearchableItem) SetUniqueIdentifier(value string)

func (CSSearchableItem) SetUpdateListenerOptions ¶

func (c CSSearchableItem) SetUpdateListenerOptions(value CSSearchableItemUpdateListenerOptions)

func (CSSearchableItem) UniqueIdentifier ¶

func (c CSSearchableItem) UniqueIdentifier() string

The value that uniquely identifies the searchable item within your app.

Discussion ¶

This property is required because it’s the only way to identify searchable items in the index when you need to access or delete them. When you create a searchable item, the system generates a UUID by default, but you can replace the default value with a unique identifier that makes sense in the context of your app. If you want to use a custom value for CSSearchableItem.UniqueIdentifier, be sure to set it before the item is indexed for the first time.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/uniqueIdentifier

func (CSSearchableItem) UpdateListenerOptions ¶

func (c CSSearchableItem) UpdateListenerOptions() CSSearchableItemUpdateListenerOptions

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItem/updateListenerOptions-swift.property

func (CSSearchableItemAttributeSet) AccountHandles ¶

func (c CSSearchableItemAttributeSet) AccountHandles() []string

An array of the canonical handles for the account with which the message is associated.

Discussion ¶

Account handles can include chat handles, email addresses, phone numbers, and so on.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/accountHandles

func (CSSearchableItemAttributeSet) AccountIdentifier ¶

func (c CSSearchableItemAttributeSet) AccountIdentifier() string

The unique identifier for the account with which the message is associated, if any.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/accountIdentifier

func (CSSearchableItemAttributeSet) AcquisitionMake ¶

func (c CSSearchableItemAttributeSet) AcquisitionMake() string

The manufacturer of the device that captured the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/acquisitionMake

func (CSSearchableItemAttributeSet) AcquisitionModel ¶

func (c CSSearchableItemAttributeSet) AcquisitionModel() string

The model of the device that captured the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/acquisitionModel

func (CSSearchableItemAttributeSet) AddedDate ¶

func (c CSSearchableItemAttributeSet) AddedDate() foundation.NSDate

The date on which the item was moved into its current location.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/addedDate

func (CSSearchableItemAttributeSet) AdditionalRecipients ¶

func (c CSSearchableItemAttributeSet) AdditionalRecipients() []CSPerson

An array of CSPerson objects representing the content of the Cc: field in an email message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/additionalRecipients

func (CSSearchableItemAttributeSet) Album ¶

func (c CSSearchableItemAttributeSet) Album() string

The title for a collection of audio media.

Discussion ¶

The value of this property is analogous to the title of a record album or photo album.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/album

func (CSSearchableItemAttributeSet) AllDay ¶

func (c CSSearchableItemAttributeSet) AllDay() foundation.NSNumber

A value that indicates if the event covers an entire day.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/allDay

func (CSSearchableItemAttributeSet) AlternateNames ¶

func (c CSSearchableItemAttributeSet) AlternateNames() []string

An array of localized strings that represent alternate display names for the item.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/alternateNames

func (CSSearchableItemAttributeSet) Altitude ¶

func (c CSSearchableItemAttributeSet) Altitude() foundation.NSNumber

The altitude of the item in meters above sea level, expressed using the WGS84 datum.

Discussion ¶

Negative values lie below sea level.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/altitude

func (CSSearchableItemAttributeSet) Aperture ¶

func (c CSSearchableItemAttributeSet) Aperture() foundation.NSNumber

The size of the lens aperture at the time the camera captured the image, as a log-scale APEX value.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/aperture

func (CSSearchableItemAttributeSet) Artist ¶

func (c CSSearchableItemAttributeSet) Artist() string

The artist associated with the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/artist

func (CSSearchableItemAttributeSet) Audiences ¶

func (c CSSearchableItemAttributeSet) Audiences() []string

A class of entity for which the item is intended or useful.

Discussion ¶

A class of entity may be determined by the creator or the publisher of the item or by a third party.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audiences

func (CSSearchableItemAttributeSet) AudioBitRate ¶

func (c CSSearchableItemAttributeSet) AudioBitRate() foundation.NSNumber

The audio bit rate of the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audioBitRate

func (CSSearchableItemAttributeSet) AudioChannelCount ¶

func (c CSSearchableItemAttributeSet) AudioChannelCount() foundation.NSNumber

The number of channels in the audio data that the file contains.

Discussion ¶

The value of this property represents only the number of discreet channels of audio data found in the file. It does not indicate any audio data configuration related to a user’s speaker setup.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audioChannelCount

func (CSSearchableItemAttributeSet) AudioEncodingApplication ¶

func (c CSSearchableItemAttributeSet) AudioEncodingApplication() string

The name of the application that encoded the data the audio file contains.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audioEncodingApplication

func (CSSearchableItemAttributeSet) AudioSampleRate ¶

func (c CSSearchableItemAttributeSet) AudioSampleRate() foundation.NSNumber

The sample rate of the audio data the file contains, as a float value representing Hz (audio frames per second), such as 44100.0 or 22254.54.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audioSampleRate

func (CSSearchableItemAttributeSet) AudioTrackNumber ¶

func (c CSSearchableItemAttributeSet) AudioTrackNumber() foundation.NSNumber

The track number of a song or audio composition when part of an album.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/audioTrackNumber

func (CSSearchableItemAttributeSet) AuthorAddresses ¶

func (c CSSearchableItemAttributeSet) AuthorAddresses() []string

An array of addresses associated with the author of the message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/authorAddresses

func (CSSearchableItemAttributeSet) AuthorEmailAddresses ¶

func (c CSSearchableItemAttributeSet) AuthorEmailAddresses() []string

An array of email addresses associated with the author of the message.

Discussion ¶

The contents of this property is not human-readable.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/authorEmailAddresses

func (CSSearchableItemAttributeSet) AuthorNames ¶

func (c CSSearchableItemAttributeSet) AuthorNames() []string

An array of names representing the authors who have worked on the message.

Discussion ¶

A message may have zero or more authors. Although the array preserves the order of authors, it is not intended to identify the main author or represent the relative importance of authors.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/authorNames

func (CSSearchableItemAttributeSet) Authors ¶

func (c CSSearchableItemAttributeSet) Authors() []CSPerson

An array of CSPerson objects representing the content of the From: field in an item.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/authors

func (CSSearchableItemAttributeSet) Autorelease ¶

func (c CSSearchableItemAttributeSet) Autorelease() CSSearchableItemAttributeSet

Autorelease adds the receiver to the current autorelease pool.

func (CSSearchableItemAttributeSet) BitsPerSample ¶

func (c CSSearchableItemAttributeSet) BitsPerSample() foundation.NSNumber

The number of bits per sample.

Discussion ¶

The value of this property can represent the bit depth of an image (such as 8-bit or 16-bit) or the bit depth per audio sample of uncompressed audio data (such as 8, 16, 24, 32, 64, and so on).

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/bitsPerSample

func (CSSearchableItemAttributeSet) CameraOwner ¶

func (c CSSearchableItemAttributeSet) CameraOwner() string

The owner of the camera that captured the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/cameraOwner

func (CSSearchableItemAttributeSet) City ¶

func (c CSSearchableItemAttributeSet) City() string

The city of the item’s origin according to guidelines that the provider establishes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/city

func (CSSearchableItemAttributeSet) Codecs ¶

func (c CSSearchableItemAttributeSet) Codecs() []string

The codecs used to encode/decode the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/codecs

func (CSSearchableItemAttributeSet) ColorSpace ¶

func (c CSSearchableItemAttributeSet) ColorSpace() string

The color space model the image uses, such as RGB, CMYK, YUV, or YCbCr.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/colorSpace

func (CSSearchableItemAttributeSet) Comment ¶

func (c CSSearchableItemAttributeSet) Comment() string

A comment related to the media file.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/comment

func (CSSearchableItemAttributeSet) CompletionDate ¶

func (c CSSearchableItemAttributeSet) CompletionDate() foundation.NSDate

The date on which the item was completed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/completionDate

func (CSSearchableItemAttributeSet) Composer ¶

func (c CSSearchableItemAttributeSet) Composer() string

The composer of the song or audio composition that the audio file contains.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/composer

func (CSSearchableItemAttributeSet) ContactKeywords ¶

func (c CSSearchableItemAttributeSet) ContactKeywords() []string

A list of contacts who are associated with the content in some way, not including the author.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contactKeywords

func (CSSearchableItemAttributeSet) ContainerDisplayName ¶

func (c CSSearchableItemAttributeSet) ContainerDisplayName() string

A localized string that specifies the name of a container to which the item belongs, suitable to display in the user interface.

Discussion ¶

For example, a container display name might be the title of a series of books. When you specify the containment properties, Spotlight can treat individual items as part of an ordered set.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/containerDisplayName

func (CSSearchableItemAttributeSet) ContainerIdentifier ¶

func (c CSSearchableItemAttributeSet) ContainerIdentifier() string

The identifier of the container to which the item belongs.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/containerIdentifier

func (CSSearchableItemAttributeSet) ContainerOrder ¶

func (c CSSearchableItemAttributeSet) ContainerOrder() foundation.NSNumber

The order of the item within the container.

Discussion ¶

For example, if the container represents a series of books, this property specifies the order in which the books should be read.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/containerOrder

func (CSSearchableItemAttributeSet) ContainerTitle ¶

func (c CSSearchableItemAttributeSet) ContainerTitle() string

The title of the container to which the item belongs.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/containerTitle

func (CSSearchableItemAttributeSet) ContentCreationDate ¶

func (c CSSearchableItemAttributeSet) ContentCreationDate() foundation.NSDate

The creation date of an edited or optimized version of the song or composition.

Discussion ¶

This property is supplementary to CSSearchableItemAttributeSet.RecordingDate, which indicates the original recording date of the song or composition.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentCreationDate

func (CSSearchableItemAttributeSet) ContentDescription ¶

func (c CSSearchableItemAttributeSet) ContentDescription() string

A description of the item’s content.

Discussion ¶

A description may consist of an abstract, table of contents, reference to a graphical representation of content, a free-text account of the content, or other matter.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentDescription

func (CSSearchableItemAttributeSet) ContentModificationDate ¶

func (c CSSearchableItemAttributeSet) ContentModificationDate() foundation.NSDate

The date on which the contents of the file was last modified.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentModificationDate

func (CSSearchableItemAttributeSet) ContentRating ¶

func (c CSSearchableItemAttributeSet) ContentRating() foundation.NSNumber

A value that indicates if the media contains explicit content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentRating

func (CSSearchableItemAttributeSet) ContentSources ¶

func (c CSSearchableItemAttributeSet) ContentSources() []string

An array of sources from which the media was obtained.

Discussion ¶

The string values in this property might include the URL of the website from which the file was downloaded or information that describes the email to which the file was attached.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentSources

func (CSSearchableItemAttributeSet) ContentType ¶

func (c CSSearchableItemAttributeSet) ContentType() string

The uniform type identifier (UTI) of the item.

Discussion ¶

To learn more about UTIs, see [UTType].

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentType

func (CSSearchableItemAttributeSet) ContentTypeTree ¶

func (c CSSearchableItemAttributeSet) ContentTypeTree() []string

An attribute type that identifies a custom hierarchy of types to describe the attributes of your item.

Discussion ¶

For example, the CSSearchableItemAttributeSet.ContentTypeTree for an item whose CSSearchableItemAttributeSet.ContentType is `public.M3u()-playlist` should include `public.M3u()-playlist` and `public.Playlist()`.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentTypeTree

func (CSSearchableItemAttributeSet) ContentURL ¶

func (c CSSearchableItemAttributeSet) ContentURL() foundation.NSURL

The file URL of the content to index.

Discussion ¶

This is an optional property. An app that is also a client of iCloud Drive can set this property to allow Spotlight to deduplicate its searchable items against the iCloud Drive items. In this scenario, Spotlight does not display searchable items from iCloud Drive that have the same CSSearchableItemAttributeSet.ContentURL property.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contentURL

func (CSSearchableItemAttributeSet) Contributors ¶

func (c CSSearchableItemAttributeSet) Contributors() []string

A list of people, organizations, or services that made contributions to the media content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/contributors

func (CSSearchableItemAttributeSet) Copyright ¶

func (c CSSearchableItemAttributeSet) Copyright() string

The copyright date of the content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/copyright

func (CSSearchableItemAttributeSet) Country ¶

func (c CSSearchableItemAttributeSet) Country() string

The full, publishable name of the country or region in which the intellectual property of the item was created, according to guidelines the provider establishes.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/country

func (CSSearchableItemAttributeSet) Coverage ¶

func (c CSSearchableItemAttributeSet) Coverage() []string

A list of descriptors that specify the extent or scope of the media.

Discussion ¶

The string values in this property typically include a location (such as a place name or geographic coordinates), a temporal period (such as a period label, date, or date range), or a jurisdiction (such as a named administrative entity).

It’s recommended that you select a value from a controlled vocabulary, and that when you need to specify a place or time period, you use a name instead of a numeric identifier, such as a set of coordinates or a date range.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/coverage

func (CSSearchableItemAttributeSet) Creator ¶

func (c CSSearchableItemAttributeSet) Creator() string

The name of the app that created the content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/creator

func (CSSearchableItemAttributeSet) DarkThumbnailURL ¶

func (c CSSearchableItemAttributeSet) DarkThumbnailURL() foundation.NSURL

The local file URL of the thumbnail image for the item when Dark Mode is active.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/darkThumbnailURL

func (CSSearchableItemAttributeSet) DeliveryType ¶

func (c CSSearchableItemAttributeSet) DeliveryType() foundation.NSNumber

The delivery type of the file.

Discussion ¶

The value of this property is 0 for fast start and 1 for RTSP.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/deliveryType

func (CSSearchableItemAttributeSet) Director ¶

func (c CSSearchableItemAttributeSet) Director() string

The name of the director of the media (for example, a movie director).

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/director

func (CSSearchableItemAttributeSet) DisplayName ¶

func (c CSSearchableItemAttributeSet) DisplayName() string

A localized string that contains the name of the item, suitable to display in the user interface.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/displayName

func (CSSearchableItemAttributeSet) DomainIdentifier ¶

func (c CSSearchableItemAttributeSet) DomainIdentifier() string

An identifier that represents the domain or owner of the item.

Discussion ¶

Specify a domain identifier to group items together and make it easier to delete them from the index. For example, to delete a user activity, set this property on the contentAttributeSet property of the NSUserActivity object and then call CSSearchableIndex.DeleteSearchableItemsWithDomainIdentifiersCompletionHandler on your app’s index.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/domainIdentifier

func (CSSearchableItemAttributeSet) DownloadedDate ¶

func (c CSSearchableItemAttributeSet) DownloadedDate() foundation.NSDate

The most recent date on which the file was downloaded or received.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/downloadedDate

func (CSSearchableItemAttributeSet) DueDate ¶

func (c CSSearchableItemAttributeSet) DueDate() foundation.NSDate

The date on which the item is due.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/dueDate

func (CSSearchableItemAttributeSet) Duration ¶

func (c CSSearchableItemAttributeSet) Duration() foundation.NSNumber

The duration (if appropriate) of the content of the file, in seconds.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/duration

func (CSSearchableItemAttributeSet) EXIFGPSVersion ¶

func (c CSSearchableItemAttributeSet) EXIFGPSVersion() string

The version of GPS Info IFD header that was used to generate the metadata for the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exifgpsVersion

func (CSSearchableItemAttributeSet) EXIFVersion ¶

func (c CSSearchableItemAttributeSet) EXIFVersion() string

The version of the EXIF header that was used to generate the metadata for the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exifVersion

func (CSSearchableItemAttributeSet) Editors ¶

func (c CSSearchableItemAttributeSet) Editors() []string

A list of editors who have worked on the file.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/editors

func (CSSearchableItemAttributeSet) EmailAddresses ¶

func (c CSSearchableItemAttributeSet) EmailAddresses() []string

An array of email addresses associated with the message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/emailAddresses

func (CSSearchableItemAttributeSet) EmailHeaders ¶

func (c CSSearchableItemAttributeSet) EmailHeaders() foundation.INSDictionary

A dictionary that contains all the headers of the message.

Discussion ¶

Dictionary keys are header names and the values are arrays of strings, because one header can occur more than once in an email message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/emailHeaders

func (CSSearchableItemAttributeSet) EncodeWithCoder ¶

func (c CSSearchableItemAttributeSet) EncodeWithCoder(coder foundation.INSCoder)

func (CSSearchableItemAttributeSet) EncodingApplications ¶

func (c CSSearchableItemAttributeSet) EncodingApplications() []string

The name of the apps that converted the original content into a PDF stream.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/encodingApplications

func (CSSearchableItemAttributeSet) EndDate ¶

func (c CSSearchableItemAttributeSet) EndDate() foundation.NSDate

The end date for the item.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/endDate

func (CSSearchableItemAttributeSet) ExposureMode ¶

func (c CSSearchableItemAttributeSet) ExposureMode() foundation.NSNumber

The mode the camera used for the exposure of the image.

Discussion ¶

This property can have the following values:

- 0 — auto exposure - 1 — manual - 2 — auto bracket

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exposureMode

func (CSSearchableItemAttributeSet) ExposureProgram ¶

func (c CSSearchableItemAttributeSet) ExposureProgram() string

The class of the program the camera used to set exposure when capturing the image.

Discussion ¶

Can include manual, normal, aperture priority, and so on.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exposureProgram

func (CSSearchableItemAttributeSet) ExposureTime ¶

func (c CSSearchableItemAttributeSet) ExposureTime() foundation.NSNumber

The time that the lens was open during exposure, in seconds.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exposureTime

func (CSSearchableItemAttributeSet) ExposureTimeString ¶

func (c CSSearchableItemAttributeSet) ExposureTimeString() string

The time that the lens was open during exposure, in a string, such as “1/250 seconds”.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/exposureTimeString

func (CSSearchableItemAttributeSet) FNumber ¶

func (c CSSearchableItemAttributeSet) FNumber() foundation.NSNumber

The focal length of the lens, divided by the diameter of the aperture when the camera captured the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/fNumber

func (CSSearchableItemAttributeSet) FileSize ¶

func (c CSSearchableItemAttributeSet) FileSize() foundation.NSNumber

The size of the document file.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/fileSize

func (CSSearchableItemAttributeSet) FlashOn ¶

func (c CSSearchableItemAttributeSet) FlashOn() foundation.NSNumber

A value that indicates if the camera used a flash to capture the image.

Discussion ¶

The value of this property is 1 if the flash is on; otherwise, 0.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/flashOn

func (CSSearchableItemAttributeSet) FocalLength ¶

func (c CSSearchableItemAttributeSet) FocalLength() foundation.NSNumber

The actual focal length of the lens, in millimeters.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/focalLength

func (CSSearchableItemAttributeSet) FocalLength35mm ¶

func (c CSSearchableItemAttributeSet) FocalLength35mm() foundation.NSNumber

A value that indicates if the focal length is 35mm.

Discussion ¶

The value of this property is 1 if the focal length is 35mm; otherwise, 0.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/focalLength35mm

func (CSSearchableItemAttributeSet) FontNames ¶

func (c CSSearchableItemAttributeSet) FontNames() []string

An array of font names the document uses.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/fontNames

func (CSSearchableItemAttributeSet) FullyFormattedAddress ¶

func (c CSSearchableItemAttributeSet) FullyFormattedAddress() string

The fully formatted address of the item, received from MapKit.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/fullyFormattedAddress

func (CSSearchableItemAttributeSet) GPSAreaInformation ¶

func (c CSSearchableItemAttributeSet) GPSAreaInformation() string

Information about the GPS area.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsAreaInformation

func (CSSearchableItemAttributeSet) GPSDOP ¶

func (c CSSearchableItemAttributeSet) GPSDOP() foundation.NSNumber

The GPS dilution of precision value.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsdop

func (CSSearchableItemAttributeSet) GPSDateStamp ¶

func (c CSSearchableItemAttributeSet) GPSDateStamp() foundation.NSDate

The date and time related to the GPS value.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDateStamp

func (CSSearchableItemAttributeSet) GPSDestBearing ¶

func (c CSSearchableItemAttributeSet) GPSDestBearing() foundation.NSNumber

The bearing to the destination point.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDestBearing

func (CSSearchableItemAttributeSet) GPSDestDistance ¶

func (c CSSearchableItemAttributeSet) GPSDestDistance() foundation.NSNumber

The distance to the destination point.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDestDistance

func (CSSearchableItemAttributeSet) GPSDestLatitude ¶

func (c CSSearchableItemAttributeSet) GPSDestLatitude() foundation.NSNumber

The latitude of the destination point.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDestLatitude

func (CSSearchableItemAttributeSet) GPSDestLongitude ¶

func (c CSSearchableItemAttributeSet) GPSDestLongitude() foundation.NSNumber

The longitude of the destination point.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDestLongitude

func (CSSearchableItemAttributeSet) GPSDifferental ¶

func (c CSSearchableItemAttributeSet) GPSDifferental() foundation.NSNumber

The differential correction applied to the GPS receiver.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsDifferental

func (CSSearchableItemAttributeSet) GPSMapDatum ¶

func (c CSSearchableItemAttributeSet) GPSMapDatum() string

The geodetic data that the GPS receiver uses.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsMapDatum

func (CSSearchableItemAttributeSet) GPSMeasureMode ¶

func (c CSSearchableItemAttributeSet) GPSMeasureMode() string

The measurement precision mode in use by the GPS receiver.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsMeasureMode

func (CSSearchableItemAttributeSet) GPSProcessingMethod ¶

func (c CSSearchableItemAttributeSet) GPSProcessingMethod() string

The location finding method that the GPS receiver uses.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsProcessingMethod

func (CSSearchableItemAttributeSet) GPSStatus ¶

func (c CSSearchableItemAttributeSet) GPSStatus() string

The status of the GPS receiver.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsStatus

func (CSSearchableItemAttributeSet) GPSTrack ¶

func (c CSSearchableItemAttributeSet) GPSTrack() foundation.NSNumber

The direction of travel of the item in degrees from true north.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/gpsTrack

func (CSSearchableItemAttributeSet) GeneralMIDISequence ¶

func (c CSSearchableItemAttributeSet) GeneralMIDISequence() foundation.NSNumber

A value that indicates whether the MIDI sequence the file contains is set up for use with a general MIDI device.

Discussion ¶

When the value of this property is 1, the MIDI sequence in the file is set up for use with a general MIDI device; when the value is 0, it is not.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/generalMIDISequence

func (CSSearchableItemAttributeSet) Genre ¶

func (c CSSearchableItemAttributeSet) Genre() string

The genre of the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/genre

func (CSSearchableItemAttributeSet) HTMLContentData ¶

func (c CSSearchableItemAttributeSet) HTMLContentData() foundation.NSData

The HTML content of the document encoded as an NSData object representing a UTF-8 encoded string.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/htmlContentData

func (CSSearchableItemAttributeSet) HasAlphaChannel ¶

func (c CSSearchableItemAttributeSet) HasAlphaChannel() foundation.NSNumber

Indicates if the image file has an alpha channel.

Discussion ¶

When the value of this property is 0, no alpha channel is used; when the value is 1, an alpha channel is used.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/hasAlphaChannel

func (CSSearchableItemAttributeSet) Headline ¶

func (c CSSearchableItemAttributeSet) Headline() string

A publishable string that provides a synopsis of the contents of the item.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/headline

func (CSSearchableItemAttributeSet) HiddenAdditionalRecipients ¶

func (c CSSearchableItemAttributeSet) HiddenAdditionalRecipients() []CSPerson

An array of CSPerson objects representing the content of the Bcc: field in an email message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/hiddenAdditionalRecipients

func (CSSearchableItemAttributeSet) ISOSpeed ¶

func (c CSSearchableItemAttributeSet) ISOSpeed() foundation.NSNumber

The ISO speed setting at the time the camera captured the image.

Discussion ¶

Typical ISO speed values are 100, 200, 400, and so on.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/isoSpeed

func (CSSearchableItemAttributeSet) Identifier ¶

func (c CSSearchableItemAttributeSet) Identifier() string

A formal identifier that references the document the item represents.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/identifier

func (CSSearchableItemAttributeSet) ImageDirection ¶

func (c CSSearchableItemAttributeSet) ImageDirection() foundation.NSNumber

The direction of the item’s image in degrees from true north.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/imageDirection

func (CSSearchableItemAttributeSet) ImportantDates ¶

func (c CSSearchableItemAttributeSet) ImportantDates() []foundation.NSDate

An array of important dates associated with the item.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/importantDates

func (CSSearchableItemAttributeSet) Information ¶

func (c CSSearchableItemAttributeSet) Information() string

Information about the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/information

func (CSSearchableItemAttributeSet) Init ¶

func (c CSSearchableItemAttributeSet) Init() CSSearchableItemAttributeSet

Init initializes the instance.

func (CSSearchableItemAttributeSet) InitWithCoder ¶

func (c CSSearchableItemAttributeSet) InitWithCoder(coder foundation.INSCoder) CSSearchableItemAttributeSet

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/init(coder:)

func (CSSearchableItemAttributeSet) InitWithContentType ¶

func (c CSSearchableItemAttributeSet) InitWithContentType(contentType uniformtypeidentifiers.UTType) CSSearchableItemAttributeSet

Creates an attribute set for the specified content type.

contentType: The type of the content. For example, png or movie.

Return Value ¶

An attribute set that represents an item of the specified content type.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/init(contentType:)

func (CSSearchableItemAttributeSet) InstantMessageAddresses ¶

func (c CSSearchableItemAttributeSet) InstantMessageAddresses() []string

An array of instant message addresses for the message.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/instantMessageAddresses

func (CSSearchableItemAttributeSet) Instructions ¶

func (c CSSearchableItemAttributeSet) Instructions() string

Instructions that concern the use of the item, such as an embargo or warning.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/instructions

func (CSSearchableItemAttributeSet) IsPriority ¶

func (c CSSearchableItemAttributeSet) IsPriority() foundation.NSNumber

A Boolean value that indicates whether the mail or messages content represents a prioritized item.

Discussion ¶

When the value of this property is `1`, Apple Intelligence identified this email or message content as needing priority classification.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/isPriority

func (CSSearchableItemAttributeSet) KeySignature ¶

func (c CSSearchableItemAttributeSet) KeySignature() string

The musical key of the song or audio composition that the file contains, such as C, Dm, or F#m.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/keySignature

func (CSSearchableItemAttributeSet) Keywords ¶

func (c CSSearchableItemAttributeSet) Keywords() []string

An array of keywords associated with the item, such as work, birthday, important, and so on.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/keywords

func (CSSearchableItemAttributeSet) Kind ¶

func (c CSSearchableItemAttributeSet) Kind() string

A description of the kind of document the item represents.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/kind

func (CSSearchableItemAttributeSet) Languages ¶

func (c CSSearchableItemAttributeSet) Languages() []string

A list of the included languages for the intellectual content of the media.

Discussion ¶

See BCP 47 for best practices in using language tags.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/languages

func (CSSearchableItemAttributeSet) LastUsedDate ¶

func (c CSSearchableItemAttributeSet) LastUsedDate() foundation.NSDate

The date on which the file was last used.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/lastUsedDate

func (CSSearchableItemAttributeSet) Latitude ¶

func (c CSSearchableItemAttributeSet) Latitude() foundation.NSNumber

The latitude of the item, in degrees north of the equator, expressed using the WGS84 datum.

Discussion ¶

Negative values lie south of the equator.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/latitude

func (CSSearchableItemAttributeSet) LayerNames ¶

func (c CSSearchableItemAttributeSet) LayerNames() []string

An array that contains the names of the various layers in the file.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/layerNames

func (CSSearchableItemAttributeSet) LensModel ¶

func (c CSSearchableItemAttributeSet) LensModel() string

The model of the lens that captured the image.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/lensModel

func (CSSearchableItemAttributeSet) LikelyJunk ¶

func (c CSSearchableItemAttributeSet) LikelyJunk() foundation.NSNumber

A value that indicates if the message is likely to be considered junk.

Discussion ¶

When the value of this property is 1, the message is likely to be considered junk; when the value is 0, the message is not likely to be considered junk.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/likelyJunk

func (CSSearchableItemAttributeSet) Local ¶

func (c CSSearchableItemAttributeSet) Local() foundation.NSNumber

A value that indicates if the media is local.

Discussion ¶

When the value of this property is 1, the media is local; when the value is 0, the media is not local.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/local

func (CSSearchableItemAttributeSet) Longitude ¶

func (c CSSearchableItemAttributeSet) Longitude() foundation.NSNumber

The longitude of the item, in degrees east of the prime meridian, expressed using the WGS84 datum.

Discussion ¶

Negative values lie west of the prime meridian.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/longitude

func (CSSearchableItemAttributeSet) Lyricist ¶

func (c CSSearchableItemAttributeSet) Lyricist() string

The lyricist or text writer for the song or audio composition that the file contains.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/lyricist

func (CSSearchableItemAttributeSet) MailboxIdentifiers ¶

func (c CSSearchableItemAttributeSet) MailboxIdentifiers() []string

An array of mailbox identifiers associated with the message.

Discussion ¶

Can include CSMailboxInbox, CSMailboxDrafts, CSMailboxSent, or a custom identifier.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/mailboxIdentifiers

func (CSSearchableItemAttributeSet) MaxAperture ¶

func (c CSSearchableItemAttributeSet) MaxAperture() foundation.NSNumber

The smallest F number of the lens.

Discussion ¶

The unit of the F number is the APEX value, which is typically in the range of 00.00 to 99.99.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/maxAperture

func (CSSearchableItemAttributeSet) MediaTypes ¶

func (c CSSearchableItemAttributeSet) MediaTypes() []string

The media types present in the content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/mediaTypes

func (CSSearchableItemAttributeSet) MetadataModificationDate ¶

func (c CSSearchableItemAttributeSet) MetadataModificationDate() foundation.NSDate

The date on which the last metadata attribute was changed.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/metadataModificationDate

func (CSSearchableItemAttributeSet) MeteringMode ¶

func (c CSSearchableItemAttributeSet) MeteringMode() string

The metering mode.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/meteringMode

func (CSSearchableItemAttributeSet) MoveFrom ¶

func (c CSSearchableItemAttributeSet) MoveFrom(sourceAttributeSet ICSSearchableItemAttributeSet)

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/move(from:)

func (CSSearchableItemAttributeSet) MusicalGenre ¶

func (c CSSearchableItemAttributeSet) MusicalGenre() string

The musical genre of the song or audio composition that the file contains, such as jazz, pop, rock, or classical.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/musicalGenre

func (CSSearchableItemAttributeSet) MusicalInstrumentCategory ¶

func (c CSSearchableItemAttributeSet) MusicalInstrumentCategory() string

The category of the instrument associated with the audio file.

Discussion ¶

A file should specify an associated instrument (note that you can use “Other Instrument” to specify an unknown instrument). In some categories, you can use instrument names to provide a more detailed instrument definition. For example, the Keyboards category lets you include instrument names such as Piano or Organ.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/musicalInstrumentCategory

func (CSSearchableItemAttributeSet) MusicalInstrumentName ¶

func (c CSSearchableItemAttributeSet) MusicalInstrumentName() string

The name of an instrument within the context of an instrument category.

Discussion ¶

For some instrument categories, such as Percussion and Keyboards, you can specify an instrument name.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/musicalInstrumentName

func (CSSearchableItemAttributeSet) NamedLocation ¶

func (c CSSearchableItemAttributeSet) NamedLocation() string

The name of the location or point of interest associated with the item.

Discussion ¶

The name may be user-provided.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/namedLocation

func (CSSearchableItemAttributeSet) Organizations ¶

func (c CSSearchableItemAttributeSet) Organizations() []string

A list of companies or organizations that created the content.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/organizations

func (CSSearchableItemAttributeSet) Orientation ¶

func (c CSSearchableItemAttributeSet) Orientation() foundation.NSNumber

The orientation of the data.

Discussion ¶

When the value of this property is 1, the orientation is portrait; when the value is 0, the orientation is landscape.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/orientation

func (CSSearchableItemAttributeSet) OriginalFormat ¶

func (c CSSearchableItemAttributeSet) OriginalFormat() string

The original format of the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/originalFormat

func (CSSearchableItemAttributeSet) OriginalSource ¶

func (c CSSearchableItemAttributeSet) OriginalSource() string

The original source of the media.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/originalSource

func (CSSearchableItemAttributeSet) PageCount ¶

func (c CSSearchableItemAttributeSet) PageCount() foundation.NSNumber

The number of pages in the document.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/pageCount

func (CSSearchableItemAttributeSet) PageHeight ¶

func (c CSSearchableItemAttributeSet) PageHeight() foundation.NSNumber

The height of the document page, in points (72 points per inch).

Discussion ¶

For a PDF document, this property specifies the height of the first page only; other pages in a PDF document may have different heights.

See: https://developer.apple.com/documentation/CoreSpotlight/CSSearchableItemAttributeSet/pageHeight