-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
RKRequestSerializable.h
53 lines (44 loc) · 1.5 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
//
// RKRequestSerializable.h
// RestKit
//
// Created by Blake Watters on 8/3/09.
// Copyright 2009 Two Toasters. All rights reserved.
//
/*
* 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.
*/
@protocol RKRequestSerializable
/**
* The value of the Content-Type header for the HTTP Body representation of the serialization
*/
- (NSString*)HTTPHeaderValueForContentType;
@optional
/**
* NOTE: One of the following methods MUST be implemented for your serializable implementation
* to be complete. If you are allowing serialization of a small in-memory data structure, implement
* HTTPBody as it is much simpler. HTTPBodyStream provides support for streaming a large payload
* from disk instead of memory.
*/
/**
* An NSData representing the HTTP Body serialization of the object implementing the protocol
*/
- (NSData*)HTTPBody;
/**
* Returns an input stream for reading the serialization as a stream. Used to provide support for
* handling large HTTP payloads.
*/
- (NSInputStream*)HTTPBodyStream;
/**
* Returns the length of the HTTP Content-Length header
*/
- (NSUInteger)HTTPHeaderValueForContentLength;
/**
* The value of the Content-Type header for the HTTP Body representation of the serialization
*
* @deprecated Implement HTTPHeaderValueForContentType instead
*/
- (NSString*)ContentTypeHTTPHeader DEPRECATED_ATTRIBUTE;
@end