\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMObject+Notifications.h | \n
|---|
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRBQRealmNotificationManager.h | \n
|---|
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMArray+Utilities.h | \n
|---|
This utility category provides convenience methods on RLMArray.
\n\t\t\t\t\t– containsObject:\nDetect if RLMArray contains a given RLMObject
\n\t\t\t- (BOOL)containsObject:(RLMObject *)anObjectanObject | \n\t\t\t\t\t\tRLMObject | \n\t\t\t\t\t
|---|
YES if RLMArray contains given object
\n\t\t\tDetect if RLMArray contains a given RLMObject
\n\t\t\tRLMArray+Utilities.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMObject+Notifications.h | \n
|---|
Category on RLMObject that provides convenience methods to change a RLMObject while automatically notifying RBQRealmChangeLogger
\n\t\t\t\t\t– changeWithNotification:\nConvenience method that accepts a RBQChangeNotificationBlock, which contains the current RLMObject as a parameter.
\n\t\t\t- (void)changeWithNotification:(RBQChangeNotificationBlock)blockblock | \n\t\t\t\t\t\tBlock contains the RLMObject used to call this method. Edit the RLMObject within the block. | \n\t\t\t\t\t
|---|
Convenience method that accepts a RBQChangeNotificationBlock, which contains the current RLMObject as a parameter.
\n\nEdit the parameter object in the block and an automatic notification will be generated for RBQRealmChangeLogger
\n\t\t\tRLMObject+Notifications.h
– changeWithNotificationInTransaction:\nConvenience method that accepts a RBQChangeNotificationBlock, which contains the current RLMObject as a parameter.
\n\t\t\t- (void)changeWithNotificationInTransaction:(RBQChangeNotificationBlock)blockblock | \n\t\t\t\t\t\tBlock contains the RLMObject used to call this method. Edit the RLMObject within the block. | \n\t\t\t\t\t
|---|
Convenience method that accepts a RBQChangeNotificationBlock, which contains the current RLMObject as a parameter.
\n\nThe block will be run within the required beginWriteTransaction and commitWriteTransaction calls automatically. Edit the parameter object in the block and an automatic notification will be generated for RBQRealmChangeLogger.
\n\t\t\tRLMObject+Notifications.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMObject+SafeObject.h | \n
|---|
Category methods for RLMObject to convert into a RBQSafeRealmObject and vice versa
\n\t\t\t\t\t+ rbq_objectFromSafeObject:\nCreate a RLMObject from a RBQSafeRealmObject
\n\t\t\t+ (instancetype)rbq_objectFromSafeObject:(RBQSafeRealmObject *)safeObjectsafeObject | \n\t\t\t\t\t\tRBQSafeRealmObject instance | \n\t\t\t\t\t
|---|
RLMObject of appropriate subtype
\n\t\t\tCreate a RLMObject from a RBQSafeRealmObject
\n\nReturns nil if the safe object’s className doesn’t match ours.
\n\t\t\tRLMObject+SafeObject.h
+ rbq_objectInRealm:fromSafeObject:\nCreate a RLMObject in a specific Realm from a RBQSafeRealmObject
\n\t\t\t+ (instancetype)rbq_objectInRealm:(RLMRealm *)realm fromSafeObject:(RBQSafeRealmObject *)safeObjectrealm | \n\t\t\t\t\t\tRealm in which the returned RLMObject is persisted | \n\t\t\t\t\t
|---|---|
safeObject | \n\t\t\t\t\t\tRBQSafeRealmObject to convert into RLMObject | \n\t\t\t\t\t
RLMObject of appropriate subtype
\n\t\t\tCreate a RLMObject in a specific Realm from a RBQSafeRealmObject
\n\nReturns nil if the safe object’s className doesn’t match ours.
\n\t\t\tRLMObject+SafeObject.h
– rbq_safeObject\nCreate a RBQSafeRealmObject from a RLMObject
\n\t\t\t- (RBQSafeRealmObject *)rbq_safeObjectRBQSafeRealmObject which is a thread-safe representation of the original RLMObject
\n\t\t\tCreate a RBQSafeRealmObject from a RLMObject
\n\t\t\tRLMObject+SafeObject.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMObject+Utilities.h | \n
|---|
This utility category provides convenience methods to retrieve the primary key and original\nclass name for an RLMObject.
\n\t\t\t\t\t+ primaryKeyValueForObject:\nRetrieve the primary key for a given RLMObject
\n\t\t\t+ (id)primaryKeyValueForObject:(RLMObject *)objectobject | \n\t\t\t\t\t\tRLMObject with a primary key | \n\t\t\t\t\t
|---|
Primary key value (NSInteger or NSString only)
\n\t\t\tRetrieve the primary key for a given RLMObject
\n\t\t\tRLMObject+Utilities.h
+ classNameForObject:\nRetrieve the original class name for a generic RLMObject. Realm dynamically changes the class at\nrun-time, whereas this method returns the programatic class name.
\n\t\t\t+ (NSString *)classNameForObject:(RLMObject *)objectobject | \n\t\t\t\t\t\tA RLMObject | \n\t\t\t\t\t
|---|
Original programatic class name
\n\t\t\tRetrieve the original class name for a generic RLMObject. Realm dynamically changes the class at\nrun-time, whereas this method returns the programatic class name.
Warning: This method returns the class name to be used programatically (such as with NSClassFromString()). Class names within Swift follow the pattern: “AppName.ClassName” whereas Obj-C it is simply “ClassName”. See Apple docs for more info: http://apple.co/1HMPGjg
RLMObject+Utilities.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Declared in | \n\tRLMRealm+Notifications.h | \n
|---|
Category on RLMRealm that provides convenience methods similar to RLMRealm class methods but include notifying RBQRealmNotificationManager
\n\t\t\t\t\t– addObjectWithNotification:\nConvenience method to add an object to the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)addObjectWithNotification:(RLMObject *)objectobject | \n\t\t\t\t\t\tStandalone RLMObject to be persisted | \n\t\t\t\t\t
|---|
Convenience method to add an object to the Realm and notify RBQRealmChangeLogger
\n\t\t\tRLMRealm+Notifications.h
– addObjectsWithNotification:\nConvenience method to add a collection of RLMObjects to the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)addObjectsWithNotification:(id<NSFastEnumeration>)arrayarray | \n\t\t\t\t\t\tA collection object that conforms to NSFastEnumeration (e.g. NSArray, RLMArray, RLMResults) | \n\t\t\t\t\t
|---|
Convenience method to add a collection of RLMObjects to the Realm and notify RBQRealmChangeLogger
\n\t\t\tRLMRealm+Notifications.h
– addOrUpdateObjectWithNotification:\nConvenience method to add or update a RLMObject to the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)addOrUpdateObjectWithNotification:(RLMObject *)objectobject | \n\t\t\t\t\t\tRLMObject to add or update in the Realm | \n\t\t\t\t\t
|---|
Convenience method to add or update a RLMObject to the Realm and notify RBQRealmChangeLogger
\n\nIf the RLMObject is already persisted, then the new object will be used to update the persisted object.
\n\t\t\tRLMRealm+Notifications.h
– addOrUpdateObjectsFromArrayWithNotification:\nConvenience method to add or update a collection of RLMObjects to the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)addOrUpdateObjectsFromArrayWithNotification:(id<NSFastEnumeration>)arrayarray | \n\t\t\t\t\t\tA collection object that conforms to NSFastEnumeration (e.g. NSArray, RLMArray, RLMResults) | \n\t\t\t\t\t
|---|
Convenience method to add or update a collection of RLMObjects to the Realm and notify RBQRealmChangeLogger
\n\nIf any RLMObject is already persisted, then the new object will be used to update the persisted object.
\n\t\t\tRLMRealm+Notifications.h
– deleteObjectWithNotification:\nConvenience method to delete a RLMObject from the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)deleteObjectWithNotification:(RLMObject *)objectobject | \n\t\t\t\t\t\tRLMObject to delete from the Realm | \n\t\t\t\t\t
|---|
Convenience method to delete a RLMObject from the Realm and notify RBQRealmChangeLogger
\n\t\t\tRLMRealm+Notifications.h
– deleteObjectsWithNotification:\nConvenience method to delete a collection of RLMObjects from the Realm and notify RBQRealmChangeLogger
\n\t\t\t- (void)deleteObjectsWithNotification:(id<NSFastEnumeration>)arrayarray | \n\t\t\t\t\t\tA collection object that conforms to NSFastEnumeration (e.g. NSArray, RLMArray, RLMResults) | \n\t\t\t\t\t
|---|
Convenience method to delete a collection of RLMObjects from the Realm and notify RBQRealmChangeLogger
\n\t\t\tRLMRealm+Notifications.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQRealmNotificationManager.h | \n
Class used by the RBQRealmNotificationManager to represent the change set for a given entity. This object is passed in the NSDictionary (keyed by the entity name) contained in the RBQNotificationBlock after a change to monitored Realm.
\n\t\t\t\t\t className\nThe class name of the entity
\n\t\t\t@property (readonly, nonatomic) NSString *classNameThe class name of the entity
\n\t\t\tRBQRealmNotificationManager.h
addedSafeObjects\nCollection of RBQSafeRealmObjects representing the added objects
\n\t\t\t@property (readonly, nonatomic) NSSet *addedSafeObjectsCollection of RBQSafeRealmObjects representing the added objects
\n\t\t\tRBQRealmNotificationManager.h
deletedSafeObjects\nCollection of RBQSafeRealmObjects representing the deleted objects
\n\t\t\t@property (readonly, nonatomic) NSSet *deletedSafeObjectsCollection of RBQSafeRealmObjects representing the deleted objects
\n\t\t\tRBQRealmNotificationManager.h
changedSafeObjects\nCollection of RBQSafeRealmObjects representing the changed objects
\n\t\t\t@property (readonly, nonatomic) NSSet *changedSafeObjectsCollection of RBQSafeRealmObjects representing the changed objects
\n\t\t\tRBQRealmNotificationManager.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQFetchRequest.h | \n
This class is used by the RBQFetchedResultsController to represent the properties of the fetch. The RBQFetchRequest is specific to one RLMObject and uses an NSPredicate and array of RLMSortDescriptors to define the query.
\n\t\t\t\t\t entityName\nRLMObject class name for the fetch request
\n\t\t\t@property (nonatomic, readonly) NSString *entityNameRLMObject class name for the fetch request
\n\t\t\tRBQFetchRequest.h
realm\nThe Realm in which the entity for the fetch request is persisted.
\n\t\t\t@property (nonatomic, readonly) RLMRealm *realmThe Realm in which the entity for the fetch request is persisted.
\n\t\t\tRBQFetchRequest.h
realmPath\nPath for the Realm associated with the fetch request
\n\t\t\t@property (nonatomic, readonly) NSString *realmPathPath for the Realm associated with the fetch request
\n\t\t\tRBQFetchRequest.h
inMemoryRealmId\nThe identifier of the in-memory Realm.
\n\t\t\t@property (nonatomic, readonly) NSString *inMemoryRealmIdThe identifier of the in-memory Realm.
Warning: return nil if fetch request initialized without in-memory Realm
RBQFetchRequest.h
predicate\nPredicate supported by Realm
\n\t\t\t@property (nonatomic, strong) NSPredicate *predicatePredicate supported by Realm
\n\nhttp://realm.io/docs/cocoa/0.89.2/#querying-with-predicates
\n\t\t\tRBQFetchRequest.h
sortDescriptors\nArray of RLMSortDescriptors
\n\t\t\t@property (nonatomic, strong) NSArray *sortDescriptorsArray of RLMSortDescriptors
\n\nhttp://realm.io/docs/cocoa/0.89.2/#ordering-results
\n\t\t\tRBQFetchRequest.h
+ fetchRequestWithEntityName:inRealm:predicate:\nConstructor method to create a fetch request for a given entity name in a specific Realm.
\n\t\t\t+ (RBQFetchRequest *)fetchRequestWithEntityName:(NSString *)entityName inRealm:(RLMRealm *)realm predicate:(NSPredicate *)predicateentityName | \n\t\t\t\t\t\tClass name for the RLMObject | \n\t\t\t\t\t
|---|---|
realm | \n\t\t\t\t\t\tRLMRealm in which the RLMObject is persisted (if passing in-memory Realm, make sure to keep a strong reference elsewhere since fetch request only stores the path) | \n\t\t\t\t\t
predicate | \n\t\t\t\t\t\tNSPredicate that represents the search query | \n\t\t\t\t\t
A new instance of RBQFetchRequest
\n\t\t\tConstructor method to create a fetch request for a given entity name in a specific Realm.
\n\t\t\tRBQFetchRequest.h
+ fetchRequestWithEntityName:inMemoryRealm:predicate:\nConstructor method to create a fetch request for a given entity name in an in-memory Realm.
\n\t\t\t+ (RBQFetchRequest *)fetchRequestWithEntityName:(NSString *)entityName inMemoryRealm:(RLMRealm *)inMemoryRealm predicate:(NSPredicate *)predicateentityName | \n\t\t\t\t\t\tClass name for the RLMObject | \n\t\t\t\t\t
|---|---|
inMemoryRealm | \n\t\t\t\t\t\tIn-memory RLMRealm in which the RLMObject is persisted (caller must retain strong reference as fetch request does not) | \n\t\t\t\t\t
predicate | \n\t\t\t\t\t\tNSPredicate that represents the search query | \n\t\t\t\t\t
A new instance of RBQFetchRequest
\n\t\t\tConstructor method to create a fetch request for a given entity name in an in-memory Realm.
\n\t\t\tRBQFetchRequest.h
– fetchObjects\nRetrieve all the RLMObjects for this fetch request in its realm.
\n\t\t\t- (RLMResults *)fetchObjectsRLMResults for all the objects in the fetch request (not thread-safe).
\n\t\t\tRetrieve all the RLMObjects for this fetch request in its realm.
\n\t\t\tRBQFetchRequest.h
– fetchObjectsInRealm:\nRetrieve all the RLMObjects for this fetch request in the specified realm.
\n\t\t\t- (RLMResults *)fetchObjectsInRealm:(RLMRealm *)realmrealm | \n\t\t\t\t\t\tRLMRealm in which the RLMObjects are persisted | \n\t\t\t\t\t
|---|
RLMResults for all the objects in the fetch request (not thread-safe).
\n\t\t\tRetrieve all the RLMObjects for this fetch request in the specified realm.
\n\t\t\tRBQFetchRequest.h
– evaluateObject:\nShould this object be in our fetch results?
\n\t\t\t- (BOOL)evaluateObject:(RLMObject *)objectobject | \n\t\t\t\t\t\tRealm object of appropriate type | \n\t\t\t\t\t
|---|
YES if performing fetch would include this object
\n\t\t\tShould this object be in our fetch results?
\n\nIntended to be used by the RBQFetchedResultsController to evaluate incremental changes. For\nsimple fetch requests this just evaluates the NSPredicate, but subclasses may have a more\ncomplicated implementaiton.
\n\t\t\tRBQFetchRequest.h
– initWithEntityName:inRealm:\nCreate RBQFetchRequest in RLMRealm instance with an entity name
\n\t\t\t- (instancetype)initWithEntityName:(NSString *)entityName inRealm:(RLMRealm *)realmentityName | \n\t\t\t\t\t\tClass name for the RLMObject | \n\t\t\t\t\t
|---|---|
realm | \n\t\t\t\t\t\tRLMRealm in which the RLMObject is persisted | \n\t\t\t\t\t
A new instance of RBQFetchRequest
\n\t\t\tCreate RBQFetchRequest in RLMRealm instance with an entity name
\n\t\t\tRBQFetchRequest.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQFetchedResultsController.h | \n
The class is used to monitor changes from a RBQRealmNotificationManager to convert these changes into specific index path or section index changes. Typically this is used to back a UITableView and support animations when items are inserted, deleted, or changed.
\n\t\t\t\t\t fetchRequest\nThe fetch request for the controller
\n\t\t\t@property (nonatomic, readonly) RBQFetchRequest *fetchRequestThe fetch request for the controller
\n\t\t\tRBQFetchedResultsController.h
sectionNameKeyPath\nThe section name key path used to create the sections. Can be nil if no sections.
\n\t\t\t@property (nonatomic, readonly) NSString *sectionNameKeyPathThe section name key path used to create the sections. Can be nil if no sections.
\n\t\t\tRBQFetchedResultsController.h
delegate\nThe delegate to pass the index path and section changes to.
\n\t\t\t@property (nonatomic, weak) id<RBQFetchedResultsControllerDelegate> delegateThe delegate to pass the index path and section changes to.
\n\t\t\tRBQFetchedResultsController.h
cacheName\nThe name of the cache used internally to represent the tableview structure.
\n\t\t\t@property (nonatomic, readonly) NSString *cacheNameThe name of the cache used internally to represent the tableview structure.
\n\t\t\tRBQFetchedResultsController.h
fetchedObjects\nAll the objects that match the fetch request.
\n\t\t\t@property (nonatomic, readonly) RLMResults *fetchedObjectsAll the objects that match the fetch request.
\n\t\t\tRBQFetchedResultsController.h
+ deleteCacheWithName:\nDeletes the cached section information with the given name
\n\t\t\t+ (void)deleteCacheWithName:(NSString *)namename | \n\t\t\t\t\t\tThe name of the cache file to delete. If name is nil, deletes all cache files. | \n\t\t\t\t\t
|---|
Deletes the cached section information with the given name
\n\nIf name is not nil, then the cache will be cleaned, but not deleted from disk.
\n\nIf name is nil, then all caches will be deleted by removing the files from disk.
Warning: If clearing all caches (name is nil), it is recommended to do this in didFinishLaunchingWithOptions: in AppDelegate because RLMRealm files cannot be deleted from disk safely, if there are strong references to them.
RBQFetchedResultsController.h
+ allCacheRealmPaths\nRetrieves all the paths for the Realm files being used as FRC caches on disk.
\n\t\t\t+ (NSArray *)allCacheRealmPathsNSArray of NSStrings representing the paths on disk for all FRC cache Realm files
\n\t\t\tRetrieves all the paths for the Realm files being used as FRC caches on disk.
\n\nThe typical use case for this method is to use the paths to perform migrations in AppDelegate. The FRC cache files need to be migrated along with your other Realm files because by default Realm includes all of the properties defined in your model in all Realm files. Thus the FRC cache files will throw an exception if they are not migrated. Call setSchemaVersion:forRealmAtPath:withMigrationBlock: for each path returned in the array.
\n\t\t\tRBQFetchedResultsController.h
– initWithFetchRequest:sectionNameKeyPath:cacheName:\nConstructor method to initialize the controller
\n\t\t\t- (id)initWithFetchRequest:(RBQFetchRequest *)fetchRequest sectionNameKeyPath:(NSString *)sectionNameKeyPath cacheName:(NSString *)namefetchRequest | \n\t\t\t\t\t\tthe RBQFetchRequest for the controller | \n\t\t\t\t\t
|---|---|
sectionNameKeyPath | \n\t\t\t\t\t\tA key path on result objects that returns the section name. Pass nil to indicate that the controller should generate a single section. If this key path is not the same as that specified by the first sort descriptor in fetchRequest, they must generate the same relative orderings. | \n\t\t\t\t\t
name | \n\t\t\t\t\t\tthe cache name (if nil, cache will not be persisted and built using an in-memory Realm) | \n\t\t\t\t\t
A new instance of RBQFetchedResultsController
\n\t\t\tConstructor method to initialize the controller
Warning: Specify a cache name if deletion of the cache later on is necessary
RBQFetchedResultsController.h
– initWithFetchRequest:sectionNameKeyPath:inMemoryRealmCache:\nConstructor method to initialize the controller using an explicit in-memory Realm rather than the persisted cache.
\n\t\t\t- (id)initWithFetchRequest:(RBQFetchRequest *)fetchRequest sectionNameKeyPath:(NSString *)sectionNameKeyPath inMemoryRealmCache:(RLMRealm *)inMemoryRealmfetchRequest | \n\t\t\t\t\t\tthe RBQFetchRequest for the controller | \n\t\t\t\t\t
|---|---|
sectionNameKeyPath | \n\t\t\t\t\t\tthe section name key path used to create sections (can be nil) | \n\t\t\t\t\t
inMemoryRealm | \n\t\t\t\t\t\tthe in-memory Realm to be used for the internal cache | \n\t\t\t\t\t
A new instance of RBQFetchedResultsController
\n\t\t\tConstructor method to initialize the controller using an explicit in-memory Realm rather than the persisted cache.
\n\t\t\tRBQFetchedResultsController.h
– performFetch\nMethod to tell the controller to perform the fetch
\n\t\t\t- (BOOL)performFetchIndicates if the fetch was successful
\n\t\t\tMethod to tell the controller to perform the fetch
\n\t\t\tRBQFetchedResultsController.h
– reset\nCall this method to force the cache to be rebuilt.
\n\t\t\t- (void)resetCall this method to force the cache to be rebuilt.
\n\nA potential use case would be to call this in a @catch after trying to call endUpdates for the table view. If an exception is thrown, then the cache will be rebuilt and you can call reloadData on the table view.
\n\t\t\tRBQFetchedResultsController.h
– numberOfRowsForSectionIndex:\nMethod to retrieve the number of rows for a given section index
\n\t\t\t- (NSInteger)numberOfRowsForSectionIndex:(NSInteger)indexindex | \n\t\t\t\t\t\tsection index | \n\t\t\t\t\t
|---|
number of rows in the section
\n\t\t\tMethod to retrieve the number of rows for a given section index
\n\t\t\tRBQFetchedResultsController.h
– numberOfSections\nMethod to retrieve the number of sections represented by the fetch request
\n\t\t\t- (NSInteger)numberOfSectionsnumber of sections
\n\t\t\tMethod to retrieve the number of sections represented by the fetch request
\n\t\t\tRBQFetchedResultsController.h
– titleForHeaderInSection:\nMethod to retrieve the title for a given section index
\n\t\t\t- (NSString *)titleForHeaderInSection:(NSInteger)sectionsection | \n\t\t\t\t\t\tsection index | \n\t\t\t\t\t
|---|
The title of the section
\n\t\t\tMethod to retrieve the title for a given section index
\n\t\t\tRBQFetchedResultsController.h
– sectionIndexForSectionName:\nMethod to retrieve the section index given a section name
\n\t\t\t- (NSUInteger)sectionIndexForSectionName:(NSString *)sectionNamesectionName | \n\t\t\t\t\t\tthe name of the section | \n\t\t\t\t\t
|---|
the index of the section (returns NSNotFound if no section with the given name)
\n\t\t\tMethod to retrieve the section index given a section name
Warning: Returns NSNotFound if there is not a section with the given name
RBQFetchedResultsController.h
– safeObjectAtIndexPath:\nRetrieve the RBQSafeRealmObject for a given index path
\n\t\t\t- (RBQSafeRealmObject *)safeObjectAtIndexPath:(NSIndexPath *)indexPathindexPath | \n\t\t\t\t\t\tthe index path of the object | \n\t\t\t\t\t
|---|
Retrieve the RBQSafeRealmObject for a given index path
\n\t\t\tRBQFetchedResultsController.h
– objectAtIndexPath:\nRetrieve the RLMObject for a given index path
\n\t\t\t- (id)objectAtIndexPath:(NSIndexPath *)indexPathindexPath | \n\t\t\t\t\t\tthe index path of the object | \n\t\t\t\t\t
|---|
RLMObject
\n\t\t\tRetrieve the RLMObject for a given index path
Warning: Returned object is not thread-safe.
RBQFetchedResultsController.h
– objectInRealm:atIndexPath:\nRetrieve the RLMObject in a specific Realm for a given index path
\n\t\t\t- (id)objectInRealm:(RLMRealm *)realm atIndexPath:(NSIndexPath *)indexPathrealm | \n\t\t\t\t\t\tthe Realm in which the RLMObject is persisted | \n\t\t\t\t\t
|---|---|
indexPath | \n\t\t\t\t\t\tthe index path of the object | \n\t\t\t\t\t
RLMObject
\n\t\t\tRetrieve the RLMObject in a specific Realm for a given index path
\n\t\t\tRBQFetchedResultsController.h
– indexPathForSafeObject:\nRetrieve the index path for a safe object in the fetch request
\n\t\t\t- (NSIndexPath *)indexPathForSafeObject:(RBQSafeRealmObject *)safeObjectsafeObject | \n\t\t\t\t\t\t\n\t\t\t\t\t |
|---|
index path of the object
\n\t\t\tRetrieve the index path for a safe object in the fetch request
\n\t\t\tRBQFetchedResultsController.h
– indexPathForObject:\nRetrieve the index path for a RLMObject in the fetch request
\n\t\t\t- (NSIndexPath *)indexPathForObject:(RLMObject *)objectobject | \n\t\t\t\t\t\tRLMObject | \n\t\t\t\t\t
|---|
index path of the object
\n\t\t\tRetrieve the index path for a RLMObject in the fetch request
\n\t\t\tRBQFetchedResultsController.h
– updateFetchRequest:sectionNameKeyPath:andPeformFetch:\nConvenience method to safely update the fetch request for an existing RBQFetchResultsController
\n\t\t\t- (void)updateFetchRequest:(RBQFetchRequest *)fetchRequest sectionNameKeyPath:(NSString *)sectionNameKeyPath andPeformFetch:(BOOL)performFetchfetchRequest | \n\t\t\t\t\t\ta new instance of RBQFetchRequest | \n\t\t\t\t\t
|---|---|
sectionNameKeyPath | \n\t\t\t\t\t\tthe section name key path for this fetch request (if nil, no sections will be shown) | \n\t\t\t\t\t
performFetch | \n\t\t\t\t\t\tindicates whether you want to immediately performFetch using the new fetch request to rebuild the cache | \n\t\t\t\t\t
Convenience method to safely update the fetch request for an existing RBQFetchResultsController
\n\t\t\tRBQFetchedResultsController.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQFetchedResultsController.h | \n
This class is used by the RBQFetchedResultsController to pass along section info.
\n\t\t\t\t\t numberOfObjects\nThe number of objects in the section.
\n\t\t\t@property (nonatomic, readonly) NSUInteger numberOfObjectsThe number of objects in the section.
\n\t\t\tRBQFetchedResultsController.h
objects\nThe objects in the section (generated on-demand and not thread-safe).
\n\t\t\t@property (nonatomic, readonly) RLMResults *objectsThe objects in the section (generated on-demand and not thread-safe).
\n\t\t\tRBQFetchedResultsController.h
name\nThe name of the section.
\n\t\t\t@property (nonatomic, readonly) NSString *nameThe name of the section.
\n\t\t\tRBQFetchedResultsController.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQRealmNotificationManager.h | \n
This class is used to track changes to a given RLMRealm. Since Realm doesn’t support automatic change tracking, this class allows the developer to log object changes, which will be passed along to the RBQRealmNotificationManager who in turn broadcasts it to any listeners
\n\nSince RLMObjects are not thread-safe, when an object is logged to the manager, it is internally transformed into an RBQSafeRealmObject that is thread-safe and this will then be passed to any listeners once the Realm being monitored updates.
Warning: Only RLMObjects with primary keys can be logged because the primary key is required to create a RBQSafeRealmObject.
+ defaultLogger\nCreates or retrieves the logger instance for the default Realm on the current thread
\n\t\t\t+ (instancetype)defaultLoggerInstance of RBQRealmChangeLogger
\n\t\t\tCreates or retrieves the logger instance for the default Realm on the current thread
\n\t\t\tRBQRealmNotificationManager.h
+ loggerForRealm:\nCreates or retrieves the logger instance for a specific Realm on the current thread
\n\t\t\t+ (instancetype)loggerForRealm:(RLMRealm *)realmrealm | \n\t\t\t\t\t\tA RLMRealm instance | \n\t\t\t\t\t
|---|
Instance of RBQRealmChangeLogger
\n\t\t\tCreates or retrieves the logger instance for a specific Realm on the current thread
\n\t\t\tRBQRealmNotificationManager.h
– didAddObject:\nRegister an addition for a given RLMObject
\n\t\t\t- (void)didAddObject:(RLMObject *)addedObjectaddedObject | \n\t\t\t\t\t\tAdded RLMObject | \n\t\t\t\t\t
|---|
Register an addition for a given RLMObject
Warning: Can be called before or after the addition to Realm
RBQRealmNotificationManager.h
– didAddObjects:\nRegister a collection of RLMObject additions
\n\t\t\t- (void)didAddObjects:(id<NSFastEnumeration>)addedObjectsaddedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of added RLMObjects | \n\t\t\t\t\t
|---|
Register a collection of RLMObject additions
Warning: Can be called before or after the additions to Realm
RBQRealmNotificationManager.h
– willDeleteObject:\nRegister a delete for a given RLMObject
\n\t\t\t- (void)willDeleteObject:(RLMObject *)deletedObjectdeletedObject | \n\t\t\t\t\t\tTo be deleted RLMObject | \n\t\t\t\t\t
|---|
Register a delete for a given RLMObject
Warning: Must be called before the delete in Realm (since the RLMObject will then be invalidated).
RBQRealmNotificationManager.h
– willDeleteObjects:\nRegister a collection of RLMObject deletes
\n\t\t\t- (void)willDeleteObjects:(id<NSFastEnumeration>)deletedObjectsdeletedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of deleted RLMObjects | \n\t\t\t\t\t
|---|
Register a collection of RLMObject deletes
Warning: Must be called before the delete in Realm (since the RLMObject will then be invalidated).
RBQRealmNotificationManager.h
– didChangeObject:\nRegister a change for a given RLMObject
\n\t\t\t- (void)didChangeObject:(RLMObject *)changedObjectchangedObject | \n\t\t\t\t\t\tChanged RLMObject | \n\t\t\t\t\t
|---|
Register a change for a given RLMObject
Warning: Can be called before or after change to Realm
RBQRealmNotificationManager.h
– didChangeObjects:\nRegister a collection of RLMObject changes
\n\t\t\t- (void)didChangeObjects:(id<NSFastEnumeration>)changedObjectschangedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of changed RLMObjects | \n\t\t\t\t\t
|---|
Register a collection of RLMObject changes
Warning: Can be called before or after change to Realm
RBQRealmNotificationManager.h
– didAddObjects:willDeleteObjects:didChangeObjects:\nConvenience method to pass array of objects changed. Will ignore nil values;
\n\t\t\t- (void)didAddObjects:(id<NSFastEnumeration>)addedObjects willDeleteObjects:(id<NSFastEnumeration>)deletedObjects didChangeObjects:(id<NSFastEnumeration>)changedObjectsaddedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of added RLMObjects | \n\t\t\t\t\t
|---|---|
deletedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of deleted RLMObjects | \n\t\t\t\t\t
changedObjects | \n\t\t\t\t\t\tRLMArray, RLMResults, NSSet, or NSArray of changed RLMObjects | \n\t\t\t\t\t
Convenience method to pass array of objects changed. Will ignore nil values;
\n\t\t\tRBQRealmNotificationManager.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQRealmNotificationManager.h | \n
This class works in conjunction with any instances of RBQRealmChangeLogger to broadcast any changes to the registered listeners
\n\t\t\t\t\t entityChanges\nCurrent representation of changes logged to the RBQRealmNotificationManager instance.
\n\t\t\t@property (readonly, nonatomic) NSDictionary *entityChangesCurrent representation of changes logged to the RBQRealmNotificationManager instance.
\n\t\t\tRBQRealmNotificationManager.h
+ defaultManager\nRetrieve the singleton RBQRealmNotificationManager that passes changes from all Realm loggers
\n\t\t\t+ (instancetype)defaultManagerSingleton RBQRealmNotificationManager
\n\t\t\tRetrieve the singleton RBQRealmNotificationManager that passes changes from all Realm loggers
\n\t\t\tRBQRealmNotificationManager.h
– addNotificationBlock:\nUse this method to add a notification block that will fire every time the Realm for this RBQNotificationManager updates. The block passes the changes from the Realm update that were logged to the RBQRealmNotificationManager.
\n\t\t\t- (RBQNotificationToken *)addNotificationBlock:(RBQNotificationBlock)blockblock | \n\t\t\t\t\t\tRBQNotificationBlock that passes a NSDictionary keyed by entity name. The object for the key is a RBQEntityChangesObject which contains NSSets of all the various changes to the entity. | \n\t\t\t\t\t
|---|
A new instance of RBQNotificationToken.
\n\t\t\tUse this method to add a notification block that will fire every time the Realm for this RBQNotificationManager updates. The block passes the changes from the Realm update that were logged to the RBQRealmNotificationManager.
Warning: You must hold onto a strong reference to the returned token or it will be deallocated, preventing any changes from propogating.
RBQRealmNotificationManager.h
– removeNotification:\nDe-register a notification given a RBQNotificationToken.
\n\t\t\t- (void)removeNotification:(RBQNotificationToken *)tokentoken | \n\t\t\t\t\t\tThe RBQNotificationToken to be de-registered. | \n\t\t\t\t\t
|---|
De-register a notification given a RBQNotificationToken.
\n\t\t\tRBQRealmNotificationManager.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Inherits from | \n\tNSObject | \n
|---|---|
| Conforms to | \n\tNSCopying | \n
| Declared in | \n\tRBQSafeRealmObject.h | \n
An RBQSafeRealmObject acts as a thread-safe representation of a RLMObject.
Warning: RBQSafeRealmObjects can only be created from RLMObjects that contain a primary key.\nAttempting to create a RBQSafeRealmObject without a primary key will result in an exception.
className\nOriginal RLMObject’s class name
\n\t\t\t@property (nonatomic, readonly) NSString *classNameOriginal RLMObject’s class name
\n\t\t\tRBQSafeRealmObject.h
primaryKeyValue\nOriginal RLMObject’s primary key value
\n\t\t\t@property (nonatomic, readonly) id primaryKeyValueOriginal RLMObject’s primary key value
\n\t\t\tRBQSafeRealmObject.h
primaryKeyType\nOriginal RLMObject’s primary key property
\n\t\t\t@property (nonatomic, readonly) RLMPropertyType primaryKeyTypeOriginal RLMObject’s primary key property
\n\t\t\tRBQSafeRealmObject.h
realm\nThe Realm in which this object is persisted
\n\t\t\t@property (nonatomic, readonly) RLMRealm *realmThe Realm in which this object is persisted
\n\t\t\tRBQSafeRealmObject.h
– initWithClassName:primaryKeyValue:primaryKeyType:realm:\nConstructor method to create an instance of RBQSafeRealmObject
\n\t\t\t- (id)initWithClassName:(NSString *)className primaryKeyValue:(id)primaryKeyValue primaryKeyType:(RLMPropertyType)primaryKeyType realm:(RLMRealm *)realmclassName | \n\t\t\t\t\t\tclass name for the original RLMObject | \n\t\t\t\t\t
|---|---|
primaryKeyValue | \n\t\t\t\t\t\tprimary key value for the original RLMObject | \n\t\t\t\t\t
primaryKeyType | \n\t\t\t\t\t\tprimary key type for the original RLMObject | \n\t\t\t\t\t
realm | \n\t\t\t\t\t\tRealm in which the original RLMObject is persisted | \n\t\t\t\t\t
A new instance of RBQSafeRealmObject
\n\t\t\tConstructor method to create an instance of RBQSafeRealmObject
\n\t\t\tRBQSafeRealmObject.h
+ safeObjectFromObject:\nCreate a RBQSafeObject from a RLMObject
\n\t\t\t+ (instancetype)safeObjectFromObject:(RLMObject *)objectobject | \n\t\t\t\t\t\tThe RLMObject to transform into RBQSafeObject | \n\t\t\t\t\t
|---|
RBQSafeObject which is a thread-safe
\n\t\t\tCreate a RBQSafeObject from a RLMObject
\n\t\t\tRBQSafeRealmObject.h
+ objectfromSafeObject:\nCreate a RLMObject from a RBQSafeObject
\n\t\t\t+ (id)objectfromSafeObject:(RBQSafeRealmObject *)safeObjectsafeObject | \n\t\t\t\t\t\tRBQSafeRealmObject instance | \n\t\t\t\t\t
|---|
RLMObject (not thread-safe)
\n\t\t\tCreate a RLMObject from a RBQSafeObject
\n\t\t\tRBQSafeRealmObject.h
+ objectInRealm:fromSafeObject:\nCreate a RLMObject in a specific Realm from a RBQSafeObject
\n\t\t\t+ (id)objectInRealm:(RLMRealm *)realm fromSafeObject:(RBQSafeRealmObject *)safeObjectrealm | \n\t\t\t\t\t\tRealm in which the returned RLMObject is persisted | \n\t\t\t\t\t
|---|---|
safeObject | \n\t\t\t\t\t\tRBQSafeRealm object to convert into RLMObject | \n\t\t\t\t\t
Converted RLMObject
\n\t\t\tCreate a RLMObject in a specific Realm from a RBQSafeObject
\n\t\t\tRBQSafeRealmObject.h
– RLMObject\nQuickly convert a RBQSafeRealm object into its RLMObject
\n\t\t\t- (id)RLMObjectRLMObject
\n\t\t\tQuickly convert a RBQSafeRealm object into its RLMObject
\n\t\t\tRBQSafeRealmObject.h
– isEqualToObject:\nEquality test for RBQSafeObject
\n\t\t\t- (BOOL)isEqualToObject:(RBQSafeRealmObject *)objectobject | \n\t\t\t\t\t\tRBQSafeRealmObject to compare | \n\t\t\t\t\t
|---|
YES if both objects contain the same primary key
\n\t\t\tEquality test for RBQSafeObject
\n\t\t\tRBQSafeRealmObject.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t| Conforms to | \n\tNSObject | \n
|---|---|
| Declared in | \n\tRBQFetchedResultsController.h | \n
Delegate to pass along the changes identified by the RBQFetchedResultsController.
\n\t\t\t\t\t– controllerWillChangeContent:\nIndicates that the controller has started identifying changes.
\n\t\t\t- (void)controllerWillChangeContent:(RBQFetchedResultsController *)controllercontroller | \n\t\t\t\t\t\tcontroller instance that noticed the change on its fetched objects | \n\t\t\t\t\t
|---|
Indicates that the controller has started identifying changes.
\n\t\t\tRBQFetchedResultsController.h
– controller:didChangeObject:atIndexPath:forChangeType:newIndexPath:\nNotifies the delegate that a fetched object has been changed due to an add, remove, move, or update. Enables RBQFetchedResultsController change tracking.
\n\t\t\t- (void)controller:(RBQFetchedResultsController *)controller didChangeObject:(RBQSafeRealmObject *)anObject atIndexPath:(NSIndexPath *)indexPath forChangeType:(NSFetchedResultsChangeType)type newIndexPath:(NSIndexPath *)newIndexPathcontroller | \n\t\t\t\t\t\tcontroller instance that noticed the change on its fetched objects | \n\t\t\t\t\t
|---|---|
anObject | \n\t\t\t\t\t\tchanged object represented as a RBQSafeRealmObject for thread safety | \n\t\t\t\t\t
indexPath | \n\t\t\t\t\t\tindexPath of changed object (nil for inserts) | \n\t\t\t\t\t
type | \n\t\t\t\t\t\tindicates if the change was an insert, delete, move, or update | \n\t\t\t\t\t
newIndexPath | \n\t\t\t\t\t\tthe destination path for inserted or moved objects, nil otherwise | \n\t\t\t\t\t
Notifies the delegate that a fetched object has been changed due to an add, remove, move, or update. Enables RBQFetchedResultsController change tracking.
\n\nChanges are reported with the following heuristics:
\n\nOn add and remove operations, only the added/removed object is reported. It’s assumed that all objects that come after the affected object are also moved, but these moves are not reported.
\n\nA move is reported when the changed attribute on the object is one of the sort descriptors used in the fetch request. An update of the object is assumed in this case, but no separate update message is sent to the delegate.
\n\nAn update is reported when an object’s state changes, but the changed attributes aren’t part of the sort keys.
\n\t\t\tRBQFetchedResultsController.h
– controller:didChangeSection:atIndex:forChangeType:\nThe fetched results controller reports changes to its section before changes to the fetched result objects.
\n\t\t\t- (void)controller:(RBQFetchedResultsController *)controller didChangeSection:(RBQFetchedResultsSectionInfo *)section atIndex:(NSUInteger)sectionIndex forChangeType:(NSFetchedResultsChangeType)typecontroller | \n\t\t\t\t\t\tcontroller controller instance that noticed the change on its fetched objects | \n\t\t\t\t\t
|---|---|
section | \n\t\t\t\t\t\tchanged section represented as a RBQFetchedResultsSectionInfo object | \n\t\t\t\t\t
sectionIndex | \n\t\t\t\t\t\tthe section index of the changed section | \n\t\t\t\t\t
type | \n\t\t\t\t\t\tindicates if the change was an insert or delete | \n\t\t\t\t\t
The fetched results controller reports changes to its section before changes to the fetched result objects.
\n\t\t\tRBQFetchedResultsController.h
– controllerDidChangeContent:\nThis method is called at the end of processing changes by the controller
\n\t\t\t- (void)controllerDidChangeContent:(RBQFetchedResultsController *)controllercontroller | \n\t\t\t\t\t\tcontroller instance that noticed the change on its fetched objects | \n\t\t\t\t\t
|---|
This method is called at the end of processing changes by the controller
\n\t\t\tRBQFetchedResultsController.h
\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t\n\t\t\t\t“Roobiq”\n\t\t\t
\n\t\t\t\n\t\t