Files
RestKit/Code/Network/RKRequestSerializable.h
Blake Watters 3d0f0ab39e Introduced the RKTableController component for iOS.
RKTableController provides a flexible, integrated system for driving iOS table views using
the RestKit object mapping engine. Local domain objects can be mapped into table cells within a
collection or presented for editing as part of a form. There are three flavors of table controllers
available:

* Static Tables: RKTableController can be used to render simple static tables that are composed of RKTableItems
presented in RKTableSections. Table items can quickly be built and added to a table without a backing model
or can have content object mapped into them for presentation.
* Network Tables: RKTableController can also render a table with the results of a network load. The typical use
case here is to have RestKit retrieve a JSON/XML payload from your remote system and then render the content into
a table.
* Core Data Tables: RKFetchedResultsTableController can efficiently drive a table view using objects pulled from a
Core Data managed object context. Typical use-cases here are for the presentation of large collections that are
pulled from a remote system, offering offline access, or speeding up a UI by using Core Data as a fast local cache.

RKTableController supports a number of bells and whistles including integrated searching/filtering and pull to refresh.
2012-02-10 16:30:54 -05:00

94 lines
3.0 KiB
Objective-C

//
// RKRequestSerializable.h
// RestKit
//
// Created by Blake Watters on 8/3/09.
// Copyright 2009 Two Toasters
//
// 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.
//
/**
This protocol is implemented by objects that can be serialized into a
representation suitable for transmission over a REST request. Suitable
serializations are x-www-form-urlencoded and multipart/form-data.
@warning One of the following methods MUST be implemented for your serializable
implementation to be complete:
- (NSData *)HTTPBody - If you are allowing serialization of a small in-memory
data structure, implement HTTPBody as it is much simpler.
- (NSInputStream *)HTTPBodyStream - This provides support for streaming a large
payload from disk instead of memory.
*/
@protocol RKRequestSerializable <NSObject>
///-----------------------------------------------------------------------------
/// @name HTTP Headers
///-----------------------------------------------------------------------------
/**
The value of the Content-Type header for the HTTP Body representation of the
serialization.
@return A string value of the Content-Type header for the HTTP body.
*/
- (NSString *)HTTPHeaderValueForContentType;
@optional
///-----------------------------------------------------------------------------
/// @name Body Implementation
///-----------------------------------------------------------------------------
/**
An NSData representing the HTTP Body serialization of the object implementing
the protocol.
@return An NSData object respresenting the HTTP body serialization.
*/
- (NSData *)HTTPBody;
/**
Returns an input stream for reading the serialization as a stream used to
provide support for handling large HTTP payloads.
@return An input stream for reading the serialization as a stream.
*/
- (NSInputStream *)HTTPBodyStream;
///-----------------------------------------------------------------------------
/// @name Optional HTTP Headers
///-----------------------------------------------------------------------------
/**
Returns the length of the HTTP Content-Length header.
@return Unsigned integer length of the HTTP Content-Length header.
*/
- (NSUInteger)HTTPHeaderValueForContentLength;
/**
The value of the Content-Type header for the HTTP Body representation of the
serialization.
@bug **DEPRECATED** in v0.9.4: Implement [RKRequestSerializable HTTPHeaderValueForContentType]
instead.
@return A string value of the Content-Type header for the HTTP body.
*/
- (NSString *)ContentTypeHTTPHeader DEPRECATED_ATTRIBUTE;
@end