BAObjectMapConfiguring

Objective-C

@protocol BAObjectMapConfiguring <NSObject>

@property (strong, nonatomic) NSMutableDictionary *registeredMappings;

/*!
   Configures the mapping for the REST adapter
 
   @param path                The request endpoint
   @param method              The HTTP request method
   @param responseEntityClass The class of the response entity
   @param requestEntityClass  The class of the request entity
   @param keyPath             The key path to match against the deserialized response body. 
                              If nil, the response descriptor matches the entire response body.
 */
- (void)configureMappingWithPath:(NSString *)path
                      httpMethod:(BAWebServiceHttpMethod)method
             responseEntityClass:(Class)responseEntityClass
              requestEntityClass:(Class)requestEntityClass
                         keyPath:(NSString *)keyPath;

/*!
 Configures the mapping the server and the client error mapping
 
 @param serverErrorClass The class of the server error response entity
 @param clientErrorClass The class of the client error response entity
 */
- (void)configureServerErrorMapping:(Class) serverErrorClass clientErrorClass: (Class) clientErrorClass;

@end

Swift

protocol BAObjectMapConfiguring : NSObjectProtocol

Undocumented

  • Undocumented

    Declaration

    Objective-C

    @property (strong, nonatomic) NSMutableDictionary *registeredMappings

    Swift

    var registeredMappings: NSMutableDictionary! { get set }
  • Undocumented

    Declaration

    Objective-C

    - (void)configureMappingWithPath:(NSString *)path
                          httpMethod:(BAWebServiceHttpMethod)method
                 responseEntityClass:(Class)responseEntityClass
                  requestEntityClass:(Class)requestEntityClass
                             keyPath:(NSString *)keyPath;

    Swift

    func configureMapping(withPath path: String!, httpMethod method: BAWebServiceHttpMethod, responseEntityClass: AnyClass!, requestEntityClass: AnyClass!, keyPath: String!)
  • Undocumented

    Declaration

    Objective-C

    - (void)configureServerErrorMapping:(Class)serverErrorClass
                       clientErrorClass:(Class)clientErrorClass;

    Swift

    func configureServerErrorMapping(_ serverErrorClass: AnyClass!, clientErrorClass: AnyClass!)