jazzy 0.0.15 → 0.0.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +7 -5
- data/Rakefile +2 -0
- data/bin/jazzy +1 -1
- data/jazzy.gemspec +1 -0
- data/lib/jazzy.rb +1 -0
- data/lib/jazzy/assets/css/highlight.css.scss +63 -0
- data/lib/jazzy/assets/css/jazzy.css.scss +27 -1
- data/lib/jazzy/assets/js/jazzy.js +8 -2
- data/lib/jazzy/config.rb +32 -0
- data/lib/jazzy/doc.mustache +15 -1
- data/lib/jazzy/doc_builder.rb +24 -12
- data/lib/jazzy/docset_builder.rb +77 -0
- data/lib/jazzy/docset_builder/info_plist.mustache +20 -0
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/highlighter.rb +10 -0
- data/lib/jazzy/partials/task.mustache +3 -3
- data/lib/jazzy/source_declaration.rb +3 -3
- data/lib/jazzy/source_declaration/type.rb +136 -0
- data/lib/jazzy/source_module.rb +10 -0
- data/lib/jazzy/sourcekitten.rb +35 -62
- data/logo.sketch +0 -0
- data/spec/integration_spec.rb +10 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Info.plist +20 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes.html +267 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager.html +488 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager/init(configuration:).html +218 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html +841 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums.html +257 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums/ParameterEncoding.html +346 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions.html +708 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Manager.html +344 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Request.html +368 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Functions.html +1040 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Global Variables.html +226 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager.html +344 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager/init(configuration:).html +218 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/ParameterEncoding.html +346 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols.html +275 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLRequestConvertible.html +227 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html +227 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Request.html +368 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLRequestConvertible.html +227 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLStringConvertible.html +227 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/highlight.css +202 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/highlight.css +202 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/index.html +755 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/init(configuration:).html +218 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.css +708 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.js +21 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jquery.min.js +4 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
- data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/docSet.dsidx.csv +81 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes.html +18 -7
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +31 -19
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html +14 -1
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +61 -46
- data/spec/integration_specs/document_alamofire/after/docs/Enums.html +18 -7
- data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +20 -4
- data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +68 -48
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +21 -7
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +22 -10
- data/spec/integration_specs/document_alamofire/after/docs/Functions.html +51 -34
- data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +15 -4
- data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +20 -7
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +16 -4
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +16 -4
- data/spec/integration_specs/document_alamofire/after/docs/css/highlight.css +202 -0
- data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +14 -0
- data/spec/integration_specs/document_alamofire/after/docs/index.html +53 -42
- data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +8 -2
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +34 -22
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +16 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +16 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +14 -1
- data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +16 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Info.plist +20 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes.html +309 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +143 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/DocumentedEnum.html +134 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums.html +147 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +134 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Global Variables.html +146 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/ImplicitlyInternalTopLevelClass.html +143 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/highlight.css +202 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/highlight.css +202 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +106 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.css +708 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.js +21 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js +4 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +15 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/highlight.css +202 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +14 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +12 -1
- data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +8 -2
- metadata +88 -5
- data/lib/jazzy/assets/css/github_syntax_highlighting.css.scss +0 -142
- data/spec/integration_specs/document_alamofire/after/docs/css/github_syntax_highlighting.css +0 -98
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/github_syntax_highlighting.css +0 -98
@@ -0,0 +1,218 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en">
|
3
|
+
<head>
|
4
|
+
<title>init(configuration:) Instance Method Reference</title>
|
5
|
+
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
|
6
|
+
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
|
7
|
+
<meta charset='utf-8'>
|
8
|
+
<script type="text/javascript">
|
9
|
+
window.jazzy = {'docset': false}
|
10
|
+
if (typeof window.dash != 'undefined') {
|
11
|
+
document.documentElement.className += ' dash'
|
12
|
+
window.jazzy.docset = true
|
13
|
+
}
|
14
|
+
if (navigator.userAgent.match(/xcode/i)) {
|
15
|
+
document.documentElement.className += ' xcode'
|
16
|
+
window.jazzy.docset = true
|
17
|
+
}
|
18
|
+
</script>
|
19
|
+
<script src="../../js/jquery.min.js" defer></script>
|
20
|
+
<script src="../../js/jazzy.js" defer></script>
|
21
|
+
</head>
|
22
|
+
<body id="reference" class="Swift">
|
23
|
+
<a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a>
|
24
|
+
<a title="init(configuration:) Instance Method Reference"></a>
|
25
|
+
<header>
|
26
|
+
<div class="content-wrapper">
|
27
|
+
<p class="header-text"><a href="../../index.html">Alamofire Docs</a> (40% documented)</p>
|
28
|
+
<p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
|
29
|
+
</div>
|
30
|
+
</header>
|
31
|
+
<section id="valence">
|
32
|
+
<div class="content-wrapper">
|
33
|
+
<p id="hierarchial_navigation">
|
34
|
+
<a href="../../index.html" id="design_resources_link">Alamofire Reference</a>
|
35
|
+
<img id="carat" src="../../img/carat.png" height="10px" width="6px" />
|
36
|
+
init(configuration:) Instance Method Reference
|
37
|
+
</p>
|
38
|
+
</div>
|
39
|
+
</section>
|
40
|
+
<div class="content-wrapper">
|
41
|
+
<nav class="book-parts">
|
42
|
+
<ul class="nav-parts">
|
43
|
+
<li class="part-name tasks">
|
44
|
+
<a href="../../Classes.html">Classes</a>
|
45
|
+
<ul class="nav-chapters">
|
46
|
+
<li class="nav-chapter">
|
47
|
+
<a href="../../Classes/Manager.html">Manager</a>
|
48
|
+
</li>
|
49
|
+
<li class="nav-chapter">
|
50
|
+
<a href="../../Classes/Request.html">Request</a>
|
51
|
+
</li>
|
52
|
+
</ul>
|
53
|
+
</li>
|
54
|
+
<li class="part-name tasks">
|
55
|
+
<a href="../../Global Variables.html">Global Variables</a>
|
56
|
+
<ul class="nav-chapters">
|
57
|
+
<li class="nav-chapter">
|
58
|
+
<a href="../../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
|
59
|
+
</li>
|
60
|
+
</ul>
|
61
|
+
</li>
|
62
|
+
<li class="part-name tasks">
|
63
|
+
<a href="../../Enums.html">Enums</a>
|
64
|
+
<ul class="nav-chapters">
|
65
|
+
<li class="nav-chapter">
|
66
|
+
<a href="../../Enums.html#/s:O9Alamofire6Method">Method</a>
|
67
|
+
</li>
|
68
|
+
<li class="nav-chapter">
|
69
|
+
<a href="../../Enums/ParameterEncoding.html">ParameterEncoding</a>
|
70
|
+
</li>
|
71
|
+
</ul>
|
72
|
+
</li>
|
73
|
+
<li class="part-name tasks">
|
74
|
+
<a href="../../Extensions.html">Extensions</a>
|
75
|
+
<ul class="nav-chapters">
|
76
|
+
<li class="nav-chapter">
|
77
|
+
<a href="../../Extensions.html#/s:SS">String</a>
|
78
|
+
</li>
|
79
|
+
<li class="nav-chapter">
|
80
|
+
<a href="../../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
81
|
+
</li>
|
82
|
+
<li class="nav-chapter">
|
83
|
+
<a href="../../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
84
|
+
</li>
|
85
|
+
<li class="nav-chapter">
|
86
|
+
<a href="../../Extensions/Request.html">Request</a>
|
87
|
+
</li>
|
88
|
+
<li class="nav-chapter">
|
89
|
+
<a href="../../Extensions/Manager.html">Manager</a>
|
90
|
+
</li>
|
91
|
+
<li class="nav-chapter">
|
92
|
+
<a href="../../Extensions.html#/s:C9Alamofire7Request">Request</a>
|
93
|
+
</li>
|
94
|
+
<li class="nav-chapter">
|
95
|
+
<a href="../../Extensions/Manager.html">Manager</a>
|
96
|
+
</li>
|
97
|
+
<li class="nav-chapter">
|
98
|
+
<a href="../../Extensions/Request.html">Request</a>
|
99
|
+
</li>
|
100
|
+
<li class="nav-chapter">
|
101
|
+
<a href="../../Extensions/Request.html">Request</a>
|
102
|
+
</li>
|
103
|
+
<li class="nav-chapter">
|
104
|
+
<a href="../../Extensions/Request.html">Request</a>
|
105
|
+
</li>
|
106
|
+
<li class="nav-chapter">
|
107
|
+
<a href="../../Extensions/Request.html">Request</a>
|
108
|
+
</li>
|
109
|
+
<li class="nav-chapter">
|
110
|
+
<a href="../../Extensions/Request.html">Request</a>
|
111
|
+
</li>
|
112
|
+
<li class="nav-chapter">
|
113
|
+
<a href="../../Extensions/Request.html">Request</a>
|
114
|
+
</li>
|
115
|
+
</ul>
|
116
|
+
</li>
|
117
|
+
<li class="part-name tasks">
|
118
|
+
<a href="../../Functions.html">Functions</a>
|
119
|
+
<ul class="nav-chapters">
|
120
|
+
<li class="nav-chapter">
|
121
|
+
<a href="../../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
|
122
|
+
</li>
|
123
|
+
<li class="nav-chapter">
|
124
|
+
<a href="../../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
|
125
|
+
</li>
|
126
|
+
<li class="nav-chapter">
|
127
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
|
128
|
+
</li>
|
129
|
+
<li class="nav-chapter">
|
130
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
|
131
|
+
</li>
|
132
|
+
<li class="nav-chapter">
|
133
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
|
134
|
+
</li>
|
135
|
+
<li class="nav-chapter">
|
136
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
|
137
|
+
</li>
|
138
|
+
<li class="nav-chapter">
|
139
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
|
140
|
+
</li>
|
141
|
+
<li class="nav-chapter">
|
142
|
+
<a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
|
143
|
+
</li>
|
144
|
+
<li class="nav-chapter">
|
145
|
+
<a href="../../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
|
146
|
+
</li>
|
147
|
+
<li class="nav-chapter">
|
148
|
+
<a href="../../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
|
149
|
+
</li>
|
150
|
+
<li class="nav-chapter">
|
151
|
+
<a href="../../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
|
152
|
+
</li>
|
153
|
+
</ul>
|
154
|
+
</li>
|
155
|
+
<li class="part-name tasks">
|
156
|
+
<a href="../../Protocols.html">Protocols</a>
|
157
|
+
<ul class="nav-chapters">
|
158
|
+
<li class="nav-chapter">
|
159
|
+
<a href="../../Protocols/URLStringConvertible.html">URLStringConvertible</a>
|
160
|
+
</li>
|
161
|
+
<li class="nav-chapter">
|
162
|
+
<a href="../../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
|
163
|
+
</li>
|
164
|
+
</ul>
|
165
|
+
</li>
|
166
|
+
</ul>
|
167
|
+
</nav>
|
168
|
+
<div class="pixel-line"></div>
|
169
|
+
<div class="rubber-band-gap"></div>
|
170
|
+
<article class="chapter">
|
171
|
+
<a name="/"></a>
|
172
|
+
<h1 class="chapter-name">init(configuration:)</h1>
|
173
|
+
<section>
|
174
|
+
<section class="section">
|
175
|
+
|
176
|
+
</section>
|
177
|
+
<section class="section task-group-section">
|
178
|
+
<div class="task-group">
|
179
|
+
<div class="task-name-container">
|
180
|
+
|
181
|
+
<a name="/Unnamed"></a>
|
182
|
+
|
183
|
+
</div>
|
184
|
+
<ul class="task-group-list">
|
185
|
+
<li class="item symbol">
|
186
|
+
<div class="task-group-term">
|
187
|
+
<code>
|
188
|
+
<a name="/s:vFC9Alamofire7ManagercFMS0_FT13configurationGSqCSo25NSURLSessionConfiguration__S0_L_13configurationGSqS1__">
|
189
|
+
<a name="//apple_ref/swift/Variable/configuration" class="dashAnchor"></a>
|
190
|
+
<a class="x-instance-method Swift" href="#/s:vFC9Alamofire7ManagercFMS0_FT13configurationGSqCSo25NSURLSessionConfiguration__S0_L_13configurationGSqS1__">configuration</a>
|
191
|
+
</code>
|
192
|
+
</div>
|
193
|
+
<div class="height-container">
|
194
|
+
<div class="pointy-thing-container"></div>
|
195
|
+
<section class="section instance-method">
|
196
|
+
<div class="pointy-thing"></div>
|
197
|
+
<div class="abstract">
|
198
|
+
<p class="para">Undocumented</p>
|
199
|
+
</div>
|
200
|
+
<div class="result-description view-on-github">
|
201
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
|
202
|
+
</div>
|
203
|
+
</section>
|
204
|
+
</div>
|
205
|
+
</li>
|
206
|
+
</ul>
|
207
|
+
</div>
|
208
|
+
</section>
|
209
|
+
</section>
|
210
|
+
<section id="footer">
|
211
|
+
<p class="copyright">© YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
|
212
|
+
<p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
213
|
+
</section>
|
214
|
+
</article>
|
215
|
+
</div>
|
216
|
+
</body>
|
217
|
+
</div>
|
218
|
+
</html>
|
@@ -0,0 +1,346 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en">
|
3
|
+
<head>
|
4
|
+
<title>ParameterEncoding Enum Reference</title>
|
5
|
+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
6
|
+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
7
|
+
<meta charset='utf-8'>
|
8
|
+
<script type="text/javascript">
|
9
|
+
window.jazzy = {'docset': false}
|
10
|
+
if (typeof window.dash != 'undefined') {
|
11
|
+
document.documentElement.className += ' dash'
|
12
|
+
window.jazzy.docset = true
|
13
|
+
}
|
14
|
+
if (navigator.userAgent.match(/xcode/i)) {
|
15
|
+
document.documentElement.className += ' xcode'
|
16
|
+
window.jazzy.docset = true
|
17
|
+
}
|
18
|
+
</script>
|
19
|
+
<script src="../js/jquery.min.js" defer></script>
|
20
|
+
<script src="../js/jazzy.js" defer></script>
|
21
|
+
</head>
|
22
|
+
<body id="reference" class="Swift">
|
23
|
+
<a name="//apple_ref/swift/Enum/ParameterEncoding" class="dashAnchor"></a>
|
24
|
+
<a title="ParameterEncoding Enum Reference"></a>
|
25
|
+
<header>
|
26
|
+
<div class="content-wrapper">
|
27
|
+
<p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
|
28
|
+
<p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
|
29
|
+
</div>
|
30
|
+
</header>
|
31
|
+
<section id="valence">
|
32
|
+
<div class="content-wrapper">
|
33
|
+
<p id="hierarchial_navigation">
|
34
|
+
<a href="../index.html" id="design_resources_link">Alamofire Reference</a>
|
35
|
+
<img id="carat" src="../img/carat.png" height="10px" width="6px" />
|
36
|
+
ParameterEncoding Enum Reference
|
37
|
+
</p>
|
38
|
+
</div>
|
39
|
+
</section>
|
40
|
+
<div class="content-wrapper">
|
41
|
+
<nav class="book-parts">
|
42
|
+
<ul class="nav-parts">
|
43
|
+
<li class="part-name tasks">
|
44
|
+
<a href="../Classes.html">Classes</a>
|
45
|
+
<ul class="nav-chapters">
|
46
|
+
<li class="nav-chapter">
|
47
|
+
<a href="../Classes/Manager.html">Manager</a>
|
48
|
+
</li>
|
49
|
+
<li class="nav-chapter">
|
50
|
+
<a href="../Classes/Request.html">Request</a>
|
51
|
+
</li>
|
52
|
+
</ul>
|
53
|
+
</li>
|
54
|
+
<li class="part-name tasks">
|
55
|
+
<a href="../Global Variables.html">Global Variables</a>
|
56
|
+
<ul class="nav-chapters">
|
57
|
+
<li class="nav-chapter">
|
58
|
+
<a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
|
59
|
+
</li>
|
60
|
+
</ul>
|
61
|
+
</li>
|
62
|
+
<li class="part-name tasks">
|
63
|
+
<a href="../Enums.html">Enums</a>
|
64
|
+
<ul class="nav-chapters">
|
65
|
+
<li class="nav-chapter">
|
66
|
+
<a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
|
67
|
+
</li>
|
68
|
+
<li class="nav-chapter">
|
69
|
+
<a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
|
70
|
+
</li>
|
71
|
+
</ul>
|
72
|
+
</li>
|
73
|
+
<li class="part-name tasks">
|
74
|
+
<a href="../Extensions.html">Extensions</a>
|
75
|
+
<ul class="nav-chapters">
|
76
|
+
<li class="nav-chapter">
|
77
|
+
<a href="../Extensions.html#/s:SS">String</a>
|
78
|
+
</li>
|
79
|
+
<li class="nav-chapter">
|
80
|
+
<a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
81
|
+
</li>
|
82
|
+
<li class="nav-chapter">
|
83
|
+
<a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
84
|
+
</li>
|
85
|
+
<li class="nav-chapter">
|
86
|
+
<a href="../Extensions/Request.html">Request</a>
|
87
|
+
</li>
|
88
|
+
<li class="nav-chapter">
|
89
|
+
<a href="../Extensions/Manager.html">Manager</a>
|
90
|
+
</li>
|
91
|
+
<li class="nav-chapter">
|
92
|
+
<a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
|
93
|
+
</li>
|
94
|
+
<li class="nav-chapter">
|
95
|
+
<a href="../Extensions/Manager.html">Manager</a>
|
96
|
+
</li>
|
97
|
+
<li class="nav-chapter">
|
98
|
+
<a href="../Extensions/Request.html">Request</a>
|
99
|
+
</li>
|
100
|
+
<li class="nav-chapter">
|
101
|
+
<a href="../Extensions/Request.html">Request</a>
|
102
|
+
</li>
|
103
|
+
<li class="nav-chapter">
|
104
|
+
<a href="../Extensions/Request.html">Request</a>
|
105
|
+
</li>
|
106
|
+
<li class="nav-chapter">
|
107
|
+
<a href="../Extensions/Request.html">Request</a>
|
108
|
+
</li>
|
109
|
+
<li class="nav-chapter">
|
110
|
+
<a href="../Extensions/Request.html">Request</a>
|
111
|
+
</li>
|
112
|
+
<li class="nav-chapter">
|
113
|
+
<a href="../Extensions/Request.html">Request</a>
|
114
|
+
</li>
|
115
|
+
</ul>
|
116
|
+
</li>
|
117
|
+
<li class="part-name tasks">
|
118
|
+
<a href="../Functions.html">Functions</a>
|
119
|
+
<ul class="nav-chapters">
|
120
|
+
<li class="nav-chapter">
|
121
|
+
<a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
|
122
|
+
</li>
|
123
|
+
<li class="nav-chapter">
|
124
|
+
<a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
|
125
|
+
</li>
|
126
|
+
<li class="nav-chapter">
|
127
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
|
128
|
+
</li>
|
129
|
+
<li class="nav-chapter">
|
130
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
|
131
|
+
</li>
|
132
|
+
<li class="nav-chapter">
|
133
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
|
134
|
+
</li>
|
135
|
+
<li class="nav-chapter">
|
136
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
|
137
|
+
</li>
|
138
|
+
<li class="nav-chapter">
|
139
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
|
140
|
+
</li>
|
141
|
+
<li class="nav-chapter">
|
142
|
+
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
|
143
|
+
</li>
|
144
|
+
<li class="nav-chapter">
|
145
|
+
<a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
|
146
|
+
</li>
|
147
|
+
<li class="nav-chapter">
|
148
|
+
<a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
|
149
|
+
</li>
|
150
|
+
<li class="nav-chapter">
|
151
|
+
<a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
|
152
|
+
</li>
|
153
|
+
</ul>
|
154
|
+
</li>
|
155
|
+
<li class="part-name tasks">
|
156
|
+
<a href="../Protocols.html">Protocols</a>
|
157
|
+
<ul class="nav-chapters">
|
158
|
+
<li class="nav-chapter">
|
159
|
+
<a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
|
160
|
+
</li>
|
161
|
+
<li class="nav-chapter">
|
162
|
+
<a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
|
163
|
+
</li>
|
164
|
+
</ul>
|
165
|
+
</li>
|
166
|
+
</ul>
|
167
|
+
</nav>
|
168
|
+
<div class="pixel-line"></div>
|
169
|
+
<div class="rubber-band-gap"></div>
|
170
|
+
<article class="chapter">
|
171
|
+
<a name="/"></a>
|
172
|
+
<h1 class="chapter-name">ParameterEncoding</h1>
|
173
|
+
<section>
|
174
|
+
<section class="section">
|
175
|
+
<p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</p>
|
176
|
+
</section>
|
177
|
+
<section class="section task-group-section">
|
178
|
+
<div class="task-group">
|
179
|
+
<div class="task-name-container">
|
180
|
+
|
181
|
+
<a name="/Unnamed"></a>
|
182
|
+
|
183
|
+
</div>
|
184
|
+
<ul class="task-group-list">
|
185
|
+
<li class="item symbol">
|
186
|
+
<div class="task-group-term">
|
187
|
+
<code>
|
188
|
+
<a name="/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">
|
189
|
+
<a name="//apple_ref/swift/Method/encode(_:parameters:)" class="dashAnchor"></a>
|
190
|
+
<a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">encode(_:parameters:)</a>
|
191
|
+
</code>
|
192
|
+
</div>
|
193
|
+
<div class="height-container">
|
194
|
+
<div class="pointy-thing-container"></div>
|
195
|
+
<section class="section instance-method">
|
196
|
+
<div class="pointy-thing"></div>
|
197
|
+
<div class="abstract">
|
198
|
+
<p class="para">Creates a URL request by encoding parameters and applying them onto an existing request.</p>
|
199
|
+
</div>
|
200
|
+
<div class="declaration">
|
201
|
+
<h4>Declaration</h4>
|
202
|
+
|
203
|
+
<div class="Swift">
|
204
|
+
<p class="aside-title">Swift</p>
|
205
|
+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-></span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
|
206
|
+
|
207
|
+
</div>
|
208
|
+
</div>
|
209
|
+
<div class="parameters">
|
210
|
+
<h4>Parameters</h4>
|
211
|
+
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
212
|
+
<tbody>
|
213
|
+
<tr>
|
214
|
+
<td scope="row">
|
215
|
+
<code>
|
216
|
+
<em class="term">URLRequest</em>
|
217
|
+
</code>
|
218
|
+
</td>
|
219
|
+
<td>
|
220
|
+
<div class="definition">
|
221
|
+
<p class="para">The request to have parameters applied</p>
|
222
|
+
</div>
|
223
|
+
</td>
|
224
|
+
</tr>
|
225
|
+
<tr>
|
226
|
+
<td scope="row">
|
227
|
+
<code>
|
228
|
+
<em class="term">parameters</em>
|
229
|
+
</code>
|
230
|
+
</td>
|
231
|
+
<td>
|
232
|
+
<div class="definition">
|
233
|
+
<p class="para">The parameters to apply</p>
|
234
|
+
</div>
|
235
|
+
</td>
|
236
|
+
</tr>
|
237
|
+
</tbody>
|
238
|
+
</table>
|
239
|
+
</div>
|
240
|
+
<div class="result-description">
|
241
|
+
<h4>Return Value</h4>
|
242
|
+
<p class="para">A tuple containing the constructed request and the error that occurred during parameter encoding, if any.</p>
|
243
|
+
</div>
|
244
|
+
<div class="result-description view-on-github">
|
245
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L77">Show on GitHub</a>
|
246
|
+
</div>
|
247
|
+
</section>
|
248
|
+
</div>
|
249
|
+
</li>
|
250
|
+
<li class="item symbol">
|
251
|
+
<div class="task-group-term">
|
252
|
+
<code>
|
253
|
+
<a name="/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">
|
254
|
+
<a name="//apple_ref/swift/Element/Custom" class="dashAnchor"></a>
|
255
|
+
<a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">Custom</a>
|
256
|
+
</code>
|
257
|
+
</div>
|
258
|
+
<div class="height-container">
|
259
|
+
<div class="pointy-thing-container"></div>
|
260
|
+
<section class="section instance-method">
|
261
|
+
<div class="pointy-thing"></div>
|
262
|
+
<div class="abstract">
|
263
|
+
<p class="para">Uses the associated closure value to construct a new request given an existing request and parameters.</p>
|
264
|
+
</div>
|
265
|
+
<div class="result-description view-on-github">
|
266
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L67">Show on GitHub</a>
|
267
|
+
</div>
|
268
|
+
</section>
|
269
|
+
</div>
|
270
|
+
</li>
|
271
|
+
<li class="item symbol">
|
272
|
+
<div class="task-group-term">
|
273
|
+
<code>
|
274
|
+
<a name="/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">
|
275
|
+
<a name="//apple_ref/swift/Element/URL" class="dashAnchor"></a>
|
276
|
+
<a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">URL</a>
|
277
|
+
</code>
|
278
|
+
</div>
|
279
|
+
<div class="height-container">
|
280
|
+
<div class="pointy-thing-container"></div>
|
281
|
+
<section class="section instance-method">
|
282
|
+
<div class="pointy-thing"></div>
|
283
|
+
<div class="abstract">
|
284
|
+
<p class="para">A query string to be set as or appended to any existing URL query for <code>GET</code>, <code>HEAD</code>, and <code>DELETE</code> requests, or set as the body for requests with any other HTTP method. The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to <code>application/x-www-form-urlencoded</code>. Since there is no published specification for how to encode collection types, the convention of appending <code>[]</code> to the key for array values (<code>foo[]=1&foo[]=2</code>), and appending the key surrounded by square brackets for nested dictionary values (<code>foo[bar]=baz</code>).</p>
|
285
|
+
</div>
|
286
|
+
<div class="result-description view-on-github">
|
287
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L52">Show on GitHub</a>
|
288
|
+
</div>
|
289
|
+
</section>
|
290
|
+
</div>
|
291
|
+
</li>
|
292
|
+
<li class="item symbol">
|
293
|
+
<div class="task-group-term">
|
294
|
+
<code>
|
295
|
+
<a name="/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">
|
296
|
+
<a name="//apple_ref/swift/Element/JSON" class="dashAnchor"></a>
|
297
|
+
<a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">JSON</a>
|
298
|
+
</code>
|
299
|
+
</div>
|
300
|
+
<div class="height-container">
|
301
|
+
<div class="pointy-thing-container"></div>
|
302
|
+
<section class="section instance-method">
|
303
|
+
<div class="pointy-thing"></div>
|
304
|
+
<div class="abstract">
|
305
|
+
<p class="para">Uses <code>NSJSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
|
306
|
+
</div>
|
307
|
+
<div class="result-description view-on-github">
|
308
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L57">Show on GitHub</a>
|
309
|
+
</div>
|
310
|
+
</section>
|
311
|
+
</div>
|
312
|
+
</li>
|
313
|
+
<li class="item symbol">
|
314
|
+
<div class="task-group-term">
|
315
|
+
<code>
|
316
|
+
<a name="/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">
|
317
|
+
<a name="//apple_ref/swift/Element/PropertyList" class="dashAnchor"></a>
|
318
|
+
<a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">PropertyList</a>
|
319
|
+
</code>
|
320
|
+
</div>
|
321
|
+
<div class="height-container">
|
322
|
+
<div class="pointy-thing-container"></div>
|
323
|
+
<section class="section instance-method">
|
324
|
+
<div class="pointy-thing"></div>
|
325
|
+
<div class="abstract">
|
326
|
+
<p class="para">Uses <code>NSPropertyListSerialization</code> to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/x-plist</code>.</p>
|
327
|
+
</div>
|
328
|
+
<div class="result-description view-on-github">
|
329
|
+
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L62">Show on GitHub</a>
|
330
|
+
</div>
|
331
|
+
</section>
|
332
|
+
</div>
|
333
|
+
</li>
|
334
|
+
</ul>
|
335
|
+
</div>
|
336
|
+
</section>
|
337
|
+
</section>
|
338
|
+
<section id="footer">
|
339
|
+
<p class="copyright">© YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
|
340
|
+
<p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
341
|
+
</section>
|
342
|
+
</article>
|
343
|
+
</div>
|
344
|
+
</body>
|
345
|
+
</div>
|
346
|
+
</html>
|