Discussion

For example, if using the popular will_paginate plugin with Ruby on Rails, we would configure our pagination mapping like so:

// Assumes the JSON format of http://stackoverflow.com/questions/4699182/will-paginate-json-support RKObjectMapping *paginationMapping = [RKObjectMapping mappingForClass:[RKObjectPaginator class]]; [paginationMapping mapKeyPath:@“current_page” toAttribute:@“currentPage”]; [paginationMapping mapKeyPath:@“per_page” toAttribute:@“perPage”]; [paginationMapping mapKeyPath:@“total_entries” toAttribute:@“objectCount”];

Discussion

You can retrieve mappings added to the provider by invoking objectMappingsForClass: and objectMappingForClass:

Discussion

The objectClass is the class for a model you use to represent data retrieved in XML or JSON format. For example, if we were developing a Twitter application we might have an objectClass of RKTweet for storing Tweet data. We could retrieve the object mapping for this model by invoking [mappingProvider objectMappingForClass:[RKTweet class]];

Mappings registered via addObjectMapping: take precedence over those registered via setObjectMapping:forKeyPath:.

Discussion

you are using dynamic mapping.

Discussion

This is a shortcut for configuring a pair of object mappings that model a simple resource the same way when going to and from the server.

For example, if we have a simple resource called ‘person’ that returns JSON in the following format:

{ "person": { "first_name": "Blake", "last_name": "Watters" } }

We might configure a mapping like so:

RKObjectMapping *mapping = [RKObjectMapping mappingForClass:[Person class]];
[mapping mapAttributes:@"first_name", @"last_name", nil];

If we want to parse the above JSON and serialize it such that using postObject: or putObject: use the same format, we can auto-generate the serialization mapping and set the whole thing up in one shot:

[[RKObjectManager sharedManager].mappingProvider registerMapping:mapping withRootKeyPath:@"person"];

This will call setMapping:forKeyPath: for you, then generate a serialization mapping and set the root keyPath as well.

If you want to manipulate the serialization mapping yourself, you can work with the mapping directly:

RKObjectMapping *serializationMappingForPerson = [personMapping inverseMapping];
// NOTE: Serialization mapping default to a nil root keyPath and will serialize to a flat dictionary
[[RKObjectManager sharedManager].mappingProvider setSerializationMapping:serializationMappingForPerson forClass:[Person class]];

Discussion

When an RKObjectMapper is performing its work, each registered keyPath within the mapping provider will be searched for content in the parsed payload. If mappable content is found, the object mapping configured for the keyPath will be used to perform an RKObjectMappingOperation.

Discussion

The resourcePathPattern is a SOCKit pattern matching property names preceded by colons within a path. For example, if a collection of reviews for a product were loaded from a remote system at the resourcePath @“/products/1234/reviews”, object mapping could be configured to handle this request with a resourcePathPattern of @“/products/:productID/reviews”.

NOTE that care must be taken when configuring patterns within the provider. The patterns will be evaluated in the order they are added to the provider, so more specific patterns must precede more general patterns where either would generate a match.

Discussion

The resourcePathPattern is a SOCKit pattern matching property names preceded by colons within a path. For example, if a collection of reviews for a product were loaded from a remote system at the resourcePath @“/products/1234/reviews”, object mapping could be configured to handle this request with a resourcePathPattern of @“/products/:productID/reviews”.

NOTE that care must be taken when configuring patterns within the provider. The patterns will be evaluated in the order they are added to the provider, so more specific patterns must precede more general patterns where either would generate a match.

Discussion

Serialization mappings are simply instances of RKObjectMapping that target NSMutableDictionary as the target object class. After the object is mapped into an NSMutableDictionary, it can be encoded to form encoded string, JSON, XML, etc.