forked from jverkoey/nimbus
/
_a_s_i_form_data_request_8h_source.html
172 lines (154 loc) · 11.3 KB
/
_a_s_i_form_data_request_8h_source.html
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Nimbus: /Users/featherless/workbench/ios/nimbus/src/ASIHTTPRequest/src/ASIFormDataRequest.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="page">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<a style="float: right;margin-right:20px;margin-top:20px" href='http://www.pledgie.com/campaigns/15519'><img alt='Click here to support Nimbus development and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/15519.png?skin_name=chrome' border='0' /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nimbus
 <span id="projectnumber">0.6.0 - <a href="http://github.com/jverkoey/nimbus">Nimbus is proudly hosted on Github</a></span>
</div>
<div id="projectbrief">An iOS framework whose growth is bounded by O(documentation).</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4-20110629 -->
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_a_s_i_form_data_request_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">/Users/featherless/workbench/ios/nimbus/src/ASIHTTPRequest/src/ASIFormDataRequest.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// ASIFormDataRequest.h</span>
<a name="l00003"></a>00003 <span class="comment">// Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// Created by Ben Copsey on 07/11/2008.</span>
<a name="l00006"></a>00006 <span class="comment">// Copyright 2008-2009 All-Seeing Interactive. All rights reserved.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#import "ASIHTTPRequest.h"</span>
<a name="l00011"></a>00011 <span class="preprocessor">#import "ASIHTTPRequestConfig.h"</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="keyword">typedef</span> <span class="keyword">enum</span> _ASIPostFormat {
<a name="l00014"></a>00014 ASIMultipartFormDataPostFormat = 0,
<a name="l00015"></a>00015 ASIURLEncodedPostFormat = 1
<a name="l00016"></a>00016
<a name="l00017"></a>00017 } ASIPostFormat;
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="keyword">@interface </span>ASIFormDataRequest : ASIHTTPRequest <NSCopying> {
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// Parameters that will be POSTed to the url</span>
<a name="l00022"></a>00022 NSMutableArray *postData;
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="comment">// Files that will be POSTed to the url</span>
<a name="l00025"></a>00025 NSMutableArray *fileData;
<a name="l00026"></a>00026
<a name="l00027"></a>00027 ASIPostFormat postFormat;
<a name="l00028"></a>00028
<a name="l00029"></a>00029 NSStringEncoding stringEncoding;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#if DEBUG_FORM_DATA_REQUEST</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span> <span class="comment">// Will store a string version of the request body that will be printed to the console when ASIHTTPREQUEST_DEBUG is set in GCC_PREPROCESSOR_DEFINITIONS</span>
<a name="l00033"></a>00033 <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *debugBodyString;
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 }
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#pragma mark utilities </span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>- (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>*)encodeURL:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)string;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#pragma mark setup request</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043 <span class="comment">// Add a POST variable to the request</span>
<a name="l00044"></a>00044 - (void)addPostValue:(<span class="keywordtype">id</span> <NSObject>)value forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="comment">// Set a POST variable for this request, clearing any others with the same key</span>
<a name="l00047"></a>00047 - (void)setPostValue:(<span class="keywordtype">id</span> <NSObject>)value forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// Add the contents of a local file to the request</span>
<a name="l00050"></a>00050 - (void)addFile:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)filePath forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">// Same as above, but you can specify the content-type and file name</span>
<a name="l00053"></a>00053 - (void)addFile:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)filePath withFileName:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)fileName andContentType:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)contentType forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// Add the contents of a local file to the request, clearing any others with the same key</span>
<a name="l00056"></a>00056 - (void)setFile:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)filePath forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// Same as above, but you can specify the content-type and file name</span>
<a name="l00059"></a>00059 - (void)setFile:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)filePath withFileName:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)fileName andContentType:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)contentType forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// Add the contents of an NSData object to the request</span>
<a name="l00062"></a>00062 - (void)addData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)data forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">// Same as above, but you can specify the content-type and file name</span>
<a name="l00065"></a>00065 - (void)addData:(<span class="keywordtype">id</span>)data withFileName:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)fileName andContentType:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)contentType forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// Add the contents of an NSData object to the request, clearing any others with the same key</span>
<a name="l00068"></a>00068 - (void)setData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)data forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">// Same as above, but you can specify the content-type and file name</span>
<a name="l00071"></a>00071 - (void)setData:(<span class="keywordtype">id</span>)data withFileName:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)fileName andContentType:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)contentType forKey:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)key;
<a name="l00072"></a>00072
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keyword">@property</span> (assign) ASIPostFormat postFormat;
<a name="l00075"></a>00075 <span class="keyword">@property</span> (assign) NSStringEncoding stringEncoding;
<a name="l00076"></a>00076 <span class="keyword">@end</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ASIFormDataRequest.h</b> </li>
</div><!-- .fixedwidth -->
<span class="footer">Generated for Nimbus by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4-20110629 </span>
</ul>
</div>
</div> <!-- page -->
</body>
</html>