RKObjectLoaderDelegate Protocol Reference
Conforms to | RKRequestDelegate |
Declared in | RKObjectLoader.h |
Tasks
-
– objectLoader:didFailWithError:
Sent when an object loaded failed to load the collection due to an error
required method -
– objectLoader:didLoadObjects:
When implemented, sent to the delegate when the object laoder has completed successfully and loaded a collection of objects. All objects mapped from the remote payload will be returned as a single array.
-
– objectLoader:didLoadObject:
When implemented, sent to the delegate when the object loader has completed succesfully. If the load resulted in a collection of objects being mapped, only the first object in the collection will be sent with this delegate method. This method simplifies things when you know you are working with a single object reference.
-
– objectLoader:didLoadObjectDictionary:
When implemented, sent to the delegate when an object loader has completed successfully. The dictionary will be expressed as pairs of keyPaths and objects mapped from the payload. This method is useful when you have multiple root objects and want to differentiate them by keyPath.
-
– objectLoaderDidFinishLoading:
Invoked when the object loader has finished loading
-
– objectLoaderDidLoadUnexpectedResponse:
Sent when an object loader encounters a response status code it does not know how to handle. 2xx, 4xx, and 5xx responses are all handled appropriately. This should only occur when the remote service sends back a really odd-ball response.
-
– objectLoader:willMapData:
Invoked just after parsing has completed, but before object mapping begins. This can be helpful to extract data from the parsed payload that is not object mapped, but is interesting for one reason or another. The mappableData will be made mutable via mutableCopy before the delegate method is invoked.
Instance Methods
objectLoader:didFailWithError:
Sent when an object loaded failed to load the collection due to an error
- (void)objectLoader:(RKObjectLoader *)objectLoader didFailWithError:(NSError *)error
Declared In
RKObjectLoader.h
objectLoader:didLoadObject:
When implemented, sent to the delegate when the object loader has completed succesfully. If the load resulted in a collection of objects being mapped, only the first object in the collection will be sent with this delegate method. This method simplifies things when you know you are working with a single object reference.
- (void)objectLoader:(RKObjectLoader *)objectLoader didLoadObject:(id)object
Declared In
RKObjectLoader.h
objectLoader:didLoadObjectDictionary:
When implemented, sent to the delegate when an object loader has completed successfully. The dictionary will be expressed as pairs of keyPaths and objects mapped from the payload. This method is useful when you have multiple root objects and want to differentiate them by keyPath.
- (void)objectLoader:(RKObjectLoader *)objectLoader didLoadObjectDictionary:(NSDictionary *)dictionary
Declared In
RKObjectLoader.h
objectLoader:didLoadObjects:
When implemented, sent to the delegate when the object laoder has completed successfully and loaded a collection of objects. All objects mapped from the remote payload will be returned as a single array.
- (void)objectLoader:(RKObjectLoader *)objectLoader didLoadObjects:(NSArray *)objects
Declared In
RKObjectLoader.h
objectLoader:willMapData:
Invoked just after parsing has completed, but before object mapping begins. This can be helpful to extract data from the parsed payload that is not object mapped, but is interesting for one reason or another. The mappableData will be made mutable via mutableCopy before the delegate method is invoked.
- (void)objectLoader:(RKObjectLoader *)loader willMapData:(inout id *)mappableData
Discussion
Note that the mappable data is a pointer to a pointer to allow you to replace the mappable data with a new object to be mapped. You must dereference it to access the value.
Declared In
RKObjectLoader.h
objectLoaderDidFinishLoading:
Invoked when the object loader has finished loading
- (void)objectLoaderDidFinishLoading:(RKObjectLoader *)objectLoader
Declared In
RKObjectLoader.h
objectLoaderDidLoadUnexpectedResponse:
Sent when an object loader encounters a response status code it does not know how to handle. 2xx, 4xx, and 5xx responses are all handled appropriately. This should only occur when the remote service sends back a really odd-ball response.
- (void)objectLoaderDidLoadUnexpectedResponse:(RKObjectLoader *)objectLoader
Discussion
@optional
Declared In
RKObjectLoader.h