RKObjectPaginatorDelegate Protocol Reference
| Conforms to | NSObject |
| Declared in | RKObjectPaginator.h |
Overview
The RKObjectPaginatorDelegate formal protocol defines RKObjectPaginator delegate methods that can be implemented by objects to receive informational callbacks about paginated loading of mapping objects through RestKit.
Tasks
-
– paginator:didLoadObjects:forPage:Tells the delegate the paginator has loaded a page of objects from the collection.
required method -
– paginator:didFailWithError:objectLoader:Tells the delegate the paginator has failed loading due to an error.
required method -
– paginator:willLoadPage:objectLoader:Tells the delegate that the paginator is about to begin loading a page of objects.
-
– paginatorDidLoadFirstPage:Tells the delegate the paginator has loaded the first page of objects in the collection.
-
– paginatorDidLoadLastPage:Tells the delegate the paginator has loaded the last page of objects in the collection.
Instance Methods
paginator:didFailWithError:objectLoader:
Tells the delegate the paginator has failed loading due to an error.
- (void)paginator:(RKObjectPaginator *)paginator didFailWithError:(NSError *)error objectLoader:(RKObjectLoader *)loaderParameters
- paginator
The paginator that failed loading due to an error.
- error
An NSError indicating the cause of the failure.
- loader
The loader request that resulted in the failure.
Declared In
RKObjectPaginator.hpaginator:didLoadObjects:forPage:
Tells the delegate the paginator has loaded a page of objects from the collection.
- (void)paginator:(RKObjectPaginator *)paginator didLoadObjects:(NSArray *)objects forPage:(NSUInteger)pageParameters
- paginator
The paginator that loaded the objects.
- objects
An array of objects mapped from the remote JSON/XML representation.
- page
The page number that was loaded.
Declared In
RKObjectPaginator.hpaginator:willLoadPage:objectLoader:
Tells the delegate that the paginator is about to begin loading a page of objects.
- (void)paginator:(RKObjectPaginator *)paginator willLoadPage:(NSUInteger)page objectLoader:(RKObjectLoader *)loaderParameters
- paginator
The paginator performing the load.
- page
The numeric page number being loaded.
- loader
The object loader request used to load the page.
Declared In
RKObjectPaginator.h