Files
RestKit/Code/ObjectMapping/RKErrorMessage.h
Blake Watters 0a033596da Relax the use of use an the informal procotol for the errorMessage property in favor of the description method. closes #1104, closes #1087, closes #1095
* Change contract to the use the `description` method instead of `errorMessage`. This makes it work with any class out of the box
* Add import for RKErrorMessage to the Support.h header so it is immediately available
* Fix incorrect keyPath in the README.md
* Add additional notes about how the errors are constructed to the README
2012-12-22 19:03:30 -05:00

45 lines
1.4 KiB
Objective-C

//
// RKError.h
// RestKit
//
// Created by Jeremy Ellison on 5/10/11.
// Copyright (c) 2009-2012 RestKit. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#import <Foundation/Foundation.h>
/**
The `RKErrorMessage` is a simple class used for representing error messages returned by a remote backend system with which the client application is communicating. Error messages are typically returned in a response body in the Client Error class (status code 4xx range).
@see `RKErrorFromMappingResult`
*/
@interface RKErrorMessage : NSObject
///-----------------------------------
/// @name Accessing Errror Information
///-----------------------------------
/**
The error message to be presented to the user.
*/
@property (nonatomic, copy) NSString *errorMessage;
/**
A dictionary of application specific information that accompanies the error message.
*/
@property (nonatomic, copy) NSDictionary *userInfo;
@end