// AVObject.h // Copyright 2013 AVOS Inc. All rights reserved. #import #import "AVConstants.h" @class AVRelation; @class AVACL; /*! An object that is a local representation of data persisted to the AVOS Cloud. This is the main class that is used to interact with objects in your app. */ @interface AVObject : NSObject #pragma mark Constructors /*! @name Creating a AVObject */ /*! Creates a new AVObject with a class name. @param className A class name can be any alphanumeric string that begins with a letter. It represents an object in your app, like a User of a Document. @return the object that is instantiated with the given class name. */ + (instancetype)objectWithClassName:(NSString *)className; /*! Creates a reference to an existing AVObject for use in creating associations between AVObjects. Calling isDataAvailable on this object will return NO until fetchIfNeeded or refresh has been called. No network request will be made. @param className The object's class. @param objectId The object id for the referenced object. @return A AVObject without data. */ + (instancetype)objectWithoutDataWithClassName:(NSString *)className objectId:(NSString *)objectId; /*! Creates a new AVObject with a class name, initialized with data constructed from the specified set of objects and keys. @param className The object's class. @param dictionary An NSDictionary of keys and objects to set on the new AVObject. @return A AVObject with the given class name and set with the given data. */ + (instancetype)objectWithClassName:(NSString *)className dictionary:(NSDictionary *)dictionary; /*! Initializes a new AVObject with a class name. @param newClassName A class name can be any alphanumeric string that begins with a letter. It represents an object in your app, like a User or a Document. @return the object that is instantiated with the given class name. */ - (id)initWithClassName:(NSString *)newClassName; #pragma mark - #pragma mark Properties /*! @name Managing Object Properties */ /*! The id of the object. */ @property (nonatomic, retain) NSString *objectId; /*! When the object was last updated. */ @property (nonatomic, retain, readonly) NSDate *updatedAt; /*! When the object was created. */ @property (nonatomic, retain, readonly) NSDate *createdAt; /*! The class name of the object. */ @property (readonly) NSString *className; /*! The ACL for this object. */ @property (nonatomic, retain) AVACL *ACL; /*! Returns an array of the keys contained in this object. This does not include createdAt, updatedAt, authData, or objectId. It does include things like username and ACL. */ - (NSArray *)allKeys; #pragma mark - #pragma mark Get and set /*! Returns the object associated with a given key. @param key The key that the object is associated with. @return The value associated with the given key, or nil if no value is associated with key. */ - (id)objectForKey:(NSString *)key; /*! Sets the object associated with a given key. @param object The object. @param key The key. */ - (void)setObject:(id)object forKey:(NSString *)key; /*! Unsets a key on the object. @param key The key. */ - (void)removeObjectForKey:(NSString *)key; /*! * In LLVM 4.0 (XCode 4.5) or higher allows myAVObject[key]. @param key The key. */ - (id)objectForKeyedSubscript:(NSString *)key; /*! * In LLVM 4.0 (XCode 4.5) or higher allows myObject[key] = value @param object The object. @param key The key. */ - (void)setObject:(id)object forKeyedSubscript:(NSString *)key; /*! Returns the relation object associated with the given key @param key The key that the relation is associated with. */ - (AVRelation *)relationforKey:(NSString *)key; #pragma mark - #pragma mark Array add and remove /*! Adds an object to the end of the array associated with a given key. @param object The object to add. @param key The key. */ - (void)addObject:(id)object forKey:(NSString *)key; /*! Adds the objects contained in another array to the end of the array associated with a given key. @param objects The array of objects to add. @param key The key. */ - (void)addObjectsFromArray:(NSArray *)objects forKey:(NSString *)key; /*! Adds an object to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed. @param object The object to add. @param key The key. */ - (void)addUniqueObject:(id)object forKey:(NSString *)key; /*! Adds the objects contained in another array to the array associated with a given key, only adding elements which are not already present in the array. The position of the insert is not guaranteed. @param objects The array of objects to add. @param key The key. */ - (void)addUniqueObjectsFromArray:(NSArray *)objects forKey:(NSString *)key; /*! Removes all occurrences of an object from the array associated with a given key. @param object The object to remove. @param key The key. */ - (void)removeObject:(id)object forKey:(NSString *)key; /*! Removes all occurrences of the objects contained in another array from the array associated with a given key. @param objects The array of objects to remove. @param key The key. */ - (void)removeObjectsInArray:(NSArray *)objects forKey:(NSString *)key; #pragma mark - #pragma mark Increment /*! Increments the given key by 1. @param key The key. */ - (void)incrementKey:(NSString *)key; /*! Increments the given key by a number. @param key The key. @param amount The amount to increment. */ - (void)incrementKey:(NSString *)key byAmount:(NSNumber *)amount; #pragma mark - #pragma mark Save /*! @name Saving an Object to AVOS Cloud */ /*! Saves the AVObject. @return whether the save succeeded. */ - (BOOL)save; /*! Saves the AVObject and sets an error if it occurs. @param error Pointer to an NSError that will be set if necessary. @return whether the save succeeded. */ - (BOOL)save:(NSError **)error; /*! Saves the AVObject asynchronously. */ - (void)saveInBackground; /*! Saves the AVObject asynchronously and executes the given callback block. @param block The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error) */ - (void)saveInBackgroundWithBlock:(AVBooleanResultBlock)block; /*! Saves the AVObject asynchronously and calls the given callback. @param target The object to call selector on. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(NSNumber *)result error:(NSError *)error. error will be nil on success and set if there was an error. [result boolValue] will tell you whether the call succeeded or not. */ - (void)saveInBackgroundWithTarget:(id)target selector:(SEL)selector; /*! @see saveEventually: */ - (void)saveEventually; /*! Saves this object to the server at some unspecified time in the future, even if AVOS Cloud is currently inaccessible. Use this when you may not have a solid network connection, and don't need to know when the save completes. If there is some problem with the object such that it can't be saved, it will be silently discarded. If the save completes successfully while the object is still in memory, then callback will be called. Objects saved with this method will be stored locally in an on-disk cache until they can be delivered to AVOS Cloud. They will be sent immediately if possible. Otherwise, they will be sent the next time a network connection is available. Objects saved this way will persist even after the app is closed, in which case they will be sent the next time the app is opened. If more than 10MB of data is waiting to be sent, subsequent calls to saveEventually will cause old saves to be silently discarded until the connection can be re-established, and the queued objects can be saved. @param callback The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error) */ - (void)saveEventually:(AVBooleanResultBlock)callback; #pragma mark - #pragma mark Save All /*! @name Saving Many Objects to AVOS Cloud */ /*! Saves a collection of objects all at once. @param objects The array of objects to save. @return whether the save succeeded. */ + (BOOL)saveAll:(NSArray *)objects; /*! Saves a collection of objects all at once and sets an error if necessary. @param objects The array of objects to save. @param error Pointer to an NSError that will be set if necessary. @return whether the save succeeded. */ + (BOOL)saveAll:(NSArray *)objects error:(NSError **)error; /*! Saves a collection of objects all at once asynchronously. @param objects The array of objects to save. */ + (void)saveAllInBackground:(NSArray *)objects; /*! Saves a collection of objects all at once asynchronously and the block when done. @param objects The array of objects to save. @param block The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error) */ + (void)saveAllInBackground:(NSArray *)objects block:(AVBooleanResultBlock)block; /*! Saves a collection of objects all at once asynchronously and calls a callback when done. @param objects The array of objects to save. @param target The object to call selector on. @param selector The selector to call. It should have the following signature: (void)callbackWithError:(NSError *)error. error will be nil on success and set if there was an error. */ + (void)saveAllInBackground:(NSArray *)objects target:(id)target selector:(SEL)selector; #pragma mark - #pragma mark Refresh /*! @name Getting an Object from AVOS Cloud */ /*! Gets whether the AVObject has been fetched. @return YES if the AVObject is new or has been fetched or refreshed. NO otherwise. */ - (BOOL)isDataAvailable; #if PARSE_IOS_ONLY // Deprecated and intentionally not available on the new OS X SDK /*! Refreshes the AVObject with the current data from the server. */ - (void)refresh; /*! Refreshes the AVObject with the current data from the server. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. */ - (void)refreshWithKeys:(NSArray *)keys; /*! Refreshes the AVObject with the current data from the server and sets an error if it occurs. @param error Pointer to an NSError that will be set if necessary. @return success or not */ - (BOOL)refresh:(NSError **)error; /*! Refreshes the AVObject asynchronously and executes the given callback block. @param block The block to execute. The block should have the following argument signature: (AVObject *object, NSError *error) */ - (void)refreshInBackgroundWithBlock:(AVObjectResultBlock)block; /*! Refreshes the AVObject with the current data from the server. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. @param block The block to execute. The block should have the following argument signature: (AVObject *object, NSError *error) */ - (void)refreshInBackgroundWithKeys:(NSArray *)keys block:(AVObjectResultBlock)block; /*! Refreshes the AVObject asynchronously and calls the given callback. @param target The target on which the selector will be called. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(AVObject *)refreshedObject error:(NSError *)error. error will be nil on success and set if there was an error. refreshedObject will be the AVObject with the refreshed data. */ - (void)refreshInBackgroundWithTarget:(id)target selector:(SEL)selector; #endif /*! Fetches the AVObject with the current data from the server. */ - (void)fetch; /*! Fetches the AVObject with the current data from the server and sets an error if it occurs. @param error Pointer to an NSError that will be set if necessary. @return success or not */ - (BOOL)fetch:(NSError **)error; /*! Fetches the AVObject with the current data and specified keys from the server and sets an error if it occurs. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. */ - (void)fetchWithKeys:(NSArray *)keys; /*! Fetches the AVObject with the current data and specified keys from the server and sets an error if it occurs. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. @param error Pointer to an NSError that will be set if necessary. @return success or not */ - (BOOL)fetchWithKeys:(NSArray *)keys error:(NSError **)error; /*! Fetches the AVObject's data from the server if isDataAvailable is false. */ - (AVObject *)fetchIfNeeded; /*! Fetches the AVObject's data from the server if isDataAvailable is false. @param error Pointer to an NSError that will be set if necessary. */ - (AVObject *)fetchIfNeeded:(NSError **)error; /*! Fetches the AVObject's data from the server if isDataAvailable is false. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. */ - (AVObject *)fetchIfNeededWithKeys:(NSArray *)keys; /*! Fetches the AVObject's data from the server if isDataAvailable is false. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. @param error Pointer to an NSError that will be set if necessary. */ - (AVObject *)fetchIfNeededWithKeys:(NSArray *)keys error:(NSError **)error; /*! Fetches the AVObject asynchronously and executes the given callback block. @param block The block to execute. The block should have the following argument signature: (AVObject *object, NSError *error) */ - (void)fetchInBackgroundWithBlock:(AVObjectResultBlock)block; /*! Fetches the AVObject asynchronously and executes the given callback block. @param keys Pointer to an NSArray that contains objects specified by the keys want to fetch. @param block The block to execute. The block should have the following argument signature: (AVObject *object, NSError *error) */ - (void)fetchInBackgroundWithKeys:(NSArray *)keys block:(AVObjectResultBlock)block; /*! Fetches the AVObject asynchronously and calls the given callback. @param target The target on which the selector will be called. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(AVObject *)refreshedObject error:(NSError *)error. error will be nil on success and set if there was an error. refreshedObject will be the AVObject with the refreshed data. */ - (void)fetchInBackgroundWithTarget:(id)target selector:(SEL)selector; /*! Fetches the AVObject's data asynchronously if isDataAvailable is false, then calls the callback block. @param block The block to execute. The block should have the following argument signature: (AVObject *object, NSError *error) */ - (void)fetchIfNeededInBackgroundWithBlock:(AVObjectResultBlock)block; /*! Fetches the AVObject's data asynchronously if isDataAvailable is false, then calls the callback. @param target The target on which the selector will be called. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(AVObject *)fetchedObject error:(NSError *)error. error will be nil on success and set if there was an error. */ - (void)fetchIfNeededInBackgroundWithTarget:(id)target selector:(SEL)selector; /*! @name Getting Many Objects from AVOS Cloud */ /*! Fetches all of the AVObjects with the current data from the server @param objects The list of objects to fetch. */ + (void)fetchAll:(NSArray *)objects; /*! Fetches all of the AVObjects with the current data from the server and sets an error if it occurs. @param objects The list of objects to fetch. @param error Pointer to an NSError that will be set if necessary @return success or not */ + (BOOL)fetchAll:(NSArray *)objects error:(NSError **)error; /*! Fetches all of the AVObjects with the current data from the server @param objects The list of objects to fetch. */ + (void)fetchAllIfNeeded:(NSArray *)objects; /*! Fetches all of the AVObjects with the current data from the server and sets an error if it occurs. @param objects The list of objects to fetch. @param error Pointer to an NSError that will be set if necessary @return success or not */ + (BOOL)fetchAllIfNeeded:(NSArray *)objects error:(NSError **)error; /*! Fetches all of the AVObjects with the current data from the server asynchronously and calls the given block. @param objects The list of objects to fetch. @param block The block to execute. The block should have the following argument signature: (NSArray *objects, NSError *error) */ + (void)fetchAllInBackground:(NSArray *)objects block:(AVArrayResultBlock)block; /*! Fetches all of the AVObjects with the current data from the server asynchronously and calls the given callback. @param objects The list of objects to fetch. @param target The target on which the selector will be called. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(NSArray *)fetchedObjects error:(NSError *)error. error will be nil on success and set if there was an error. fetchedObjects will the array of AVObjects that were fetched. */ + (void)fetchAllInBackground:(NSArray *)objects target:(id)target selector:(SEL)selector; /*! Fetches all of the AVObjects with the current data from the server asynchronously and calls the given block. @param objects The list of objects to fetch. @param block The block to execute. The block should have the following argument signature: (NSArray *objects, NSError *error) */ + (void)fetchAllIfNeededInBackground:(NSArray *)objects block:(AVArrayResultBlock)block; /*! Fetches all of the AVObjects with the current data from the server asynchronously and calls the given callback. @param objects The list of objects to fetch. @param target The target on which the selector will be called. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(NSArray *)fetchedObjects error:(NSError *)error. error will be nil on success and set if there was an error. fetchedObjects will the array of AVObjects that were fetched. */ + (void)fetchAllIfNeededInBackground:(NSArray *)objects target:(id)target selector:(SEL)selector; #pragma mark - #pragma mark Delete /*! @name Removing an Object from AVOS Cloud */ /*! Deletes the AVObject. @return whether the delete succeeded. */ - (BOOL)delete; /*! Deletes the AVObject and sets an error if it occurs. @param error Pointer to an NSError that will be set if necessary. @return whether the delete succeeded. */ - (BOOL)delete:(NSError **)error; /*! Deletes the AVObject asynchronously. */ - (void)deleteInBackground; /*! Deletes the AVObject asynchronously and executes the given callback block. @param block The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error) */ - (void)deleteInBackgroundWithBlock:(AVBooleanResultBlock)block; /*! Deletes the AVObject asynchronously and calls the given callback. @param target The object to call selector on. @param selector The selector to call. It should have the following signature: (void)callbackWithResult:(NSNumber *)result error:(NSError *)error. error will be nil on success and set if there was an error. [result boolValue] will tell you whether the call succeeded or not. */ - (void)deleteInBackgroundWithTarget:(id)target selector:(SEL)selector; /*! Deletes this object from the server at some unspecified time in the future, even if AVOS Cloud is currently inaccessible. Use this when you may not have a solid network connection, and don't need to know when the delete completes. If there is some problem with the object such that it can't be deleted, the request will be silently discarded. Delete instructions made with this method will be stored locally in an on-disk cache until they can be transmitted to AVOS Cloud. They will be sent immediately if possible. Otherwise, they will be sent the next time a network connection is available. Delete requests will persist even after the app is closed, in which case they will be sent the next time the app is opened. If more than 10MB of saveEventually or deleteEventually commands are waiting to be sent, subsequent calls to saveEventually or deleteEventually will cause old requests to be silently discarded until the connection can be re-established, and the queued requests can go through. */ - (void)deleteEventually; /*! deleteEventually with callback block. @param block The block to execute. */ - (void)deleteEventuallyWithBlock:(AVIdResultBlock)block; /** * Deletes all objects specified in object array. The element of objects array is AVObject or its subclass. * * @param objects object array * @param block The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error) */ + (void)deleteAllInBackground:(NSArray *)objects block:(AVBooleanResultBlock)block; #pragma mark - extension @property (nonatomic, readwrite) BOOL fetchWhenSave; /*! Generate JSON dictionary from AVObject or its subclass object. */ -(NSMutableDictionary *)dictionaryForObject; /** * Load object properties from JSON dictionary. * * @param dict JSON dictionary */ -(void)objectFromDictionary:(NSDictionary *)dict; @end