Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Commit

Permalink
[Issue #201] Adding documentation about caveat of AFIncrementalStoreR…
Browse files Browse the repository at this point in the history
…equestOperationKey returning single operation in fetch notifications, but an array of operations in save changes notifications.
  • Loading branch information
mattt committed Jun 18, 2013
1 parent 9db865a commit f0c6bb2
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions AFIncrementalStore/AFIncrementalStore.h
Original file line number Diff line number Diff line change
Expand Up @@ -308,32 +308,38 @@ extern NSString * const AFIncrementalStoreUnimplementedMethodException;
///--------------------

/**
Posted before an HTTP request operation starts.
Posted before an HTTP request operation corresponding to a fetch request starts.
The object is the managed object context of the request.
The notification `userInfo` contains the finished request operation, keyed at `AFIncrementalStoreRequestOperationKey`, as well as the associated persistent store request, if applicable, keyed at `AFIncrementalStorePersistentStoreRequestKey`.
*/
extern NSString * const AFIncrementalStoreContextWillFetchRemoteValues;

/**
Posted before an HTTP request operation corresponding to a fetch request starts.
The object is the managed object context of the request.
The notification `userInfo` contains an array of request operations, keyed at `AFIncrementalStoreRequestOperationKey`, as well as the associated persistent store request, if applicable, keyed at `AFIncrementalStorePersistentStoreRequestKey`.
*/
extern NSString * const AFIncrementalStoreContextWillSaveRemoteValues;

/**
Posted after an HTTP request operation finishes.
Posted after an HTTP request operation corresponding to a fetch request finishes.
The object is the managed object context of the request.
The notification `userInfo` contains the finished request operation, keyed at `AFIncrementalStoreRequestOperationKey`, as well as the associated persistent store request, if applicable, keyed at `AFIncrementalStorePersistentStoreRequestKey`.
*/
extern NSString * const AFIncrementalStoreContextDidFetchRemoteValues;

/**
Posted after an HTTP request operation corresponding to a fetch request finishes.
The object is the managed object context of the request.
The notification `userInfo` contains an array of request operations, keyed at `AFIncrementalStoreRequestOperationKey`, as well as the associated persistent store request, if applicable, keyed at `AFIncrementalStorePersistentStoreRequestKey`.
*/
extern NSString * const AFIncrementalStoreContextDidSaveRemoteValues;

/**
A key in the `userInfo` dictionary in a `AFIncrementalStoreContextWillFetchRemoteValues` or `AFIncrementalStoreContextDidFetchRemoteValues` notification.
The corresponding value is an `AFHTTPRequestOperation` object representing the associated request. */
A key in the `userInfo` dictionary in a `AFIncrementalStoreContextWillFetchRemoteValues` and `AFIncrementalStoreContextDidFetchRemoteValues` as well as `AFIncrementalStoreContextWillSaveRemoteValues` and `AFIncrementalStoreContextDidSaveRemoteValues` notifications.
For `AFIncrementalStoreContextWillFetchRemoteValues` and `AFIncrementalStoreContextDidFetchRemoteValues` notifications the corresponding value is an `AFHTTPRequestOperation` object representing the associated fetch request.
For `AFIncrementalStoreContextWillSaveRemoteValues` and `AFIncrementalStoreContextDidSaveRemoteValues` notifications, the corresponding value is an `NSArray` of `AFHTTPRequestOperation` objects corresponding to the request operations triggered by the save changes request.
*/
extern NSString * const AFIncrementalStoreRequestOperationKey;

/**
Expand Down

0 comments on commit f0c6bb2

Please sign in to comment.