Conforms to NSObject
Declared in RKMappingOperation.h

Overview

Objects acting as the delegate for RKMappingOperation objects must adopt the RKMappingOperationDelegate protocol. These methods enable the delegate to be notified of events such as the application of attribute and relationship mappings during a mapping operation.

Tasks

Other Methods

Tracking Dynamic Mapping Selection

Tracking Relationship Connections

Instance Methods

mappingOperation:didConnectRelationship:toValue:usingConnection:

- (void)mappingOperation:(RKMappingOperation *)operation didConnectRelationship:(NSRelationshipDescription *)relationship toValue:(id)value usingConnection:(RKConnectionDescription *)connection
Discussion

Tells the delegate that the mapping operation has connected a relationship.

Only sent when mapping an RKEntityMapping object that contains connection mappings.

Parameters

operation

The mapping operation.

relationship

The relationship that was connected.

value

The value that was connected to the relationship

connection

The connection object describing how the relationship was to be connected.

Declared In

RKMappingOperation.h

mappingOperation:didFailToConnectRelationship:usingConnection:

- (void)mappingOperation:(RKMappingOperation *)operation didFailToConnectRelationship:(NSRelationshipDescription *)relationship usingConnection:(RKConnectionDescription *)connection
Discussion

Tells the delegate that the mapping operation failed to connect a relationship.

Only sent when mapping an RKEntityMapping object that contains connection mappings.

Parameters

operation

The mapping operation.

relationship

The relationship that was connected.

connection

The connection object describing how the relationship was to be connected.

Declared In

RKMappingOperation.h

mappingOperation:didFailWithError:

- (void)mappingOperation:(RKMappingOperation *)operation didFailWithError:(NSError *)error
Discussion

Tells the delegate that the mapping operation has failed due to an error.

Parameters

operation

The object mapping operation that has failed.

error

An error object indicating the reason for the failure.

Declared In

RKMappingOperation.h

mappingOperation:didFindValue:forKeyPath:mapping:

- (void)mappingOperation:(RKMappingOperation *)operation didFindValue:(id)value forKeyPath:(NSString *)keyPath mapping:(RKPropertyMapping *)propertyMapping
Discussion

Tells the delegate that an attribute or relationship mapping was found for a given key path within the data being mapped.

Parameters

operation

The object mapping operation being performed.

value

The value that was found at the given key path in the source object representation.

keyPath

The key path in the source object for which the mapping is to be applied.

propertyMapping

The RKAttributeMapping or RKRelationshipMapping for which the mappable value was found within the source object representation.

Declared In

RKMappingOperation.h

mappingOperation:didNotFindValueForKeyPath:mapping:

- (void)mappingOperation:(RKMappingOperation *)operation didNotFindValueForKeyPath:(NSString *)keyPath mapping:(RKPropertyMapping *)propertyMapping
Discussion

Tells the delegate that no attribute or relationships mapping was found for a given key path within the data being mapped.

Parameters

operation

The object mapping operation being performed.

keyPath

The key path in the source object for which no mappable value was found.

propertyMapping

The RKAttributeMapping or RKRelationshipMapping for which no mappable value could be found within the source object representation.

Declared In

RKMappingOperation.h

mappingOperation:didNotSetUnchangedValue:forKeyPath:usingMapping:

- (void)mappingOperation:(RKMappingOperation *)operation didNotSetUnchangedValue:(id)value forKeyPath:(NSString *)keyPath usingMapping:(RKPropertyMapping *)propertyMapping
Discussion

Tells the delegate that the mapping operation has declined to set a value for a given key path because the value has not changed.

Parameters

operation

The object mapping operation being performed.

value

A unchanged value for the key path in the destination object.

keyPath

The key path in the destination object for which a unchanged value was not set.

propertyMapping

The RKAttributeMapping or RKRelationshipMapping found for the key path.

Declared In

RKMappingOperation.h

mappingOperation:didSelectObjectMapping:forDynamicMapping:

- (void)mappingOperation:(RKMappingOperation *)operation didSelectObjectMapping:(RKObjectMapping *)objectMapping forDynamicMapping:(RKDynamicMapping *)dynamicMapping
Discussion

Tells the delegate that the mapping operation has selected a concrete object mapping with which to map the source object.

Only sent if the receiver was initialized with an instance of RKDynamicMapping as the mapping.

Parameters

operation

The mapping operation.

objectMapping

The concrete object mapping with which to perform the mapping.

dynamicMapping

The dynamic source mapping from which the object mapping was determined.

Declared In

RKMappingOperation.h

mappingOperation:didSetValue:forKeyPath:usingMapping:

- (void)mappingOperation:(RKMappingOperation *)operation didSetValue:(id)value forKeyPath:(NSString *)keyPath usingMapping:(RKPropertyMapping *)propertyMapping
Discussion

Tells the delegate that the mapping operation has set a value for a given key path with an attribute or relationship mapping.

Parameters

operation

The object mapping operation being performed.

value

A new value that was set on the destination object.

keyPath

The key path in the destination object for which a new value has been set.

propertyMapping

The RKAttributeMapping or RKRelationshipMapping found for the key path.

Declared In

RKMappingOperation.h

mappingOperation:shouldSetValue:forKeyPath:usingMapping:

- (BOOL)mappingOperation:(RKMappingOperation *)operation shouldSetValue:(id)value forKeyPath:(NSString *)keyPath usingMapping:(RKPropertyMapping *)propertyMapping
Discussion

Asks the delegate if the mapping operation should set a value for a given key path with an attribute or relationship mapping. This method is invoked before the value is set. If the delegate does not implement this method, then the mapping operation will determine if the value should be set by comparing the current property value with the new property value.

Parameters

operation

The object mapping operation being performed.

value

A new value that was set on the destination object.

keyPath

The key path in the destination object for which a new value has been set.

propertyMapping

The RKAttributeMapping or RKRelationshipMapping found for the key path.

Return Value

YES if the operation should set the proposed value for the key path, else NO.

Declared In

RKMappingOperation.h