/
RKRequestSerializable.h
93 lines (73 loc) · 3.04 KB
/
RKRequestSerializable.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
//
// RKRequestSerializable.h
// RestKit
//
// Created by Blake Watters on 8/3/09.
// 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.
//
/**
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.10.0: Implement [RKRequestSerializable HTTPHeaderValueForContentType]
instead.
@return A string value of the Content-Type header for the HTTP body.
*/
- (NSString *)ContentTypeHTTPHeader DEPRECATED_ATTRIBUTE;
@end