NCMBQuery Class Reference

Inherits from	NSObject
Declared in	NCMBQuery.h

Overview

NCMBQueryは、mobile backend上のデータを検索するためのクラスです。

Other Methods

`ncmbClassName`

検索を行うデータストアのクラス名

@property (nonatomic) NSString *ncmbClassName

Declared In

NCMBQuery.h

`limit`

検索結果の件数

@property (nonatomic) int limit

Declared In

NCMBQuery.h

`skip`

検索結果のスキップ数

@property (nonatomic) int skip

Declared In

NCMBQuery.h

`includeKey`

検索結果に子オブジェクトを含める場合の親データのキー

@property (nonatomic) NSString *includeKey

Declared In

NCMBQuery.h

Initialize

`+ queryWithClassName:`

クラス名を指定してクエリを作成する

+ (NCMBQuery *)queryWithClassName:(NSString *)className

Parameters

`className`	指定するクラス名

Return Value

NCMBQueryのインスタンス

Declared In

NCMBQuery.h

Configuration

`– includeKey:`

子の情報も含めて親情報を取得。クエリに設定された検索条件で取得できるオブジェクトに加えて、各オブジェクトに格納された、キー（引数）のオブジェクトの情報も取得する。

- (void)includeKey:(NSString *)key

Parameters

`key`	取得するキー

Declared In

NCMBQuery.h

`– whereKeyExists:`

「指定したキーの値が存在するオブジェクトを検索する」という検索条件を設定

- (void)whereKeyExists:(NSString *)key

Parameters

`key`	検索条件に使用するキー

Declared In

NCMBQuery.h

`– whereKeyDoesNotExist:`

「指定したキーの値が存在しないオブジェクトを検索する」という検索条件を設定

- (void)whereKeyDoesNotExist:(NSString *)key

Parameters

`key`	検索条件に使用するキー

Declared In

NCMBQuery.h

`– whereKey:equalTo:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)と等しいものを検索する」という検索条件を設定

- (void)whereKey:(NSString *)key equalTo:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:lessThan:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)の値より小さいものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key lessThan:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:lessThanOrEqualTo:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)の値以下のものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key lessThanOrEqualTo:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:greaterThan:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)の値より大きいものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key greaterThan:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:greaterThanOrEqualTo:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)の値以上のものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key greaterThanOrEqualTo:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:notEqualTo:`

「親クエリに指定したキーの値の中から指定したオブジェクト(第二引数)と等しくないものを検索する」という検索条件を設定

- (void)whereKey:(NSString *)key notEqualTo:(id)object

Parameters

`key`	検索条件に使用するキー
`object`	検索条件に使用する値(オブジェクト)

Declared In

NCMBQuery.h

`– whereKey:containedIn:`

「指定したキーの値が指定した配列の値のうちいずれか１つと一致するものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key containedIn:(NSArray *)array

Parameters

`key`	検索条件に使用するキー
`array`	検索条件に使用する配列

Declared In

NCMBQuery.h

`– whereKey:containedInArrayTo:`

「指定したキーに設定された配列の値と、指定した配列の値が１つ以上一致するものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key containedInArrayTo:(NSArray *)array

Parameters

`key`	検索条件に使用するキー（指定したキーの値が配列）
`array`	検索条件に使用する配列

Declared In

NCMBQuery.h

`– whereKey:notContainedIn:`

「指定したキーの値が指定した配列の値のいずれとも一致しないものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key notContainedIn:(NSArray *)array

Parameters

`key`	検索条件に使用するキー
`array`	検索条件に使用する配列

Declared In

NCMBQuery.h

`– whereKey:notContainedInArrayTo:`

「指定したキーに設定された配列の値と、指定した配列の値が１つも一致しないものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key notContainedInArrayTo:(NSArray *)array

Parameters

`key`	検索条件に使用するキー（指定したキーの値が配列）
`array`	検索条件に使用する配列

Declared In

NCMBQuery.h

`– whereKey:containsAllObjectsInArrayTo:`

「指定したキーの値に対して、指定した配列の値が全て含まれるものを検索」という検索条件を設定。指定した配列の値が全て含まれている場合は、指定したキーの値の中に一致しないものが含まれている場合でも検索される

- (void)whereKey:(NSString *)key containsAllObjectsInArrayTo:(NSArray *)array

Parameters

`key`	検索条件に使用するキー（指定したキーの値が配列）
`array`	検索条件に使用する配列

Declared In

NCMBQuery.h

`– whereKey:nearGeoPoint:`

指定位置から近い順にオブジェクトを取得。取得件数はlimit依存。

- (void)whereKey:(NSString *)key nearGeoPoint:(NCMBGeoPoint *)geoPoint

Parameters

`key`	検索条件に使用するキー
`geoPoint`	位置情報

Declared In

NCMBQuery.h

`– whereKey:nearGeoPoint:withinMiles:`

指定位置から近い順に、指定距離までの範囲に含まれるオブジェクトを取得。取得件数はlimit依存。

- (void)whereKey:(NSString *)key nearGeoPoint:(NCMBGeoPoint *)geoPoint withinMiles:(double)maxDistance

Parameters

`key`	検索条件に使用するキー
`geoPoint`	位置情報
`maxDistance`	検索範囲

Declared In

NCMBQuery.h

`– whereKey:nearGeoPoint:withinKilometers:`

指定位置から近い順に、指定距離までの範囲に含まれるオブジェクトを取得。取得件数はlimit依存。

- (void)whereKey:(NSString *)key nearGeoPoint:(NCMBGeoPoint *)geoPoint withinKilometers:(double)maxDistance

Parameters

`key`	検索条件に使用するキー
`geoPoint`	位置情報
`maxDistance`	検索範囲

Declared In

NCMBQuery.h

`– whereKey:nearGeoPoint:withinRadians:`

指定位置から近い順に、指定距離までの範囲に含まれるオブジェクトを取得。取得件数はlimit依存。

- (void)whereKey:(NSString *)key nearGeoPoint:(NCMBGeoPoint *)geoPoint withinRadians:(double)maxDistance

Parameters

`key`	検索条件に使用するキー
`geoPoint`	位置情報
`maxDistance`	検索範囲

Declared In

NCMBQuery.h

`– whereKey:withinGeoBoxFromSouthwest:toNortheast:`

指定された短形範囲に含まれるオブジェクトを取得。短形は、左下（南西）と右上（北東）を指定する。ソートは通常検索に準拠。取得件数はlimit依存。

- (void)whereKey:(NSString *)key withinGeoBoxFromSouthwest:(NCMBGeoPoint *)southwest toNortheast:(NCMBGeoPoint *)northeast

Parameters

`key`	検索条件に使用するキー
`southwest`	南西座標
`northeast`	北東座標

Declared In

NCMBQuery.h

Sub Queries

`– whereKey:matchesKey:inQuery:`

「第一引数は親クエリにおけるキー、第二引数はサブクエリ（第三引数）におけるキーとし、親とサブクエリで得られた値の中で一致するものを検索」という検索条件を設定。

- (void)whereKey:(NSString *)key matchesKey:(NSString *)otherKey inQuery:(NCMBQuery *)query

Parameters

`key`	親クエリにおけるキー
`otherKey`	サブクエリ（第三引数）におけるキー
`query`	サブクエリ

Declared In

NCMBQuery.h

`– whereKey:matchesQuery:`

「サブクエリ（第二引数）で取得できるオブジェクトの内、親クエリに指定したキー（第一引数）の値(オブジェクト)と一致するものを検索」という検索条件を設定

- (void)whereKey:(NSString *)key matchesQuery:(NCMBQuery *)query

Parameters

`key`	検索条件に使用するキー
`query`	検索条件に使用するクエリ

Declared In

NCMBQuery.h

`+ orQueryWithSubqueries:`

条件にしたい複数のクエリ

+ (NCMBQuery *)orQueryWithSubqueries:(NSArray *)queries

Parameters

`queries`	条件にしたい複数のクエリ

Declared In

NCMBQuery.h

Order

`– orderByAscending:`

「指定したキーで昇順に並べ替える」という検索条件を設定。すでに並べ替え設定が存在している場合は上書きされる。

- (void)orderByAscending:(NSString *)key

Parameters

`key`	並べ替えに使用するキー

Declared In

NCMBQuery.h

`– addAscendingOrder:`

「指定したキーで昇順に並べ替える」という設定を検索条件に追加。すでに並べ替え設定が存在している場合は、既存のものより優先度が低い。

- (void)addAscendingOrder:(NSString *)key

Parameters

`key`	並べ替えに使用するキー

Declared In

NCMBQuery.h

`– orderByDescending:`

「指定したキーで降順に並べ替える」という検索条件を設定。すでに並べ替え設定が存在している場合は上書きされる。

- (void)orderByDescending:(NSString *)key

Parameters

`key`	並べ替えに使用するキー

Declared In

NCMBQuery.h

`– addDescendingOrder:`

「指定したキーで降順に並べ替える」という設定を検索条件に追加。すでに並べ替え設定が存在している場合は、既存のものより優先度が低い。

- (void)addDescendingOrder:(NSString *)key

Parameters

`key`	並べ替えに使用するキー

Declared In

NCMBQuery.h

`– orderBySortDescriptor:`

「指定したNSSortDescriptor通りに並べ替える」という検索条件を設定。すでに並べ替え設定が存在している場合は上書きされる。

- (void)orderBySortDescriptor:(NSSortDescriptor *)sortDescriptor

Parameters

`sortDescriptor`	並び替えに使用するNSSortDescriptorのインスタンス

Declared In

NCMBQuery.h

`– orderBySortDescriptors:`

「指定した複数のNSSortDescriptor通りに並べ替える」という検索条件を設定。すでに並べ替え設定が存在している場合は上書きされる。

- (void)orderBySortDescriptors:(NSArray *)sortDescriptors

Parameters

`sortDescriptors`	並び替えに使用するNSSortDescriptorのインスタンスが格納された配列

Declared In

NCMBQuery.h

Getting Objects by ID

`+ getObjectOfClass:objectId:error:`

指定したクラスとobjectIDを持つオブジェクトを取得。必要があればエラーをセットし、取得することもできる。

+ (NCMBObject *)getObjectOfClass:(NSString *)objectClass objectId:(NSString *)objectId error:(NSError **)error

Parameters

`objectClass`	取得するオブジェクトのクラス名
`objectId`	取得するオブジェクトのobjectID
`error`	処理中に起きたエラーのポインタ

Return Value

指定されたNCMBObject

Declared In

NCMBQuery.h

`– getObjectWithId:error:`

指定したobjectIDを持つオブジェクトを取得。必要があればエラーをセットし、取得することもできる。

- (NCMBObject *)getObjectWithId:(NSString *)objectId error:(NSError **)error

Parameters

`objectId`	取得するオブジェクトのobjectID
`error`	処理中に起きたエラーのポインタ

Return Value

指定されたオブジェクト

Declared In

NCMBQuery.h

`– getObjectInBackgroundWithId:block:`

指定したobjectIDを持つオブジェクトを非同期で取得。取得し終わったら与えられたblockを呼び出す。

- (void)getObjectInBackgroundWithId:(NSString *)objectId block:(NCMBObjectResultBlock)block

Parameters

`objectId`	取得するオブジェクトのobjectID
`block`	通信後に実行されるblock。blockは次の引数のシグネチャを持つ必要がある (NCMBObject object, NSError error) objectには取得したオブジェクトが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

`– getObjectInBackgroundWithId:target:selector:`

指定したobjectIDを持つオブジェクトを非同期で取得。取得し終わったら指定されたコールバックを呼び出す。

- (void)getObjectInBackgroundWithId:(NSString *)objectId target:(id)target selector:(SEL)selector

Parameters

`objectId`	取得するオブジェクトのobjectID
`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult(NCMBObject)result error:(NSError )error resultには取得したオブジェクトが渡され、当てはまるものがなければnilが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

Getting User

`+ getUserObjectWithId:error:`

指定したobjectIDのユーザを取得。必要があればエラーをセットし、取得することもできる。

+ (NCMBUser *)getUserObjectWithId:(NSString *)objectId error:(NSError **)error

Parameters

`objectId`	取得するユーザのobjectID
`error`	処理中に起きたエラーのポインタ

Return Value

指定されたNCMBUser

Declared In

NCMBQuery.h

Find Objects

`– findObjects:`

設定されている検索条件に当てはまるオブジェクトを取得。必要があればエラーをセットし、取得することもできる。

- (NSArray *)findObjects:(NSError **)error

Parameters

`error`	処理中に起きたエラーのポインタ

Return Value

検索結果の配列

Declared In

NCMBQuery.h

`– findObjectsInBackgroundWithBlock:`

設定されている検索条件に当てはまるオブジェクトを非同期で取得。取得し終わったら与えられたblockを呼び出す。

- (void)findObjectsInBackgroundWithBlock:(NCMBArrayResultBlock)block

Parameters

`block`	信後に実行されるblock。blockは次の引数のシグネチャを持つ必要がある（NSArray objects, NSError error） objectsには取得したオブジェクトが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

`– findObjectsInBackgroundWithTarget:selector:`

設定されている検索条件に当てはまるオブジェクトを非同期で取得。取得し終わったら指定されたコールバックを呼び出す。

- (void)findObjectsInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NSArray )result error:(NSError )error. resultには取得したオブジェクトが渡され、当てはまるものがなければnilが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

Get first object

`– getFirstObject:`

設定されている検索条件に当てはまるオブジェクトを一件取得。必要があればエラーをセットし、取得することもできる。

- (id)getFirstObject:(NSError **)error

Parameters

`error`	処理中に起きたエラーのポインタ

Return Value

検索条件に該当するオブジェクト

Declared In

NCMBQuery.h

`– getFirstObjectInBackgroundWithBlock:`

設定されている検索条件に当てはまるオブジェクト一件を非同期で取得。取得し終わったら与えられたblockを呼び出す。

- (void)getFirstObjectInBackgroundWithBlock:(NCMBAnyObjectResultBlock)block

Parameters

`block`	通信後に実行されるblock。blockは次の引数のシグネチャを持つ必要がある（id object, NSError *error） objectには取得したオブジェクトが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

`– getFirstObjectInBackgroundWithTarget:selector:`

設定されている検索条件に当てはまるオブジェクト一件を非同期で取得。取得し終わったら指定されたコールバックを呼び出す。

- (void)getFirstObjectInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NCMBObject)result error:(NSError )error resultには取得したオブジェクトが渡され、当てはまるものがなければnilが渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

Count Objects

`– countObjects:`

設定されている検索条件に当てはまるオブジェクトの件数を取得。必要があればエラーをセットし、取得することもできる。

- (NSInteger)countObjects:(NSError **)error

Parameters

`error`	処理中に起きたエラーのポインタ

Return Value

検索条件に該当するオブジェクトの件数

Declared In

NCMBQuery.h

`– countObjectsInBackgroundWithBlock:`

設定されている検索条件に当てはまるオブジェクトの件数を非同期で取得。取得し終わったら与えられたblockを呼び出す。

- (void)countObjectsInBackgroundWithBlock:(NCMBIntegerResultBlock)block

Parameters

`block`	通信後に実行されるblock。blockは次の引数のシグネチャを持つ必要がある (int number, NSError *error) countには取得した件数が渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

`– countObjectsInBackgroundWithTarget:selector:`

設定されている検索条件に当てはまるオブジェクトの件数を非同期で取得。取得し終わったら指定されたコールバックを呼び出す。

- (void)countObjectsInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NSNumber )result error:(NSError )error resultには取得した件数が渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBQuery.h

Cancel

`– cancel`

非同期通信をキャンセルする。通信キャンセル後、コールバックは呼ばれない。

- (void)cancel

Declared In

NCMBQuery.h

Cache Setting

`– setCachePolicy:`

データ検索時のcachePolicyを設定する

- (void)setCachePolicy:(NSURLRequestCachePolicy)cachePolicy

Parameters

`cachePolicy`	クエリに設定するNSURLRequestCachePolicy

Declared In

NCMBQuery.h

`– hasCachedResult`

設定されている検索条件に当てはまるキャッシュの有無を取得

- (BOOL)hasCachedResult

Return Value

キャッシュが存在する場合はYESを返す

Declared In

NCMBQuery.h

`– clearCachedResult`

設定されている検索条件に当てはまるキャッシュをクリア

- (void)clearCachedResult

Declared In

NCMBQuery.h

`+ clearAllCachedResults`

全てのキャッシュをクリア

+ (void)clearAllCachedResults

Declared In

NCMBQuery.h

`– relatedTo:objectId:key:`

指定されたオブジェクトのリレーション先オブジェクトを検索する

- (void)relatedTo:(NSString *)targetClassName objectId:(NSString *)objectId key:(NSString *)key

Parameters

`targetClassName`	リレーション元のクラス名
`objectId`	リレーション元のオブジェクトID
`key`	リレーション元オブジェクトでリレーションが設定されているフィールド名

Declared In

NCMBQuery.h