Class

NSMetadataQuery

A query that you perform against Spotlight metadata. あなたがSpotlightメタデータに対して実行する照会。

Declaration 宣言

class NSMetadataQuery : NSObject

Overview 概要

The NSMetadataQuery class encapsulates the functionality provided by the MDQuery opaque type for querying the Spotlight metadata. NSMetadataQueryクラスは、Spotlightメタデータに問い合わせるためにMDQuery不透明型によって提供される機能性をカプセル化します。

NSMetadataQuery objects provide metadata query results in several ways: NSMetadataQueryオブジェクトは、メタデータ照会結果をいくつかの方法で提供します：

As individual attribute values for requested attributes. 照会された属性に対する独立した属性値として。
As value lists that contain the distinct values for given attributes in the query results. 値リストとして、それは与えられた属性に対するそれぞれ別個の値を照会結果において含みます。
As a result array proxy, containing all the query results. This is suitable for use with Cocoa bindings. 全ての照会結果を含んでいる、結果配列プロキシとして。これは、Cocoaバインディングで使うのに適します。
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. 結果それらからなる階層コレクションとして、指定されたグループ化属性に対して同じ値を持つ項目を一緒にまとめています。これもまた、Cocoaバインディングで使うのに適します。

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 the searchScopes property to customize. 省略時には、レシーバはそれの検索作用域に関して制限を持ちません。searchScopesプロパティを使ってカスタマイズしてください。

By default, notification of updated results occurs at 1.0 seconds. Use the notificationBatchingInterval property to customize. 省略時には、結果更新の通知は1.0秒で起こります。notificationBatchingIntervalプロパティを使ってカスタマイズしてください。

You must set a predicate with the predicate property before starting a query. あなたは、照会を始める前に、述部をpredicateプロパティで設定しなければなりません。

Topics 話題

Configuring Queries 照会を構成設定する

var searchScopes: [Any]

An array containing the search scopes. 検索作用域それらを含んでいる配列。

var predicate: NSPredicate?

The predicate used to filter query results. 照会結果をフィルタするために使われる述部。

var sortDescriptors: [NSSortDescriptor]

An array of sort descriptor objects. ソート記述子オブジェクトそれらからなる配列。

var valueListAttributes: [String]

An array of attributes whose values are gathered by the query. 属性それらからなる配列、それらの値が照会によって収集されます。

var groupingAttributes: [String]?

An array of grouping attributes. (read-only) グループ化属性それらからなる配列。（読み出しのみ）

var notificationBatchingInterval: TimeInterval

The interval at which notification of updated results occurs. 結果更新の通知が起こる間隔。

var delegate: NSMetadataQueryDelegate?

The query’s delegate. 照会のもつ委任先。

var searchItems: [Any]?

An array of objects that define the query’s scope. その照会のもつ領域を定義するオブジェクトからなる配列。

Running Queries 照会を実行する

var isStarted: Bool

A Boolean value that indicates whether the query has started. (read-only) 照会が始まったかどうかを指し示すブール値。（読み出しのみ）

func start() -> Bool

Attempts to start the query. 照会を開始しようと試みます。

var isGathering: Bool

A Boolean value that indicates whether the receiver is in the initial gathering phase of the query. (read-only) レシーバがその照会の最初の収集段階の中にあるかどうかを指し示すブール値。（読み出しのみ）

var isStopped: Bool

A Boolean value that indicates whether the query has stopped. 照会が停止したかどうかを指し示すブール値。

func stop()

Stops the receiver’s current query from gathering any further results. レシーバの現在の照会が何かさらに結果を収集するのを止めます。

Getting Query Results 照会結果を取得する

var results: [Any]

An array containing the query’s results. 照会の持つ結果を含んでいる配列。

var resultCount: Int

The number of results returned by the query. (read-only) 照会によって返される結果の数。（読み出しのみ）

func result(at: Int) -> Any

Returns the query result at a specific index. 指定されたインデックスでの照会結果を返します。

func index(ofResult: Any) -> Int

Returns the index of a query result object in the receiver’s results array. レシーバのもつ結果配列の中の照会結果オブジェクトのインデックスを返します。

var groupedResults: [NSMetadataQueryResultGroup]

An array containing hierarchical groups of query results. (read-only) 照会結果の階層化したグループを含んでいる配列。（読み出しのみ）

class NSMetadataQueryResultGroup

The NSMetadataQueryResultGroup class represents a collection of grouped attribute results returned by an NSMetadataQuery object. NSMetadataQueryResultGroupクラスは、NSMetadataQueryオブジェクトによって返されるグループ化された属性結果のコレクションを表します。

func enumerateResults((Any, Int, UnsafeMutablePointer<ObjCBool>) -> Void)

Enumerates the current set of results using the given block. 与えられたブロックを使って現在の結果の集合を列挙します。

func enumerateResults(options: NSEnumerationOptions, using: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Void)

Enumerates the current set of results using the given options and block. 与えられたオプションとブロックを使って現在の結果の集合を列挙します。

var valueLists: [String : [NSMetadataQueryAttributeValueTuple]]

A dictionary containing the value lists generated by the query. 照会によって生成される値リストそれらを含んでいるある辞書。

class NSMetadataQueryAttributeValueTuple

The NSMetadataQueryAttributeValueTuple class represents attribute-value tuples, which are objects that contain the attribute name and value of a metadata attribute. NSMetadataQueryAttributeValueTupleクラスは「属性値」タプルを表します、それは、あるメタデータ属性の属性名と値を含んでいるオブジェクトです。

func value(ofAttribute: String, forResultAt: Int) -> Any?

Returns the value for the attribute name attrName at the index in the results specified by idx. 属性名attrNameに対する、idxによって指定される結果の中のインデックスでの値を返します。

func enableUpdates()

Enables updates to the query results. 照会結果の更新を可能にします。

func disableUpdates()

Disables updates to the query results. 照会結果の更新を不可能にします。

var operationQueue: OperationQueue?

The queue on which query result notifications are posted. それの上に照会結果通知が投函されるところのキュー。

Constants 定数

Metadata Query Search Scopes Metadata照会の検索作用域

Constants for the predefined search scopes used by searchScopes. searchScopesによって使われるあらかじめ定義された検索作用域に対する定数。

Content Relevance 内容妥当性

In addition to including the requested metadata attributes, a query result also includes content relevance, accessed with the following key. 照会されたメタデータ属性を含むことに加えて、照会結果はまた内容妥当性を含み、以下のキーでアクセスされます。

Keys for Use with a Notification Info Dictionary 通知情報辞書で使うためのキー

Constants for keys to retrieve the collection of changed items from a notification’s user info dictionary. 変更された項目からなるコレクションを通知のもつユーザ情報辞書から取ってくるキーに対する定数。