Platforms to show: All Mac Windows Linux Cross-Platform
NSMetadataQueryMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | iCloud | MBS MacCloud Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
You may prefer MDQueryMBS class from our plugins. NSMetadataQueryMBS exists as it supports iCloud search.
NSMetadataQuery objects provide metadata query results in several ways:
- As individual attribute values for requested attributes.
- As value lists that contain the distinct values for given attributes in the query results.
- A result array proxy, containing all the query results. This is suitable for use with Cocoa bindings.
- As a hierarchical collection of results, grouping together items with the same values for specified grouping attributes. This is also suitable for use with Cocoa bindings.
Queries have two phases: the initial gathering phase that collects all currently matching results and a second live-update phase.
By default the receiver has no limitation on its search scope. Use setSearchScopes to customize.
By default, notification of updated results occurs at 1.0 seconds. Use setNotificationBatchingInterval to customize.
You must set a predicate with the setPredicate method before starting a query.
- 4 events
- event DidFinishGathering(n as NSNotificationMBS)
- event DidStartGathering(n as NSNotificationMBS)
- event DidUpdate(n as NSNotificationMBS)
- event GatheringProgress(n as NSNotificationMBS)
- 3 properties
- property Handle as Integer
- property notificationBatchingInterval as Double
- property predicate as NSPredicateMBS
- 23 methods
- method Constructor
- method Destructor
- method disableUpdates
- method enableUpdates
- method groupedResults as NSMetadataQueryResultGroupMBS()
- method groupingAttributes as string()
- method indexOfResult(item as NSMetadataItemMBS) as Integer
- method isGathering as boolean
- method isStarted as boolean
- method isStopped as boolean
- method resultAtIndex(index as Integer) as NSMetadataItemMBS
- method resultCount as Integer
- method results as NSMetadataItemMBS()
- method searchScopes as string()
- method setGroupingAttributes(attributeNames() as string)
- method setSearchScopes(folders() as folderitem)
- method setSearchScopes(paths() as string)
- method setSearchScopes(paths() as string, folders() as folderitem)
- method setSortDescriptor(sortDescriptor as NSSortDescriptorMBS)
- method setSortDescriptors(sortDescriptors() as NSSortDescriptorMBS)
- method sortDescriptors as NSSortDescriptorMBS()
- method startQuery as boolean
- method stopQuery
- 10 shared methods
- shared method NSMetadataQueryDidFinishGatheringNotification as string
- shared method NSMetadataQueryDidStartGatheringNotification as string
- shared method NSMetadataQueryDidUpdateNotification as string
- shared method NSMetadataQueryGatheringProgressNotification as string
- shared method NSMetadataQueryLocalComputerScope as string
- shared method NSMetadataQueryNetworkScope as string
- shared method NSMetadataQueryResultContentRelevanceAttribute as string
- shared method NSMetadataQueryUbiquitousDataScope as string
- shared method NSMetadataQueryUbiquitousDocumentsScope as string
- shared method NSMetadataQueryUserHomeScope as string
This class has no sub classes.
Some examples using this class:
Blog Entries
The items on this page are in the following plugins: MBS MacCloud Plugin.
NSMetadataItemMBS - NSMetadataQueryResultGroupMBS