CSSearchableIndex Class

Definition

Namespace:: CoreSpotlight

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A search index used by Spotlight.

[Foundation.Register("CSSearchableIndex", true)]
public class CSSearchableIndex : Foundation.NSObject

[<Foundation.Register("CSSearchableIndex", true)>]
type CSSearchableIndex = class
    inherit NSObject

Inheritance: Object

NSObject
CSSearchableIndex

Attributes: RegisterAttribute

Remarks

Typically, developers should use DefaultSearchableIndex to index their application data.

Constructors

Name	Description
CSSearchableIndex()	Creates a new CSSearchableIndex with default values.
CSSearchableIndex(NativeHandle)	A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
CSSearchableIndex(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
CSSearchableIndex(String, CSFileProtection)	Creates a new CSSearchableIndex with the specified `name` and protection options.
CSSearchableIndex(String, NSFileProtectionType, String, IntPtr)
CSSearchableIndex(String, NSString, String, IntPtr)
CSSearchableIndex(String, NSString)	Creates a new index on the device with the specified name and protection class.
CSSearchableIndex(String)	Creates a new index on the device with the specified name.

Properties

Name	Description
AccessibilityAttributedUserInputLabels	(Inherited from NSObject)
AccessibilityRespondsToUserInteraction	(Inherited from NSObject)
AccessibilityTextualContext	(Inherited from NSObject)
AccessibilityUserInputLabels	(Inherited from NSObject)
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
DebugDescription	(Inherited from NSObject)
DefaultSearchableIndex	Gets the default search index for the device.
Description	(Inherited from NSObject)
ExposedBindings	(Inherited from NSObject)
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IndexDelegate	Gets or sets the delegate that responds to requests for index-related tasks.
IsDirectBinding	(Inherited from NSObject)
IsIndexingAvailable	Gets a Boolean value that tells whether indexing is available.
IsProxy	(Inherited from NSObject)
RetainCount	(Inherited from NSObject)
Self	(Inherited from NSObject)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Zone	(Inherited from NSObject)

Methods

Name	Description
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	(Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSBindingOptions)	(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
Copy()	(Inherited from NSObject)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
Delete(String[], Action<NSError>)	Removes the identified items and runs `completionHandler` when finished.
DeleteAll(Action<NSError>)	Removes all items and runs `completionHandler` when finished.
DeleteAllAsync()	Asynchronously removes all items.
DeleteAsync(String[])	Asynchronously removes the identified items.
DeleteWithDomain(String[], Action<NSError>)	Removes all items from the specified domains and runs `completionHandler` after the index change is journaled.
DeleteWithDomainAsync(String[])	Asynchronously removes all items from the specified domains.
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
FetchData(String, String, UTType, Action<NSData,NSError>)
FetchDataAsync(String, String, UTType)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Index(CSSearchableItem[], Action<NSError>)	Indexes the specified searchable items and runs `completionHandler` when finished.
IndexAsync(CSSearchableItem[])	Asynchronously indexes the specified searchable items.
Init()	(Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	(Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
ProvideData(String, String, String, Action<NSData,NSError>)
ProvideDataAsync(String, String, String)
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
RespondsToSelector(Selector)	(Inherited from NSObject)
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)

Extension Methods

Name	Description
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
BeginIndexBatch(CSSearchableIndex)	Begins an index update batch.
EndIndexBatch(CSSearchableIndex, NSData, NSData, CSSearchableIndexEndIndexHandler)
EndIndexBatch(CSSearchableIndex, NSData, Action<NSError>)	Ends an index update batch, relying on the 250 bytes of information for crash recovery, and calls `completionHandler` when finished.
FetchLastClientState(CSSearchableIndex, CSSearchableIndexFetchHandler)	Fetches the client state and runs `completionHandler` when finished..
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
AccessibilityHitTest(NSObject, CGPoint, UIEvent)
GetAccessibilityNextTextNavigationElement(NSObject)
GetAccessibilityNextTextNavigationElementBlock(NSObject)
GetAccessibilityPreviousTextNavigationElement(NSObject)
GetAccessibilityPreviousTextNavigationElementBlock(NSObject)
SetAccessibilityNextTextNavigationElement(NSObject, NSObject)
SetAccessibilityNextTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityPreviousTextNavigationElement(NSObject, NSObject)
SetAccessibilityPreviousTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
GetAccessibilityTextInputResponder(NSObject)
GetAccessibilityTextInputResponderHandler(NSObject)
SetAccessibilityTextInputResponder(NSObject, IUITextInput)
SetAccessibilityTextInputResponderHandler(NSObject, UITextInputReturnHandler)

Applies to

Share via