Inherits from NSObject
Declared in RKObjectParameterization.h

Overview

The RKObjectParameterization class provides an interface for mapping a local domain object into an NSDictionary representation suitable for use as the parameters of an HTTP request.

Tasks

Parameterizing an Object

  • + parametersWithObject:requestDescriptor:error:

    Returns a dictionary representation of the given object by performing object mapping using the mapping from the given request descriptor. If the request descriptor specifies a root key path, the mapped parameters will be nested within the dictionary under the specified root key path.

Class Methods

parametersWithObject:requestDescriptor:error:

+ (NSDictionary *)parametersWithObject:(id)object requestDescriptor:(RKRequestDescriptor *)requestDescriptor error:(NSError **)error
Discussion

Returns a dictionary representation of the given object by performing object mapping using the mapping from the given request descriptor. If the request descriptor specifies a root key path, the mapped parameters will be nested within the dictionary under the specified root key path.

Parameters

object

The object to be parameterized.

requestDescriptor

The request descriptor describing how the object is to be mapped into an NSDictionary of parameters.

error

If there is a problem mapping the parameters, upon return contains a pointer to an instance of NSError that describes the problem.

Return Value

A new dictionary containing the mapped parameters or nil if an error has occurred.

Declared In

RKObjectParameterization.h