PFQuery.h

#import <Foundation/Foundation.h>

#import <Bolts/BFTask.h>

#import <Parse/PFConstants.h>
#import <Parse/PFGeoPoint.h>
#import <Parse/PFObject.h>
#import <Parse/PFUser.h>

NS_ASSUME_NONNULL_BEGIN

@interface PFQuery<PFGenericObject : PFObject *> : NSObject<NSCopying>

#pragma mark - Blocks

typedef void (^PFQueryArrayResultBlock)(NSArray<PFGenericObject> *_Nullable objects, NSError * _Nullable error);

#pragma mark - Creating a Query for a Class

- (instancetype)initWithClassName:(NSString *)className;

+ (instancetype)queryWithClassName:(NSString *)className;

+ (instancetype)queryWithClassName:(NSString *)className predicate:(nullable NSPredicate *)predicate;

@property (nonatomic, strong) NSString *parseClassName;

#pragma mark - Adding Basic Constraints

- (instancetype)includeKey:(NSString *)key;

- (instancetype)includeKeys:(NSArray<NSString *> *)keys;

- (instancetype)selectKeys:(NSArray<NSString *> *)keys;

- (instancetype)whereKeyExists:(NSString *)key;

- (instancetype)whereKeyDoesNotExist:(NSString *)key;

- (instancetype)whereKey:(NSString *)key equalTo:(id)object;

- (instancetype)whereKey:(NSString *)key lessThan:(id)object;

- (instancetype)whereKey:(NSString *)key lessThanOrEqualTo:(id)object;

- (instancetype)whereKey:(NSString *)key greaterThan:(id)object;

- (instancetype)whereKey:(NSString *)key greaterThanOrEqualTo:(id)object;

- (instancetype)whereKey:(NSString *)key notEqualTo:(id)object;

- (instancetype)whereKey:(NSString *)key containedIn:(NSArray *)array;

- (instancetype)whereKey:(NSString *)key notContainedIn:(NSArray *)array;

- (instancetype)whereKey:(NSString *)key containsAllObjectsInArray:(NSArray *)array;

#pragma mark - Adding Location Constraints

- (instancetype)whereKey:(NSString *)key nearGeoPoint:(PFGeoPoint *)geopoint;

- (instancetype)whereKey:(NSString *)key
            nearGeoPoint:(PFGeoPoint *)geopoint
             withinMiles:(double)maxDistance;

- (instancetype)whereKey:(NSString *)key
            nearGeoPoint:(PFGeoPoint *)geopoint
        withinKilometers:(double)maxDistance;

- (instancetype)whereKey:(NSString *)key
            nearGeoPoint:(PFGeoPoint *)geopoint
           withinRadians:(double)maxDistance;

- (instancetype)whereKey:(NSString *)key withinGeoBoxFromSouthwest:(PFGeoPoint *)southwest toNortheast:(PFGeoPoint *)northeast;

#pragma mark - Adding String Constraints

- (instancetype)whereKey:(NSString *)key matchesRegex:(NSString *)regex;

- (instancetype)whereKey:(NSString *)key
            matchesRegex:(NSString *)regex
               modifiers:(nullable NSString *)modifiers;

- (instancetype)whereKey:(NSString *)key containsString:(nullable NSString *)substring;

- (instancetype)whereKey:(NSString *)key hasPrefix:(nullable NSString *)prefix;

- (instancetype)whereKey:(NSString *)key hasSuffix:(nullable NSString *)suffix;

#pragma mark - Adding Subqueries

+ (instancetype)orQueryWithSubqueries:(NSArray<PFQuery *> *)queries;

- (instancetype)whereKey:(NSString *)key
              matchesKey:(NSString *)otherKey
                 inQuery:(PFQuery *)query;

- (instancetype)whereKey:(NSString *)key
         doesNotMatchKey:(NSString *)otherKey
                 inQuery:(PFQuery *)query;

- (instancetype)whereKey:(NSString *)key matchesQuery:(PFQuery *)query;

- (instancetype)whereKey:(NSString *)key doesNotMatchQuery:(PFQuery *)query;

#pragma mark - Sorting

- (instancetype)orderByAscending:(NSString *)key;

- (instancetype)addAscendingOrder:(NSString *)key;

- (instancetype)orderByDescending:(NSString *)key;

- (instancetype)addDescendingOrder:(NSString *)key;

- (instancetype)orderBySortDescriptor:(NSSortDescriptor *)sortDescriptor;

- (instancetype)orderBySortDescriptors:(nullable NSArray<NSSortDescriptor *> *)sortDescriptors;

#pragma mark - Getting Objects by ID

- (BFTask<PFGenericObject> *)getObjectInBackgroundWithId:(NSString *)objectId;

- (void)getObjectInBackgroundWithId:(NSString *)objectId
                              block:(nullable void (^)(PFGenericObject _Nullable object, NSError *_Nullable error))block;

#pragma mark - Getting User Objects

+ (instancetype)queryForUser PARSE_DEPRECATED("Use [PFUser query] instead.");

#pragma mark - Getting all Matches for a Query

- (BFTask<NSArray<PFGenericObject> *> *)findObjectsInBackground;

- (void)findObjectsInBackgroundWithBlock:(nullable PFQueryArrayResultBlock)block;

#pragma mark - Getting the First Match in a Query

- (BFTask<PFGenericObject> *)getFirstObjectInBackground;

- (void)getFirstObjectInBackgroundWithBlock:(nullable void (^)(PFGenericObject _Nullable object, NSError *_Nullable error))block;

#pragma mark - Counting the Matches in a Query

- (BFTask<NSNumber *> *)countObjectsInBackground;

- (void)countObjectsInBackgroundWithBlock:(nullable PFIntegerResultBlock)block;

#pragma mark - Cancelling a Query

- (void)cancel;

#pragma mark - Paginating Results

@property (nonatomic, assign) NSInteger limit;

@property (nonatomic, assign) NSInteger skip;

#pragma mark - Controlling Caching Behavior

@property (nonatomic, assign) PFCachePolicy cachePolicy;

@property (nonatomic, assign) NSTimeInterval maxCacheAge;

@property (nonatomic, assign, readonly) BOOL hasCachedResult;

- (void)clearCachedResult;

+ (void)clearAllCachedResults;

#pragma mark - Query Source

- (instancetype)fromLocalDatastore;

- (instancetype)fromPin;

- (instancetype)fromPinWithName:(nullable NSString *)name;

- (instancetype)ignoreACLs;

#pragma mark - Advanced Settings

@property (nonatomic, assign) BOOL trace;

@end

NS_ASSUME_NONNULL_END