jazzy 0.0.20 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitmodules +6 -3
- data/.travis.yml +1 -1
- data/CHANGELOG.md +23 -1
- data/Gemfile.lock +41 -5
- data/Rakefile +21 -0
- data/jazzy.gemspec +1 -0
- data/lib/jazzy/assets/css/jazzy.css.scss +26 -0
- data/lib/jazzy/config.rb +29 -0
- data/lib/jazzy/doc_builder.rb +17 -9
- data/lib/jazzy/docset_builder.rb +13 -4
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/jazzy_markdown.rb +2 -1
- data/lib/jazzy/podspec_documenter.rb +109 -0
- data/lib/jazzy/readme_generator.rb +33 -6
- data/lib/jazzy/sourcekitten.rb +15 -2
- data/lib/jazzy/sourcekitten/Commandant.framework/Commandant +0 -0
- data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Commandant +0 -0
- data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Modules/module.modulemap +10 -0
- data/{spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures → lib/jazzy/sourcekitten/Commandant.framework/Versions/A/Resources}/Info.plist +21 -7
- data/lib/jazzy/sourcekitten/LlamaKit.framework/LlamaKit +0 -0
- data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/LlamaKit +0 -0
- data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Modules/module.modulemap +10 -0
- data/lib/jazzy/sourcekitten/LlamaKit.framework/Versions/A/Resources/Info.plist +47 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/SourceKittenFramework +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/SwiftXPC +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/module.modulemap +10 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist +42 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/SwiftXPC +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftSecurity.dylib +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Modules/module.modulemap +10 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/Resources/Info.plist +42 -0
- data/lib/jazzy/sourcekitten/SourceKittenFramework.framework/Versions/A/SourceKittenFramework +0 -0
- data/lib/jazzy/sourcekitten/sourcekitten +0 -0
- data/spec/integration_spec.rb +6 -0
- metadata +50 -122
- data/bin/sourcekitten +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes.html +0 -268
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +0 -488
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +0 -842
- data/spec/integration_specs/document_alamofire/after/docs/Enums.html +0 -258
- data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +0 -383
- data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +0 -703
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +0 -345
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +0 -369
- data/spec/integration_specs/document_alamofire/after/docs/Functions.html +0 -1041
- data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +0 -227
- data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +0 -276
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/css/highlight.css +0 -202
- data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +0 -708
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Info.plist +0 -20
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes.html +0 -268
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/Manager.html +0 -488
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html +0 -842
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Enums.html +0 -258
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Enums/ParameterEncoding.html +0 -383
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions.html +0 -703
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions/Manager.html +0 -345
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Extensions/Request.html +0 -369
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html +0 -1041
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Global Variables.html +0 -227
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Manager.html +0 -345
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/ParameterEncoding.html +0 -383
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols.html +0 -276
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols/URLRequestConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Request.html +0 -369
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/URLRequestConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/URLStringConvertible.html +0 -228
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/css/highlight.css +0 -202
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/css/jazzy.css +0 -708
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/highlight.css +0 -202
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/img/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html +0 -756
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jazzy.css +0 -708
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jazzy.js +0 -21
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jquery.min.js +0 -4
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js +0 -21
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js +0 -4
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/undocumented.txt +0 -18
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/docSet.dsidx.csv +0 -80
- data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.xml +0 -1
- data/spec/integration_specs/document_alamofire/after/docs/img/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/img/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/img/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/index.html +0 -756
- data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +0 -21
- data/spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js +0 -4
- data/spec/integration_specs/document_alamofire/after/docs/undocumented.txt +0 -18
- data/spec/integration_specs/document_alamofire/after/execution_output.txt +0 -5
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +0 -333
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +0 -171
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +0 -152
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/highlight.css +0 -202
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +0 -708
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Info.plist +0 -20
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes.html +0 -333
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/DocumentedEnum.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums.html +0 -171
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Global Variables.html +0 -152
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/ImplicitlyInternalTopLevelClass.html +0 -149
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/highlight.css +0 -202
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/jazzy.css +0 -708
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/highlight.css +0 -202
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +0 -112
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.css +0 -708
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.js +0 -21
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js +0 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js +0 -21
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js +0 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/undocumented.txt +0 -3
- data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +0 -17
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +0 -112
- data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +0 -21
- data/spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js +0 -4
- data/spec/integration_specs/misc_jazzy_features/after/docs/undocumented.txt +0 -3
- data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +0 -5
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj +0 -293
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.xcworkspace/contents.xcworkspacedata +0 -7
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +0 -60
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/MiscJazzyFeatures.h +0 -10
- data/spec/integration_specs/misc_jazzy_features/before/docs/Classes.html +0 -317
- data/spec/integration_specs/misc_jazzy_features/before/docs/Classes/ImplicitlyInternalTopLevelClass.html +0 -138
- data/spec/integration_specs/misc_jazzy_features/before/docs/Enums.html +0 -155
- data/spec/integration_specs/misc_jazzy_features/before/docs/Enums/DocumentedEnum.html +0 -128
- data/spec/integration_specs/misc_jazzy_features/before/docs/Global Variables.html +0 -138
- data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +0 -609
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/index.html +0 -99
- data/spec/integration_specs/misc_jazzy_features/before/docs/js/jazzy.js +0 -15
- data/spec/integration_specs/misc_jazzy_features/before/docs/js/jquery.min.js +0 -4
@@ -1,842 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html lang="en">
|
3
|
-
<head>
|
4
|
-
<title>Request Class 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/Class/Request" class="dashAnchor"></a>
|
24
|
-
<a title="Request Class Reference"></a>
|
25
|
-
<header>
|
26
|
-
<div class="content-wrapper">
|
27
|
-
<p class="header-text"><a href="../index.html">Alamofire Docs</a> (83% 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
|
-
<p id="header-links"><a href="dash-feed://http%3A%2F%2Fstatic%2Erealm%2Eio%2Fjazzy_demo%2FAlamofire%2Fdocsets%2FAlamofire%2Exml"><img id="header-icon" src="../img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
|
30
|
-
</div>
|
31
|
-
</header>
|
32
|
-
<section id="valence">
|
33
|
-
<div class="content-wrapper">
|
34
|
-
<p id="hierarchial_navigation">
|
35
|
-
<a href="../index.html" id="design_resources_link">Alamofire Reference</a>
|
36
|
-
<img id="carat" src="../img/carat.png" height="10px" width="6px" />
|
37
|
-
Request Class Reference
|
38
|
-
</p>
|
39
|
-
</div>
|
40
|
-
</section>
|
41
|
-
<div class="content-wrapper">
|
42
|
-
<nav class="book-parts">
|
43
|
-
<ul class="nav-parts">
|
44
|
-
<li class="part-name tasks">
|
45
|
-
<a href="../Classes.html">Classes</a>
|
46
|
-
<ul class="nav-chapters">
|
47
|
-
<li class="nav-chapter">
|
48
|
-
<a href="../Classes/Manager.html">Manager</a>
|
49
|
-
</li>
|
50
|
-
<li class="nav-chapter">
|
51
|
-
<a href="../Classes/Request.html">Request</a>
|
52
|
-
</li>
|
53
|
-
</ul>
|
54
|
-
</li>
|
55
|
-
<li class="part-name tasks">
|
56
|
-
<a href="../Global Variables.html">Global Variables</a>
|
57
|
-
<ul class="nav-chapters">
|
58
|
-
<li class="nav-chapter">
|
59
|
-
<a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
|
60
|
-
</li>
|
61
|
-
</ul>
|
62
|
-
</li>
|
63
|
-
<li class="part-name tasks">
|
64
|
-
<a href="../Enums.html">Enums</a>
|
65
|
-
<ul class="nav-chapters">
|
66
|
-
<li class="nav-chapter">
|
67
|
-
<a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
|
68
|
-
</li>
|
69
|
-
<li class="nav-chapter">
|
70
|
-
<a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
|
71
|
-
</li>
|
72
|
-
</ul>
|
73
|
-
</li>
|
74
|
-
<li class="part-name tasks">
|
75
|
-
<a href="../Extensions.html">Extensions</a>
|
76
|
-
<ul class="nav-chapters">
|
77
|
-
<li class="nav-chapter">
|
78
|
-
<a href="../Extensions/Manager.html">Manager</a>
|
79
|
-
</li>
|
80
|
-
<li class="nav-chapter">
|
81
|
-
<a href="../Extensions/Manager.html">Manager</a>
|
82
|
-
</li>
|
83
|
-
<li class="nav-chapter">
|
84
|
-
<a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
85
|
-
</li>
|
86
|
-
<li class="nav-chapter">
|
87
|
-
<a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
|
88
|
-
</li>
|
89
|
-
<li class="nav-chapter">
|
90
|
-
<a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
|
91
|
-
</li>
|
92
|
-
<li class="nav-chapter">
|
93
|
-
<a href="../Extensions/Request.html">Request</a>
|
94
|
-
</li>
|
95
|
-
<li class="nav-chapter">
|
96
|
-
<a href="../Extensions/Request.html">Request</a>
|
97
|
-
</li>
|
98
|
-
<li class="nav-chapter">
|
99
|
-
<a href="../Extensions/Request.html">Request</a>
|
100
|
-
</li>
|
101
|
-
<li class="nav-chapter">
|
102
|
-
<a href="../Extensions/Request.html">Request</a>
|
103
|
-
</li>
|
104
|
-
<li class="nav-chapter">
|
105
|
-
<a href="../Extensions/Request.html">Request</a>
|
106
|
-
</li>
|
107
|
-
<li class="nav-chapter">
|
108
|
-
<a href="../Extensions/Request.html">Request</a>
|
109
|
-
</li>
|
110
|
-
<li class="nav-chapter">
|
111
|
-
<a href="../Extensions/Request.html">Request</a>
|
112
|
-
</li>
|
113
|
-
<li class="nav-chapter">
|
114
|
-
<a href="../Extensions.html#/s:SS">String</a>
|
115
|
-
</li>
|
116
|
-
</ul>
|
117
|
-
</li>
|
118
|
-
<li class="part-name tasks">
|
119
|
-
<a href="../Functions.html">Functions</a>
|
120
|
-
<ul class="nav-chapters">
|
121
|
-
<li class="nav-chapter">
|
122
|
-
<a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
|
123
|
-
</li>
|
124
|
-
<li class="nav-chapter">
|
125
|
-
<a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
|
126
|
-
</li>
|
127
|
-
<li class="nav-chapter">
|
128
|
-
<a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
|
129
|
-
</li>
|
130
|
-
<li class="nav-chapter">
|
131
|
-
<a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
|
132
|
-
</li>
|
133
|
-
<li class="nav-chapter">
|
134
|
-
<a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
|
135
|
-
</li>
|
136
|
-
<li class="nav-chapter">
|
137
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
|
138
|
-
</li>
|
139
|
-
<li class="nav-chapter">
|
140
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
|
141
|
-
</li>
|
142
|
-
<li class="nav-chapter">
|
143
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
|
144
|
-
</li>
|
145
|
-
<li class="nav-chapter">
|
146
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
|
147
|
-
</li>
|
148
|
-
<li class="nav-chapter">
|
149
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
|
150
|
-
</li>
|
151
|
-
<li class="nav-chapter">
|
152
|
-
<a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
|
153
|
-
</li>
|
154
|
-
</ul>
|
155
|
-
</li>
|
156
|
-
<li class="part-name tasks">
|
157
|
-
<a href="../Protocols.html">Protocols</a>
|
158
|
-
<ul class="nav-chapters">
|
159
|
-
<li class="nav-chapter">
|
160
|
-
<a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
|
161
|
-
</li>
|
162
|
-
<li class="nav-chapter">
|
163
|
-
<a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
|
164
|
-
</li>
|
165
|
-
</ul>
|
166
|
-
</li>
|
167
|
-
</ul>
|
168
|
-
</nav>
|
169
|
-
<div class="pixel-line"></div>
|
170
|
-
<div class="rubber-band-gap"></div>
|
171
|
-
<article class="chapter">
|
172
|
-
<a name="/"></a>
|
173
|
-
<h1 class="chapter-name">Request</h1>
|
174
|
-
<section>
|
175
|
-
<section class="section">
|
176
|
-
<p class="para">Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying <code>NSURLSessionTask</code>.</p>
|
177
|
-
</section>
|
178
|
-
<section class="section task-group-section">
|
179
|
-
<div class="task-group">
|
180
|
-
<div class="task-name-container">
|
181
|
-
|
182
|
-
<a name="/Unnamed"></a>
|
183
|
-
|
184
|
-
</div>
|
185
|
-
<ul class="task-group-list">
|
186
|
-
<li class="item symbol">
|
187
|
-
<div class="task-group-term">
|
188
|
-
<code>
|
189
|
-
<a name="/s:C9Alamofire7Request10Serializer">
|
190
|
-
<a name="//apple_ref/swift/Alias/Serializer" class="dashAnchor"></a>
|
191
|
-
<a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
|
192
|
-
</code>
|
193
|
-
</div>
|
194
|
-
<div class="height-container">
|
195
|
-
<div class="pointy-thing-container"></div>
|
196
|
-
<section class="section instance-method">
|
197
|
-
<div class="pointy-thing"></div>
|
198
|
-
<div class="abstract">
|
199
|
-
<p class="para">A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</p>
|
200
|
-
</div>
|
201
|
-
<div class="declaration">
|
202
|
-
<h4>Declaration</h4>
|
203
|
-
|
204
|
-
<div class="Swift">
|
205
|
-
<p class="aside-title">Swift</p>
|
206
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Serializer</span> <span class="o">=</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">NSData</span><span class="p">?)</span> <span class="o">-></span> <span class="p">(</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
|
207
|
-
|
208
|
-
</div>
|
209
|
-
</div>
|
210
|
-
<div class="result-description view-on-github">
|
211
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
|
212
|
-
</div>
|
213
|
-
</section>
|
214
|
-
</div>
|
215
|
-
</li>
|
216
|
-
<li class="item symbol">
|
217
|
-
<div class="task-group-term">
|
218
|
-
<code>
|
219
|
-
<a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
|
220
|
-
<a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
|
221
|
-
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
|
222
|
-
</code>
|
223
|
-
</div>
|
224
|
-
<div class="height-container">
|
225
|
-
<div class="pointy-thing-container"></div>
|
226
|
-
<section class="section instance-method">
|
227
|
-
<div class="pointy-thing"></div>
|
228
|
-
<div class="abstract">
|
229
|
-
<p class="para">The underlying task.</p>
|
230
|
-
</div>
|
231
|
-
<div class="declaration">
|
232
|
-
<h4>Declaration</h4>
|
233
|
-
|
234
|
-
<div class="Swift">
|
235
|
-
<p class="aside-title">Swift</p>
|
236
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">NSURLSessionTask</span></code></pre>
|
237
|
-
|
238
|
-
</div>
|
239
|
-
</div>
|
240
|
-
<div class="result-description view-on-github">
|
241
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
|
242
|
-
</div>
|
243
|
-
</section>
|
244
|
-
</div>
|
245
|
-
</li>
|
246
|
-
<li class="item symbol">
|
247
|
-
<div class="task-group-term">
|
248
|
-
<code>
|
249
|
-
<a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
|
250
|
-
<a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
|
251
|
-
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
|
252
|
-
</code>
|
253
|
-
</div>
|
254
|
-
<div class="height-container">
|
255
|
-
<div class="pointy-thing-container"></div>
|
256
|
-
<section class="section instance-method">
|
257
|
-
<div class="pointy-thing"></div>
|
258
|
-
<div class="abstract">
|
259
|
-
<p class="para">The session belonging to the underlying task.</p>
|
260
|
-
</div>
|
261
|
-
<div class="declaration">
|
262
|
-
<h4>Declaration</h4>
|
263
|
-
|
264
|
-
<div class="Swift">
|
265
|
-
<p class="aside-title">Swift</p>
|
266
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">NSURLSession</span></code></pre>
|
267
|
-
|
268
|
-
</div>
|
269
|
-
</div>
|
270
|
-
<div class="result-description view-on-github">
|
271
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
|
272
|
-
</div>
|
273
|
-
</section>
|
274
|
-
</div>
|
275
|
-
</li>
|
276
|
-
<li class="item symbol">
|
277
|
-
<div class="task-group-term">
|
278
|
-
<code>
|
279
|
-
<a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
|
280
|
-
<a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
|
281
|
-
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
|
282
|
-
</code>
|
283
|
-
</div>
|
284
|
-
<div class="height-container">
|
285
|
-
<div class="pointy-thing-container"></div>
|
286
|
-
<section class="section instance-method">
|
287
|
-
<div class="pointy-thing"></div>
|
288
|
-
<div class="abstract">
|
289
|
-
<p class="para">The request sent or to be sent to the server.</p>
|
290
|
-
</div>
|
291
|
-
<div class="declaration">
|
292
|
-
<h4>Declaration</h4>
|
293
|
-
|
294
|
-
<div class="Swift">
|
295
|
-
<p class="aside-title">Swift</p>
|
296
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">NSURLRequest</span></code></pre>
|
297
|
-
|
298
|
-
</div>
|
299
|
-
</div>
|
300
|
-
<div class="result-description view-on-github">
|
301
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
|
302
|
-
</div>
|
303
|
-
</section>
|
304
|
-
</div>
|
305
|
-
</li>
|
306
|
-
<li class="item symbol">
|
307
|
-
<div class="task-group-term">
|
308
|
-
<code>
|
309
|
-
<a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
|
310
|
-
<a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
|
311
|
-
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
|
312
|
-
</code>
|
313
|
-
</div>
|
314
|
-
<div class="height-container">
|
315
|
-
<div class="pointy-thing-container"></div>
|
316
|
-
<section class="section instance-method">
|
317
|
-
<div class="pointy-thing"></div>
|
318
|
-
<div class="abstract">
|
319
|
-
<p class="para">The response received from the server, if any.</p>
|
320
|
-
</div>
|
321
|
-
<div class="declaration">
|
322
|
-
<h4>Declaration</h4>
|
323
|
-
|
324
|
-
<div class="Swift">
|
325
|
-
<p class="aside-title">Swift</p>
|
326
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?</span></code></pre>
|
327
|
-
|
328
|
-
</div>
|
329
|
-
</div>
|
330
|
-
<div class="result-description view-on-github">
|
331
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
|
332
|
-
</div>
|
333
|
-
</section>
|
334
|
-
</div>
|
335
|
-
</li>
|
336
|
-
<li class="item symbol">
|
337
|
-
<div class="task-group-term">
|
338
|
-
<code>
|
339
|
-
<a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
|
340
|
-
<a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
|
341
|
-
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
|
342
|
-
</code>
|
343
|
-
</div>
|
344
|
-
<div class="height-container">
|
345
|
-
<div class="pointy-thing-container"></div>
|
346
|
-
<section class="section instance-method">
|
347
|
-
<div class="pointy-thing"></div>
|
348
|
-
<div class="abstract">
|
349
|
-
<p class="para">The progress of the request lifecycle.</p>
|
350
|
-
</div>
|
351
|
-
<div class="declaration">
|
352
|
-
<h4>Declaration</h4>
|
353
|
-
|
354
|
-
<div class="Swift">
|
355
|
-
<p class="aside-title">Swift</p>
|
356
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">NSProgress</span><span class="p">?</span></code></pre>
|
357
|
-
|
358
|
-
</div>
|
359
|
-
</div>
|
360
|
-
<div class="result-description view-on-github">
|
361
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
|
362
|
-
</div>
|
363
|
-
</section>
|
364
|
-
</div>
|
365
|
-
</li>
|
366
|
-
</ul>
|
367
|
-
</div>
|
368
|
-
<div class="task-group">
|
369
|
-
<div class="task-name-container">
|
370
|
-
|
371
|
-
<a name="/Authentication"></a>
|
372
|
-
<a name="//apple_ref/swift/Section/Authentication" class="dashAnchor"></a>
|
373
|
-
<a href="#/Authentication">
|
374
|
-
<h3 class="section-name">Authentication</h3>
|
375
|
-
</a>
|
376
|
-
|
377
|
-
</div>
|
378
|
-
<ul class="task-group-list">
|
379
|
-
<li class="item symbol">
|
380
|
-
<div class="task-group-term">
|
381
|
-
<code>
|
382
|
-
<a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
|
383
|
-
<a name="//apple_ref/swift/Method/authenticate(user:password:)" class="dashAnchor"></a>
|
384
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
|
385
|
-
</code>
|
386
|
-
</div>
|
387
|
-
<div class="height-container">
|
388
|
-
<div class="pointy-thing-container"></div>
|
389
|
-
<section class="section instance-method">
|
390
|
-
<div class="pointy-thing"></div>
|
391
|
-
<div class="abstract">
|
392
|
-
<p class="para">Associates an HTTP Basic credential with the request.</p>
|
393
|
-
</div>
|
394
|
-
<div class="declaration">
|
395
|
-
<h4>Declaration</h4>
|
396
|
-
|
397
|
-
<div class="Swift">
|
398
|
-
<p class="aside-title">Swift</p>
|
399
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="nv">#user</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
|
400
|
-
|
401
|
-
</div>
|
402
|
-
</div>
|
403
|
-
<div class="parameters">
|
404
|
-
<h4>Parameters</h4>
|
405
|
-
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
406
|
-
<tbody>
|
407
|
-
<tr>
|
408
|
-
<td scope="row">
|
409
|
-
<code>
|
410
|
-
<em class="term">user</em>
|
411
|
-
</code>
|
412
|
-
</td>
|
413
|
-
<td>
|
414
|
-
<div class="definition">
|
415
|
-
<p class="para">The user.</p>
|
416
|
-
</div>
|
417
|
-
</td>
|
418
|
-
</tr>
|
419
|
-
<tr>
|
420
|
-
<td scope="row">
|
421
|
-
<code>
|
422
|
-
<em class="term">password</em>
|
423
|
-
</code>
|
424
|
-
</td>
|
425
|
-
<td>
|
426
|
-
<div class="definition">
|
427
|
-
<p class="para">The password.</p>
|
428
|
-
</div>
|
429
|
-
</td>
|
430
|
-
</tr>
|
431
|
-
</tbody>
|
432
|
-
</table>
|
433
|
-
</div>
|
434
|
-
<div class="result-description">
|
435
|
-
<h4>Return Value</h4>
|
436
|
-
<p class="para">The request.</p>
|
437
|
-
</div>
|
438
|
-
<div class="result-description view-on-github">
|
439
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L565">Show on GitHub</a>
|
440
|
-
</div>
|
441
|
-
</section>
|
442
|
-
</div>
|
443
|
-
</li>
|
444
|
-
<li class="item symbol">
|
445
|
-
<div class="task-group-term">
|
446
|
-
<code>
|
447
|
-
<a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
|
448
|
-
<a name="//apple_ref/swift/Method/authenticate(usingCredential:)" class="dashAnchor"></a>
|
449
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
|
450
|
-
</code>
|
451
|
-
</div>
|
452
|
-
<div class="height-container">
|
453
|
-
<div class="pointy-thing-container"></div>
|
454
|
-
<section class="section instance-method">
|
455
|
-
<div class="pointy-thing"></div>
|
456
|
-
<div class="abstract">
|
457
|
-
<p class="para">Associates a specified credential with the request.</p>
|
458
|
-
</div>
|
459
|
-
<div class="declaration">
|
460
|
-
<h4>Declaration</h4>
|
461
|
-
|
462
|
-
<div class="Swift">
|
463
|
-
<p class="aside-title">Swift</p>
|
464
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">usingCredential</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">NSURLCredential</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
|
465
|
-
|
466
|
-
</div>
|
467
|
-
</div>
|
468
|
-
<div class="parameters">
|
469
|
-
<h4>Parameters</h4>
|
470
|
-
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
471
|
-
<tbody>
|
472
|
-
<tr>
|
473
|
-
<td scope="row">
|
474
|
-
<code>
|
475
|
-
<em class="term">credential</em>
|
476
|
-
</code>
|
477
|
-
</td>
|
478
|
-
<td>
|
479
|
-
<div class="definition">
|
480
|
-
<p class="para">The credential.</p>
|
481
|
-
</div>
|
482
|
-
</td>
|
483
|
-
</tr>
|
484
|
-
</tbody>
|
485
|
-
</table>
|
486
|
-
</div>
|
487
|
-
<div class="result-description">
|
488
|
-
<h4>Return Value</h4>
|
489
|
-
<p class="para">The request.</p>
|
490
|
-
</div>
|
491
|
-
<div class="result-description view-on-github">
|
492
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L578">Show on GitHub</a>
|
493
|
-
</div>
|
494
|
-
</section>
|
495
|
-
</div>
|
496
|
-
</li>
|
497
|
-
</ul>
|
498
|
-
</div>
|
499
|
-
<div class="task-group">
|
500
|
-
<div class="task-name-container">
|
501
|
-
|
502
|
-
<a name="/Progress"></a>
|
503
|
-
<a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
|
504
|
-
<a href="#/Progress">
|
505
|
-
<h3 class="section-name">Progress</h3>
|
506
|
-
</a>
|
507
|
-
|
508
|
-
</div>
|
509
|
-
<ul class="task-group-list">
|
510
|
-
<li class="item symbol">
|
511
|
-
<div class="task-group-term">
|
512
|
-
<code>
|
513
|
-
<a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
|
514
|
-
<a name="//apple_ref/swift/Method/progress(closure:)" class="dashAnchor"></a>
|
515
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
|
516
|
-
</code>
|
517
|
-
</div>
|
518
|
-
<div class="height-container">
|
519
|
-
<div class="pointy-thing-container"></div>
|
520
|
-
<section class="section instance-method">
|
521
|
-
<div class="pointy-thing"></div>
|
522
|
-
<div class="abstract">
|
523
|
-
<p class="para">Sets a closure to be called periodically during the lifecycle of the request as data is written to or read from the server.<ul><li>For uploads, the progress closure returns the bytes written, total bytes written, and total bytes expected to write.</li><li>For downloads, the progress closure returns the bytes read, total bytes read, and total bytes expected to write.</li></ul></p>
|
524
|
-
</div>
|
525
|
-
<div class="declaration">
|
526
|
-
<h4>Declaration</h4>
|
527
|
-
|
528
|
-
<div class="Swift">
|
529
|
-
<p class="aside-title">Swift</p>
|
530
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">progress</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
|
531
|
-
|
532
|
-
</div>
|
533
|
-
</div>
|
534
|
-
<div class="parameters">
|
535
|
-
<h4>Parameters</h4>
|
536
|
-
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
537
|
-
<tbody>
|
538
|
-
<tr>
|
539
|
-
<td scope="row">
|
540
|
-
<code>
|
541
|
-
<em class="term">closure</em>
|
542
|
-
</code>
|
543
|
-
</td>
|
544
|
-
<td>
|
545
|
-
<div class="definition">
|
546
|
-
<p class="para">The code to be executed periodically during the lifecycle of the request.</p>
|
547
|
-
</div>
|
548
|
-
</td>
|
549
|
-
</tr>
|
550
|
-
</tbody>
|
551
|
-
</table>
|
552
|
-
</div>
|
553
|
-
<div class="result-description">
|
554
|
-
<h4>Return Value</h4>
|
555
|
-
<p class="para">The request.</p>
|
556
|
-
</div>
|
557
|
-
<div class="result-description view-on-github">
|
558
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L596">Show on GitHub</a>
|
559
|
-
</div>
|
560
|
-
</section>
|
561
|
-
</div>
|
562
|
-
</li>
|
563
|
-
</ul>
|
564
|
-
</div>
|
565
|
-
<div class="task-group">
|
566
|
-
<div class="task-name-container">
|
567
|
-
|
568
|
-
<a name="/Response"></a>
|
569
|
-
<a name="//apple_ref/swift/Section/Response" class="dashAnchor"></a>
|
570
|
-
<a href="#/Response">
|
571
|
-
<h3 class="section-name">Response</h3>
|
572
|
-
</a>
|
573
|
-
|
574
|
-
</div>
|
575
|
-
<ul class="task-group-list">
|
576
|
-
<li class="item symbol">
|
577
|
-
<div class="task-group-term">
|
578
|
-
<code>
|
579
|
-
<a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
|
580
|
-
<a name="//apple_ref/swift/Method/responseDataSerializer()" class="dashAnchor"></a>
|
581
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
|
582
|
-
</code>
|
583
|
-
</div>
|
584
|
-
<div class="height-container">
|
585
|
-
<div class="pointy-thing-container"></div>
|
586
|
-
<section class="section instance-method">
|
587
|
-
<div class="pointy-thing"></div>
|
588
|
-
<div class="abstract">
|
589
|
-
<p class="para">Creates a response serializer that returns the associated data as-is.</p>
|
590
|
-
</div>
|
591
|
-
<div class="declaration">
|
592
|
-
<h4>Declaration</h4>
|
593
|
-
|
594
|
-
<div class="Swift">
|
595
|
-
<p class="aside-title">Swift</p>
|
596
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">responseDataSerializer</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Serializer</span></code></pre>
|
597
|
-
|
598
|
-
</div>
|
599
|
-
</div>
|
600
|
-
<div class="result-description">
|
601
|
-
<h4>Return Value</h4>
|
602
|
-
<p class="para">A data response serializer.</p>
|
603
|
-
</div>
|
604
|
-
<div class="result-description view-on-github">
|
605
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L620">Show on GitHub</a>
|
606
|
-
</div>
|
607
|
-
</section>
|
608
|
-
</div>
|
609
|
-
</li>
|
610
|
-
<li class="item symbol">
|
611
|
-
<div class="task-group-term">
|
612
|
-
<code>
|
613
|
-
<a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
|
614
|
-
<a name="//apple_ref/swift/Method/response(_:)" class="dashAnchor"></a>
|
615
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
|
616
|
-
</code>
|
617
|
-
</div>
|
618
|
-
<div class="height-container">
|
619
|
-
<div class="pointy-thing-container"></div>
|
620
|
-
<section class="section instance-method">
|
621
|
-
<div class="pointy-thing"></div>
|
622
|
-
<div class="abstract">
|
623
|
-
<p class="para">Adds a handler to be called once the request has finished.</p>
|
624
|
-
</div>
|
625
|
-
<div class="declaration">
|
626
|
-
<h4>Declaration</h4>
|
627
|
-
|
628
|
-
<div class="Swift">
|
629
|
-
<p class="aside-title">Swift</p>
|
630
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
|
631
|
-
|
632
|
-
</div>
|
633
|
-
</div>
|
634
|
-
<div class="parameters">
|
635
|
-
<h4>Parameters</h4>
|
636
|
-
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
637
|
-
<tbody>
|
638
|
-
<tr>
|
639
|
-
<td scope="row">
|
640
|
-
<code>
|
641
|
-
<em class="term">completionHandler</em>
|
642
|
-
</code>
|
643
|
-
</td>
|
644
|
-
<td>
|
645
|
-
<div class="definition">
|
646
|
-
<p class="para">The code to be executed once the request has finished.</p>
|
647
|
-
</div>
|
648
|
-
</td>
|
649
|
-
</tr>
|
650
|
-
</tbody>
|
651
|
-
</table>
|
652
|
-
</div>
|
653
|
-
<div class="result-description">
|
654
|
-
<h4>Return Value</h4>
|
655
|
-
<p class="para">The request.</p>
|
656
|
-
</div>
|
657
|
-
<div class="result-description view-on-github">
|
658
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L633">Show on GitHub</a>
|
659
|
-
</div>
|
660
|
-
</section>
|
661
|
-
</div>
|
662
|
-
</li>
|
663
|
-
<li class="item symbol">
|
664
|
-
<div class="task-group-term">
|
665
|
-
<code>
|
666
|
-
<a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
|
667
|
-
<a name="//apple_ref/swift/Method/response(queue:serializer:completionHandler:)" class="dashAnchor"></a>
|
668
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">response(queue:serializer:completionHandler:)</a>
|
669
|
-
</code>
|
670
|
-
</div>
|
671
|
-
<div class="height-container">
|
672
|
-
<div class="pointy-thing-container"></div>
|
673
|
-
<section class="section instance-method">
|
674
|
-
<div class="pointy-thing"></div>
|
675
|
-
<div class="abstract">
|
676
|
-
<p class="para">Adds a handler to be called once the request has finished.</p>
|
677
|
-
</div>
|
678
|
-
<div class="declaration">
|
679
|
-
<h4>Declaration</h4>
|
680
|
-
|
681
|
-
<div class="Swift">
|
682
|
-
<p class="aside-title">Swift</p>
|
683
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="n">dispatch_queue_t</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
|
684
|
-
|
685
|
-
</div>
|
686
|
-
</div>
|
687
|
-
<div class="parameters">
|
688
|
-
<h4>Parameters</h4>
|
689
|
-
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
690
|
-
<tbody>
|
691
|
-
<tr>
|
692
|
-
<td scope="row">
|
693
|
-
<code>
|
694
|
-
<em class="term">queue</em>
|
695
|
-
</code>
|
696
|
-
</td>
|
697
|
-
<td>
|
698
|
-
<div class="definition">
|
699
|
-
<p class="para">The queue on which the completion handler is dispatched.</p>
|
700
|
-
</div>
|
701
|
-
</td>
|
702
|
-
</tr>
|
703
|
-
<tr>
|
704
|
-
<td scope="row">
|
705
|
-
<code>
|
706
|
-
<em class="term">serializer</em>
|
707
|
-
</code>
|
708
|
-
</td>
|
709
|
-
<td>
|
710
|
-
<div class="definition">
|
711
|
-
<p class="para">The closure responsible for serializing the request, response, and data.</p>
|
712
|
-
</div>
|
713
|
-
</td>
|
714
|
-
</tr>
|
715
|
-
<tr>
|
716
|
-
<td scope="row">
|
717
|
-
<code>
|
718
|
-
<em class="term">completionHandler</em>
|
719
|
-
</code>
|
720
|
-
</td>
|
721
|
-
<td>
|
722
|
-
<div class="definition">
|
723
|
-
<p class="para">The code to be executed once the request has finished.</p>
|
724
|
-
</div>
|
725
|
-
</td>
|
726
|
-
</tr>
|
727
|
-
</tbody>
|
728
|
-
</table>
|
729
|
-
</div>
|
730
|
-
<div class="result-description">
|
731
|
-
<h4>Return Value</h4>
|
732
|
-
<p class="para">The request.</p>
|
733
|
-
</div>
|
734
|
-
<div class="result-description view-on-github">
|
735
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L646">Show on GitHub</a>
|
736
|
-
</div>
|
737
|
-
</section>
|
738
|
-
</div>
|
739
|
-
</li>
|
740
|
-
<li class="item symbol">
|
741
|
-
<div class="task-group-term">
|
742
|
-
<code>
|
743
|
-
<a name="/s:FC9Alamofire7Request7suspendFS0_FT_T_">
|
744
|
-
<a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
|
745
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request7suspendFS0_FT_T_">suspend()</a>
|
746
|
-
</code>
|
747
|
-
</div>
|
748
|
-
<div class="height-container">
|
749
|
-
<div class="pointy-thing-container"></div>
|
750
|
-
<section class="section instance-method">
|
751
|
-
<div class="pointy-thing"></div>
|
752
|
-
<div class="abstract">
|
753
|
-
<p class="para">Suspends the request.</p>
|
754
|
-
</div>
|
755
|
-
<div class="declaration">
|
756
|
-
<h4>Declaration</h4>
|
757
|
-
|
758
|
-
<div class="Swift">
|
759
|
-
<p class="aside-title">Swift</p>
|
760
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span></code></pre>
|
761
|
-
|
762
|
-
</div>
|
763
|
-
</div>
|
764
|
-
<div class="result-description view-on-github">
|
765
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L661">Show on GitHub</a>
|
766
|
-
</div>
|
767
|
-
</section>
|
768
|
-
</div>
|
769
|
-
</li>
|
770
|
-
<li class="item symbol">
|
771
|
-
<div class="task-group-term">
|
772
|
-
<code>
|
773
|
-
<a name="/s:FC9Alamofire7Request6resumeFS0_FT_T_">
|
774
|
-
<a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
|
775
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6resumeFS0_FT_T_">resume()</a>
|
776
|
-
</code>
|
777
|
-
</div>
|
778
|
-
<div class="height-container">
|
779
|
-
<div class="pointy-thing-container"></div>
|
780
|
-
<section class="section instance-method">
|
781
|
-
<div class="pointy-thing"></div>
|
782
|
-
<div class="abstract">
|
783
|
-
<p class="para">Resumes the request.</p>
|
784
|
-
</div>
|
785
|
-
<div class="declaration">
|
786
|
-
<h4>Declaration</h4>
|
787
|
-
|
788
|
-
<div class="Swift">
|
789
|
-
<p class="aside-title">Swift</p>
|
790
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span></code></pre>
|
791
|
-
|
792
|
-
</div>
|
793
|
-
</div>
|
794
|
-
<div class="result-description view-on-github">
|
795
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L668">Show on GitHub</a>
|
796
|
-
</div>
|
797
|
-
</section>
|
798
|
-
</div>
|
799
|
-
</li>
|
800
|
-
<li class="item symbol">
|
801
|
-
<div class="task-group-term">
|
802
|
-
<code>
|
803
|
-
<a name="/s:FC9Alamofire7Request6cancelFS0_FT_T_">
|
804
|
-
<a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
|
805
|
-
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6cancelFS0_FT_T_">cancel()</a>
|
806
|
-
</code>
|
807
|
-
</div>
|
808
|
-
<div class="height-container">
|
809
|
-
<div class="pointy-thing-container"></div>
|
810
|
-
<section class="section instance-method">
|
811
|
-
<div class="pointy-thing"></div>
|
812
|
-
<div class="abstract">
|
813
|
-
<p class="para">Cancels the request.</p>
|
814
|
-
</div>
|
815
|
-
<div class="declaration">
|
816
|
-
<h4>Declaration</h4>
|
817
|
-
|
818
|
-
<div class="Swift">
|
819
|
-
<p class="aside-title">Swift</p>
|
820
|
-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
|
821
|
-
|
822
|
-
</div>
|
823
|
-
</div>
|
824
|
-
<div class="result-description view-on-github">
|
825
|
-
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L675">Show on GitHub</a>
|
826
|
-
</div>
|
827
|
-
</section>
|
828
|
-
</div>
|
829
|
-
</li>
|
830
|
-
</ul>
|
831
|
-
</div>
|
832
|
-
</section>
|
833
|
-
</section>
|
834
|
-
<section id="footer">
|
835
|
-
<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>
|
836
|
-
<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>
|
837
|
-
</section>
|
838
|
-
</article>
|
839
|
-
</div>
|
840
|
-
</body>
|
841
|
-
</div>
|
842
|
-
</html>
|